{"info":{"_postman_id":"491431fc-b398-4c8b-96d5-40875d031b29","name":"payabl. - Banking Product API","description":"

API Reference to provide detailed specifications about the available endpoints, methods, 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":"491431fc-b398-4c8b-96d5-40875d031b29","publishedId":"2sBYArUYF1","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-08-20T15:12:57.000Z"},"item":[{"name":"Authorization","item":[{"name":"Get User token","event":[{"listen":"test","script":{"exec":["let responseData = pm.response.json();\r","pm.collectionVariables.set(\"token\", responseData.uuid);"],"type":"text/javascript","packages":{},"id":"f9c3c30b-2eae-40ce-ae9e-4241e085aaa5"}}],"id":"d96a53ca-3f8c-41a5-8c10-00ec1d2be7e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"companyCif\": \"your_company_cif\",\n \"username\": \"your_email\",\n \"password\": \"your_password\"\n}","options":{"raw":{"language":"json"}}},"url":"https://payabl-api.preprod.payabl1.com/api/v1/auth","description":"

Authenticate User

\n

This endpoint allows you to authenticate and obtain an access token for accessing the Payabl API.

\n

Request

\n\n

Example Request Body:

\n
{\n    \"companyCif\": \"C00751\",\n    \"username\": \"user_email\",\n    \"password\": \"user_password\"\n}\n\n
\n

Response

\n

The response will include the following fields:

\n\n

Example Success Response:

\n
{\n    \"accessToken\": \"********\",\n    \"expiresIn\": 0\n}\n\n
\n

Example Invalid Auth Response:

\n
{\n    \"detail\": \"Authentication failed\"\n}\n\n
\n

The request should be sent as an HTTP POST to the specified URL with the following parameters in the request body:

\n\n

The response will include the following fields:

\n\n

Example success response:

\n
{\n    \"accessToken\": \"********\",\n    \"expiresIn\": 0\n}\n\n
\n

Example Invalid Auth response:

\n
{\n    \"detail\": \"Authentication failed\"\n}\n\n
\n","urlObject":{"protocol":"https","path":["api","v1","auth"],"host":["payabl-api","preprod","payabl1","com"],"query":[],"variable":[]}},"response":[{"id":"5ebf4d49-539e-456d-a69e-b2435df78771","name":"Invalid Auth","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"companyCif\": \"companyCif\",\r\n \"username\": \"invalid@test.com\",\r\n \"password\": \"test@123\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payabl-api.preprod.payabl1.com/api/v1/auth"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 19 Mar 2024 09:53:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"34"},{"key":"Connection","value":"keep-alive"},{"key":"server","value":"uvicorn"},{"key":"apigw-requestid","value":"U3wJriHXliAEPbA="}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Authentication failed\"\n}"},{"id":"16b708a0-cf3a-44e2-86b4-8f81b08e41c3","name":"Get token Success Reponse","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"companyCif\": \"companyCif\",\r\n \"username\": \"user_email\",\r\n \"password\": \"user_password\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payabl-api.preprod.payabl1.com/api/v1/auth"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 19 Mar 2024 09:54:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3741"},{"key":"Connection","value":"keep-alive"},{"key":"server","value":"uvicorn"},{"key":"apigw-requestid","value":"U3wP4jnTliAEPVw="}],"cookie":[],"responseTime":null,"body":"{\n \"accessToken\": \"jwt_token\",\n \"expiresIn\": 300\n}"}],"_postman_id":"d96a53ca-3f8c-41a5-8c10-00ec1d2be7e8"}],"id":"aba8b6d4-2f2e-4175-94bc-ad3456e5ca88","description":"

Sandbox URL: https://payabl-api.preprod.payabl1.com/api/v1/auth

\n

Production URL: https://public-payabl-api.prod.payabl1.com/api/v1/auth

\n

Note: 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":"aba8b6d4-2f2e-4175-94bc-ad3456e5ca88"},{"name":"Accounts","item":[{"name":"Get list of all accounts","id":"28949272-4e02-44dd-8203-2dc2e9da504d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://payabl-api.preprod.payabl1.com/api/v1/accounts","description":"

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.

\n

Query Parameters

\n\n

Success 200

\n

Returns list of all accounts.

\n

Unauthenticated 401

\n

The request was not authenticated. Please ensure that the token is correct and not expired.

\n

Success Response(200)

\n

The 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\n
\n

The 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

Unauthenticated Response(401)

\n
{\n    \"detail\": \"Unauthorized\"\n}\n\n
\n","urlObject":{"protocol":"https","path":["api","v1","accounts"],"host":["payabl-api","preprod","payabl1","com"],"query":[],"variable":[]}},"response":[{"id":"133f5a44-ca4b-4ad0-b680-d2476e7dfb78","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":"https://payabl-api.preprod.payabl1.com/api/v1/accounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 19 Mar 2024 10:28:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"399"},{"key":"Connection","value":"keep-alive"},{"key":"server","value":"uvicorn"},{"key":"apigw-requestid","value":"U31RDh_yliAEMCw="}],"cookie":[],"responseTime":null,"body":"{\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}"},{"id":"dfc968e4-0eab-482a-9797-c2b26a7ac78d","name":"Invalid Token","originalRequest":{"method":"GET","header":[],"url":"https://payabl-api.preprod.payabl1.com/api/v1/accounts"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 19 Mar 2024 10:30:39 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"25"},{"key":"Connection","value":"keep-alive"},{"key":"server","value":"uvicorn"},{"key":"apigw-requestid","value":"U31kYholFiAEMsg="}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Unauthorized\"\n}"}],"_postman_id":"28949272-4e02-44dd-8203-2dc2e9da504d"},{"name":"Get details of an account","id":"04ff602b-b4bd-4669-8aff-2a3268ac7fca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://payabl-api.preprod.payabl1.com/api/v1/accounts/","description":"

This endpoint retrieves information about a specific account using the account's UUID as a path parameter.

\n

Request

\n

HTTP Method

\n

GET

\n

Endpoint

\n

https://payabl-api.preprod.payabl1.com/api/v1/accounts/{account_uuid}

\n

Responses

\n

Success 200

\n

Returns account information including UUID, name, status, aliases (with UUID, account number, BIC, and identifier), balances (with available balance and currency code), and creation timestamp.

\n

Unauthorized Response

\n

If the token is expired or invalid you will get unauthorized response with status code 401.

\n

Success Example

\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

Unauthenticated Example

\n
{\n    \"detail\": \"Unauthorized\"\n}\n\n
\n","urlObject":{"protocol":"https","path":["api","v1","accounts",""],"host":["payabl-api","preprod","payabl1","com"],"query":[],"variable":[]}},"response":[{"id":"ad2e4736-cc00-4355-aef2-3a8698fcf96f","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":"https://payabl-api.preprod.payabl1.com/api/v1/accounts/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 19 Mar 2024 10:49:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"341"},{"key":"Connection","value":"keep-alive"},{"key":"server","value":"uvicorn"},{"key":"apigw-requestid","value":"U34QfjNCliAEM8A="}],"cookie":[],"responseTime":null,"body":"{\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}"},{"id":"b9e9c243-a98a-4671-9225-6db7c0be48b7","name":"Invalid Token","originalRequest":{"method":"GET","header":[],"url":"https://payabl-api.preprod.payabl1.com/api/v1/accounts/f96448e8-6b57-4187-96a6-007043d39a0c"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 19 Mar 2024 10:49:23 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"25"},{"key":"Connection","value":"keep-alive"},{"key":"server","value":"uvicorn"},{"key":"apigw-requestid","value":"U34UCjoQliAEMHw="}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Unauthorized\"\n}"}],"_postman_id":"04ff602b-b4bd-4669-8aff-2a3268ac7fca"}],"id":"bfa2f134-030b-4a39-836f-3d11aa70adfe","description":"

Sandbox URL: https://payabl-api.preprod.payabl1.com/api/v1/accounts

\n

Production URL: https://public-payabl-api.prod.payabl1.com/api/v1/accounts

\n

Note: 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":"bfa2f134-030b-4a39-836f-3d11aa70adfe"},{"name":"Payments","item":[{"name":"Create Transaction API","id":"8667eb10-662b-4de4-8a59-449b9b42ae17","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":"

Create a Transaction

\n

This endpoint allows you to create a new transaction.

\n

Request Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
accountUuidstring (uuid4)✅ YesThe UUID of the account alias. You can get the account alias UUID from the accounts API response.
uuidstring or nullNoA unique ID for the request to prevent duplicate payments. Must be unique for each transfer request.
currencystring✅ YesThe currency of the amount to be transferred.
amountnumber or string✅ YesThe amount of the transaction.
purposestring✅ YesThe purpose of the transaction. Max 140 characters. Pattern: ^[A-Za-z0-9?:().,'+\\-]+(?:\\s+[A-Za-z0-9?:().,'+\\-]+)*$
isSepaInstbooleanNoIndicates if it is a SEPA instant transaction. Default: true
prioritystringNoThe priority for the transfer. Default: \"STANDARD\". Enum: \"STANDARD\", \"EXPRESS\"
beneficiaryobject✅ YesDetails of the beneficiary (see below).
\n

Beneficiary Object

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
namestring✅ YesBeneficiary name. Must be non-empty. Pattern: ^[\\p{L}0-9?:()-.\\/,'+]+(?: [\\p{L}0-9?:()-.\\/,'+]+)*$
identifierstringNoThe type of receiving account. Default: \"IBAN\". Enum: \"IBAN\", \"ACCOUNT_NUMBER\", \"SORT_ACCOUNT\", \"CARD\"
accountstring✅ YesThe beneficiary account number (format depends on identifier type).
bicstring or nullNoThe BIC/SWIFT code of the beneficiary's bank.
bankNamestring or nullNoName of the beneficiary's bank.
bankAddressstring or nullNoAddress of the beneficiary's bank.
bankCountrystring or nullNoCountry of the beneficiary's bank.
addressstring or nullNoBeneficiary's address.
postalCodestring or nullNoBeneficiary's postal code.
citystring or nullNoBeneficiary's city.
countrystring✅ YesBeneficiary's country.
additionalInfoobject or nullNoAdditional information about the beneficiary.
\n

Example Request Body

\n
{\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

Response

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
uuidstringThe UUID of the transaction.
publicIdstringThe public ID of the transaction.
amountstringThe amount of the transaction.
feeAmountstring or nullThe fee amount, if applicable.
remitterobjectDetails of the remitter including name, IBAN, BIC, address, city, postal code, and country.
beneficiaryobjectDetails of the beneficiary including name, IBAN, BIC, address, city, postal code, and country.
currencystringThe currency of the transaction.
paymentRailstringThe payment rail used for the transaction (e.g., \"SWIFT\").
valueDatestring (datetime)The value date of the transaction.
purposestringThe purpose of the transaction.
operationTypestringThe type of operation (e.g., \"INCOMING_SINGLE\").
statusstringThe status of the transaction (e.g., \"WAITING_FX_CONSENT\").
createdAtstring (datetime)The timestamp of when the transaction was created.
\n

Example Response

\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","urlObject":{"protocol":"https","path":["api","v1","transactions"],"host":["payabl-api","preprod","payabl1","com"],"query":[],"variable":[]}},"response":[{"id":"478bf43d-5697-41f8-b1c9-f9058e1ebac7","name":"Success Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"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"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\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}"},{"id":"a7fd0777-1551-4697-b3ac-8cfe05718429","name":"Already exising transaction","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountUuid\": \"string\",\n \"currency\": \"string\",\n \"uuid\": \"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"},"status":"Conflict","code":409,"_postman_previewlanguage":"Text","header":[{}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"detail\": \"Transaction id {uuid} is already taken\"\n}"},{"id":"090e0523-8ded-41e6-ab86-2b5e50b23754","name":"Invalid Token","originalRequest":{"method":"POST","header":[],"url":"https://payabl-api.preprod.payabl1.com/api/v1/transactions"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"detail\": \"Unauthorized\"\n}"}],"_postman_id":"8667eb10-662b-4de4-8a59-449b9b42ae17"},{"name":"Get details of an transaction","id":"3a285cb5-853c-4894-87f3-27e221e1e077","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://payabl-api.preprod.payabl1.com/api/v1/transactions/","description":"

This endpoint retrieves information about a specific transaction using the transaction UUID as a path parameter.

\n

Request

\n

HTTP Method

\n

GET

\n

Endpoint

\n

https://payabl-api.preprod.payabl1.com/api/v1/transactions/

\n

Responses

\n

Success 200

\n

Returns transaction information contiaing the following information,

\n
    \n

  • uuid

    \n
    • \n

  • parenttransactionuuid

    \n
    • \n

  • publicId

    \n
    • \n

  • Mandatepublicid

    \n
    • \n

  • amount

    \n
    • \n

  • Feeamount

    \n
    • \n

  • Returnchargesamount

    \n
    • \n

  • BeneficiaryOrRemitter

    \n
    • \n

  • Currency

    \n
    • \n

  • paymentRail - Enum \"SWIFT\" \"SEPA_SCT\" \"INTERNAL\" \"SEPA_INST\" \"SIC\" \"TARGET2\" \"BACS\" \"FASTER_PAYMENT\" \"CHAPS\" \"TRANSFER\" \"DEBIT_CARD\" \"SEPA_DD\"

    \n
    • \n

  • Valuedate

    \n
    • \n

  • purpose

    \n
    • \n

  • Reasoncode

    \n
    • \n

  • OperationTypes

    \n
    • \n

  • ExternalTransactionTypes

    \n
    • \n

  • isReturnTransaction

    \n
    • \n

  • string

    \n
    • \n

  • createdAt

    \n
    • \n
\n

Unauthorized Response

\n

If the token is expired or invalid you will get unauthorized response with status code 401.

\n

Success Example

\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

Unauthenticated Example

\n
{\n    \"detail\": \"Unauthorized\"\n}\n\n
\n","urlObject":{"protocol":"https","path":["api","v1","transactions",""],"host":["payabl-api","preprod","payabl1","com"],"query":[],"variable":[]}},"response":[{"id":"90bec0c6-0362-4d33-8240-d2f919887d45","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":"https://payabl-api.preprod.payabl1.com/api/v1/transactions/"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\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}"},{"id":"e3db8d6e-7dbb-41f9-9251-6b8623a7ae59","name":"Invalid Token","originalRequest":{"method":"GET","header":[],"url":"https://payabl-api.preprod.payabl1.com/api/v1/transactions/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"detail\": \"Unauthorized\"\n}"}],"_postman_id":"3a285cb5-853c-4894-87f3-27e221e1e077"},{"name":"Get All transactions","id":"9f5c0625-617d-4af1-b292-49f78beeddea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://payabl-api.preprod.payabl1.com/api/v1/transactions","description":"

Get Transactions

\n

This endpoint retrieves a list of transactions.

\n

Query Parameters

\n
    \n

  • account_uuid (string or null): The UUID of the account for which transactions are being retrieved.

    \n
    • \n

  • page__limit (integer): The limit of transactions per page. Default is 10.

    \n
    • \n

  • page__offset (integer): The offset for the current page. Default is 0.

    \n
    • \n

  • transaction__created_at__lte (string or null): Filter for transactions created at or before the specified date.

    \n
    • \n

  • transaction__created_at__gte (string or null): Filter for transactions created at or after the specified date.

    \n
    • \n

  • transaction__posting_datetime__lte (string or null): Filter for transactions posted at or before the specified datetime.

    \n
    • \n

  • transaction__posting_datetime__gte (string or null): Filter for transactions posted at or after the specified datetime.

    \n
    • \n

  • transaction__mandate_public_id__eq (string or null): Filter for transactions with a specific mandate public ID.

    \n
    • \n

  • transaction__transaction_type__in (string or null): Filter for transactions of specific types.

    \n
    • \n

  • transaction__is_return__eq (boolean or null): Filter for transactions that are return transactions.

    \n
    • \n

  • order_by (string): Specify the order of the returned transactions.

    \n
    • \n
\n

Success Response

\n
    \n

  • Status: 200

    \n
    • \n

  • Content-Type: application/json

    \n
    • \n
\n

Example 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\n
\n

Example of an Invalid Token

\n

If the token used for authentication is invalid, the response will have an appropriate error message indicating the invalid token.

\n

The transaction object includes the following properties:

\n
    \n

  • uuid (string): The unique identifier for the transaction.

    \n
    • \n

  • publicId (string): The public identifier for the transaction.

    \n
    • \n

  • amount (string): The amount of the transaction.

    \n
    • \n

  • feeAmount (null): The fee amount for the transaction, if applicable.

    \n
    • \n

  • remitter (object): An object containing information about the remitter, including name, IBAN, BIC, address, city, postal code, and country.

    \n
    • \n

  • beneficiary (object): An object containing information about the beneficiary, including name, IBAN, BIC, address, city, postal code, and country.

    \n
    • \n

  • currency (string): The currency of the transaction.

    \n
    • \n

  • paymentRail (string): The payment rail used for the transaction.

    \n
    • \n

  • valueDate (string): The value date of the transaction.

    \n
    • \n

  • purpose (string): The purpose of the transaction.

    \n
    • \n

  • operationType (string): The type of operation for the transaction.

    \n
    • \n

  • status (string): The status of the transaction.

    \n
    • \n

  • createdAt (string): The timestamp indicating when the transaction was created.

    \n
    • \n
\n

The pagination object includes the following properties:

\n
    \n

  • total (number): The total number of transactions available.

    \n
    • \n

  • limit (number): The limit of transactions per page.

    \n
    • \n

  • offset (number): The offset for the current page.

    \n
    • \n
\n

The response can be documented as a JSON schema to define the structure and properties of the transaction and pagination objects.

\n

This endpoint retrieves a list of transactions.

\n

Request Parameters

\n
    \n

  • page__limit (integer, optional): The maximum number of transactions to return per page. Default value is 10.

    \n
    • \n

  • page__offset (integer, optional): The starting point for the transactions to return. Default value is 0.

    \n
    • \n
\n

Success Response

\n
    \n

  • Status: 200

    \n
    • \n

  • Content-Type: application/json

    \n
    • \n
\n

Example 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\n
\n

Example of an Invalid Token

\n

If the token used for authentication is invalid, the response will have an appropriate error message indicating the invalid token.

\n

The transaction object includes the following properties:

\n
    \n

  • uuid (string): The unique identifier for the transaction.

    \n
    • \n

  • publicId (string): The public identifier for the transaction.

    \n
    • \n

  • amount (string): The amount of the transaction.

    \n
    • \n

  • feeAmount (null): The fee amount for the transaction, if applicable.

    \n
    • \n

  • remitter (object): An object containing information about the remitter, including name, IBAN, BIC, address, city, postal code, and country.

    \n
    • \n

  • beneficiary (object): An object containing information about the beneficiary, including name, IBAN, BIC, address, city, postal code, and country.

    \n
    • \n

  • currency (string): The currency of the transaction.

    \n
    • \n

  • paymentRail (string): The payment rail used for the transaction.

    \n
    • \n

  • valueDate (string): The value date of the transaction.

    \n
    • \n

  • purpose (string): The purpose of the transaction.

    \n
    • \n

  • operationType (string): The type of operation for the transaction.

    \n
    • \n

  • status (string): The status of the transaction.

    \n
    • \n

  • createdAt (string): The timestamp indicating when the transaction was created.

    \n
    • \n
\n

The pagination object includes the following properties:

\n
    \n

  • total (number): The total number of transactions available.

    \n
    • \n

  • limit (number): The limit of transactions per page.

    \n
    • \n

  • offset (number): The offset for the current page.

    \n
    • \n
\n

The response can be documented as a JSON schema to define the structure and properties of the transaction and pagination objects.

\n

This endpoint retrieves a list of transactions.

\n

Success Response

\n
    \n

  • Status: 200

    \n
    • \n

  • Content-Type: application/json

    \n
    • \n
\n

Example 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\n
\n

The transaction object includes the following properties:

\n
    \n

  • uuid (string): The unique identifier for the transaction.

    \n
    • \n

  • publicId (string): The public identifier for the transaction.

    \n
    • \n

  • amount (string): The amount of the transaction.

    \n
    • \n

  • feeAmount (null): The fee amount for the transaction, if applicable.

    \n
    • \n

  • remitter (object): An object containing information about the remitter, including name, IBAN, BIC, address, city, postal code, and country.

    \n
    • \n

  • beneficiary (object): An object containing information about the beneficiary, including name, IBAN, BIC, address, city, postal code, and country.

    \n
    • \n

  • currency (string): The currency of the transaction.

    \n
    • \n

  • paymentRail (string): The payment rail used for the transaction.

    \n
    • \n

  • valueDate (string): The value date of the transaction.

    \n
    • \n

  • purpose (string): The purpose of the transaction.

    \n
    • \n

  • operationType (string): The type of operation for the transaction.

    \n
    • \n

  • status (string): The status of the transaction.

    \n
    • \n

  • createdAt (string): The timestamp indicating when the transaction was created.

    \n
    • \n
\n

The pagination object includes the following properties:

\n
    \n

  • total (number): The total number of transactions available.

    \n
    • \n

  • limit (number): The limit of transactions per page.

    \n
    • \n

  • offset (number): The offset for the current page.

    \n
    • \n
\n

The 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":"cb11e329-201a-498b-9b9f-6d122dcdb366","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":"https://payabl-api.preprod.payabl1.com/api/v1/transactions"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"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":"67fe997f-0cac-42fa-bc2d-f49485b53080","name":"Invalid Token","originalRequest":{"method":"GET","header":[],"url":"https://payabl-api.preprod.payabl1.com/api/v1/transactions"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Unauthorized\"\n}"}],"_postman_id":"9f5c0625-617d-4af1-b292-49f78beeddea"},{"name":"Download Transaction Confirmation Pdf","id":"7cd0b29d-57d5-47ad-8884-e15c661aec54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://payabl-api.preprod.payabl1.com/api/v1/transactions//confirmation-pdf","description":"

Download Confirmation PDF

\n

This endpoint retrieves the confirmation PDF for a specific transaction identified by the transactionUuid. The request is made using the HTTP GET method.

\n

Request

\n
    \n

  • URL: https://payabl-api.preprod.payabl1.com/api/v1/transactions//confirmation-pdf

    \n
    • \n

  • Method: GET

    \n
    • \n
\n

Headers

\n
    \n

  • Authorization: Bearer token

    \n
    • \n

  • X-API-Key: API key

    \n
    • \n
\n

Response

\n

The response will vary based on the outcome of the request:

\n
    \n

  • 200 OK: The request was successful, and the response will contain the confirmation PDF.

    \n
      \n
    • Content-Type: application/pdf
      • \n
    \n
    • \n

  • 404 Not Found: The specified transaction UUID does not exist.

    \n
      \n

    • Content-Type: application/json

      \n
      • \n

    • Response Body: {\"message\":\"\"}

      \n
      • \n
    \n
    • \n

  • 422 Unprocessable Entity: The request was well-formed but unable to be processed.

    \n
      \n
    • Content-Type: application/pdf (No sample provided)
      • \n
    \n
    • \n
\n

Example

\n

Success Request Example

\n
GET /api/v1/transactions//confirmation-pdf HTTP/1.1\nHost: payabl-api.preprod.payabl1.com\nAuthorization: Bearer your_access_token\nX-API-Key: your_api_key\n\n
\n

Response Example

\n
HTTP/1.1 200 OK\nContent-Type: application/pdf\n\n
\n

This documentation provides the necessary details to successfully retrieve a confirmation PDF for a transaction using the specified endpoint.

\n

This endpoint retrieves the confirmation PDF for a specific transaction identified by transactionUuid.

\n

Request

\n
    \n

  • Method: GET

    \n
    • \n

  • URL: https://payabl-api.preprod.payabl1.com/api/v1/transactions//confirmation-pdf

    \n
    • \n
\n

Request Headers

\n
    \n

  • Authorization: Bearer token

    \n
    • \n

  • X-API-Key: API key (This key will be shared with you upon request).

    \n
    • \n
\n

Response

\n
    \n

  • Status: 404

    \n
    • \n

  • Content-Type: application/json

    \n
    • \n

  • { \"message\": \"\"}

    \n
    • \n
\n

Notes

\n

A 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.

\n

This endpoint retrieves the confirmation PDF for a specific transaction identified by its UUID.

\n

Request

\n
    \n

  • Method: GET

    \n
    • \n

  • URL: https://payabl-api.preprod.payabl1.com/api/v1/transactions//confirmation-pdf

    \n
    • \n
\n

Path Parameters

\n
    \n

  • transactionUuid:

    \n
      \n

    • Type: string

      \n
      • \n

    • Description: 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.

      \n
      • \n
    \n
    • \n
\n

Authorization

\n

This endpoint requires authorization via the following methods:

\n
    \n

  • HTTP: Bearer Token

    \n
    • \n

  • API Key:

    \n
      \n

    • Header:

      \n
        \n
      • Parameter Name: Authorization
        • \n
      \n
      • \n
    \n
    • \n
\n

Response

\n
    \n

  • Status Code: 404

    \n
    • \n

  • Content-Type: application/json

    \n
    • \n

  • { \"message\": \"\"}

    \n
    • \n
\n

A 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.

\n

This endpoint allows you to retrieve the confirmation PDF for a specific transaction using its unique identifier (transactionUuid).

\n

HTTP Method

\n

GET

\n

URL

\n

https://payabl-api.preprod.payabl1.com/api/v1/transactions//confirmation-pdf

\n

Authorization

\n

This request requires HTTP Authorization using the Bearer scheme. Ensure to include a valid Bearer token in the request header.

\n

Response

\n
    \n

  • Status Code: 404

    \n
    • \n

  • Content-Type: application/json

    \n
    • \n

  • { \"message\": \"\"}

    \n
    • \n
\n

The response indicates that the requested resource could not be found. Please ensure that the transactionUuid provided is correct.

\n

This endpoint retrieves the confirmation PDF for a specific transaction identified by the transactionUuid.

\n

Request

\n
    \n

  • Method: GET

    \n
    • \n

  • URL: https://payabl-api.preprod.payabl1.com/api/v1/transactions//confirmation-pdf

    \n
    • \n

  • Headers:

    \n
      \n
    • X-API-Key: This key is required for authentication and will be shared with the user upon request.
      • \n
    \n
    • \n
\n

Response

\n
    \n

  • Status Code: 404

    \n
    • \n

  • Content-Type: application/json

    \n
    • \n

  • Body:

    \n
      \n
    • message: An empty string indicating that the requested resource was not found.
      • \n
    \n
    • \n
\n

Note

\n

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.

\n

This endpoint allows users to download the confirmation PDF for a specific transaction identified by its transactionUuid.

\n

Request

\n
    \n

  • Method: GET

    \n
    • \n

  • Endpoint: https://payabl-api.preprod.payabl1.com/api/v1/transactions//confirmation-pdf

    \n
    • \n
\n

Responses

\n
    \n

  • 200 OK: Successfully retrieves the PDF transaction confirmation file.

    \n
    • \n

  • 400 Bad Request: The server cannot generate a PDF for this transaction due to client-side issues.

    \n
    • \n

  • 404 Not Found: The specified transaction does not exist.

    \n
    • \n

  • 422 Unprocessable Entity: Validation error occurred, indicating that the request was well-formed but unable to be followed due to semantic errors.

    \n
    • \n
\n

Response Schema

\n
    \n
  • Content-Type: application/json
    • \n
\n

Example Response

\n
No sample\n\n
\n

Use this endpoint to efficiently manage transaction confirmation PDF downloads.

\n","urlObject":{"protocol":"https","path":["api","v1","transactions","","confirmation-pdf"],"host":["payabl-api","preprod","payabl1","com"],"query":[],"variable":[]}},"response":[{"id":"eef1b6bd-2955-4e38-90c8-bb8db584c5b6","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":"https://payabl-api.preprod.payabl1.com/api/v1/transactions//confirmation-pdf"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"No sample\n"},{"id":"879618a6-ccc6-4240-a4cc-9aeff38fbe98","name":"Invalid Token","originalRequest":{"method":"GET","header":[],"url":"https://payabl-api.preprod.payabl1.com/api/v1/transactions//confirmation-pdf"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Unauthorized\"\n}"}],"_postman_id":"7cd0b29d-57d5-47ad-8884-e15c661aec54"}],"id":"b0b560e6-4456-40f3-b96a-bc7552c2ee2b","description":"

Sandbox: https://payabl-api.preprod.payabl1.com/api/v1/transactions

\n

Production URL: https://public-payabl-api.prod.payabl1.com/api/v1/transactions

\n

Note: 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":"b0b560e6-4456-40f3-b96a-bc7552c2ee2b"},{"name":"FX (Foreign Exchange)","item":[{"name":"Request FX Quote","id":"c75ca488-e6c6-49d3-a5c2-87c9d15ea82e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sellAccountNumber\": \"string\",\n \"sellCurrency\": \"EUR\",\n \"buyAccountNumber\": \"string\",\n \"buyCurrency\": \"USD\",\n \"buySell\": \"SELL\",\n \"amount\": \"1000.00\"\n}","options":{"raw":{"language":"json"}}},"url":"https://payabl-api.preprod.payabl1.com/api/v1/fx/quotes","description":"

Request an FX Quote

\n

This endpoint allows you to request a foreign exchange quote for a currency conversion between two accounts.

\n

Request Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
sellAccountNumberstring✅ YesThe account number to sell (debit) from.
sellCurrencystring (3 chars)✅ YesThe 3-letter currency code to sell (e.g., \"EUR\").
buyAccountNumberstring✅ YesThe account number to buy (credit) into.
buyCurrencystring (3 chars)✅ YesThe 3-letter currency code to buy (e.g., \"USD\").
buySellstring✅ YesDirection of the trade. Enum: \"BUY\", \"SELL\".
amountnumber or string✅ YesThe amount to convert. Must be greater than 0.
\n

Example Request Body

\n
{\n  \"sellAccountNumber\": \"CY12345678901234567890123456\",\n  \"sellCurrency\": \"EUR\",\n  \"buyAccountNumber\": \"CY65432109876543210987654321\",\n  \"buyCurrency\": \"USD\",\n  \"buySell\": \"SELL\",\n  \"amount\": \"1000.00\"\n}\n\n
\n

Response

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
quoteIdstring (uuid4)The unique identifier of the quote. Use this to execute the order or view the quote.
fromCurrencystringThe source currency.
toCurrencystringThe target currency.
ratestringThe exchange rate applied.
soldAmountstringThe amount being sold.
boughtAmountstringThe amount being bought.
feeAmountstring or nullThe fee amount, if applicable.
expiresAtstring (datetime)The timestamp when the quote expires.
expiresInSecondsintegerNumber of seconds until the quote expires.
\n

Example Success Response (201)

\n
{\n  \"quoteId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"fromCurrency\": \"EUR\",\n  \"toCurrency\": \"USD\",\n  \"rate\": \"1.0856\",\n  \"soldAmount\": \"1000.00\",\n  \"boughtAmount\": \"1085.60\",\n  \"feeAmount\": null,\n  \"expiresAt\": \"2025-08-15T12:31:45Z\",\n  \"expiresInSeconds\": 30\n}\n\n
\n

Unauthenticated Response (401)

\n
{\n  \"detail\": \"Unauthorized\"\n}\n\n
\n","urlObject":{"protocol":"https","path":["api","v1","fx","quotes"],"host":["payabl-api","preprod","payabl1","com"],"query":[],"variable":[]}},"response":[{"id":"0dd9e6e6-78a7-494f-a0f4-f6f585dcc0c0","name":"Success Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sellAccountNumber\": \"CY12345678901234567890123456\",\n \"sellCurrency\": \"EUR\",\n \"buyAccountNumber\": \"CY65432109876543210987654321\",\n \"buyCurrency\": \"USD\",\n \"buySell\": \"SELL\",\n \"amount\": \"1000.00\"\n}","options":{"raw":{"language":"json"}}},"url":"https://payabl-api.preprod.payabl1.com/api/v1/fx/quotes"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"quoteId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"fromCurrency\": \"EUR\",\n \"toCurrency\": \"USD\",\n \"rate\": \"1.0856\",\n \"soldAmount\": \"1000.00\",\n \"boughtAmount\": \"1085.60\",\n \"feeAmount\": null,\n \"expiresAt\": \"2025-08-15T12:31:45Z\",\n \"expiresInSeconds\": 30\n}"},{"id":"e10d6511-4eef-4e28-84fe-e62af77bcee2","name":"Invalid Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sellAccountNumber\": \"string\",\n \"sellCurrency\": \"EUR\",\n \"buyAccountNumber\": \"string\",\n \"buyCurrency\": \"USD\",\n \"buySell\": \"SELL\",\n \"amount\": \"1000.00\"\n}","options":{"raw":{"language":"json"}}},"url":"https://payabl-api.preprod.payabl1.com/api/v1/fx/quotes"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Unauthorized\"\n}"}],"_postman_id":"c75ca488-e6c6-49d3-a5c2-87c9d15ea82e"},{"name":"View FX Quote","id":"a0c0ec14-3903-4a52-a779-4df78beb6792","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://payabl-api.preprod.payabl1.com/api/v1/fx/quotes/","description":"

View an Active FX Quote

\n

This endpoint retrieves the details of an active FX quote using the quote ID.

\n

Path Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeRequiredDescription
quote_idstring (uuid4)✅ YesThe UUID of the quote to retrieve.
\n

Response

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
quoteIdstring (uuid4)The unique identifier of the quote.
fromCurrencystringThe source currency.
toCurrencystringThe target currency.
ratestringThe exchange rate applied.
soldAmountstringThe amount being sold.
boughtAmountstringThe amount being bought.
feeAmountstring or nullThe fee amount, if applicable.
expiresAtstring (datetime)The timestamp when the quote expires.
expiresInSecondsintegerNumber of seconds until the quote expires.
\n

Example Success Response (200)

\n
{\n  \"quoteId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"fromCurrency\": \"EUR\",\n  \"toCurrency\": \"USD\",\n  \"rate\": \"1.0856\",\n  \"soldAmount\": \"1000.00\",\n  \"boughtAmount\": \"1085.60\",\n  \"feeAmount\": null,\n  \"expiresAt\": \"2025-08-15T12:31:45Z\",\n  \"expiresInSeconds\": 15\n}\n\n
\n

Unauthenticated Response (401)

\n
{\n  \"detail\": \"Unauthorized\"\n}\n\n
\n","urlObject":{"protocol":"https","path":["api","v1","fx","quotes",""],"host":["payabl-api","preprod","payabl1","com"],"query":[],"variable":[]}},"response":[{"id":"38f32413-17fa-4d13-8829-cdae682b49b6","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":"https://payabl-api.preprod.payabl1.com/api/v1/fx/quotes/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"quoteId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"fromCurrency\": \"EUR\",\n \"toCurrency\": \"USD\",\n \"rate\": \"1.0856\",\n \"soldAmount\": \"1000.00\",\n \"boughtAmount\": \"1085.60\",\n \"feeAmount\": null,\n \"expiresAt\": \"2025-08-15T12:31:45Z\",\n \"expiresInSeconds\": 15\n}"},{"id":"e5cfe11a-5e85-4b13-9f85-ce10d46b22dc","name":"Invalid Token","originalRequest":{"method":"GET","header":[],"url":"https://payabl-api.preprod.payabl1.com/api/v1/fx/quotes/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Unauthorized\"\n}"}],"_postman_id":"a0c0ec14-3903-4a52-a779-4df78beb6792"},{"name":"Execute FX Order","id":"1f95fce8-26ad-46a3-ad1c-47ecc60d2145","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"quoteId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"purpose\": \"Currency conversion for supplier payment\"\n}","options":{"raw":{"language":"json"}}},"url":"https://payabl-api.preprod.payabl1.com/api/v1/fx/orders","description":"

Execute an FX Order

\n

This endpoint executes a foreign exchange order, optionally against a previously obtained quote.

\n

Request Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
quoteIdstring (uuid4) or nullNoThe ID of a previously obtained quote. If provided, the order is executed at the quoted rate.
sellAccountNumberstring or nullNo*The account number to sell from.
sellCurrencystring (3 chars) or nullNo*The 3-letter currency code to sell.
buyAccountNumberstring or nullNo*The account number to buy into.
buyCurrencystring (3 chars) or nullNo*The 3-letter currency code to buy.
buySellstring or nullNo*Direction of the trade. Enum: \"BUY\", \"SELL\".
amountnumber or string or nullNo*The amount to convert. Must be greater than 0.
purposestringNoPurpose of the FX order. Max 140 characters. Pattern: ^[A-Za-z0-9?:().,'+\\-]+(?:\\s+[A-Za-z0-9?:().,'+\\-]+)*$
\n
\n

Note: If quoteId is provided, the order uses the quote's parameters. If quoteId is not provided, sellAccountNumber, sellCurrency, buyAccountNumber, buyCurrency, buySell, and amount are required.

\n
\n

Example Request Body (with quote)

\n
{\n  \"quoteId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"purpose\": \"Currency conversion for supplier payment\"\n}\n\n
\n

Example Request Body (without quote)

\n
{\n  \"sellAccountNumber\": \"CY12345678901234567890123456\",\n  \"sellCurrency\": \"EUR\",\n  \"buyAccountNumber\": \"CY65432109876543210987654321\",\n  \"buyCurrency\": \"USD\",\n  \"buySell\": \"SELL\",\n  \"amount\": \"1000.00\",\n  \"purpose\": \"Currency conversion for supplier payment\"\n}\n\n
\n

Response

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
uuidstring (uuid4)Unique identifier of the FX order.
createdAtstring (datetime)When the order was created.
operationTypestringType of operation. Enum: \"INCOMING_SINGLE\", \"INCOMING_BATCH\", \"OUTGOING_SINGLE\", \"OUTGOING_BATCH\"
publicIdstringPublic identifier of the transaction.
transactionTypestringThe transaction type (e.g., \"CURRENCY_EXCHANGE\").
statusstringStatus of the order. Enum: \"DRAFT\", \"PENDING_SIGNATURE\", \"PROCESSING\", \"PROCESSED\", \"REJECTED\", \"CANCELED\", \"FAILED\"
soldAmountstringThe amount sold.
boughtAmountstringThe amount bought.
clientTradeRatestringThe rate applied for the trade.
remitterAccountstringThe account from which funds were debited.
beneficiaryAccountstringThe account to which funds were credited.
buySellstringDirection of the trade. \"BUY\" or \"SELL\".
purposestringPurpose of the transaction.
currencyFromstringThe source currency.
currencyTostringThe target currency.
\n

Example Success Response (201)

\n
{\n  \"uuid\": \"660f9500-f39c-52e5-b827-557766550000\",\n  \"createdAt\": \"2025-08-15T12:30:45Z\",\n  \"operationType\": \"OUTGOING_SINGLE\",\n  \"publicId\": \"FX20250815001\",\n  \"transactionType\": \"CURRENCY_EXCHANGE\",\n  \"status\": \"PROCESSED\",\n  \"soldAmount\": \"1000.00\",\n  \"boughtAmount\": \"1085.60\",\n  \"clientTradeRate\": \"1.0856\",\n  \"remitterAccount\": \"CY12345678901234567890123456\",\n  \"beneficiaryAccount\": \"CY65432109876543210987654321\",\n  \"buySell\": \"SELL\",\n  \"purpose\": \"Currency conversion for supplier payment\",\n  \"currencyFrom\": \"EUR\",\n  \"currencyTo\": \"USD\"\n}\n\n
\n

Unauthenticated Response (401)

\n
{\n  \"detail\": \"Unauthorized\"\n}\n\n
\n","urlObject":{"protocol":"https","path":["api","v1","fx","orders"],"host":["payabl-api","preprod","payabl1","com"],"query":[],"variable":[]}},"response":[{"id":"a33e9748-98fe-4fe1-b982-465d4bc54f7b","name":"Success Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"quoteId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"purpose\": \"Currency conversion for supplier payment\"\n}","options":{"raw":{"language":"json"}}},"url":"https://payabl-api.preprod.payabl1.com/api/v1/fx/orders"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"660f9500-f39c-52e5-b827-557766550000\",\n \"createdAt\": \"2025-08-15T12:30:45Z\",\n \"operationType\": \"OUTGOING_SINGLE\",\n \"publicId\": \"FX20250815001\",\n \"transactionType\": \"CURRENCY_EXCHANGE\",\n \"status\": \"PROCESSED\",\n \"soldAmount\": \"1000.00\",\n \"boughtAmount\": \"1085.60\",\n \"clientTradeRate\": \"1.0856\",\n \"remitterAccount\": \"CY12345678901234567890123456\",\n \"beneficiaryAccount\": \"CY65432109876543210987654321\",\n \"buySell\": \"SELL\",\n \"purpose\": \"Currency conversion for supplier payment\",\n \"currencyFrom\": \"EUR\",\n \"currencyTo\": \"USD\"\n}"},{"id":"10af579f-b145-4191-b86b-9c1bfe88a77b","name":"Invalid Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"quoteId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"purpose\": \"Currency conversion for supplier payment\"\n}","options":{"raw":{"language":"json"}}},"url":"https://payabl-api.preprod.payabl1.com/api/v1/fx/orders"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Unauthorized\"\n}"}],"_postman_id":"1f95fce8-26ad-46a3-ad1c-47ecc60d2145"},{"name":"Refresh FX Rates","id":"85d9f8a9-f763-445d-b1cf-fac5645fa5d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"minutes\": 5\n}","options":{"raw":{"language":"json"}}},"url":"https://payabl-api.preprod.payabl1.com/api/v1/fx/rate/refresh","description":"

Refresh Currency Rates

\n

This endpoint refreshes the caller's currency rates. Use this to ensure you have the most up-to-date exchange rates before requesting a quote.

\n

Request Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
minutesintegerNoThe number of minutes for rate validity. Must be between 1 and 9999. Default: 1.
\n

Example Request Body

\n
{\n  \"minutes\": 5\n}\n\n
\n
\n

Note: The request body is optional. If omitted, rates are refreshed with a default validity of 1 minute.

\n
\n

Response

\n

204 No Content — Rates refreshed successfully. No response body.

\n

Unauthenticated Response (401)

\n
{\n  \"detail\": \"Unauthorized\"\n}\n\n
\n","urlObject":{"protocol":"https","path":["api","v1","fx","rate","refresh"],"host":["payabl-api","preprod","payabl1","com"],"query":[],"variable":[]}},"response":[{"id":"99eb8c55-8ef5-4e5f-a5b7-d90021852417","name":"Success Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"minutes\": 5\n}","options":{"raw":{"language":"json"}}},"url":"https://payabl-api.preprod.payabl1.com/api/v1/fx/rate/refresh"},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"b55c7d09-63c0-4bb9-a437-2586e313e7de","name":"Invalid Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"minutes\": 5\n}","options":{"raw":{"language":"json"}}},"url":"https://payabl-api.preprod.payabl1.com/api/v1/fx/rate/refresh"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Unauthorized\"\n}"}],"_postman_id":"85d9f8a9-f763-445d-b1cf-fac5645fa5d4"}],"id":"56a8758f-4124-4971-b38e-b5546a1bfaef","description":"

Sandbox URL: https://payabl-api.preprod.payabl1.com/api/v1/fx

\n

Production URL: https://public-payabl-api.prod.payabl1.com/api/v1/fx

\n

Note: Access to the production URL is restricted by IP whitelisting. Clients must provide their source IP addresses in advance to be granted access.

\n

The FX (Foreign Exchange) API allows you to request currency conversion quotes, execute FX orders, and manage exchange rates between your multi-currency accounts.

\n

Workflow

\n
    \n
  1. Refresh Rates (optional) — Ensure you have the latest exchange rates.
    2. \n
  2. Request a Quote — Get a locked-in rate for a specific currency pair and amount.
    3. \n
  3. Execute an Order — Convert funds using the quoted rate (or at market rate without a quote).
    4. \n
\n

Key Concepts

\n
    \n
  • buySell: Indicates whether the amount refers to the currency being bought (BUY) or sold (SELL).
    • \n
  • Quote Expiry: Quotes are time-limited. Check expiresInSeconds and execute before expiry.
    • \n
  • With/Without Quote: Orders can be executed against a quote (guaranteed rate) or without one (market rate at time of execution).
    • \n
\n","_postman_id":"56a8758f-4124-4971-b38e-b5546a1bfaef"},{"name":"Webhook Notifications","item":[{"name":"Webhook Notification Example","id":"b37292dd-f007-4cec-b510-121bb234ebb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"transaction_id","value":"TRX123456","type":"text"},{"key":"amount","value":"150.75","type":"text"},{"key":"currency","value":"EUR","type":"text"},{"key":"iban","value":"DE23370400440532013000","type":"text"},{"key":"bic","value":"","type":"text"},{"key":"status","value":"PROCESSED","type":"text"},{"key":"updated_at","value":"2025-08-15T12:30:45Z","type":"text"},{"key":"description","value":"Invoice Payment","type":"text"},{"key":"bank_id","value":"TRX123456","type":"text"},{"key":"account_holder_name","value":"John Doe","type":"text"},{"key":"uuid","value":"550e8400-e29b-41d4-a716-446655440000","type":"text"},{"key":"security","value":"2f88d7d2...","type":"text"}]},"url":"https://your-webhook-endpoint.com/webhook","description":"

Webhook Notification Example

\n

This is an example of the webhook notification payload sent by our bank to your registered endpoint.

\n

Notifications are sent as application/x-www-form-urlencoded form data.

\n

Payload Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
transaction_idstringUnique identifier of the transaction.
amountdecimalTransaction amount.
currencystringCurrency code of the transaction (e.g. EUR, USD).
ibanstringIBAN (account number) of the beneficiary/counterparty.
bicstringBIC/SWIFT code of the counterparty bank.
statusstringCurrent transaction status.
updated_atdatetimeTimestamp when the transaction was last updated.
descriptionstringPayment purpose/description.
bank_idstringInternal bank transaction identifier. Equal to transaction_id.
account_holder_namestringName of the account holder associated with the transaction.
uuidstringTransaction UUID.
securitystringSHA-512 signature used to verify webhook authenticity.
\n

Signature Verification

\n
SHA512(bank_id + int(amount * 100) + status + secret_key)\n\n
\n

Example:

\n
SHA512(\"TRX12345615075PROCESSEDmy-secret-key\")\n\n
\n

Expected Response

\n

Your endpoint must return HTTP 200 OK.

\n

Retry Policy

\n
    \n
  • Retry interval: 1 minute
    • \n
  • Maximum retries: 11 attempts
    • \n
\n","urlObject":{"protocol":"https","path":["webhook"],"host":["your-webhook-endpoint","com"],"query":[],"variable":[]}},"response":[{"id":"279f48cf-2764-433d-bd81-aea76d9a1285","name":"Success Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"transaction_id","value":"TRX123456","type":"text"},{"key":"amount","value":"150.75","type":"text"},{"key":"currency","value":"EUR","type":"text"},{"key":"iban","value":"DE23370400440532013000","type":"text"},{"key":"bic","value":"","type":"text"},{"key":"status","value":"PROCESSED","type":"text"},{"key":"updated_at","value":"2025-08-15T12:30:45Z","type":"text"},{"key":"description","value":"Invoice Payment","type":"text"},{"key":"bank_id","value":"TRX123456","type":"text"},{"key":"account_holder_name","value":"John Doe","type":"text"},{"key":"uuid","value":"550e8400-e29b-41d4-a716-446655440000","type":"text"},{"key":"security","value":"2f88d7d2...","type":"text"}]},"url":"https://your-webhook-endpoint.com/webhook"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"b37292dd-f007-4cec-b510-121bb234ebb0"}],"id":"14d12be5-c984-476f-963d-2ae351311e04","description":"

