Get banks
Read on populating banks available for payout
The bank and branch APIs provide the list of banks and their respective branches that are available in the destination country.

Get bank list

GET /banks?country={{country}}

Query Parameter
Request Sample
Response Sample
Name
Type
Required
Description
1
curl --location --request GET '{{url}}/banks?country=NG' \
2
--header 'X-Client-Id: {{client_id}}' \
3
--header 'X-Client-Secret: {{client_secret}}' \
4
--header 'Content-Type: application/json'
Copied!
1
{
2
"branches": [
3
{
4
"city": "Abuja",
5
"id": 38,
6
"name": "DIAMOND BANK LTD",
7
"state": "Abuja"
8
}
9
],
10
"country": "NG",
11
"id": 39,
12
"name": "DIAMOND BANK LTD"
13
},
14
{
15
"branches": [
16
{
17
"city": "Abuja",
18
"id": 39,
19
"name": "ECOBANK NIGERIA PLC",
20
"state": "Abuja"
21
}
22
],
23
"country": "NG",
24
"id": 40,
25
"name": "ECOBANK NIGERIA PLC"
26
}
Copied!

Get bank by ID

GET /banks/{{bankId}}

Request Sample
Response Sample
1
curl --location --request GET 'https://v4test.machpay.com/v4/banks/{bankId}' \
2
--header 'X-Client-Id: {{client_id}}' \
3
--header 'X-Client-Secret: {{client_secret}}' \
4
--header 'Content-Type: application/json'
Copied!
1
{
2
"branches": [
3
{
4
"city": "Abuja",
5
"id": 38,
6
"name": "DIAMOND BANK LTD",
7
"state": "Abuja"
8
}
9
],
10
"country": "NG",
11
"id": 39,
12
"name": "DIAMOND BANK LTD",
13
"receiving_currency": [
14
"USD"
15
]
16
}
Copied!