Settle AePS Balance Api
Settle AePS Balance
Description :
This API endpoint is used to settle AePS balance.
Endpoint URL :Request Parameters
| Request Parameter | Data Type | Default Value | Required | Description | Change Date | Change Description |
|---|---|---|---|---|---|---|
| mPin | string | Yes | Please enter 4 digit mpin | |||
| amount | Int | Yes | Please enter amount to settle | |||
| settlement_type | string | Yes | should be Wallet or Bank | |||
| whitelistAccount | string | Conditional ( Required if settlement_type Bank) | Please enter whitelist account id | |||
| paymentMode | string | Conditional ( Required if settlement_type Bank) | Please enter payment mode (IMPS,NEFT,RTGS) |
Request Example
Responses (JSON)
- status_code (integer): The status code of the response.
- status: status of the transaction (SUCCESS, FAILED, PENDING)
- message: Settlement done.
{"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": 3, "message": "Oops..! Wrong mPin entered"}
- Status Code 3: mPin Error Message
- Description: A specific error message.
- 'status_code' (integer): 3
- 'message' (string): "Oops..! Wrong mPin entered."
{"status_code": 0, "message": "Transfer Amount should be in range of 100 and 5000000"}
- Status Code 0: Error message
- Description: A specific error message.
- 'status_code' (integer): 0
- 'message' (string): "Transfer Amount should be in range of 100 and 5000000"
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.