Skip to content

Merchant Reconciliation API (3.0.0)

API allows merchant/integrator to reconcile Payments

History

(2025-07-24)

  • Remove SubmerchantName and SubmerchantID.
Download OpenAPI description
merchant-reconciliation.openapi.json
merchant-reconciliation.openapi.yaml
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/

payoutList

Operations

Get a list of all payouts for the merchant

Request

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..

Security
JWS-Request-Signature
Query
sizeinteger[ 10000 .. 10000 ]

the size of the page to be returned in list requests.

Default 10000
pageinteger>= 0

zero-based page index in list requests.

Default 0
datestring(date)

The date in yyyy-MM-dd format for which the list of payouts should be returned. If not provided, current date in UTC will be used.

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'

Responses

Payouts List Response

Headers
Signaturestring

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))

    JOSE Header =

    { "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.

Bodyapplication/json
sizeinteger>= 0required

the total number of elements in the current page of this response

totalPagesintegerrequired

the total number of pages in the response

totalElementsintegerrequired

the total number of elements in the response

numberintegerrequired

the current page number

payoutsArray of objects(PayoutListItem)required

a list of payouts. If the list is empty, then there were no payouts made.

payouts[].​payoutIdstring= 24 charactersrequired

The unique identifier associated with the payout if a pay-out was successfully created

payouts[].​merchantIdstring= 24 charactersrequired

The merchant id used during aggregation of the payout run

payouts[].​bulkIdstringnon-emptyrequired

The bulk id used during aggregation of the of the payout run if available, if not NONE would be sent as default

payouts[].​ibanstringnon-empty^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$required

The IBAN in (ISO 13616) format used during aggregation of the payout run and this will be used to payout to the merchant

payouts[].​payoutStatusstring(PayoutStatus)required
  • SUCCEEDED - Payout was successfully processed
  • FAILED - Payout failed.
Enum"SUCCEEDED""FAILED"
payouts[].​payoutDatestring(date-time)required

timestamp, when payout was created in UTC

payouts[].​payoutCurrencystring(Currency)required

currency code. Only EUR is supported ISO 4217

Value"EUR"
payouts[].​totalPaymentsintegerrequired

The total number of payments included in the payout

payouts[].​totalRefundsintegerrequired

The total number of refunds included in the payout

payouts[].​totalPaymentAmountinteger(int64)> 1required

The total payment amount in cents contained in the payout.

payouts[].​totalRefundAmountinteger(int64)> 0required

The total refund amount in cents contained in the payout.

payouts[].​payoutAmountinteger(int64)> 1required

Total amount in cents paid out the to merchant

Response
application/json
{
  "size": 0,
  "totalPages": 0,
  "totalElements": 0,
  "number": 0,
  "payouts": [
    { … }
  ]
}

payoutPayments

Operations

payoutRefunds

Operations