Sign in

v1

latestOpenAPI 3.1.02026-08-0683254.8 KB
Merchant Endpoints

search payments

Endpoint responsible for searching payments by PaymentWebQuery model and returning the latest n(number set on the 'limit' parameter) payments, starting from the 'offset' payment(set in 'offset' parameter). By default the latest 10 payments (sorted by creation date descending) are returned per request

post/v3/payments/search

Query parameters

pageinteger

zero-based page index in list requests.

sizeinteger

the size of the page to be returned in list requests.

Request body

fromstring date-time

default is today - 1day (yesterday)

tostring date-time
paymentStatusesMerchantPaymentStatus[]
referencestring

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

Example request

{
  "reference": "19848995"
}

Response

List of payments

sizeinteger required

Size of the elements returned in current page

totalPagesinteger required

Total number of pages in the backend for the list requested

totalElementsinteger required

Total number of elements in the list requested

numberinteger required

Current page number

Example response

{
  "details": [
    {
      "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"
    }
  ]
}