Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-07-244223105.2 KB
Payment links

Create a payment link

Create a new payment link

post/v3/payment/payment-links

Request body

expired_datestring date-time

The link status will be set to "EXPIRED" after this date. Format is yyyy-MM-ddThh:mm:ssZ (ISO8601)

client_referencestring

A reference to link this link to your system (100 char. max)

callback_urlstring url

If you want to redirect the users to your interface instead of Bridge's interface after they completed the journey from their bank website or application

country'fr' | 'es' | 'de' | 'gb'

To define the default banks displayed in the banks list. If not defined, french banks will be displayed.

provider_idinteger

If the parameter is set, your user won't see the providers list. Be careful to select providers with at least the single_payment capability

sender_ibanstring

The IBAN which will be debited for providers that support it, otherwise this setting will be ignored

Response

Payment link creation response

idstring

The created payment link's unique identifier

urlstring

The url to go to initiate the payment

Example response

{
  "id": "697aa2b2-a65f-473b-a5c9-4bd9a2ecefbd",
  "url": "https://pay.bridgeapi.io/link/e2ce0722fd15b9e6270680d96faa46357069c15eca35eeda3878cf023ab99fe5"
}