User Balance & Due Api
User Balance & Due
Description :
This API endpoint is used to get the current balance & due of user.
Endpoint URL :Request Parameters
| Request Parameter | Data Type | Default Value | Required | Description | Change Date | Change Description |
|---|---|---|---|---|---|---|
| user_id | string | Yes | Please pass user id |
Request Example
user_id=11
Responses (JSON)
- Description: Data fetched successfully.
- status_code (integer): The status code of the response (1).
- data (object):
- wallet1 (string): Main wallet balance
- wallet2 (string): Utility wallet balance
- wallet3 (string): AePS wallet balance
- credit_due (integer): Credit due
{"status_code": 2, "message": "user_id is required"}, 200
- 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": "Invalid user id"}, 400
- Status Code 0: Error message
- Description: A specific error message.
- 'status_code' (integer): 0
- 'message' (string): "there is no data found"
Note
- The API endpoint should be accessed via a POST request.
- Ensure that the request is properly validated and sanitized to prevent security vulnerabilities.
- 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.