Get Customer Wallet Balance
- Benjamin Ononogbu
- Emmanuel Okorie
The Monnify "Get Customer Balance" API facilitates the retrieval of a customer's available balance by providing their wallet account number.
This endpoint is protected with a Basic Authentication. To access this endpoint, include the Authorization header in your HTTP requests. The header should start with the word "Basic" followed by a space and a base64-encoded string representing your apiKey and clientSecret as "apiKey:clientSecret".
Endpoint URL: {{base_url}}/api/v1/disbursements/wallet/balance?accountNumber={walletAccountNumber}
HTTP Method: GET
The {{base_url}} for the test is https://sandbox.monnify.com but when you go live, it changes to the live URL
To retrieve the wallet balance for a customer, simply append the imputed customer account number to the endpoint URL and the account balance linked to the wallet will be returned.
Sample wallet balance response
{
"requestSuccessful": true,
"responseMessage": "success",
"responseCode": "0",
"responseBody": {
"availableBalance": 1999.19,
"ledgerBalance": 1999.19
}
}Field Reference
Field | Description |
|---|---|
walletAccountNumber | The internal wallet account id returned from the wallet creation API |