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

payoutPayments

Operations

payoutRefunds

Operations

get list of refunds

Request

Endpoint to get list of refunds.

Security
JWS-Request-Signature
Query
payout-idstring= 24 characters

Payout Id

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
start-datestring(date)

The start date (inclusive) in yyyy-MM-dd format for which the list of payments/refunds should be returned. The maximum difference between the start date and end date can be 30 days When the start date is filled the end date needs to be filled as well.

end-datestring(date)

The end date (inclusive) in yyyy-MM-dd format for which the list of payments/refunds should be returned. The maximum difference between the start date and end date can be 30 days. When the end date is filled the start date needs to be filled as well.

curl -i -X GET \
  'https://docs.payconiq.be/_mock/apis/merchant-reconciliation.openapi/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'

Responses

returns all the refunds for this payout

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

refundsArray of objects(RefundDetails)required

a list of refunds included in the payout.

refunds[].​paymentIdstring= 24 charactersrequired

The id of the payment

refunds[].​payoutIdstring= 24 characters

The id of the payout

refunds[].​paymentProfileIdstring= 24 charactersrequired

The profile id of the merchant used in the transaction

refunds[].​merchantNamestringnon-emptyrequired

The name of the merchant

refunds[].​paymentChannelstring(PaymentChannel)required

"The channel of the payment"

Enum"ONLINE""INSTORE""INVOICE"
refunds[].​currencystring(Currency)required

currency code. Only EUR is supported ISO 4217

Value"EUR"
refunds[].​amountinteger(int64)>= 1required

Total amount in cents of the transaction

refunds[].​referencestringnon-empty

The reference provided by the merchant/partner during a payment/refund

refunds[].​descriptionstringnon-empty

The description provided by the merchant/partner during a payment/refund

refunds[].​transactionDatestring(date-time)required

timestamp, when transaction was created in UTC

refunds[].​refundIdstring= 24 charactersrequired

The id of the refund

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