Banks
Read on retrieving available banks
The bank and branch APIs provide the list of banks and their respective branches that are available in the destination country.
Bank Object
Field | Type | Description |
---|---|---|
id | integer | ID |
name | string | Name of the bank |
country | string | 3-character ISO code of the country |
receiving_currency | List | List of 3-character ISO code of the currency supported by the bank. |
branches | List | List of branch objects. |
Branch Object
Field | Type | Description |
---|---|---|
bank_id | integer | Bank ID |
bank_name | string | Name of the bank |
branch_id | integer | Branch ID |
branch_name | string | Name of the branch |
address | string | Branch address |
city | string | Branch city |
state | string | Branch state or province |
Get bank list
GET /v2/banks
GET /v2/banks
Field | Required | Type | Description |
---|---|---|---|
countryId | No | integer | Country ID |
countryCode | No | String | ISO Code of a Country |
Get banks by country
GET
/v2/
banks?countryCode={{countryCode}}
GET
/v2/
banks?countryCode={{countryCode}}
Get banks by ID
GET
/v2/
banks/{{bankId}}
GET
/v2/
banks/{{bankId}}
Field | Required | Type | Description |
---|---|---|---|
bankId | Yes | integer | Bank ID |
Last updated