---
updatedAt: 2026-05-27T08:29:42.000Z
agentTools:
  projectIndex: https://docs.bridgeapi.io/llms.txt
---

# Create a payment consent

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

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Bridge API",
    "version": "2025-01-15",
    "description": "Bridge provides an Open Banking API to initiate payments and aggregate financial data.  \nOur API uses standards such as HTTP verbs, RESTful routing and JSON for payloads.",
    "license": {
      "name": "Proprietary",
      "url": "https://docs.bridgeapi.io"
    },
    "contact": {
      "name": "BridgeAPI",
      "url": "https://bridgeapi.io",
      "email": "support@bridgeapi.io"
    }
  },
  "servers": [
    {
      "description": "Production",
      "url": "https://api.bridgeapi.io"
    }
  ],
  "tags": [
    {
      "name": "Payment consents",
      "description": "Payment consents allow you to obtain user consent for future payment operations in a secure and compliant way."
    }
  ],
  "paths": {
    "/v3/payment/consents": {
      "summary": "Payment consents",
      "parameters": [
        {
          "$ref": "#/components/parameters/version"
        }
      ],
      "post": {
        "operationId": "CreatePaymentConsent",
        "summary": "Create a payment consent",
        "description": "For eligible partners only. Create a new payment consent to accept Bridge's ToS",
        "tags": [
          "Payment consents"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "title": "Create a payment consent",
                "type": "object",
                "required": [
                  "external_reference",
                  "transactions",
                  "redirect_url",
                  "user"
                ],
                "properties": {
                  "external_reference": {
                    "type": "string",
                    "description": "A reference to your payment",
                    "example": "payment-test-123"
                  },
                  "redirect_url": {
                    "type": "string",
                    "description": "URL to redirect the user after consent completion",
                    "example": "https://example.com/callback"
                  },
                  "transactions": {
                    "type": "array",
                    "description": "Details of the payment that requires consent",
                    "items": {
                      "required": [
                        "currency",
                        "amount",
                        "label"
                      ],
                      "type": "object",
                      "properties": {
                        "amount": {
                          "type": "number",
                          "format": "float",
                          "example": 150
                        },
                        "currency": {
                          "type": "string",
                          "enum": [
                            "EUR"
                          ],
                          "description": "Only EUR is supported for now",
                          "example": "EUR"
                        },
                        "label": {
                          "type": "string",
                          "description": "Label for the transaction",
                          "example": "Payment for goods"
                        }
                      }
                    }
                  },
                  "user": {
                    "required": [
                      "email"
                    ],
                    "type": "object",
                    "properties": {
                      "first_name": {
                        "description": "Mandatory with lastname or only company_name (max 35 char : alphanumeric, space and some symbols + ( ) / . - ! ? , ; & % € are supported but it must contain at least one letter)",
                        "type": "string",
                        "example": "Richard"
                      },
                      "last_name": {
                        "description": "Mandatory with firstname or only company_name (max 35 char : alphanumeric, space and some symbols + ( ) / . - ! ? , ; & % € are supported but it must contain at least one letter)",
                        "type": "string",
                        "example": "Hendricks"
                      },
                      "company_name": {
                        "description": "Mandatory or firstname and last_name must be completed (max 35 char : alphanumeric, space and some symbols + ( ) / . - ! ? , ; & % € are supported but it must contain at least one letter)",
                        "type": "string",
                        "example": "BestCompany"
                      },
                      "email": {
                        "description": "Mandatory",
                        "type": "string",
                        "example": "r.hendricks@mail.com"
                      }
                    }
                  }
                }
              },
              "example": {
                "external_reference": "payment-test-123",
                "redirect_url": "https://example.com/callback",
                "transactions": [
                  {
                    "amount": 150,
                    "currency": "EUR",
                    "label": "Payment for goods"
                  }
                ],
                "user": {
                  "company_name": "ACME",
                  "email": "user@company.com"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Payment consent creation response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "consent_url": {
                      "description": "The URL on Bridge Pay to accept the terms and conditions",
                      "type": "string",
                      "example": "https://pay.bridgeapi.io/consent/9d4d49e4-a99b-4c18-a58d-b4931c4b79db/terms"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "version": {
        "in": "header",
        "name": "Bridge-Version",
        "schema": {
          "type": "string",
          "enum": [
            "2025-01-15"
          ],
          "default": "2025-01-15"
        },
        "required": true,
        "description": "The Bridge API version"
      }
    },
    "securitySchemes": {
      "clientIdAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "Client-Id"
      },
      "clientSecretAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "Client-Secret"
      }
    }
  },
  "security": [
    {
      "clientIdAuth": [],
      "clientSecretAuth": []
    }
  ],
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false
  }
}
```