/api/creditcontrol/accounts

Search all accounts

• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json
• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json

/api/creditcontrol/accounts

Open an Account

• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json

/api/creditcontrol/accounts/{accountId}

Open or Change Account

• accountId (path, required) — It must be an alphanumeric value
• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json

/api/creditcontrol/accounts/{creditAccountId}

Close an Account

• creditAccountId (path, required) — Credit account's identifier
• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json

/api/creditcontrol/accounts/{creditAccountId}

Retrieve an Account by Id

• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json
• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
• creditAccountId (path, required)

/api/creditcontrol/accounts/{creditAccountId}

Update email and description of a account

• creditAccountId (path, required) — Credit account's identification
• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json

/api/creditcontrol/accounts/{creditAccountId}/creditlimit

Change credit limit of an Account

• creditAccountId (path, required) — Credit account's identifier
• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json

/api/creditcontrol/accounts/{creditAccountId}/holders

Add an account Holder

• creditAccountId (path, required) — Credit account's identification
• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json

/api/creditcontrol/accounts/{creditAccountId}/holders/{holderId}

Delete an account holder

• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json
• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
• creditAccountId (path, required) — Credit account's identification
• holderId (path, required)

/api/creditcontrol/accounts/{creditAccountId}/invoices

Retrieve invoice by creditAccountId

• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json
• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
• creditAccountId (path, required)

/api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}

Cancel Invoice

• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json
• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
• creditAccountId (path, required) — Credit account's identification
• invoiceId (path, required)

/api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}

Retrieve Invoice by Id

• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json
• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
• creditAccountId (path, required) — Credit account's identification
• invoiceId (path, required)

/api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}

Change Invoice

• creditAccountId (path, required) — Credit account's identification
• invoiceId (path, required)
• friendlyId (query) — Invoice's identification
• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json

/api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}/payments

Mark an invoice as Paid

• creditAccountId (path, required) — Credit account's identification
• invoiceId (path, required)
• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json

/api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}/postponement

Postpone an invoice

• creditAccountId (path, required) — Credit account's identification
• invoiceId (path, required)
• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json

/api/creditcontrol/accounts/{creditAccountId}/statements

Account statements

• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json
• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
• creditAccountId (path, required)

/api/creditcontrol/accounts/{creditAccountId}/statements/{statementId}

Decrease balance of an account

• creditAccountId (path, required) — Credit account's identification
• statementId (path, required)
• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json

/api/creditcontrol/accounts/{creditAccountId}/tolerance

Change tolerance of an account

• creditAccountId (path, required) — Credit account's identification
• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json

/api/creditcontrol/accounts/{creditAccountId}/transaction

Create a Pre Authorization

• creditAccountId (path, required) — Credit account's identification
• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json

/api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId}

Cancel a Pre Authorization

• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json
• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
• creditAccountId (path, required) — Credit account's identification
• transactionId (path, required)

/api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId}

Create a Pre Authorization (using id)

• creditAccountId (path, required) — Credit account's identification
• transactionId (path, required)
• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json

/api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId}/refunds

Partial or Total Refund a Settlement

• creditAccountId (path, required) — Credit account's identification
• transactionId (path, required)
• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json

/api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId}/settlement

Create or Update Settlement

• creditAccountId (path, required) — Credit account's identification
• transactionId (path, required)
• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json

/api/creditcontrol/invoices

Search all invoices

• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json
• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
• from (query)
• to (query)
• createdDateFrom (query)
• createdDateTo (query)
• value (query) — Invoice's value. It must be completed with a decimal value.
• status (query) — Invoice's status. It must be completed with "Paid", "Cancelled" or "Open" value.
• friendlyId (query) — Invoice's identifier
• creditAccountId (query) — Credit account's identifier

/api/creditcontrol/storeconfig

Retrieve store configuration

• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json
• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json

/api/creditcontrol/storeconfig

Create or change store configuration

• Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
• Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json