API Reference to provide details specifications about the avaialable endpoints, methonds, request parameters and response objects supported by our API.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"30773475","collectionId":"06a4ea98-24bd-426a-864c-add01290a31a","publishedId":"2sA2xpUAMe","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-05-14T12:00:14.000Z"},"item":[{"name":"Authorization","item":[{"name":"Get User token","event":[{"listen":"test","script":{"id":"6fc5b2b4-b476-47b2-8031-6e43c0affcb6","exec":["let responseData = pm.response.json();\r","pm.collectionVariables.set(\"token\", responseData.uuid);"],"type":"text/javascript","packages":{}}}],"id":"0778b5c8-f3d9-46e7-9f54-b70ad302cbac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"companyCif\": \"C80808081\",\r\n \"username\": \"vedprakash.singh+preproduat@payabl.com\",\r\n \"password\": \"Test@123\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payabl-api.preprod.payabl1.com/api/v1/auth","description":"This endpoint allows you to authenticate and obtain an access token for accessing the Payabl API.
\nMethod: POST
URL: https://payabl-api.preprod.payabl1.com/api/v1/auth
Headers:
\napplication/jsonBody:
\ncompanyCif: The CIF of the company.
username: The username for authentication.
password: The password for authentication.
Example Request Body:
\n{\n \"companyCif\": \"C00751\",\n \"username\": \"user_email\",\n \"password\": \"user_password\"\n}\n\nThe response will include the following fields:
\naccessToken: The access token for accessing the API.
expiresIn: The expiration time of the access token in seconds.
Example Success Response:
\n{\n \"accessToken\": \"********\",\n \"expiresIn\": 0\n}\n\nExample Invalid Auth Response:
\n{\n \"detail\": \"Authentication failed\"\n}\n\nThe request should be sent as an HTTP POST to the specified URL with the following parameters in the request body:
\ncompanyCif: The CIF of the company.
username: The username for authentication.
password: The password for authentication.
The response will include the following fields:
\naccessToken: The access token for accessing the API.
expiresIn: The expiration time of the access token in seconds.
Example success response:
\n{\n \"accessToken\": \"********\",\n \"expiresIn\": 0\n}\n\nExample Invalid Auth response:
\n{\n \"detail\": \"Authentication failed\"\n}\n\nSandbox URL: https://payabl-api.preprod.payabl1.com/api/v1/auth
\nProduction URL: https://public-payabl-api.prod.payabl1.com/api/v1/auth
\nNote: Access to the production URL is restricted by IP whitelisting. Clients must provide their source IP addresses in advance to be granted access.
\n","_postman_id":"df7bbb98-e216-4190-8fc6-b65fc844a93d"},{"name":"Accounts","item":[{"name":"Get list of all accounts","id":"3e6ddcee-9e07-46bf-a7c9-063c6bbf210c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint makes an HTTP GET request to retrieve a list of accounts. It includes query parameters for pagination, with a limit of 10 accounts per page and an offset of 1 for the page number.
\npage__limit (integer): Specifies the limit of accounts per page.
page__offset (integer): Specifies the offset for paginated results.
Returns list of all accounts.
\nThe request was not authenticated. Please ensure that the token is correct and not expired.
\nThe request returns a 200 status code with a JSON response in the following format:
\n{\n \"data\": [\n {\n \"uuid\": \"string\",\n \"name\": \"string\",\n \"status\": \"PENDING_ACTIVATION\",\n \"aliases\": [\n {\n \"uuid\": \"string\",\n \"accountNumber\": \"string\",\n \"bic\": \"string\",\n \"identifier\": \"IBAN\"\n }\n ],\n \"balances\": [\n {\n \"availableBalance\": \"string\",\n \"currencyCode\": \"string\"\n }\n ],\n \"createdAt\": \"2019-08-24T14:15:22Z\"\n }\n ],\n \"pagination\": {\n \"total\": 0,\n \"limit\": 0,\n \"offset\": 0\n }\n}\n\nThe data field contains an array of accounts, and the pagination field provides information about the total number of accounts, the limit, and the offset.
{\n \"detail\": \"Unauthorized\"\n}\n\nThis endpoint retrieves information about a specific account using the account's UUID as a path parameter.
\nGET
\nhttps://payabl-api.preprod.payabl1.com/api/v1/accounts/{account_uuid}
\nReturns account information including UUID, name, status, aliases (with UUID, account number, BIC, and identifier), balances (with available balance and currency code), and creation timestamp.
\nIf the token is expired or invalid you will get unauthorized response with status code 401.
\n{\n \"uuid\": \"string\",\n \"name\": \"string\",\n \"status\": \"PENDING_ACTIVATION\",\n \"aliases\": [\n {\n \"uuid\": \"string\",\n \"accountNumber\": \"string\",\n \"bic\": \"string\",\n \"identifier\": \"IBAN\"\n }\n ],\n \"balances\": [\n {\n \"availableBalance\": \"string\",\n \"currencyCode\": \"string\"\n }\n ],\n \"createdAt\": \"2019-08-24T14:15:22Z\"\n}\n\n{\n \"detail\": \"Unauthorized\"\n}\n\nSandbox URL: https://payabl-api.preprod.payabl1.com/api/v1/accounts
\nProduction URL: Will be shared sepeartely with API credentials over email.
\n","_postman_id":"abb08504-5d4d-4c6c-b638-b565e0ef411b"},{"name":"Payments","item":[{"name":"Create Transaction API","id":"07b8c54a-d84f-4e28-aa4e-679d3a740002","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"accountUuid\": \"string\",\n \"currency\": \"string\",\n \"amount\": 0,\n \"purpose\": \"string\",\n \"isSepaInst\": false,\n \"beneficiary\": {\n \"name\": \"string\",\n \"identifier\": \"IBAN\",\n \"account\": \"string\",\n \"bic\": \"stringst\",\n \"bankName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCountry\": \"string\",\n \"address\": \"string\",\n \"postalCode\": \"string\",\n \"city\": \"string\",\n \"country\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://payabl-api.preprod.payabl1.com/api/v1/transactions","description":"This endpoint allows you to create a new transaction.
\naccountUuid (string): The UUID of the account alias. You can get the account alias UUID from the accounts API response.
currency (string): The currency of the amount to be transferred.
amount (number): The amount of the transaction.
purpose (string): The purpose of the transaction.
isSepaInst (boolean): Indicates if it is a SEPA instant transaction.
Deafult: \"true\"
beneficiary (object): Details of the beneficiary including name, identifier, account, BIC, bank details, and address.
uuid (string): optional but we recommend sending a unique ID for each of your requests to prevent duplicate payments. The key needs to be unique for each transfer request.
priority (string): optional, The prirority for the transfer.
Deafult: \"STANDARD\"
Enum: \"STANDARD\" \"EXPRESS\"
uuid (string): The UUID of the transaction.
publicId (string): The public ID of the transaction.
amount (string): The amount of the transaction.
feeAmount (null or number): The fee amount, if applicable.
remitter (object): Details of the remitter including name, IBAN, BIC, address, city, postal code, and country.
beneficiary (object): Details of the beneficiary including name, IBAN, BIC, address, city, postal code, and country.
currency (string): The currency of the transaction.
paymentRail (string): The payment rail used for the transaction.
valueDate (string): The value date of the transaction.
purpose (string): The purpose of the transaction.
operationType (string): The type of operation.
status (string): The status of the transaction.
createdAt (string): The timestamp of when the transaction was created.
{\n \"accountUuid\": \"string\",\n \"currency\": \"string\",\n \"amount\": 0,\n \"purpose\": \"string\",\n \"isSepaInst\": false,\n \"beneficiary\": {\n \"name\": \"string\",\n \"identifier\": \"IBAN\",\n \"account\": \"string\",\n \"bic\": \"stringst\",\n \"bankName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCountry\": \"string\",\n \"address\": \"string\",\n \"postalCode\": \"string\",\n \"city\": \"string\",\n \"country\": \"string\"\n }\n}\n\n{\n \"uuid\": \"string\",\n \"parentTransactionUuid\": \"string\",\n \"publicId\": \"string\",\n \"mandatePublicId\": \"string\",\n \"amount\": \"string\",\n \"feeAmount\": \"string\",\n \"returnChargesAmount\": \"string\",\n \"remitter\": {\n \"name\": \"string\",\n \"iban\": \"string\",\n \"bic\": \"string\",\n \"address\": \"string\",\n \"city\": \"string\",\n \"postalCode\": \"string\",\n \"country\": \"string\"\n },\n \"beneficiary\": {\n \"name\": \"string\",\n \"iban\": \"string\",\n \"bic\": \"string\",\n \"address\": \"string\",\n \"city\": \"string\",\n \"postalCode\": \"string\",\n \"country\": \"string\"\n },\n \"currency\": \"string\",\n \"paymentRail\": \"SWIFT\",\n \"valueDate\": \"2019-08-24T14:15:22Z\",\n \"purpose\": \"string\",\n \"reasonCode\": \"string\",\n \"operationType\": \"INCOMING_SINGLE\",\n \"transactionType\": \"TRANSFER\",\n \"isReturnTransaction\": true,\n \"status\": \"WAITING_FX_CONSENT\",\n \"createdAt\": \"2019-08-24T14:15:22Z\"\n}\n\nThis endpoint retrieves information about a specific transaction using the transaction UUID as a path parameter.
\nGET
\nhttps://payabl-api.preprod.payabl1.com/api/v1/transactions/{{transactionUuid}}
\nReturns transaction information contiaing the following information,
\nuuid
\nparenttransactionuuid
\npublicId
\nMandatepublicid
\namount
\nFeeamount
\nReturnchargesamount
\nBeneficiaryOrRemitter
\nCurrency
\npaymentRail - Enum \"SWIFT\" \"SEPA_SCT\" \"INTERNAL\" \"SEPA_INST\" \"SIC\" \"TARGET2\" \"BACS\" \"FASTER_PAYMENT\" \"CHAPS\" \"TRANSFER\" \"DEBIT_CARD\" \"SEPA_DD\"
\nValuedate
\npurpose
\nReasoncode
\nOperationTypes
\nExternalTransactionTypes
\nisReturnTransaction
\nstring
\ncreatedAt
\nIf the token is expired or invalid you will get unauthorized response with status code 401.
\n{\n \"uuid\": \"string\",\n \"parentTransactionUuid\": \"string\",\n \"publicId\": \"string\",\n \"mandatePublicId\": \"string\",\n \"amount\": \"string\",\n \"feeAmount\": \"string\",\n \"returnChargesAmount\": \"string\",\n \"remitter\": {\n \"name\": \"string\",\n \"iban\": \"string\",\n \"bic\": \"string\",\n \"address\": \"string\",\n \"city\": \"string\",\n \"postalCode\": \"string\",\n \"country\": \"string\"\n },\n \"beneficiary\": {\n \"name\": \"string\",\n \"iban\": \"string\",\n \"bic\": \"string\",\n \"address\": \"string\",\n \"city\": \"string\",\n \"postalCode\": \"string\",\n \"country\": \"string\"\n },\n \"currency\": \"string\",\n \"paymentRail\": \"SWIFT\",\n \"valueDate\": \"2019-08-24T14:15:22Z\",\n \"purpose\": \"string\",\n \"reasonCode\": \"string\",\n \"operationType\": \"INCOMING_SINGLE\",\n \"transactionType\": \"TRANSFER\",\n \"isReturnTransaction\": true,\n \"status\": \"WAITING_FX_CONSENT\",\n \"createdAt\": \"2019-08-24T14:15:22Z\"\n}\n\n{\n \"detail\": \"Unauthorized\"\n}\n\nThis endpoint retrieves a list of transactions.
\nStatus: 200
\nContent-Type: application/json
\nExample response body:
\n{\n \"data\": [\n {\n \"uuid\": \"\",\n \"publicId\": \"\",\n \"amount\": \"\",\n \"feeAmount\": null,\n \"remitter\": {\n \"name\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\"\n },\n \"beneficiary\": {\n \"name\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\"\n },\n \"currency\": \"\",\n \"paymentRail\": \"\",\n \"valueDate\": \"\",\n \"purpose\": \"\",\n \"operationType\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": 0,\n \"limit\": 0,\n \"offset\": 0\n }\n}\n#### Example of an Invalid Token\nIf the token used for authentication is invalid, the response will have an appropriate error message indicating the invalid token.\n\nThe transaction object includes the following properties:
\nuuid (string): The unique identifier for the transaction.
\npublicId (string): The public identifier for the transaction.
\namount (string): The amount of the transaction.
\nfeeAmount (null): The fee amount for the transaction, if applicable.
\nremitter (object): An object containing information about the remitter, including name, IBAN, BIC, address, city, postal code, and country.
\nbeneficiary (object): An object containing information about the beneficiary, including name, IBAN, BIC, address, city, postal code, and country.
\ncurrency (string): The currency of the transaction.
\npaymentRail (string): The payment rail used for the transaction.
\nvalueDate (string): The value date of the transaction.
\npurpose (string): The purpose of the transaction.
\noperationType (string): The type of operation for the transaction.
\nstatus (string): The status of the transaction.
\ncreatedAt (string): The timestamp indicating when the transaction was created.
\nThe pagination object includes the following properties:
\ntotal (number): The total number of transactions available.
\nlimit (number): The limit of transactions per page.
\noffset (number): The offset for the current page.
\nThe response can be documented as a JSON schema to define the structure and properties of the transaction and pagination objects.
\n","urlObject":{"protocol":"https","path":["api","v1","transactions"],"host":["payabl-api","preprod","payabl1","com"],"query":[],"variable":[]}},"response":[{"id":"40b0223e-2cfe-424a-8d90-b40a7cea178b","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":"https://payabl-api.preprod.payabl1.com/api/v1/transactions"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"uuid\": \"string\",\n \"parentTransactionUuid\": \"string\",\n \"publicId\": \"string\",\n \"mandatePublicId\": \"string\",\n \"amount\": \"string\",\n \"feeAmount\": \"string\",\n \"returnChargesAmount\": \"string\",\n \"remitter\": {\n \"name\": \"string\",\n \"iban\": \"string\",\n \"bic\": \"string\",\n \"address\": \"string\",\n \"city\": \"string\",\n \"postalCode\": \"string\",\n \"country\": \"string\"\n },\n \"beneficiary\": {\n \"name\": \"string\",\n \"iban\": \"string\",\n \"bic\": \"string\",\n \"address\": \"string\",\n \"city\": \"string\",\n \"postalCode\": \"string\",\n \"country\": \"string\"\n },\n \"currency\": \"string\",\n \"paymentRail\": \"SWIFT\",\n \"valueDate\": \"2019-08-24T00:00:00\",\n \"purpose\": \"string\",\n \"reasonCode\": \"string\",\n \"operationType\": \"INCOMING_SINGLE\",\n \"transactionType\": \"TRANSFER\",\n \"isReturnTransaction\": true,\n \"status\": \"WAITING_FX_CONSENT\",\n \"createdAt\": \"2019-08-24T14:15:22Z\"\n }\n ],\n \"pagination\": {\n \"total\": 0,\n \"limit\": 0,\n \"offset\": 0\n }\n}"},{"id":"2c092ef1-c13c-482a-97bd-16c8bcf34203","name":"Invalid Token","originalRequest":{"method":"GET","header":[],"url":"https://payabl-api.preprod.payabl1.com/api/v1/transactions"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Unauthorized\"\n}"}],"_postman_id":"e54a3e07-81f4-4f85-b9ad-c1ef51910589"},{"name":"Download Transaction Confirmation Pdf","id":"0ea65d29-2325-4bec-b105-c19eea44ed73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearertoken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://payabl-api.preprod.payabl1.com/api/v1/transactions/{{transactionUuid}}/confirmation-pdf","description":"This endpoint retrieves the confirmation PDF for a specific transaction identified by the transactionUuid. The request is made using the HTTP GET method.
URL: https://payabl-api.preprod.payabl1.com/api/v1/transactions/{{transactionUuid}}/confirmation-pdf
Method: GET
\nAuthorization: Bearer token
\nX-API-Key: API key
\nThe response will vary based on the outcome of the request:
\n200 OK: The request was successful, and the response will contain the confirmation PDF.
\n404 Not Found: The specified transaction UUID does not exist.
\nContent-Type: application/json
\nResponse Body: {\"message\":\"\"}
422 Unprocessable Entity: The request was well-formed but unable to be processed.
\nGET /api/v1/transactions/{{transactionUuid}}/confirmation-pdf HTTP/1.1\nHost: payabl-api.preprod.payabl1.com\nAuthorization: Bearer your_access_token\nX-API-Key: your_api_key\n\nHTTP/1.1 200 OK\nContent-Type: application/pdf\n\nThis documentation provides the necessary details to successfully retrieve a confirmation PDF for a transaction using the specified endpoint.
\nThis endpoint retrieves the confirmation PDF for a specific transaction identified by transactionUuid.
Method: GET
\nURL: https://payabl-api.preprod.payabl1.com/api/v1/transactions/{{transactionUuid}}/confirmation-pdf
Authorization: Bearer token
\nX-API-Key: API key (This key will be shared with you upon request).
\nStatus: 404
\nContent-Type: application/json
\n{ \"message\": \"\"}
\nA 404 status indicates that the requested confirmation PDF for the specified transaction UUID was not found. Ensure that the transactionUuid is correct and that the transaction exists.
This endpoint retrieves the confirmation PDF for a specific transaction identified by its UUID.
\nMethod: GET
\nURL: https://payabl-api.preprod.payabl1.com/api/v1/transactions/{{transactionUuid}}/confirmation-pdf
transactionUuid:
\nType: string
\nDescription: The UUID of the transaction for which the confirmation PDF is requested. This is a required parameter and must be in the format of a UUIDv4.
\nThis endpoint requires authorization via the following methods:
\nHTTP: Bearer Token
\nAPI Key:
\nHeader:
\nAuthorizationStatus Code: 404
\nContent-Type: application/json
\n{ \"message\": \"\"}
\nA 404 status indicates that the requested resource could not be found, which may occur if the provided transaction UUID does not correspond to an existing transaction.
\nThis endpoint allows you to retrieve the confirmation PDF for a specific transaction using its unique identifier (transactionUuid).
GET
https://payabl-api.preprod.payabl1.com/api/v1/transactions/{{transactionUuid}}/confirmation-pdf
This request requires HTTP Authorization using the Bearer scheme. Ensure to include a valid Bearer token in the request header.
\nStatus Code: 404
\nContent-Type: application/json
\n{ \"message\": \"\"}
\nThe response indicates that the requested resource could not be found. Please ensure that the transactionUuid provided is correct.
This endpoint retrieves the confirmation PDF for a specific transaction identified by the transactionUuid.
Method: GET
URL: https://payabl-api.preprod.payabl1.com/api/v1/transactions/{{transactionUuid}}/confirmation-pdf
Headers:
\nX-API-Key: This key is required for authentication and will be shared with the user upon request.Status Code: 404
Content-Type: application/json
Body:
\nmessage: An empty string indicating that the requested resource was not found.Ensure that the transactionUuid is valid to avoid receiving a 404 status. The X-API-Key must be included in the request headers for successful authentication.
This endpoint allows users to download the confirmation PDF for a specific transaction identified by its transactionUuid.
Method: GET
\nEndpoint: https://payabl-api.preprod.payabl1.com/api/v1/transactions/{{transactionUuid}}/confirmation-pdf
200 OK: Successfully retrieves the PDF transaction confirmation file.
\n400 Bad Request: The server cannot generate a PDF for this transaction due to client-side issues.
\n404 Not Found: The specified transaction does not exist.
\n422 Unprocessable Entity: Validation error occurred, indicating that the request was well-formed but unable to be followed due to semantic errors.
\napplication/jsonNo sample\n\nUse this endpoint to efficiently manage transaction confirmation PDF downloads.
\n","urlObject":{"protocol":"https","path":["api","v1","transactions","{{transactionUuid}}","confirmation-pdf"],"host":["payabl-api","preprod","payabl1","com"],"query":[],"variable":[]}},"response":[{"id":"e6571572-4c4d-4ed4-ac36-cbaac9ab21d3","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":"https://payabl-api.preprod.payabl1.com/api/v1/transactions/{{transactionUuid}}/confirmation-pdf"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"No sample\n"},{"id":"4e4661dd-ef72-4ef7-bbc3-b353b7dcad7a","name":"Invalid Token","originalRequest":{"method":"GET","header":[],"url":"https://payabl-api.preprod.payabl1.com/api/v1/transactions/{{transactionUuid}}/confirmation-pdf"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Unauthorized\"\n}"}],"_postman_id":"0ea65d29-2325-4bec-b105-c19eea44ed73"}],"id":"306fd6b4-4eeb-4622-9830-f74179a3df2c","description":"Sandbox: https://payabl-api.preprod.payabl1.com/api/v1/transactions
\nProduction URL: Will be shared sepeartely with API credentials over email.
\n","_postman_id":"306fd6b4-4eeb-4622-9830-f74179a3df2c"}],"variable":[{"key":"user_email","value":"vedprakash.singh+preprod@payabl.com\""},{"key":"user_password","value":"Admin@123"},{"key":"compan UUID","value":"a3619242-5508-43ab-a898-3eacbfac34b9"},{"key":"company_uuid","value":"a3619242-5508-43ab-a898-3eacbfac34b9"},{"key":"token","value":""}]}