Sandbox URL: https://payabl-api.preprod.payabl1.com/api/v1/webhooks

\n

Production URL: https://public-payabl-api.prod.payabl1.com/api/v1/webhooks

\n

Note: Access to the production URL is restricted by IP whitelisting. Clients must provide their source IP addresses in advance to be granted access.

\n
\n

Our bank provides webhook notifications for both incoming and outgoing transactions.

\n

Webhook notifications allow your system to receive real-time updates about transaction events without polling the API.

\n

Overview

\n

Incoming Transactions

\n

You will receive a webhook notification when funds arrive in your account.

\n

Incoming transactions have only one possible status:

\n
    \n
  • PROCESSED
    • \n
\n

Outgoing Transactions

\n

You will receive webhook notifications throughout the lifecycle of an outgoing transaction.

\n

Possible statuses are:

\n
    \n

  • PENDING_SIGNATURE – Transaction is awaiting signature/authorization.

    \n
    • \n

  • PROCESSING – Transaction is being processed.

    \n
    • \n

  • PROCESSED – Transaction has been successfully completed.

    \n
    • \n

  • REJECTED – Transaction has been rejected.

    \n
    • \n

  • CANCELED – Transaction has been canceled.

    \n
    • \n

  • FAILED – Transaction processing failed.

    \n
    • \n
