Our Reconciliation API helps you reconcile and match the payouts credited in your account and with the transactions and refund operations they relate to.
Three endpoints are available to help you with your reconciliation:
GET Payout List: will provide you with a list of all the payments credited into your payout account(s) by date.GET Payment List: will provide you with a list of all theSUCCEEDEDtransactions by Payout ID or by date range.GET Refund List: will provide you wirh a list of all theSUCCEEDEDrefunds by Payout ID or by date range.
Please note that all reconciliation data will only be made available on D+1 starting at 09:00CET. Recociliation data is available in both PREPROD and PROD environements.
For the full endpoint documentation, please refer to the Reconciliation API.
For more information on Payouts and Remittance Information, please refer to this guide.
This endpoint allows you to retrieve a list of all the payments credited into your payout account(s) by date.
| Name | Type | Required | Description |
|---|---|---|---|
size | Integer | No | The size of the page to be returned (Default is 10000). |
page | Integer | No | Zero-based page index in list request (Default is 0). |
date | String | No | The date for which the list of payouts should be returned. Format should be yyyy-MM-dd. (Default is current UTC date) |
the total number of elements in the current page of this response
the total number of pages in the response
the total number of elements in the response
the current page number
a list of payouts. If the list is empty, then there were no payouts made.
The unique identifier associated with the payout if a pay-out was successfully created
The merchant id used during aggregation of the payout run
The bulk id used during aggregation of the of the payout run if available, if not NONE would be sent as default
The IBAN in (ISO 13616) format used during aggregation of the payout run and this will be used to payout to the merchant
- SUCCEEDED - Payout was successfully processed
- FAILED - Payout failed.
timestamp, when payout was created in UTC
currency code. Only EUR is supported ISO 4217
The total number of payments included in the payout
The total number of refunds included in the payout
The total payment amount in cents contained in the payout.
The total refund amount in cents contained in the payout.
Total amount in cents paid out the to merchant
| HTTP Status | Code | Meaning |
|---|---|---|
| 400 | BAD_REQUEST | Some fields in the requests were not formatted correctly |
| 401 | UNAUTHORIZED | The JWS signature is not valid the caller does not have valid authentication credentials |
| 403 | ACCESS_DENIED | Operation not allowed, the caller doesnot have the required authorities |
| 500 | TECHNICAL_ERROR | Internal technical error in the payment service. |
| 503 | // | Service unavailable. |
- PREPROD merchant API
https://merchant.api.preprod.bancontact.net/reconciliation/payouts
- PROD merchant API
https://merchant.api.bancontact.net/reconciliation/payouts
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://merchant.api.preprod.bancontact.net/reconciliation/payouts?size=10000&page=0&date=2020-06-18' \
-H 'Signature: YOUR_API_KEY_HERE'This endpoint allows you to retrieve a list of all all the SUCCEEDED transactions by Payout ID or by date range.
| Name | Type | Required | Description |
|---|---|---|---|
size | Integer | No | The size of the page to be returned (Defaul is 10000). |
page | Integer | No | Zero-based page indew in list request (Default is 0). |
start-date | String | No, unless end-date provided | The inclusive start date for the Payment list. Format should be yyyy-MM-dd. Maximum 30 days between start-date and end-date |
end-date | String | No, unless start-date provided | The inclusive end date for the Payment list. Format should be yyyy-MM-dd. Maximum 30 days between start-date and end-date |
payout-id | Integer | No | Unique payout identifier for which you wish to retrieve the Payment list. |
the total number of elements in the current page of this response
the total number of pages in the response
the total number of elements in the response
the current page number
a list of payments included in the payout.
The id of the payment
The id of the payout
The profile id of the merchant used in the transaction
The name of the merchant
"The channel of the payment"
currency code. Only EUR is supported ISO 4217
Total amount in cents of the transaction
The reference provided by the merchant/partner during a payment/refund
The description provided by the merchant/partner during a payment/refund
timestamp, when transaction was created in UTC
| HTTP Status | Code | Meaning |
|---|---|---|
| 400 | BAD_REQUEST | Some fields in the requests were not formatted correctly |
| 401 | UNAUTHORIZED | The JWS signature is not valid the caller does not have valid authentication credentials |
| 403 | ACCESS_DENIED | Operation not allowed, the caller doesnot have the required authorities |
| 404 | PAYOUT_NOT_FOUND | Could not find a Payout with the prodivded ID |
| 500 | TECHNICAL_ERROR | Internal technical error in the payment service. |
| 503 | // | Service unavailable. |
- PREPROD merchant API
https://merchant.api.preprod.bancontact.net/reconciliation/payments
- PROD merchant API
https://merchant.api.bancontact.net/reconciliation/payments
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://merchant.api.preprod.bancontact.net/reconciliation/payments?payout-id=stringstringstringstring&size=10000&page=0&start-date=2020-06-18&end-date=2020-06-18' \
-H 'Signature: YOUR_API_KEY_HERE'This endpoint allows you to retrieve a list of all all the SUCCEEDED refunds by Payout ID or by date range.
| Name | Type | Required | Description |
|---|---|---|---|
size | Integer | No | The size of the page to be returned (Defaul is 10000). |
page | Integer | No | Zero-based page indew in list request (Default is 0). |
start-date | String | No, unless end-date provided | The inclusive start date for the Payment list. Format should be yyyy-MM-dd. Maximum 30 days between start-date and end-date |
end-date | String | No, unless start-date provided | The inclusive end date for the Payment list. Format should be yyyy-MM-dd. Maximum 30 days between start-date and end-date |
payout-id | Integer | No | Unique payout identifier for which you wish to retrieve the Payment list. |
the total number of elements in the current page of this response
the total number of pages in the response
the total number of elements in the response
the current page number
a list of refunds included in the payout.
The id of the payment
The id of the payout
The profile id of the merchant used in the transaction
The name of the merchant
"The channel of the payment"
currency code. Only EUR is supported ISO 4217
Total amount in cents of the transaction
The reference provided by the merchant/partner during a payment/refund
The description provided by the merchant/partner during a payment/refund
timestamp, when transaction was created in UTC
The id of the refund
| HTTP Status | Code | Meaning |
|---|---|---|
| 400 | BAD_REQUEST | Some fields in the requests were not formatted correctly |
| 401 | UNAUTHORIZED | The JWS signature is not valid the caller does not have valid authentication credentials |
| 403 | ACCESS_DENIED | Operation not allowed, the caller doesnot have the required authorities |
| 404 | PAYOUT_NOT_FOUND | Could not find a Payout with the prodivded ID |
| 500 | TECHNICAL_ERROR | Internal technical error in the payment service. |
| 503 | // | Service unavailable. |
- PREPROD merchant API
https://merchant.api.preprod.bancontact.net/reconciliation/refunds
- PROD merchant API
https://merchant.api.bancontact.net/reconciliation/refunds
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://merchant.api.preprod.bancontact.net/reconciliation/refunds?payout-id=stringstringstringstring&size=10000&page=0&start-date=2020-06-18&end-date=2020-06-18' \
-H 'Signature: YOUR_API_KEY_HERE'