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 see the main updates.

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

Let's jump right in!

Get Started

Manage beneficiaries

You have two options for the beneficiaries of your payments.
Please configure your choice on your dashboard in the payment settings section.

Payment settings on your dashboardPayment settings on your dashboard

Payment settings on your dashboard

Allow Payments to only one beneficiary

Complete the "Single beneficiary" on your dashboard with the required fields below:

  • Beneficiary alias
  • Beneficiary name
  • Bank name
  • IBAN
  • BIC

All the payments initiated with your application will be send to this beneficiary.

Allow Payments to different beneficiaries

For each payment you will need to send the details of the beneficiary in your payment request through the beneficiary resource.

  • name : name of the beneficiary
  • iban : IBAN of the beneficiary
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"
    },
    "beneficiary": {
       "name": "Firstname Lastname",
       "iban": "FR76XXXXXXXXXXXXXXXX"
    },
    "client_reference": "12345678-AZERTY",
    "bank_id": 6
    }'

Updated 3 months ago


Manage beneficiaries


Suggested Edits are limited on API Reference Pages

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