PayAnyBank API
This API call used to perform bank payments. To perform a Pay Any Bank transaction, please use the example below
replacing key and sourceAccount with the values you have from the previous steps. Pay special attention to the ‘fields’
object. Note that every country has different requirements for bank transactions which should be observed within the
data passed. The parameters Money, BankPayee and Fields should be changed according to the bank country. The
details are shown for each country within the list.
HTTP Request
Header
Parameter | Type | Description |
---|---|---|
Content-Type | String | Use value 'application/json' |
Accept | String | Use value 'application/json' |
x-api-version | String | Use value 1 |
Key | String | API key |
Parameters
Field | Type | Required | Description |
---|---|---|---|
sourceAccount | String | true | Account number from which the amount of money will be debited |
money | Money | true | The Object containing two String attributes: amount and currency of the transfer |
description | String | true | Description for this transfer which min character is 1 and max characters are 25 |
traceId | String | true | Unique transaction identifier. You can assign any value |
bankPayee | BankPayee | true | Destination account and destination bank data. In demo you can use fake data |
The object field Money is defined as below:
Money
Field | Type | Required | Description |
---|---|---|---|
amount | Number | true | Transaction value |
currency | String | true | Currency code (ISO 4217) |
The object BankPayee is defined as below:
BankPayee
Field | Type | Required | Description |
---|---|---|---|
country | Object | true | Country code of the bank country |
currency | String | true | Bank Payee Currency |
description | String | false | Description for this transfer which min character is 1 and max characters are 25 |
personal | Boolean | conditional | Input "false" for B2B transaction |
fields | Map | true | Map of type String |
Please Note : country field should contain the country code of the bank’s country and not the user’s address country. For Instance, if the user belongs to Norway and has an Revolut account based in Lithuania , the bank payee country code should be LT and not NO.
fields
The fields object is entirely dependent on the country and currency. Please use the APIs to find the bank detail fields required for each country and currency under our Bank Details Fields in our next section.
Updated about 2 months ago