Use the getCashPickupLocation endpoint to get the local pickup bank locations.
Syntax
POST https://nairagrambasket.com/api/getCashPickupLocation
Response Codes
The following table lists the status codes that are returned in response to the getCashPickupLocation request.
Code | Status |
---|---|
200 | Success |
401 | Unauthorized or Invalid Token |
The cash pick-up locations may not be the same banks included in the Bank List API.
Input Parameters
The following table lists the parameters that you need to provide in the getCashPickupLocation request.
Field | Value Format | Required/Optional | Description |
---|---|---|---|
username | username | Required | Input the valid email address that you submitted to your Partner Company. |
password | password | Required | Input your secure password. |
secretKey | SecretKey | Required | Input the API key provided to you by your Partner Company. |
country | NG | Optional | Input the code of the country. |
Sample Request
curl --location --request POST 'https://nairagrambasket.com/api/getCashPickupLocation' \
--form 'username="your username"' \
--form 'password="Your password"' \
--form 'secretKey="Your SecretKey"' \
--form 'country="NG"'
Sample Response
{
"Code": 200,
"Message": "Successfully",
"Content": [
{
"code": "001",
"location": "Zenith Bank",
"country": "NG"
},
{
"code": "002",
"location": "Fidelity Bank",
"country": "NG"
}
]
}