\n
\n

Webhook Request

\n

Notifications are sent as application/x-www-form-urlencoded form data.

\n

Payload Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
transaction_idstringUnique identifier of the transaction.
amountdecimalTransaction amount.
currencystringCurrency code of the transaction (e.g. EUR, USD).
ibanstringIBAN (account number) of the beneficiary/counterparty.
bicstringBIC/SWIFT code of the counterparty bank.
statusstringCurrent transaction status.
updated_atdatetimeTimestamp when the transaction was last updated.
descriptionstringPayment purpose/description.
bank_idstringInternal bank transaction identifier. Equal to transaction_id.
account_holder_namestringName of the account holder associated with the transaction.
uuidstringTransaction UUID.
securitystringSHA-512 signature used to verify webhook authenticity.
\n
\n

Example Payload

\n
transaction_id=TRX123456\namount=150.75\ncurrency=EUR\niban=DE23370400440532013000\nbic=<BIC>\nstatus=PROCESSED\nupdated_at=2025-08-15T12:30:45Z\ndescription=Invoice Payment\nbank_id=TRX123456\naccount_holder_name=John Doe\nuuid=550e8400-e29b-41d4-a716-446655440000\nsecurity=2f88d7d2...\n\n
\n
\n

Webhook Signature Verification

\n

