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

Create a Payment Link from the dashboard

📘

This guide is about creating a payment link manually from the dashboard

You can also create payment links thanks to our endpoints. See the documentation here

Before creating a Payment Link, you need to configure the Payment settings on our dashboard.

The field Whitelisted domain for callback URLs is not used for the Payment Links feature so you can fill it with your product website URL for example or any other https URL (there is no consequences). Let Allow payments to different beneficiaries unchecked.

Then complete the Default beneficiary with the fields:

  • Alias
  • Account name
  • IBAN
  • Bank Swift code
  • Bank name

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

Note: if your application is in production, you need to be an administrator to edit the payments settings

Payment settingsPayment settings

Payment settings

Then you can generate payments links :

The required fields are:

  • Amount
  • Expiration date : the maximum duration is 90 days
  • Label : description displayed on the bank interface of the customer
  • End to end ID (optional) : id that will be sent to the bank
  • Payment user name : name of the customer who will use the Payment Link
Configure your Payment LinkConfigure your Payment Link

Configure your Payment Link

Then you have access to all your payments links generated:

Payments Links listPayments Links list

Payments Links list

Updated 29 days ago

Create a Payment Link from the dashboard


Suggested Edits are limited on API Reference Pages

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