Check Wallet Balance
User can get wallet account balance.
The POST request will be send over HTTPS to the
endpoint.
Sample Request
Sample Response
NOTE:
- customerId , secKey – is provided in the getSecretKey API response
- verificationHash - SHA256Algorithm.generateSHA256Hash(secKey.trim()+customerId.trim())
How to generate verification Hash?
Verification Hash has to be calculated with following combination using SHA256
algorithm and need to be send along with the authentication parameters in each server-to-server request:
<secKey><customerId>
Sample Code
Request Parameters
This reference lists all the standard flow parameters to be send in request.
Parameter | Description | Format | Required |
---|---|---|---|
customerId | Generated unique customer id on per user sign up. | A255 | Yes |
verificationHash | Verification Hash has collected combination of parameters. | String | Yes |
walletOwnerId | Provided by Unique id. | N20
[0-9] |
Yes |
Response Parameters
This reference list lists all the standard flow parameters to be received in response.
Parameter | Description | Format | Required |
---|---|---|---|
amount | Total Balance of the default wallet. | N50 [0-9] {1,50} |
Yes |
responseCode | Response code | [a-zA-Z0-9] | Yes |
walletId | ID of the wallet. | [0-9] | Yes |
walletName | Name of the wallet. | [a-zA-Z0-9] | Yes |
currency | Currency of the wallet. | A3 [A-Z]{3} |
Yes |
balance | Total Amount in the wallet. | N50 [0-9] {1,50} |
Yes |
isDefault | To check if the wallet is default. | A [A-Z]{1} |
Yes |
Response Code | Message |
---|---|
1 | SUCCESS |
2 | FAILED |
3 | Invalid Request |