Account Enquiry
This API endpoint retrieves details about a specific bank account in Nigeria (country=NG) using the Nigerian Naira (currency=NGN).
Endpoint
POST {baseurl}/v1/account/enquiry
Authentication
| Header Name | Value | Required | Description |
|---|---|---|---|
Content-Type | application/json | Yes | Specifies JSON request body format |
X-API-KEY | YOUR_API_KEY | Yes | API key for authentication |
Request Example
curl --location {{baseURL}}/v1/account/enquiry' \
--header 'Content-Type: application/json' \
--header 'x-api-key: YOUR_API_KEY' \
--data '{
"currency": "NGN",
"account": {
"accountNumber": "0690000032",
"sortCode": "044"
},
"country": "NG"
}'Request Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
currency | string | Yes | Currency code (Nigerian Naira - NGN) |
country | string | Yes | Country code (Nigeria - NG) |
account | object | Yes | Account details object |
account.accountNumber | string | Yes | Bank account number to enquire about |
account.sortCode | string | Yes | Bank sort code (bank code) |
Successful Response (200 OK)
{
"message": "account details fetched successfully",
"status": "success",
"data": {
"accountNumber": "0690000032",
"accountName": "JOHN DOE",
"bankName": "ACCESS BANK NIGERIA",
"sortCode": "044",
"currency": "NGN",
"country": "NG"
}
}Error Responses
| Status Code | Description | Response Body Example |
|---|---|---|
401 | Occurs if the API key is missing or invalid. | "Invalid API key" |
400 | Occurs if any required parameter is missing or invalid. | "Missing required parameter: accountNumber" |
404 | Occurs if the account number is not found. | "Account not found" |
422 | Occurs if the account validation fails. | "Invalid account details" |