--- updatedAt: 2026-05-27T08:29:42.000Z agentTools: projectIndex: https://docs.bridgeapi.io/llms.txt --- # Get a single payment request Retrieve the details of a single payment request # 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 links", "description": "Payment links allow you to conveniently receive payments by simply sharing these links" }, { "name": "Payment requests", "description": "Capability to facilitate payments from any sender account to any receiver account, using API only" }, { "name": "Payment account", "description": "Our Payment Account service empowers you to effortlessly collect payments and efficiently manage refunds and payouts.\nWe handle the intricacies of payment management on your behalf, simplifying your financial operations." } ], "paths": { "/v3/payment/payment-links": { "summary": "Payment links", "parameters": [ { "$ref": "#/components/parameters/version" } ], "post": { "operationId": "CreatePaymentLink", "summary": "Create a payment link", "description": "Create a new payment link", "tags": [ "Payment links" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "title": "Create a payment link", "allOf": [ { "$ref": "#/paths/~1v3~1payment~1payment-links/post/requestBody/content/application~1json/schema/oneOf/1" }, { "properties": { "transactions": { "items": { "properties": { "label": { "type": "string", "description": "This label will be displayed on the bank accounts: sender and receiver \n(max 50 char : alphanumeric, space and some symbols + ( ) / _ . - ! ? , ; & % € are supported)", "example": "Your label" } } } } } } ] }, { "title": "Create a payment link with payment account", "type": "object", "required": [ "user", "transactions" ], "properties": { "user": { "type": "object", "description": "User who will initiate the payment", "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 depending on your use case", "type": "string", "example": "r.hendricks@mail.com" }, "external_reference": { "type": "string", "example": "AEF142536-890", "description": "We recommend filling this value with a unique ID that identifies your user. \nIt helps Bridge optimize fraud detection by tracking how many payments have been initiated by a single user within a specific period." } } }, "expired_date": { "type": "string", "format": "date-time", "description": "The link status will be set to \"EXPIRED\" after this date. Format is yyyy-MM-ddThh:mm:ssZ (ISO8601)", "example": "2024-07-24T22:00:00.000Z" }, "client_reference": { "type": "string", "description": "A reference to link this link to your system (100 char. max)", "example": "ABCDE_FG-HI_12345" }, "transactions": { "type": "array", "description": "Details of the payment", "items": { "required": [ "currency", "amount" ], "type": "object", "properties": { "amount": { "type": "number", "format": "float", "example": 120.98 }, "currency": { "type": "string", "enum": [ "EUR" ], "description": "Only EUR is supported for now", "example": "EUR" }, "end_to_end_id": { "$ref": "#/paths/~1v3~1payment~1payment-account~1refunds/post/requestBody/content/application~1json/schema/properties/end_to_end_id" }, "client_reference": { "type": "string", "description": "A reference to link this transaction to your system (100 char. max)", "example": "ABCDE_FG-HI_12345" }, "execution_date": { "type": "string", "format": "date", "description": "YYYY-MM-DD up to 60 days from today", "example": "2024-12-18" }, "beneficiary": { "type": "object", "description": "By default, the trusted beneficiary configured in the dashboard will be used\nPlease contact us if you need to specify beneficiaries via the API", "required": [ "iban" ], "properties": { "iban": { "type": "string", "description": "IBAN recipient" }, "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 depending on your use case", "type": "string", "example": "r.hendricks@mail.com" }, "virtual_iban_mode": { "type": "string", "description": "If ondemand, the VIBAN will be created when the user decides to pay with a manual transfer. \nIf auto, the VIBAN is automatically created and available in the API answer.", "example": "auto" }, "virtual_iban_id": { "type": "string", "description": "Let you reuse an existing VIBAN", "example": "FR7630006000011234567890189" } } } } } }, "callback_url": { "type": "string", "format": "url", "description": "If you want to redirect the users to your interface instead of Bridge's interface \nafter they completed the journey from their bank website or application", "example": "https://my-website.com" }, "country": { "type": "string", "enum": [ "fr", "es", "de", "gb" ], "description": "To define the default banks displayed in the banks list. If not defined, french banks will be displayed.", "example": "fr" }, "provider_id": { "type": "integer", "description": "If the parameter is set, your user won't see the providers list. \nBe careful to select providers with at least the single_payment capability", "example": 122 }, "sender_iban": { "type": "string", "description": "The IBAN which will be debited for providers that support it, otherwise this setting will be ignored" } } }, { "title": "Create a bulk payment link", "allOf": [ { "$ref": "#/paths/~1v3~1payment~1payment-links/post/requestBody/content/application~1json/schema/oneOf/1" } ] } ] }, "examples": { "nopaymentaccount": { "summary": "CREATE A PAYMENT LINK", "value": { "client_reference": "ABCDE_FG-HI_12345", "user": { "email": "test@gmail.com", "first_name": "Firstname", "last_name": "Lastname", "external_reference": "REF-1234_AZ" }, "transactions": [ { "amount": 1000, "currency": "EUR", "label": "label", "end_to_end_id": "E2E_ID-1234" } ] } }, "nopaymentaccount-dynamicbeneficiary": { "summary": "CREATE A PAYMENT LINK - DYNAMIC BENEFICIARY", "value": { "client_reference": "ABCDE_FG-HI_12345", "user": { "email": "test@gmail.com", "first_name": "Firstname", "last_name": "Lastname", "external_reference": "REF-1234_AZ" }, "transactions": [ { "amount": 1000, "currency": "EUR", "label": "label", "end_to_end_id": "E2E_ID-1234", "beneficiary": { "iban": "FR7630006000011234567890189" } } ] } }, "withpaymentaccount": { "summary": "CREATE A PAYMENT LINK WITH PAYMENT ACCOUNT", "value": { "client_reference": "ABCDE_FG-HI_12345", "user": { "email": "test@gmail.com", "first_name": "Firstname", "last_name": "Lastname", "external_reference": "REF-1234_AZ" }, "transactions": [ { "amount": 1000, "currency": "EUR", "label": "label", "end_to_end_id": "E2E_ID-1234", "beneficiary": { "iban": "FR7630006000011234567890189" } } ] } }, "bulk": { "summary": "CREATE A BULK PAYMENT LINK", "value": { "client_reference": "ABCDE_FG-HI_12345", "user": { "email": "test@gmail.com", "first_name": "Firstname", "last_name": "Lastname", "external_reference": "REF-1234_AZ" }, "transactions": [ { "amount": 1000, "currency": "EUR", "label": "first transaction", "end_to_end_id": "E2E_ID-1234", "beneficiary": { "iban": "FR7630006000011234567890189" } }, { "amount": 500, "currency": "EUR", "label": "second transaction", "end_to_end_id": "E2E_ID-5678", "beneficiary": { "iban": "FR7630006000011234567890189" } }, { "amount": 250, "currency": "EUR", "label": "third transaction", "end_to_end_id": "E2E_ID-9012", "beneficiary": { "iban": "FR7630006000011234567890189" } } ] } } } } } }, "responses": { "200": { "description": "Payment link creation response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "The created payment link's unique identifier", "type": "string", "example": "697aa2b2-a65f-473b-a5c9-4bd9a2ecefbd" }, "url": { "description": "The url to go to initiate the payment", "type": "string", "example": "https://pay.bridgeapi.io/link/e2ce0722fd15b9e6270680d96faa46357069c15eca35eeda3878cf023ab99fe5" } } } } } } } } }, "/v3/payment/payment-requests/{id}": { "summary": "Payment requests", "parameters": [ { "$ref": "#/components/parameters/version" } ], "get": { "operationId": "GetPaymentRequest", "summary": "Get a single payment request", "description": "Retrieve the details of a single payment request", "tags": [ "Payment requests" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "bb4ddd039fec46ff96a6266446a19c55" } } ], "responses": { "200": { "description": "Payment request", "content": { "application/json": { "schema": { "oneOf": [ { "title": "Payment request resource", "type": "object", "properties": { "id": { "description": "Payment request's unique identifier", "type": "string", "example": "e959dccd632c49d7922a766e946ad9e9" }, "status": { "description": "Payment request's status", "type": "string", "enum": [ "CREA", "ACTC", "PDNG", "ACSC", "RJCT", "PART" ] }, "status_reason": { "description": "Payment request's status reason", "type": "string", "example": "debit_account_insufficient_funds" }, "user": { "type": "object", "properties": { "first_name": { "description": "The user first name", "type": "string", "example": "Thomas" }, "last_name": { "description": "The user last name", "type": "string", "example": "Pichet" }, "company_name": { "description": "The company name", "type": "string", "example": "ACME" }, "email": { "description": "The user email", "type": "string", "example": "r.hendricks@mail.com" }, "external_reference": { "$ref": "#/paths/~1v3~1payment~1payment-links/post/requestBody/content/application~1json/schema/oneOf/1/properties/user/properties/external_reference" }, "ip_address": { "description": "The user's IP address", "type": "string", "example": "0.0.0.0" } } }, "sender": { "type": "object", "properties": { "name": { "description": "The sender name information communicated by the provider", "type": "string", "example": "John Doe" }, "iban": { "description": "The sender iban information communicated by the provider", "type": "string", "example": "FR18XXXXXXXXXXXXXXXXXXXXJ81" } } }, "client_reference": { "type": "string", "example": "ABCDE-EEEE_9398848", "description": "A reference you can specify to optimize your payment request reconciliation. \nThis reference will also be available when you retrieve the payment status using Bridge endpoints. \nThere is a similar field in the transaction resource that can be used to reconcile individual transactions." }, "payment_link_id": { "description": "The payment link's unique identifier", "type": "string", "example": "d96a760a-a70b-40ec-bb15-2589894d9f6e" }, "provider_id": { "description": "The provider's unique identifier", "type": "number", "example": 6 }, "created_at": { "description": "The payment request creation date", "type": "string", "example": "2024-08-04T16:37:29Z" }, "updated_at": { "description": "The payment request last update date", "type": "string", "example": "2024-08-04T16:37:29Z" }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "The transaction id", "type": "string", "example": "79e61d0c29b1491196bc0c39f27b5bb8" }, "amount": { "description": "The transaction amount", "type": "number", "format": "float", "example": 2899.5 }, "currency": { "description": "The transaction currency", "type": "string", "example": "EUR" }, "label": { "description": "The transaction label", "type": "string", "example": "Payment label" }, "execution_date": { "description": "Date for which the payment is scheduled", "type": "string", "format": "date", "example": "2024-10-30" }, "status": { "description": "Transaction's status", "type": "string", "enum": [ "CREA", "ACTC", "PDNG", "ACSC", "RJCT", "PART" ] }, "beneficiary": { "type": "object", "items": { "type": "object", "properties": { "first_name": { "description": "The beneficiary first name", "type": "string", "example": "John" }, "last_name": { "description": "The beneficiary last name", "type": "string", "example": "Doe" }, "company_name": { "description": "The company name", "type": "string", "example": "ACME" }, "email": { "description": "The beneficiary email", "type": "string", "example": "r.hendricks@mail.com" }, "iban": { "description": "The beneficiary iban", "type": "string", "example": "FR76XXXXXXXXXXXXXXXXXXXX185" } } } }, "client_reference": { "$ref": "#/paths/~1v3~1payment~1payment-requests~1%7Bid%7D/get/responses/200/content/application~1json/schema/oneOf/0/properties/client_reference" }, "end_to_end_id": { "$ref": "#/paths/~1v3~1payment~1payment-account~1refunds/post/requestBody/content/application~1json/schema/properties/end_to_end_id" } } } } } }, { "title": "Payment request resource with payment account", "allOf": [ { "$ref": "#/paths/~1v3~1payment~1payment-requests~1%7Bid%7D/get/responses/200/content/application~1json/schema/oneOf/0" }, { "properties": { "transactions": { "items": { "properties": { "payment_account_transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the transaction on the payment account", "example": "cb7d1bcf-bbc2-4cc0-a106-e9011b2c4c61" }, "external_id": { "type": "string", "description": "Identifier of the transaction in our provider (Xpollens) system" }, "status": { "type": "string", "enum": [ "not_received", "received", "pending_refund", "partially_refunded", "refunded", "recalled" ], "description": "Transaction status on the payment account", "example": "received" } } } } } } } } } ] } ] }, "examples": { "payment-request": { "value": { "resources": [ { "id": "5cde82dc416a4e94a08567ed0242f82a", "status": "ACSC", "user": { "first_name": "Thomas", "last_name": "Pichet", "external_reference": "AEF142536-890" }, "sender": { "iban": "FR76XXXXXXXXXXXXXXXXXXXX222", "name": "Thomas Pichet" }, "transactions": [ { "id": "b746dfd13a3f444bbfeff0000170df2e", "status": "ACSC", "beneficiary": { "iban": "FR76XXXXXXXXXXXXXXXXXXXX280", "company_name": "ACME" }, "amount": 200, "end_to_end_id": "E2E_TEST-123", "currency": "EUR", "label": "payment label", "client_reference": "ABCDE-EEEE_9398848" } ], "provider_id": "574,", "created_at": "2024-12-23T15:35:06.558Z", "updated_at": "2024-12-23T16:36:03.152Z" } ] } } } } } } } } }, "/v3/payment/payment-account/refunds": { "summary": "Refunds", "parameters": [ { "$ref": "#/components/parameters/version" } ], "post": { "operationId": "CreateRefund", "summary": "Create refund", "description": "Create a refund request", "tags": [ "Payment account" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "payment_account_transaction_id", "amount" ], "properties": { "payment_account_transaction_id": { "type": "string", "description": "The id of the payment account transaction you want to refund", "example": "9f7052e8-96cd-45da-8e5c-08c82ef83164" }, "amount": { "type": "number", "description": "The amount you wish to refund (positive and up to 2 decimals). You can partially refund the payment transaction.", "example": 10 }, "client_reference": { "type": "string", "description": "An optional reference to link this refund request to your system (100 characters max.)", "example": "client-reference" }, "description": { "type": "string", "description": "This description is only for an internal purpose and will allow to have information on the Dashboard (140 characters max.)", "example": "My product refund description" }, "end_to_end_id": { "type": "string", "example": "E2E_TEST-123", "description": "Technical id between you, Bridge and the bank (35 char. max.)" } } } } } }, "responses": { "200": { "description": "Refund creation response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "5d838eace5f64cb3b8b395ae5cf4a6fe" }, "payment_account_transaction_id": { "type": "string", "example": "9f7052e8-96cd-45da-8e5c-08c82ef83164" }, "amount": { "type": "number", "example": 150 }, "currency": { "type": "string", "example": "EUR" }, "status": { "type": "string", "enum": [ "created", "processing", "in_transit", "paid", "canceled", "rejected", "failed", "recalled" ], "example": "paid" }, "client_reference": { "type": "string", "description": "Your internal reference for reconciliation", "example": "client-ref-1234" }, "description": { "type": "string", "description": "Your internal description", "example": "Reimbursement B" }, "end_to_end_id": { "$ref": "#/paths/~1v3~1payment~1payment-account~1refunds/post/requestBody/content/application~1json/schema/properties/end_to_end_id" }, "created_at": { "type": "string", "format": "date-time", "example": "2023-05-03T14:13:43.618Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2023-05-03T14:13:50.021Z" } } } } } } } } } }, "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 } } ```