--- updatedAt: 2025-09-24T00:03:55.000Z agentTools: projectIndex: https://docs.bridgeapi.io/v2021.06.01/llms.txt --- # Get a payment request # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "v2021-06-01", "version": "2021.06.01" }, "servers": [ { "url": "https://api.bridgeapi.io/v2" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "Client-Id" }, "sec1": { "type": "apiKey", "in": "header", "name": "Client-Secret" } } }, "security": [ { "sec0": [], "sec1": [] } ], "paths": { "/payment-requests/{id}": { "get": { "summary": "Get a payment request", "description": "", "operationId": "get-payment-request", "parameters": [ { "name": "Client-Id", "in": "header", "description": "Application's client id.", "required": true, "schema": { "type": "string" } }, { "name": "Client-Secret", "in": "header", "description": "Application's client secret.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The payment request id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Payment succeeded": { "value": "{\n \"id\": \"e959dccd632c49d7922a766e946ad9e9\",\n \"status\": \"ACSC\",\n \"user\": {\n \"first_name\": \"Thomas\",\n \"last_name\": \"Pichet\",\n \"external_reference\": \"AEF142536-890\",\n \"ip_address\": \"0.0.0.0\"\n\t},\n \"sender\": {\n \"name\": \"John doe\",\n \"iban\": \"FR18XXXXXXXXXXXXXXXXXXXXJ81\"\n },\n \"transactions\": [\n {\n \"amount\": 99.5,\n \"currency\": \"EUR\",\n \"label\": \"Payment label\",\n \"id\": \"79e61d0c29b1491196bc0c39f27b5bb8\",\n \"status\": \"ACSC\",\n \"beneficiary\": {\n \"first_name\": \"Test\",\n \"last_name\": \"Merchant\",\n \"iban\": \"FR76XXXXXXXXXXXXXXXXXXXX185\"\n },\n \"client_reference\": \"12345678-AZERTY\"\n }\n ],\n \"created_at\": \"2020-08-04T16:37:29Z\",\n \"updated_at\": \"2020-08-04T16:37:29Z\",\n \"client_reference\": \"12345678-AZERTY\",\n \"payment_link_id\": \"d96a760a-a70b-40ec-bb15-2589894d9f6e\",\n \"bank_id\": 6\n}" }, "Payment failed": { "value": "{\n \"id\": \"bb4ddd039fec46ff96a6266446a19c55\",\n \"status\": \"RJCT\",\n \"status_reason\": \"MS03\",\n \"user\": {\n \"first_name\": \"Thomas\",\n \"last_name\": \"Pichet\",\n \"external_reference\": \"AEF142536-890\",\n \"ip_address\": \"0.0.0.0\"\n },\n \"sender\": {},\n \"transactions\": [\n {\n \"external_merchant_id\": \"12345678-AFERS\",\n \"currency\": \"EUR\",\n \t\"label\": \"Payment label\",\n \"amount\": 99.0,\n \"id\": \"79e61d0c29b1491196bc0c39f27b5bb8\",\n \"status\": \"RJCT\",\n \"status_reason\": \"MS03\",\n \"beneficiary\": {\n \"first_name\": \"Test\",\n \"last_name\": \"Merchant\",\n \"iban\": \"FR76XXXXXXXXXXXXXXXXXXXX185\"\n }\n }\n ],\n \"created_at\": \"2020-08-13T15:26:55.267373Z\",\n \"updated_at\": \"2020-08-13T15:27:31.893451Z\"\n}" }, "200 Payment succeeded with execution date": { "value": "{\n \"id\": \"e959dccd632c49d7922a766e946ad9e9\",\n \"status\": \"ACSC\",\n \"user\": {\n \"first_name\": \"Thomas\",\n \"last_name\": \"Pichet\",\n \"external_reference\": \"AEF142536-890\",\n \"ip_address\": \"0.0.0.0\"\n },\n \"sender\": {\n \"name\": \"John doe\",\n \"iban\": \"FR18XXXXXXXXXXXXXXXXXXXXJ81\"\n },\n \"transactions\": [\n {\n \"id\": \"79e61d0c29b1491196bc0c39f27b5bb8\",\n \"amount\": 99.5,\n \"currency\": \"EUR\",\n \"label\": \"Payment label\",\n \"execution_date\": \"2021-10-30\",\n \"status\": \"ACSC\",\n \"beneficiary\": {\n \"first_name\": \"Test\",\n \"last_name\": \"Merchant\",\n \"iban\": \"FR76XXXXXXXXXXXXXXXXXXXX185\"\n },\n \"client_reference\": \"12345678-AZERTY\"\n }\n ],\n \"created_at\": \"2020-08-04T16:37:29Z\",\n \"updated_at\": \"2020-08-04T16:37:29Z\",\n \"client_reference\": \"12345678-AZERTY\",\n \"payment_link_id\": \"d96a760a-a70b-40ec-bb15-2589894d9f6e\",\n \"bank_id\": 6\n}" } }, "schema": { "oneOf": [ { "title": "Payment succeeded", "type": "object", "properties": { "id": { "type": "string", "example": "e959dccd632c49d7922a766e946ad9e9" }, "status": { "type": "string", "example": "ACSC" }, "user": { "type": "object", "properties": { "first_name": { "type": "string", "example": "Thomas" }, "last_name": { "type": "string", "example": "Pichet" }, "external_reference": { "type": "string", "example": "AEF142536-890" }, "ip_address": { "type": "string", "example": "0.0.0.0" } } }, "sender": { "type": "object", "properties": { "name": { "type": "string", "example": "John doe" }, "iban": { "type": "string", "example": "FR18XXXXXXXXXXXXXXXXXXXXJ81" } } }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "example": 99.5, "default": 0 }, "currency": { "type": "string", "example": "EUR" }, "label": { "type": "string", "example": "Payment label" }, "id": { "type": "string", "example": "79e61d0c29b1491196bc0c39f27b5bb8" }, "status": { "type": "string", "example": "ACSC" }, "beneficiary": { "type": "object", "properties": { "first_name": { "type": "string", "example": "Test" }, "last_name": { "type": "string", "example": "Merchant" }, "iban": { "type": "string", "example": "FR76XXXXXXXXXXXXXXXXXXXX185" } } }, "client_reference": { "type": "string", "example": "12345678-AZERTY" } } } }, "created_at": { "type": "string", "example": "2020-08-04T16:37:29Z" }, "updated_at": { "type": "string", "example": "2020-08-04T16:37:29Z" }, "client_reference": { "type": "string", "example": "12345678-AZERTY" }, "payment_link_id": { "type": "string", "example": "d96a760a-a70b-40ec-bb15-2589894d9f6e" }, "bank_id": { "type": "integer", "example": 6, "default": 0 } } }, { "title": "Payment failed", "type": "object", "properties": { "id": { "type": "string", "example": "bb4ddd039fec46ff96a6266446a19c55" }, "status": { "type": "string", "example": "RJCT" }, "status_reason": { "type": "string", "example": "MS03" }, "user": { "type": "object", "properties": { "first_name": { "type": "string", "example": "Thomas" }, "last_name": { "type": "string", "example": "Pichet" }, "external_reference": { "type": "string", "example": "AEF142536-890" }, "ip_address": { "type": "string", "example": "0.0.0.0" } } }, "sender": { "type": "object", "properties": {} }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "external_merchant_id": { "type": "string", "example": "12345678-AFERS" }, "currency": { "type": "string", "example": "EUR" }, "label": { "type": "string", "example": "Payment label" }, "amount": { "type": "integer", "example": 99, "default": 0 }, "id": { "type": "string", "example": "79e61d0c29b1491196bc0c39f27b5bb8" }, "status": { "type": "string", "example": "RJCT" }, "status_reason": { "type": "string", "example": "MS03" }, "beneficiary": { "type": "object", "properties": { "first_name": { "type": "string", "example": "Test" }, "last_name": { "type": "string", "example": "Merchant" }, "iban": { "type": "string", "example": "FR76XXXXXXXXXXXXXXXXXXXX185" } } } } } }, "created_at": { "type": "string", "example": "2020-08-13T15:26:55.267373Z" }, "updated_at": { "type": "string", "example": "2020-08-13T15:27:31.893451Z" } } }, { "title": "200 Payment succeeded with execution date", "type": "object", "properties": { "id": { "type": "string", "example": "e959dccd632c49d7922a766e946ad9e9" }, "status": { "type": "string", "example": "ACSC" }, "user": { "type": "object", "properties": { "first_name": { "type": "string", "example": "Thomas" }, "last_name": { "type": "string", "example": "Pichet" }, "external_reference": { "type": "string", "example": "AEF142536-890" }, "ip_address": { "type": "string", "example": "0.0.0.0" } } }, "sender": { "type": "object", "properties": { "name": { "type": "string", "example": "John doe" }, "iban": { "type": "string", "example": "FR18XXXXXXXXXXXXXXXXXXXXJ81" } } }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "79e61d0c29b1491196bc0c39f27b5bb8" }, "amount": { "type": "number", "example": 99.5, "default": 0 }, "currency": { "type": "string", "example": "EUR" }, "label": { "type": "string", "example": "Payment label" }, "execution_date": { "type": "string", "example": "2021-10-30" }, "status": { "type": "string", "example": "ACSC" }, "beneficiary": { "type": "object", "properties": { "first_name": { "type": "string", "example": "Test" }, "last_name": { "type": "string", "example": "Merchant" }, "iban": { "type": "string", "example": "FR76XXXXXXXXXXXXXXXXXXXX185" } } }, "client_reference": { "type": "string", "example": "12345678-AZERTY" } } } }, "created_at": { "type": "string", "example": "2020-08-04T16:37:29Z" }, "updated_at": { "type": "string", "example": "2020-08-04T16:37:29Z" }, "client_reference": { "type": "string", "example": "12345678-AZERTY" }, "payment_link_id": { "type": "string", "example": "d96a760a-a70b-40ec-bb15-2589894d9f6e" }, "bank_id": { "type": "integer", "example": 6, "default": 0 } } } ] } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"errors\": [\n {\n \"code\": \"payment.unknown_request\",\n \"message\": \"The payment request XXXXXXXXXXXXXXXXXXXXXX does not exist\"\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "example": "payment.unknown_request" }, "message": { "type": "string", "example": "The payment request XXXXXXXXXXXXXXXXXXXXXX does not exist" } } } } } } } } } }, "deprecated": false, "x-readme": { "code-samples": [ { "language": "curl", "code": "curl 'https://api.bridgeapi.io/v2/payment-requests/e959dccd632c49d7922a766e946ad9e9' \\\n\t-X GET \\\n -H 'Bridge-Version: 2021-06-01' \\\n\t-H 'Client-Id: MY_CLIENT_ID' \\\n\t-H 'Client-Secret: MY_CLIENT_SECRET'" } ], "samples-languages": [ "curl" ] } } } }, "x-readme": { "headers": [ { "key": "Bridge-Version", "value": "2021-06-01" } ], "explorer-enabled": false, "proxy-enabled": false }, "x-readme-fauxas": true } ```