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

Product changelog

📘

June 2021: new API version

We published a new API version, if you want to know the main changes, you can click here

2021


Q2 2021

ModificationDescription
New API versionWe are happy to share with you a new version of our API: simpler syntax, better performance, new statuses for Bridge Pay transfers and more and more evolutions to come! Read the guide and check the main changes.
Initiate Bridge Pay single transfers to any IBANWe improved our single transfers feature. In the past this feature was limited to trusted beneficiaries only, but now your users can initiate transfers to any IBAN. See documentation.
More precise status and failing reason for Bridge Pay transfersIn the API new version, we introduced 2 new statused for transfers: "initiated" and "executed". "initiated" means the transfer has been initiated with success (sent to the bank) and `executed` means the transfers has been executed by the bank (the money has been transferred). When a transfer failed, you can get more information in a the new field "status_reason". See documentation.

Q1 2021

ModificationDescription
Simplify your integration with webhooksYou can now use webhooks to simplify your integration. 4 events are avaiable for now: item created, account created, account created, item refreshed. You can check the documentation here and create webhooks from your dashboard.
New data for banksIn List banks endpoint, we added new fields: capabilities (the features available for this bank: ais, single or bulk transfers, single or bulk payments) and linked information (max number of transactions for bulk transfers, max number of characters for the label)
New endpoint to list and filter banksYou can use the new Search banks endpoint to filter the banks you want to display to your users depending on the countries (fr, uk, de, es) and the capabilities data (ais, single_transfer, bulk_transfer, single_payment, bulk_payment)
Double SCA managementThe double SCA sometimes needed for professional banks is nows handled in the Bridge Connect. Your users will see 2 successive pages asking them to enter a code

2020


Q4 2020

ModificationDescription
New data available in your dashboardLogin to your dashboard and access your page and find new data available: your items status and the top banks by items status
New flag for transactions from differed debit card accountsIt might happen that your users see duplicated transactions from their differed debit card accounts and their checkin accounts. From now on duplicated transactions have a flag show_client_side at false so you can hide them. See documentation
Retrieve a transfer from a transfer requestYou can now check if a transfer has been created from a transfer request (therefore know what your users did in the Bridge Pay). Modification is applied for single and bulk transfer requests
Link a reference to transfers and bulksWhen calling single and bulk transfers endpoint to generate a Bridge Pay link, you can now add a new input client_reference, to help you keeping track of your users single and bulk transfers

Q3 2020

ModificationDescription
New feature: merchant paymentsYour users can proceed to payments thanks to our new endpoint Create a payment request. They will go through their bank interface and process a transfer as a payment to your bank account
New feature: bulk transfers with Bridge PayYou can now execute multiple transfers in one user journey, with only one SCA. One bank is available for now: Qonto. Contact us if you want to test it and check the guide
New feature: check our connectors statuses by APIIf you have an application in production, you can now use a new endpoint to check our connectors statuses. You can use it to automate some actions or communications to your users. Documentation
Bridge Pay: pre-fill the beneficiary via receiver account idYou could already pre-fill a transfer's beneficiary so that your user doesn't have to select it in the Bridge Pay, thanks to its IBAN. You can now use the receiver account id instead. Documentation
Bridge Connect: pre-fill the bankWhen calling the Bridge Connect endpoint, you can define a bank id as an input. With this, your user will directly access to the corresponding bank form, without going through the banks list. Documentation

Q2 2020

ModificationDescription
Bridge Pay: pre-fill the beneficiary via IBANYou can now pre-fill a transfer's beneficiary so that your user doesn't have to select it in the Bridge Pay. To do it, define an IBAN when calling Send transfer endpoint
Dashboard: members invitationNew feature in the dashboard: you can invite members to access your applications. They can see your applications information and edit sandbox apps, but cannot edit production apps. More information
KYCWe developed a new endpoint to list KYC data of you user. Please ask us to get the documentation and try the endpoint
New connector: PaypalYou users can now synchronize their Paypal account with the Bridge Connect

Q1 2020

ModificationDescription
New dashboardWe deployed a new dashboard where you can manage your applications and customize them. Access the dashboard
New category: payment incidentsWe improved our categorization engine thanks to a new category for the payment incidents. The id of this new category is 756587. This category will gather the banking commissions and the other payment incidents
More details on the items' statusYou can now access the status_code_info and the status_code_description to manage the banking connections of your clients. These new fields are detailed on our Items status page
Caisse d'Epargne ParticuliersWe have migrated to the PSD2 API of the bank Caisse d'Epargne Particuliers. Therefore we are now displaying in Bridge the details of its 15 regional branches

2019


ModificationDescription
New Bridge ConnectWe revamped the Bridge Connect: simplified user journey and new design. You can also select the banks you want to highlight when the user arrives on the banks list.
Initiate transfers with Bridge PayYour users can now initiare transfers to their trusted beneficiary thanks to our new interface "Bridge Pay". Documentation
Future transactionsTransactions have a new field is_future so you know the transaction impacts or not the account balance. False: false : it means the transaction is a debited transaction. True: it means the transaction will be debited in the future and doesn’t affect the account’s balance
Accounts' IBAN (AIS)The Account ressource has a new field for the IBAN. Support for this information varies depending on the account's bank
API authenticationThe Client-Id and the Client-Secret of your application should be send through Headers and not Params anymore
User authenticationThe email and the password of your users should be send through Body and not Params anymore

2018


ModificationDescription
New Bridge ConnectWe revamped the Bridge Connect: simplified user journey and new design. You can also select the banks you want to highlight when the user arrives on the banks list.
Initiate transfers with Bridge PayYour users can now initiare transfers to their trusted beneficiary thanks to our new interface "Bridge Pay". Documentation
Future transactionsTransactions have a new field is_future so you know the transaction impacts or not the account balance. False: false : it means the transaction is a debited transaction. True: it means the transaction will be debited in the future and doesn’t affect the account’s balance
Accounts' IBAN (AIS)The Account ressource has a new field for the IBAN. Support for this information varies depending on the account's bank
API authenticationThe Client-Id and the Client-Secret of your application should be send through Headers and not Params anymore
User authenticationThe email and the password of your users should be send through Body and not Params anymore
Manage Strong Customer Authentication with Bridge ConnectYou can manage all the PSD2 authentication complexities with our web application by using the endpoint Manage SCA and Sync
Bridge Connect: country selectionYou now have the ability to set up the default country for the banks displayed in the Bridge Connect. Use the country parameter in your "Connect an item" call. Available country codes : fr, uk, de, es, nl
Bridge Connect: email pre-fillingYou now have the ability to pre-fill the email of your user on the email validation page of the Bridge Connect. Use the prefill_email parameter in your "Connect an item" call
Bridge Connect stepsYou can follow the path of your user in the Bridge Connect funnels in details. How? By interpreting the redirect URL, at the end of the funnel, enriched with parameters. You will be able to know at which step the user has left the funnel