Get Available Banks
base_url: https://demo.etranzact.com/bankit-api/antPeer/v1
Description: This endpoint is used to get list of all available banks
- Sample Request
- Sample Response
Request Parameters
Parameter | Type | Description | Required |
---|---|---|---|
sessionId | string | Session ID | Yes |
reference | string | Client’s reference | Yes |
merchantId | string | Merchant ID | Yes |
phoneNo | integer | Customer’s phone number. This should be preceded with 234 | Yes |
GET /banks/list
curl `${base_url}/banks/list`
-H "Content-type: application/json"
-H "Authorization: Bearer YOUR_SECRET_KEY"
-X POST
-d '{
"sessionId": "1uMifUW7I0El3Q3b",
"reference": "1dkD2PLYDL8M1k6LBUI9",
"merchantId": "ANT-PEER",
"phoneNo": 2347065099181,
}
'
Response Parameters
Parameter | Type | Description | Mandatory |
---|---|---|---|
status | String | Response Code of the operation. See Response Code in Response table | Yes |
message | String | Response message for the operation. See response message in Response Table | Yes |
data | Object | An object holding additional information | Yes |
sessionId | String | Session ID | Yes |
reference | String | Client’s reference | Yes |
phoneNo | integer | Customer’s phone number | Yes |
newAccount | Boolean | This is to identify if the account to be added is a new account | Yes |
banks | Object | This is an object holding the list available for the customer | Yes |
bankCode | String | This is the unique Bank code | Yes |
bankName | String | This is the Bank name | Yes |
accountNumber | String | This is the account number of the customer at the bank | Yes |
transactionStatus | String | Transaction status | Yes |
statusMessage | String | Transaction status message | Yes |
GET /banks/list
{
"status": "200",
"message": "Successful",
"data": {
"reference": "1625AGHTF64165rB8902",
"sessionId": "4573829305928473",
"phoneNo": "2347065099181",
"newAccount": true,
"banks": [
{
"bankName": "Polaris Bank",
"bankCode": "076",
"accountNumber": null
}
],
"transactionStatus": "0",
"statusMessage": "Transaction Successful"
}
}