v1

latestOpenAPI 3.1.0Proprietary2026-07-244223105.2 KB

Payment consents

Create a payment consent

For eligible partners only. Create a new payment consent to accept Bridge's ToS

post/v3/payment/consents

Request body

external_referencestring required

A reference to your payment

redirect_urlstring required

URL to redirect the user after consent completion

Example request

{
  "external_reference": "payment-test-123",
  "redirect_url": "https://example.com/callback",
  "transactions": [
    {
      "amount": 150,
      "currency": "EUR",
      "label": "Payment for goods"
    }
  ],
  "user": {
    "first_name": "Richard",
    "last_name": "Hendricks",
    "company_name": "BestCompany",
    "email": "r.hendricks@mail.com"
  }
}

Response

Payment consent creation response

consent_urlstring

The URL on Bridge Pay to accept the terms and conditions

Example response

{
  "consent_url": "https://pay.bridgeapi.io/consent/9d4d49e4-a99b-4c18-a58d-b4931c4b79db/terms"
}