Sign in

v1

latestOpenAPI 3.1.02026-08-0683254.8 KB
Merchant Endpoints

get a payment by id

This API is intended for merchants requiring information on a specific payment. 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
get/v3/payments/{id}

Path parameters

idstring required

Response

Payment details

paymentIdstring required

id of the payment

createdAtstring date-time required

the creation time of the payment

expireAtstring date-time required

the time from which the payment will be expired

succeededAtstring date-time

if the payment is SUCCEEDED, then this field represents the date-time on which the payment was SUCCEEDED

currency'EUR' required

Currency code. Only EUR is supported ISO 4217

status'PENDING' | 'IDENTIFIED' | 'AUTHORIZED' | 'AUTHORIZATION_FAILED' | 'SUCCEEDED' | 'FAILED' | 'CANCELLED' | 'EXPIRED' | 'PENDING_MERCHANT_ACKNOWLEDGEMENT' | 'VOIDED' required
StatusDescription
PENDINGThe merchant has created the payment and and is pending to proceed with identify step.
IDENTIFIEDThe user has scanned the payment's QR code with the Bancontact Pay.
AUTHORIZEDThe user has confirmed the payment and the bank authorized it.
AUTHORIZATION_FAILEDThe authorization with the bank failed.
FAILEDSomething went wrong during the payment process(e.g authorization failed).
SUCCEEDEDThe payment has succeeded.
CANCELLEDWhen the payment has been canceled after the user has scanned it, or the merchant has cancelled the payment.
EXPIREDThe payment has expired.
PENDING_MERCHANT_ACKNOWLEDGEMENTThe payment is waiting for the merchant to acknowledge.
VOIDEDThe payment has been voided
amountinteger required

Amount in cents originally requested. If no amount was requested by creditor, this will be 0

descriptionstring

merchant's description of the payment

messagestring

debtor's message of the payment

referencestring

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

bulkIdstring

Field used to reference a bulk batch, so the merchant can choose how to bulk the payments. Mandatory if merchant profile does have bulking enabled, otherwise will miss from the response. If it's not set in the create call it will default to the value configured in the profile if it exists, otherwise its value will be defaulted by the application.

Example response

{
  "paymentId": "5f91483d-78a7-4914-bc6f=",
  "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"
  },
  "debtor": {
    "name": "John",
    "iban": "*************12636"
  },
  "description": "5 coke.",
  "message": "Money send.",
  "reference": "19848995",
  "bulkId": "Bulk-1-200"
}
All 8 operations