Get Balance By Account Number

This request retrieves the customer's account balance based on the provided account number. You will need to pass the customer's accountNumber in the request query.

GET /api/account/v1/getbyaccountnumber

Headers

Name
Value

Content-Type*

application/json

Authorization*

Bearer <token>

Request-Reference

{unique-reference}

Query Parameter

Name
Data Type (length)
Required
Description

accountNumber

string

Customer's account number

Sample Request
curl --location -g '{{baseurl}}/api/account/v1/getbyaccountnumber?AccountNumber=1100029938' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data ''
Response : 200
{
  "status": true,
  "message": "Successful",
  "data": {
    "accountNumber": "string",
    "ledgerBalance": 0,
    "availableBalance": 0,
    "withdrawableBalance": 0,
    "lienAmount": 0
  }
}

Last updated