To verify that a webhook was sent by the bank, validate the security field.

\n

The signature is generated using the following algorithm:

\n
SHA512(\n    bank_id +\n    int(amount * 100) +\n    status +\n    secret_key\n)\n\n
\n

Where:

\n
    \n

  • bank_id = transaction identifier

    \n
    • \n

  • amount = transaction amount multiplied by 100 and converted to an integer

    \n
    • \n

  • status = transaction status

    \n
    • \n

  • secret_key = secret value shared with you by the bank

    \n
    • \n
\n

Example

\n

For:

\n
bank_id = TRX123456\namount = 150.75\nstatus = PROCESSED\nsecret_key = my-secret-key\n\n
\n

The string to hash is:

\n
TRX12345615075PROCESSEDmy-secret-key\n\n
\n

Then calculate:

\n
SHA512(\"TRX12345615075PROCESSEDmy-secret-key\")\n\n
\n

Compare the resulting hash with the value received in the security field.

\n
\n

Webhook Response Requirements

\n

Your endpoint must return a successful HTTP response (2xx) after processing the webhook.

\n

Example:

\n
HTTP/1.1 200 OK\n\n
\n
\n

Retry Policy

\n

If a successful response is not received, the webhook notification will be retried.

\n

Retry behavior:

\n
    \n

  • Retry interval: 1 minute

    \n
    • \n

  • Maximum retries: 11 attempts

    \n
    • \n
\n

After the final retry attempt, the notification will no longer be delivered.

\n
\n

Status Reference

\n

Incoming Transactions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
StatusDescription
PROCESSEDFunds have been successfully credited to your account.
\n

Outgoing Transactions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
StatusDescription
PENDING_SIGNATUREAwaiting signature or authorization.
PROCESSINGTransaction is currently being processed.
PROCESSEDTransaction completed successfully.
REJECTEDTransaction was rejected.
CANCELEDTransaction was canceled.
FAILEDTransaction processing failed.
\n
","_postman_id":"14d12be5-c984-476f-963d-2ae351311e04"},{"name":"Validations","item":[{"name":"Validate name","id":"40227077-1bde-4eee-9c27-02ffa8747d91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"accountNumber\": \"string\",\n \"sortCode\": \"string\",\n \"type\": \"INDIVIDUAL\",\n \"identifierType\": \"IBAN\"\n}","options":{"raw":{"language":"json"}}},"url":"https://payabl-api.preprod.payabl1.com/api/v1/validations/name-validation","description":"

