Create refund for payment

Endpoint to initiate refund of Bancontact Company payment to the debtor. This endpoint is idempotent based on 'Idempotency-Key' header. So the same request can be safely retried in case of timeout/network issue.

post/v3/payments/{payment-id}/refunds

Request

Base URL
https://merchant.api.preprod.bancontact.net
Auth
API key in header Signature
TypeScript
https://skmtc.dev/bancontactpro/apis/payment-refund-service-api/docs/v3/payments/:payment-id/refunds/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

payment-idstring required

Payment Id

Headers

Idempotency-Keystring required

Unique request identifier with a maximum of 64 characters (we recommend UUID). It will be used for idempotency check.

Request body

amountinteger required

Amount in cents

currency'EUR' required

currency code. Only EUR is supported ISO 4217

descriptionstring

refund description

Response

Refund successfully created

refundIdstring required

refund identifier

paymentIdstring required

payment identifier

status'PENDING' required

Refund status after creation. Always has value 'PENDING', because refund processing is asynchronous. Current status can be checked using GET '/v3/payments/{payment-id}/refunds/{refund-id}' endpoint.