Invoice

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

Introduction

Our invoice solution allows your to print a single use payment QR code on your invoices. Your consumers simply scan the QR code with their preferred payment application and confirm the transaction.

For digital invoices, a deeplink alternative is available to allow your consumers to settle their invoices directly from their mobile devices.

Important Note Invoices can be used with or without structured communication (GMO). The parameter must be activated upon product creation by our support team.

Process Flow

The following section outlines the key steps involved in a On a Display Instore payment with Bancontact Payconiq. The process involves several key parties, each playing a specific role in completing the transaction.

Prerequisites

• API Key – This is used to secure the request between the Merchant’s backend and Bancontact Payconiq’s backend. Do not share your API keys in public areas such as online sites or client-side code.
• Product Profile ID or PPID – The unique product identifier.
• Merchant CallbackUrl (Optional) – This URL will be called by Payconiq’s backend servers in order to send the status of the payment to the merchant.

Involved Parties

The following parties participate in a display-based in-store payment with Bancontact Payconiq:

• Payer Application: The consumer's preferred payment app used to complete the transaction.
• Merchant Frontend: The physical or digital invoice where the QR code is displayed
• Merchant Backend: The merchant’s server-side system that integrates with Bancontact Payconiq.
• Bancontact Payconiq Backend: The backend system responsible for handling payment processing and integration services.

Step-by-Step Payment Flow

• The Merchant Backend creates a one-time usage QR code using the Bancontact Payconiq service URL. The QR code will contain parameters such as the amount to be paid, a discription and a payment reference.
• The QR Code is printed on the Merchant Fronted
• The consumer confirms the payment n the Payer app using PIN, fingerprint, or face ID. The Payer app then submits the payment request to the Bancontact Payconiq backend for authorization.
• The consumer confirms the payment n the Payer app using PIN, fingerprint, or face ID. The Payer app then submits the payment request to the Bancontact Payconiq backend for authorization.
• The Bancontact Payconiq backend sends a payment notification with the payment status to the merchant backend via the configured callback URL.
• The merchant backend acknowledges the callback notification.
• The merchant frontend displays the payment status (digital invoices)

Important Note: The order in which the merchant and consumer receive payment status notifications is not guaranteed. Network and connectivity differences may cause one party to receive the update before the other.

Payment Flow Diagram

In the following diagrams you will find a visual overview of the process flows presented above:

Embed diagram INVOICE

Implementation Guide

In order to create a QR code you need to use the Bancontact Payconiq service URL as ilustrated below. Once created, you will be able to print the Static QR on the medium of your choice.

For the full endpoint documentation, please refer to the Merchant Payment API.

1. Creating QR Code

In order to create a QR code you need to use the Bancontact Payconiq service URL as ilustrated below. Once created, you will be able to print the Static QR on the medium of your choice.

QR Code Parameters

The QR code contains the following parameters:

IMPORTANT NOTE: The combination of amount, reference, and description should always be unique. If not, the QR code could be considered as already paid.

QR code creation process

You can now execute the URL in a web view to obtain your Static QR Code and print it on the medium of your choice.

Invoice Deeplink

For digital invoices, you can use the Payload URL as a deeplink to allow your consumers to pay withdirectly from their mobile device.

To do so, simply send the Bancontact Payconiq Payload URL generated in the Step 4 of the QR Code creation process and send it to your consumers.

Invoice DeepLink Example

• Description: Invoice Payment
• Amount: 2.50€
• Reference: 4198798465

https://payconiq.com/t/1/5c18cbd1296e9a26d3278518?D=Invoice%20Payment&A=250&R=4198798465

2. The Bancontact Payconiq Callback

You can specify a callback URL where the Bancontact Payconiq backend will send notifications about the status of a payment. This will allow you to take appropriate action and process the payment data.

The merchant backend must verify that the notification message originated from Bancontact Payconiq backend was not altered or corrupted during the tranmission. To do so, please ensure signature validation.

For the full Callback documentation, please refer to the Callback Guide.

📦 Request Body

📥 Response

(No defined response schema)

🔍 Sample Request – callback

curl -i -X POST \
  https://merchant.api.preprod.bancontact.net/callback \
  -H 'Content-Type: application/json' \
  -H 'Signature: YOUR_API_KEY_HERE' \
  -H 'User-Agent: Payconiq' \
  -d '{
    "paymentId": "5f91483d-78a7-4914-bc6f=",
    "currency": "EUR",
    "amount": 0,
    "description": "string",
    "reference": "19848995",
    "createdAt": "2019-08-24T14:15:22Z",
    "expireAt": "2019-08-24T14:15:22Z",
    "succeededAt": "2019-08-24T14:15:22Z",
    "status": "PENDING",
    "debtor": {
      "iban": "*************12636",
      "name": "John"
    }
  }'

Callback Failure

In the event you do not receive a callback or the callback validation fails, please refer to "Get Payment Details". This alternative will also allow you to confirm the status of a transaction in order to complete the payment.

3. Get Payment Details

By calling this endpoint you can obtain the details of an existing payment transaction by passing the unique payment ID.

Note: it is highly recommended to implement this call as a fallback option if callback fails.

🧩 Path Parameters

• id (string, required)

📥 Response

🔧 Error Codes for merchant-get-payment

🔍 Sample Request – merchant-get-payment

curl -i -X GET \
  'https://merchant.api.preprod.bancontact.net/v3/payments/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

4. Get Payment List

You can also retrieve a list of payments by specifying how many records to return, as well as a filter on the results for the total number of records returned per page.

📦 Request Body

📥 Response

🔧 Error Codes for search

🔍 Sample Request – search

curl -i -X POST \
  'https://merchant.api.preprod.bancontact.net/v3/payments/search?page=0&size=10' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "from": "2019-08-24T14:15:22Z",
    "to": "2019-08-24T14:15:22Z",
    "paymentStatuses": [
      "PENDING"
    ],
    "reference": "19848995"
  }'