Name validation

\n

This endpoint allows you validate the owner name using CoP or VoP, against the IBAN or Account number and Sort code

\n

Request Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
namestring✅ YesName of the account owner
accountNumberstring✅ YesIBAN or account number that is being validated against
sortCodestringNo*Sort code that is being used with account number, should be used only for CoP check and with identifierType of ACCOUNT_NUMBER
typeenum[INDIVIDUAL,COMPANY]✅ YesThe type of account owner
identifierTypeenum[IBAN, ACCOUNT_NUMBER]✅ YesIdentifier type of account that is being validated.
\n

Example Request Body

\n
{\n  \"name\": \"John Doe\",\n  \"accountNumber\": \"CY12345678901234567890123456\",\n  \"sortCode\": null,\n  \"type\": \"INDIVIDUAL\",\n  \"identifierType\": \"IBAN\"\n}\n\n
\n

The logic for name validation is the following:

\n

GB (IBAN or sort+account) → CoP → EXACT / PARTIAL / NO

\n

41 SEPA countries (IBAN) → VOP → MATCH / CLOSE_MATCH / CANNOT_VERIFY

\n

Other countries → skip → NOT_APPLICABLE

\n

Account without sort code → skip → NOT_APPLICABLE

\n

Response

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
matchenum[EXACT, PARTIAL, NO, MATCH, CLOSE_MATCH, NO_MATCH, CANNOT_VERIFY, NOT_APPLICABLE]Match response, if the name validation matched or not
namestring or nullIf the response is PARTIAL or CLOSE_MATCH, then full name will be returned
typeenum[INDIVIDUAL, COMPANY]type of the owner of account
\n

Example Success Response (201)

\n
{\n  \"match\": \"EXACT\",\n  \"name\": null,\n  \"type\": \"INDIVIDUAL\"\n}\n\n
\n

Unauthenticated Response (401)

\n
{\n  \"detail\": \"Unauthorized\"\n}\n\n
\n","urlObject":{"protocol":"https","path":["api","v1","validations","name-validation"],"host":["payabl-api","preprod","payabl1","com"],"query":[],"variable":[]}},"response":[{"id":"161e0f08-449b-40f4-b4c5-555089ceda3a","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"John Doe\",\n \"accountNumber\": \"CY12345678901234567890123456\",\n \"sortCode\": null,\n \"type\": \"INDIVIDUAL\",\n \"identifierType\": \"IBAN\"\n}\n","options":{"raw":{"language":"json"}}}},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"match\": \"EXACT\",\n \"name\": null,\n \"type\": \"INDIVIDUAL\"\n}"}],"_postman_id":"40227077-1bde-4eee-9c27-02ffa8747d91"}],"id":"95577be9-97a5-4f35-a8b0-041226fb118b","description":"

Sandbox URL: https://payabl-api.preprod.payabl1.com/api/v1/validations

\n

Production URL: https://public-payabl-api.prod.payabl1.com/api/v1/validations

\n

Note: 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":"95577be9-97a5-4f35-a8b0-041226fb118b"}],"variable":[{"key":"company_uuid","value":""},{"key":"account_uuid","value":""},{"key":"transactionUuid","value":""},{"key":"token","value":""},{"key":"quote_id","value":""}]}