AePS Settlement Data Api
AePS Settlement Data
Description :
This API endpoint is used to fetch the data of aeps settlement.
Endpoint URL :Request Parameters
| Request Parameter | Data Type | Default Value | Required | Description | Change Date | Change Description |
|---|---|---|---|---|---|---|
| from_date | date in Y-m-d format | Yes | Please enter from date | |||
| to_date | date in Y-m-d format | Yes | Please enter to date | |||
| offset | integer | 0 | No | number of records to skip before starting to return results. | ||
| limit | integer | 10 | No | determines the maximum number of records to return in the response. |
Request Example
Responses (JSON)
- 'status_code' (integer): 1
- 'message' (string): "records successfully fetched"
- 'recordsTotal' (integer): "number or total records"
- 'recordsFiltered' (integer): "number or records filtered"
- aeps_balance: balance in Aeps wallet
- data: (object):
- sr_no (string): Serail Number
- settlement_type (string): settlement type of txn.
- bank_name (string): bank name
- account_number (string): bank account no.
- ifsc (string): bank ifsc code
- amount (string): settlement amount
- surcharge (string): charge on settlement
- gst (string): gst on settlement
- final_amount (string): final transfered amount
- utr (string): utr no
- status (string): status of transaction
- created_Date (string): Transaction date (20-03-2024).
- created_time (string): Transaction time (11:06:32 AM).
{"status_code": 2, "message": "from_ate is required"}, 422
- 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"}, 200
- Status Code 0: Error message
- Description: A specific error message.
- 'status_code' (integer): 0
- 'message' (string): "Unable to fetch data"
- 'status' (string): "Failed"
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.