Sign in

v1

latestOpenAPI 3.1.02026-08-0683254.8 KB
Merchant Endpoints

create a payment

This API is intended for merchants initiating payments for specific profiles. Onboarded merchants should have api keys for each profile, the api key will carry the profileId information required to find the correct creditor in the merchant-service

The token/api-key necessary to call this endpoint must contain:

  • subjectType : "INTEGRATOR:{CCV_ID}" or "MERCHANT:{ID}"
  • resource: "PAYMENTPROFILE:{profileId}",
  • authority: MERCHANT_PAYMENT
post/v3/payments

Request body

referencestring

Merchant payment reference, used to reference the Bancontact 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.

bulkIdstring

Field used to reference a bulk batch, so the merchant can inform how the payments should be bulked. If it's not set here it will default to the one configured in the profile.

amountinteger required

Amount in cents requested

currency'EUR'

Currency code. Only EUR is supported ISO 4217

descriptionstring

Description of the payment that will be shown to the debtor, also used in the bank statement for reconciliation purposes. The characters used must comply with the SEPA Requirements for an Extended Character Set (UNICODE Subset) - Best Practices | European Payments Council.

identifyCallbackUrlstring

Callback url to which merchants will be notified about the payment identification. If it's not set here it will default to the one configured in the profile

callbackUrlstring

callbackUrl to which the merchant will be notified about the payment payout. If it's not set here it will default to the one set in the profile

returnUrlstring

Merchant return url to which the dynamic payment page will redirect after the payment is completed

Example request

{
  "reference": "19848995",
  "bulkId": "Bulk-1-200",
  "identifyCallbackUrl": "https://api.merchant.bancontact.net/identify",
  "callbackUrl": "https://api.merchant.bancontact.net/payment",
  "returnUrl": "https://api.merchant.bancontact.net/payment",
  "voucherEligibility": [
    {
      "voucherSchemes": [
        "BEL_MEAL_VOUCHER"
      ],
      "amount": 1013
    }
  ]
}

Response

Payment has been created successfully

paymentIdstring required

Payment ID

status'PENDING' required

the status of the payment created

createdAtstring date-time required

the creation time of the payment

expiresAtstring date-time required

the time from which the payment will be expired

descriptionstring

Description of the payment that will be shown to the debtor, also used in the bank statement for reconciliation purposes. The characters used must comply with the SEPA Requirements for an Extended Character Set (UNICODE Subset) - Best Practices | European Payments Council. Only first 35 characters will be used for the remittance info

referencestring

Merchant payment reference, used to reference the Bancontact 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.

amountinteger required

Amount in cents requested

currency'EUR' required

Currency code. Only EUR is supported ISO 4217

Example response

{
  "paymentId": "5f91483d-78a7-4914-bc6f=",
  "reference": "19848995",
  "creditor": {
    "profileId": "07e998f9-d932-4848-8b60-d5b5ae94b1b2",
    "merchantId": "dee718bb-3b6d-4312-9404-3d63d14529cc",
    "name": "John",
    "iban": "BE12 3456 7890 1234",
    "identifyCallbackUrl": "https://api.merchant.bancontact.net/identify",
    "callbackUrl": "https://api.merchant.bancontact.net/payment"
  }
}