--- updatedAt: 2026-04-27T10:26:51.000Z agentTools: siteIndex: https://developers.pismo.io/llms.txt projectIndex: https://developers.pismo.io/pismo-docs/llms.txt --- # Get FPS transaction [beta] Gets a FPS transaction given its end-to-end identifier in the path. The Faster Payments System (FPS) is a UK service that allows near-instant electronic money transfers between banks. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Instant payments - Faster payments", "description": "Faster Payments (FPS) real-time payments system API", "contact": { "name": "API Support", "url": "https://developers.pismo.io/support/" }, "license": { "name": "Copyright Pismo" }, "version": "1.0" }, "servers": [ { "url": "https://sandbox.pismolabs.io/fps", "description": "Sandbox API server for testing." } ], "tags": [ { "name": "Faster payments", "description": "Faster Payment Service (FPS) endpoints" } ], "components": { "parameters": { "authHeader": { "name": "Authorization", "in": "header", "schema": { "type": "string" }, "description": "Account token—token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message.\n", "required": true }, "endToEndIDPath": { "name": "endToEndId", "in": "path", "description": "FPS transaction's end to end ID.", "required": true, "schema": { "type": "string", "maxLength": 31 } }, "tenantHeader": { "name": "x-tenant", "in": "header", "schema": { "type": "string" }, "description": "Organization ID", "required": true }, "reqTrackingIdHeader": { "name": "x-cid", "in": "header", "schema": { "type": "string" }, "description": "Request tracking identifier. If not provided, a random UUID will be generated.\n", "required": false } }, "schemas": { "Amount": { "type": "number", "description": "Transaction amount", "example": 853.09 }, "customer.DetailMessage": { "type": "object", "properties": { "external": { "type": "array", "items": { "$ref": "#/components/schemas/customer.ExternalMessage" } }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/customer.ParameterMessage" } }, "payload": { "type": "array", "items": { "$ref": "#/components/schemas/customer.PayloadMessage" } } } }, "customer.Error": { "type": "object", "properties": { "code": { "type": "string", "description": "Error's code.", "example": "EPT0001" }, "details": { "$ref": "#/components/schemas/customer.DetailMessage" }, "message": { "type": "string", "description": "Error's message.", "example": "User not found" } } }, "customer.ExternalMessage": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Code", "example": "PBE315" }, "message": { "type": "string", "description": "Message", "example": "Generic error" } } }, "customer.ParameterMessage": { "type": "object", "required": [ "field", "message" ], "properties": { "field": { "type": "string", "description": "Field", "example": "Query parameter" }, "message": { "type": "string", "description": "Message", "example": "Generic error" } } }, "customer.PayloadMessage": { "type": "object", "required": [ "field", "message" ], "properties": { "field": { "type": "string", "description": "Field", "example": "Entity.field" }, "message": { "type": "string", "description": "Message", "example": "Generic error" } } }, "endToEndID": { "maxLength": 31, "type": "string", "description": "Client-generated transaction identifier. Must be unique for each transaction.\n", "example": "1374f841568e4ff4b3a63b023c170ec" }, "fps_get.FpsGetResponse": { "type": "object", "properties": { "end_to_end_id": { "$ref": "#/components/schemas/endToEndID" }, "status": { "$ref": "#/components/schemas/status" }, "amount": { "$ref": "#/components/schemas/Amount" } } }, "status": { "type": "string", "enum": [ "CREATED", "PROCESSING", "SETTLED", "CANCELLED", "HOLD" ], "description": "- `CREATED` - Payment has been created and is pending processing\n- `PROCESSING` - P2P balance was impacted and waiting for provider confirmation\n- `SETTLED` - Transaction completed processing and is settled\n- `CANCELLED` - Something went wrong and the transaction is cancelled. Refer to `reason` for more details\n- `HOLD` - The payment is on hold, pending further review\n", "example": "PROCESSING" } } }, "paths": { "/v1/payments/fps/{endToEndId}": { "get": { "summary": "Get FPS transaction [beta]", "description": "Gets a FPS transaction given its end-to-end identifier in the path.\n\nThe Faster Payments System (FPS) is a UK service that allows near-instant electronic money transfers between banks.\n", "operationId": "get-fps-in-transaction", "tags": [ "Faster payments" ], "parameters": [ { "$ref": "#/components/parameters/authHeader" }, { "$ref": "#/components/parameters/tenantHeader" }, { "$ref": "#/components/parameters/reqTrackingIdHeader" }, { "$ref": "#/components/parameters/endToEndIDPath" } ], "responses": { "200": { "description": "Response Body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fps_get.FpsGetResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer.Error" }, "examples": { "EFPS0004": { "summary": "Validation Error", "value": { "code": "EFPS0004", "message": "Validation error" } }, "EFPS0016": { "summary": "Unmarshal Error", "value": { "code": "EFPS0016", "message": "Unmarshal error" } }, "EFPS0019": { "summary": "Accounts API Invalid Request Error", "value": { "code": "EFPS0019", "message": "Accounts - API returned 4xx error" } }, "EFPS0025": { "summary": "P2P API Invalid Request Error", "value": { "code": "EFPS0025", "message": "P2p - API returned 4xx error" } }, "EFPS0029": { "summary": "Ledger API Invalid Request Error", "value": { "code": "EFPS0029", "message": "Ledger - API returned 4xx error" } }, "EFPS0037": { "summary": "Invalid Creditor Sort Code Account Number", "value": { "code": "EFPS0037", "message": "Invalid creditor sort code/account number" } }, "EFPS0038": { "summary": "Invalid Creditor IBAN", "value": { "code": "EFPS0038", "message": "Invalid creditor IBAN" } }, "EFPS0039": { "summary": "Invalid Creditor BBAN", "value": { "code": "EFPS0039", "message": "Invalid creditor BBAN" } }, "EFPS0046": { "summary": "IntlBankAccounts API Invalid Request Error", "value": { "code": "EFPS0046", "message": "IntlBankAccounts - API returned 4xx error" } }, "EFPS0047": { "summary": "PSP Gateway API Bad Request", "value": { "code": "EFPS0047", "message": "Invalid FPS Request. Check error details for more information." } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer.Error" }, "examples": { "EFPS0002": { "summary": "Missing Tenant Header", "value": { "code": "EFPS0002", "message": "Missing required header: 'x-tenant'" } }, "EFPS0021": { "summary": "Account Blocked Or Cancelled", "value": { "code": "EFPS0021", "message": "Account blocked or cancelled" } }, "EFPS0033": { "summary": "Invalid Account Id", "value": { "code": "EFPS0033", "message": "Invalid account id header: 'x-account-id'" } }, "EFPS0034": { "summary": "Invalid Idempotency Key", "value": { "code": "EFPS0034", "message": "Missing required header: 'x-idempotency-key'" } }, "EFPS0035": { "summary": "Account Has No Active Addresses", "value": { "code": "EFPS0035", "message": "Account has no active addresses" } }, "EFPS0040": { "summary": "FPS Not Enabled", "value": { "code": "EFPS0040", "message": "FPS is not enabled for the creditor sort code" } }, "EFPS0041": { "summary": "Modulus Check Error", "value": { "code": "EFPS0041", "message": "Failed to execute account number modulus check" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer.Error" }, "examples": { "EFPS0010": { "summary": "Sort Code Not Found", "value": { "code": "EFPS0010", "message": "Sort Code not found" } }, "EFPS0018": { "summary": "Accounts API Not Found Error", "value": { "code": "EFPS0018", "message": "Accounts - Not found" } }, "EFPS0028": { "summary": "Ledger API Not Found Error", "value": { "code": "EFPS0028", "message": "Ledger - Not found" } }, "EFPS0031": { "summary": "IntlBankAccounts API Not Found Error", "value": { "code": "EFPS0031", "message": "IntlBankAccounts - Not found" } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer.Error" }, "examples": { "EFPS0022": { "summary": "Transaction Already Exists", "value": { "code": "EFPS0022", "message": "A transaction with the specified idempotency key and end_to_end_id already exists" } }, "EFPS0036": { "summary": "Mismatching Currency Error", "value": { "code": "EFPS0036", "message": "The provided currency does not match with the account's configured currency" } } } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer.Error" }, "examples": { "EFPS0015": { "summary": "PSP Gateway API Rate Limit", "value": { "code": "EFPS0015", "message": "PSPGateway API Rate Limit exceeded" } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer.Error" }, "examples": { "EFPS0006": { "summary": "HTTP Error", "value": { "code": "EFPS0006", "message": "HTTP request error" } }, "EFPS0009": { "summary": "IntlBankAccounts API Timeout", "value": { "code": "EFPS0009", "message": "IntlBankAccounts API timeout error" } }, "EFPS0011": { "summary": "IntlBankAccounts API Internal Error", "value": { "code": "EFPS0011", "message": "IntlBankAccounts API Internal Server error" } }, "EFPS0012": { "summary": "PSP Gateway API Timeout", "value": { "code": "EFPS0012", "message": "PSPGateway API timeout error" } }, "EFPS0017": { "summary": "Accounts API Timeout", "value": { "code": "EFPS0017", "message": "Accounts API timeout error" } }, "EFPS0020": { "summary": "Accounts API Server Error", "value": { "code": "EFPS0020", "message": "Accounts - API returned 5xx error" } }, "EFPS0023": { "summary": "Transaction Database Error", "value": { "code": "EFPS0023", "message": "Transaction database error" } }, "EFPS0024": { "summary": "P2P API Timeout", "value": { "code": "EFPS0024", "message": "P2p - API timeout error" } }, "EFPS0026": { "summary": "P2P API Server Error", "value": { "code": "EFPS0026", "message": "P2p - API returned 5xx error" } }, "EFPS0027": { "summary": "Ledger API Timeout", "value": { "code": "EFPS0027", "message": "Ledger API timeout error" } }, "EFPS0030": { "summary": "Ledger API Server Error", "value": { "code": "EFPS0030", "message": "Ledger - API returned 5xx error" } }, "EFPS0032": { "summary": "IntlBankAccounts API Server Error", "value": { "code": "EFPS0032", "message": "IntlBankAccounts - API returned 5xx error" } } } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer.Error" }, "examples": { "EFPS0014": { "summary": "PSP Gateway API Bad Gateway", "value": { "code": "EFPS0014", "message": "PSPGateway API Bad Gateway" } } } } } } } } } } } ```