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

Out of the Bridge Transfer

In the funnel when a user closes the app, the redirect URL (defined in your Bridge dashboard) is called.

This url is enriched with some parameters depending on the situation :

  • user_uuid : id of the user in the funnel
  • success : the status (true or false) of the funnel when the user has left it
  • step: (only when success = false) the step in the funnel where the user has left it by clicking on the redirect or the quit button
  • reference : id of the transfer
  • bulk_id: id of the bulk (only for the bulk payments)
  • source: connect, pay or manage
  • context: optional context which is an open parameter that you can send through the Bridge Transfer

Possible steps

The parameter step set in the URL can be one of those defined in the list:

  • transfer_no_compatible_account
  • amount_form
  • senders_list
  • transfer_summary
  • multiple_transfers_summary
  • otp_form
  • bank_password_form
  • transfer_in_progress
  • transfer_success
  • transfer_error
  • transfer_unknown


Important: the user can close our hosted page without your callback urls being called

When integrating our solution, please keep in mind that your users can close the tab displaying our hosted page anytime and consequently might not be redirected to your callback URL.

To keep your data in sync, we recommend you to integrate our Webhooks events to be updated on transfers statuses.

Updated 3 months ago

Out of the Bridge Transfer

Suggested Edits are limited on API Reference Pages

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