Skip to content

Last updated: April 29, 2022

Start accepting payments using Bancontact, a favorite payment method in Belgium.

Information

To start accepting Bancontact payments, please contact your Customer Success Manager.

Model

Collecting

Payment flow

Redirect

Payment method type

Card Payment

One-step payment

check

Authorization

error

Capture

error

Refund

check

Partial refund

check

Chargeback

error

Recurring payment

error

Overview

Bancontact payments follow a two-step process:

  1. Request a Bancontact payment
  2. Redirect the customer

Request a payment

Endpoints

For the full API specification, see the API reference.

post

https://api.checkout.com/payments

Request example

1
{
2
"amount": 100,
3
"currency": "EUR",
4
"source": {
5
"type": "bancontact",
6
"account_holder_name": "John Smith",
7
"payment_country": "BE",
8
"billing_descriptor": "test payment"
9
}
10
}

Response example

If you receive a 202 Success response, with a status field set to Pending, your request was successful. You now need to redirect your customer as described below.

1
{
2
"id": "pay_scoqartlkpzerp45c5ujmj6uue",
3
"status": "Pending",
4
"customer": {
5
"id": "cus_wqzgcjuiwucudpmfu7kn5mukh4"
6
},
7
"_links": {
8
"self": {
9
"href": "https://api.sandbox.checkout.com/payments/pay_scoqartlkpzerp45c5ujmj6uue"
10
},
11
"redirect": {
12
"href": "https://trusted.girogate.de/ti/dumbdummy?tx=455332564&rs=O34Tn460YM76zZzI7yfXXPIsVnnWAhaV&cs=bb716499d072a5adfb314437c5965e1150b15550aac7a298b5d9d317653427a1"
13
},
14
"bancontact:mobile": {
15
"href": "BEPGenApp://DoTx?TransId=1BC.GIROGATE.DE/BCMC/123456789$ICAE3BUIH5P9U53Y5HKA9CRT"
16
}
17
}
18
}

Redirect the customer

Redirect your customer to the redirect link’s href in the response. This will allow the customer to authorize the payment, before they are transferred to your predefined success or failure URL.

Alternatively, use the bancontact:mobile redirection link in the response to take them to the Bancontact mobile app. This mobile redirection link, however, is only provided in the live environment and only when the amount is less than or equal to 50000 (500 EUR).


Get details about a payment

You can retrieve details about an existing Bancontact payment with the following endpoint.

Use the details below to set up your request.

Endpoints

For the full API specification, see the API reference.

get

https://api.checkout.com/payments/{id}

Response example

1
{
2
"id": "pay_zvamjy6rl3pehdeufoqaygbjzm",
3
"requested_on": "2019-05-17T15:17:06Z",
4
"source": {
5
"type": "bancontact"
6
},
7
"amount": 100,
8
"currency": "EUR",
9
"payment_type": "Regular",
10
"status": "Captured",
11
"approved": true,
12
"risk": {
13
"flagged": false
14
},
15
"customer": {
16
"id": "cus_t4rcgkbd2keuzeoo3p36u2xqcu"
17
},
18
"_links": {
19
"self": {
20
"href": "https://api.sandbox.checkout.com/payments/pay_zvamjy6rl3pehdeufoqaygbjzm"
21
},
22
"actions": {
23
"href": "https://api.sandbox.checkout.com/payments/pay_zvamjy6rl3pehdeufoqaygbjzm/actions"
24
},
25
"refund": {
26
"href": "https://api.sandbox.checkout.com/payments/pay_zvamjy6rl3pehdeufoqaygbjzm/refunds"
27
}
28
}
29
}

Refund a payment

Bancontact supports both partial and full refunds. You can refund a payment through the Dashboard or by using the refund API.


Cancel a payment

If the customer fails to complete their payment, we will automatically void the payment and send a payment_expired webhook.

If the customer cancels their payment, we will send a payment_canceled webhook.


Testing Bancontact

Note

To start testing, you'll need to contact your Customer Success Manager or Integrations Engineer to activate Bancontact payments in the sandbox environment.

  1. Create a Bancontact transaction as above, following the redirect link in the response to Bancontact's website.
  2. Set the payment response and payment delay as necessary.
  3. Select Submit. You should then be redirected to your predefined success URL.