This API is used to indicate if there are payouts available after a payout run. If there are no payouts for any reason, API will indicate it in the response by returning an empty list..
Merchant Reconciliation API (3.0.0)
API allows merchant/integrator to reconcile Payments
Download OpenAPI description
Languages
Servers
Mock server
https://docs.payconiq.be/_mock/apis/merchant-reconciliation.openapi/
PREPROD merchant API
https://merchant.api.preprod.bancontact.net/
PROD merchant API
https://merchant.api.bancontact.net/
- Mock server
https://docs.payconiq.be/_mock/apis/merchant-reconciliation.openapi/reconciliation/payouts
- 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://docs.payconiq.be/_mock/apis/merchant-reconciliation.openapi/reconciliation/payouts?size=10000&page=0&date=2020-06-18' \
-H 'Signature: YOUR_API_KEY_HERE'Payouts List Response
Detached JWS signature of response payload. Bancontact Payconiq Company hosts the Public Key in JWK format as JWKS at:
https://jwks.bancontact.net/
https://jwks.preprod.bancontact.net/ for PROD and PREPROD environments respectively. Merchants should use the Public key downloaded from this url identified by kid claim in JOSE header. Bancontact Payconiq Company will use the same algorithm to sign the response as the one used for request signature The signature must be computed as per following instructions:
jws = base64URLEncode(JOSE Header)..alg(base64URLEncode(JOSE Header).base64URLEncode(Response Body))
{ "typ": "jose+json", "kid": "JWK kid", "alg": "ES256(ECDSA using P-256 and SHA-256. Minimum keysize 256 bit)", "https://payconiq.com/sub" : "{merchantProfileId}", "https://payconiq.com/iss" : "Payconiq", "https://payconiq.com/iat" : "{Current creation date time in ISODateTime format, expressed in UTC time format(YYYY-MM-DDThh:mm:ss.sssZ)}, "https://payconiq.com/jti" : "{X-Request-ID}", "https://payconiq.com/path": "request path eg. /bag/v1/payments/{payment-id}/authorization/{authorization-id}/confirm" "crit": ["https://payconiq.com/sub", "https://payconiq.com/iss", "https://payconiq.com/iat", "https://payconiq.com/jti", "https://payconiq.com/path"] }
JWS Payload MUST be same as the response body as base64url encoded JSON data.
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.
Enum"SUCCEEDED""FAILED"
currency code. Only EUR is supported ISO 4217
Value"EUR"
The total payment amount in cents contained in the payout.
The total refund amount in cents contained in the payout.
Response
application/json
{ "size": 0, "totalPages": 0, "totalElements": 0, "number": 0, "payouts": [ { … } ] }