Bancontact

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

📘

To start accepting Bancontact payments, please contact your customer success manager.

Process a Bancontact payment

Bancontact payments follow a two-step process:

1. Request a Bancontact payment
2. Redirect the customer

Step 1: Request a Bancontact payment

The request

Use the following details to set up your payment request.

Endpoints

Live

POSThttps://api.checkout.com/payments

Sandbox

POSThttps://api.sandbox.checkout.com/payments

Header parameters

Body parameters

📘

The table below describes the minimum recommended fields. You can find the full list, as well as complete request and response examples, in our API reference.

Request example

{
  "amount": 100,
  "currency": "EUR",
  "source": {
    "type": "bancontact",
    "account_holder_name": "Bruce Wayne",
    "payment_country": "BE",
    "billing_descriptor": "CKO Demo - bancontact"
  }
}

The response

If you receive a 202 Success response with a status field set to Pending, your request was successful.

Response example

{
  "id": "pay_scoqartlkpzerp45c5ujmj6uue",
  "status": "Pending",
  "customer": {
    "id": "cus_wqzgcjuiwucudpmfu7kn5mukh4"
  },
  "_links": {
    "self": {
      "href": "https://api.sandbox.checkout.com/payments/pay_scoqartlkpzerp45c5ujmj6uue"
    },
    "redirect": {
      "href": "https://trusted.girogate.de/ti/dumbdummy?tx=455332564&rs=O34Tn460YM76zZzI7yfXXPIsVnnWAhaV&cs=bb716499d072a5adfb314437c5965e1150b15550aac7a298b5d9d317653427a1"
    },
    "bancontact:mobile": {
      "href": "BEPGenApp://DoTx?TransId=1BC.GIROGATE.DE/BCMC/123456789$ICAE3BUIH5P9U53Y5HKA9CRT"
    }
  }
}

Step 2: 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 <= 5000.

Get details about a Bancontact payment

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

The request

Use the details below to set up your request.

Endpoint

Live

GEThttps://api.checkout.com/payments/{payment_id}

Sandbox

GEThttps://api.sandbox.checkout.com/payments/{payment_id}

Header and path parameters

The response

Response example

{
  "id": "pay_zvamjy6rl3pehdeufoqaygbjzm",
  "requested_on": "2019-05-17T15:17:06Z",
  "source": {
    "type": "bancontact"
  },
  "amount": 100,
  "currency": "EUR",
  "payment_type": "Regular",
  "status": "Captured",
  "approved": true,
  "risk": {
    "flagged": false
  },
  "customer": {
    "id": "cus_t4rcgkbd2keuzeoo3p36u2xqcu"
  },
  "_links": {
    "self": {
      "href": "https://api.sandbox.checkout.com/payments/pay_zvamjy6rl3pehdeufoqaygbjzm"
    },
    "actions": {
      "href": "https://api.sandbox.checkout.com/payments/pay_zvamjy6rl3pehdeufoqaygbjzm/actions"
    },
    "refund": {
      "href": "https://api.sandbox.checkout.com/payments/pay_zvamjy6rl3pehdeufoqaygbjzm/refunds"
    }
  }
}

Refund a Bancontact payment

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

Cancel a Bancontact 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

🚧

To start testing, you'll need to:

• create a test account, and
• 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. Click "Submit".

4. You should then be redirected to your predefined success URL.

Can we help?

Thanks for using Checkout.com. If you need any help or just have a question, please get in touch with our support team at [email protected].