Bridge API Documentation

Bridge Documentation

Welcome to our API documentation!

We're happy to share with you our new API 2021 version! Please check our Product Changelog to know the main changes.

You'll find comprehensive guides and documentation to help you start working with Bridge as quickly as possible, as well as support if you get stuck.

Let's jump right in!

Get Started

Initiate your first Payment

To initiate a standalone payment you just need to create a Payment Request that will generate a consent_url. This URL will redirect your client to his bank interface to validate the payment.

The fields to complete are :

  • successful_callback_url: the client will be redirected on this URL if the payment initiation is a success

  • unsuccessful_callback_url (optional): the client will be redirected on this URL if the payment is a failure

  • transactions: the details of the payment you want the customer to initiate

    • end_to_end_id (optional): this field is an open value that will be available on the payment request and will be sent to the bank
    • currency
    • label: the label of the payment which will be displayed on bank interfaces
    • amount
    • client_reference (optional): a reference to help you match the transaction to your system

📘

Reconciliation

Please note that all banks don't display the end_to_end_id on the beneficiary's interface. You may use the label to pass reconciliation information from end to end.

  • user

    • name: name of your client which will initiate the payment (first name and last name or company name)
    • ip_address: IP address of your client
    • external_reference (optional): this field is an open value that will be available on the payment request
  • bank_id: id of the bank of your client
    You can check which banks support the Payments thanks to the capability single_payment or bulk_payment field on the List banks.

  • client_reference (optional): a reference to help you match the payment request to your system

Please check the Manage beneficiaries chapter for this specific topic.

curl 'https://api.bridgeapi.io/v2/payment-requests' \
    -X POST \
    -H 'Bridge-Version: 2021-06-01' \
    -H 'Client-Id: MY_CLIENT_ID' \
    -H 'Client-Secret: MY_CLIENT_SECRET'
    -H 'Content-Type: application/json' \
    -d '{
      "successful_callback_url": "https://my-callback-url.com:8080/pay/success",
      "unsuccessful_callback_url": "https://my-callback-url.com:8080/pay/error",
      "transactions": [
       {
         "end_to_end_id": "12345678-AFERS",
         "currency": "EUR",
         "label": "Payment label",
         "amount": 99.5,
         "client_reference": "12345678-AZERTY"
       }
      ],
      "user": {
         "name": "Firstname Lastname",
         "ip_address": "0.0.0.0",
         "external_reference": "AEF142536-890"
      },
      "client_reference": "12345678-AZERTY",
      "bank_id": 6
    }'
curl 'https://api.bridgeapi.io/v2/payment-requests' \
    -X POST \
    -H 'Bridge-Version: 2021-06-01' \
    -H 'Client-Id: MY_CLIENT_ID' \
    -H 'Client-Secret: MY_CLIENT_SECRET'
    -H 'Content-Type: application/json' \
    -d '{
      "successful_callback_url": "https://my-callback-url.com:8080/pay/success",
      "unsuccessful_callback_url": "https://my-callback-url.com:8080/pay/error",
      "transactions": [
       {
         "end_to_end_id": "12345678-AFERS",
         "currency": "EUR",
         "label": "Payment label",
         "amount": 99.5,
         "beneficiary": {
            "name": "Firstname Lastname",
            "iban": "0.0.0.0"
          },
          "client_reference": "12345678-AZERTY"
      ],
      "user": {
         "name": "Firstname Lastname",
         "ip_address": "0.0.0.0",
         "external_reference": "AEF142536-890"
      },
      "bank_id": 6
    }'

The answer of the call will give :

  • id: id of the payment request
  • consent_url: bank URL to initiate the payment
{
  "id": "e959dccd632c49d7922a766e946ad9e9",
  "consent_url": "https://consent_url.com"
}

Updated 16 days ago

Initiate your first Payment


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.