Wallet Balance
Wallet Balance Details
Description :
This API endpoint is used to get the wallet balance details.
Endpoint URL :Request Parameters
| Request Parameter | Data Type | Required | Description |
|---|---|---|---|
| token | string | Yes | API access token for user authentication. [To known more about token Click Here] |
Request Example
token=02c4aa7315a0778abb7095c944a1f09b
Responses (JSON)
{
"status_code": 1,
"message": "Data fetched successfully",
"main": "645",
"utility": "0",
"aeps": "0",
"total": "645",
"creditDue": "0",
}
- Status Code 1: Data fetched successfully
- Description: data successfully fetched.
- 'message' (string): "Data fetched successfully"
- 'main' (integer): "balance of main wallet"
- 'utility' (integer): "balance of utility wallet"
- 'aeps' (integer): "balance of aeps wallet"
- 'total' (integer): "total balance of all wallets"
- 'creditDue' (integer): "due credit"
{"status_code": 2, "message": "token is required"}
- Status Code 2: Validation Error
- Description: Validation error in the input parameters.
- 'status_code' (integer): 2
- 'message' (string): "A specific validation error message."
{"status_code": 0, "message": "Unable to fetch data due to user not exists"}
- Status Code 0: Error message
- Description: A specific error message.
- 'status_code' (integer): 0
- 'message' (string): "Unable to fetch data due to user not exists"
Note
- The API endpoint should be accessed via a GET request.
- Implement proper error handling on the client side to display user-friendly error messages based on the 'status_code' and 'message' fields in the response.