Skip to content

Payment V3 API (3.6.5)

APIs intended to support the merchant/partner's payment flow on creation, cancellation, search and refunds.

History

3.6.5 (2025-08-29)

  • No longer returning REFUND_NOT_ALLOWED error for products with refundAllowed=false in getDebtorIban operation.

3.6.4 (2025-08-26)

  • Added JWS-Request-Signature-Payment for all payment call.

3.6.3 (2025-08-22)

  • Modified description by adding the SEPA requirements allowed character sets.
  • Modified reference by adding the SEPA requirements allowed character sets.

3.6.2 (2025-07-17)

  • Removed totalAmount, tippingAmount, and transferAmount from the Open API, as they are no longer in use.
  • Added examples to provide additional context.
Download OpenAPI description
merchant-payment.openapi.json
merchant-payment.openapi.yaml
Languages
Servers
Mock server
https://docs.payconiq.be/_mock/apis/merchant-payment.openapi
PREPROD merchant API
https://merchant.api.preprod.bancontact.net
PROD merchant API
https://merchant.api.bancontact.net

Merchant Endpoints

Operations

Callback to Merchants

Operations

Merchant Acknowledge

Operations

Merchant acknowledges payment status callback was received

Request

Security
api_key_payment_profile or JWS-Request-Signature-Payment
Path
idstring= 24 charactersrequired

Bancontact Payconiq Company Payment Id

Bodyapplication/json
currencystring(currency)required

Currency code. Only EUR is supported ISO 4217

Value"EUR"
amountinteger(int64)(payment_amount)( 1 .. 999999999999 ]required

Amount in cents requested

referencestring

Merchant payment reference, used to reference the Bancontact Payconiq Company payment in the merchant’s system. The characters used must comply with the SEPA Requirements for an Extended Character Set (UNICODE Subset) - Best Practices | European Payments Council.

curl -i -X POST \
  'https://docs.payconiq.be/_mock/apis/merchant-payment.openapi/v3/payments/{id}/acknowledge' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "currency": "EUR",
    "amount": 1,
    "reference": "19848995"
  }'

Responses

The acknowledge request for the specified payment has been processed

Response
No content

Refunds

Operations