Transaction Report Api
Transaction Report
Description :
This API endpoint is used to fetch the data of transaction report.
Endpoint URL :Request Parameters
| Request Parameter | Data Type | Default Value | Required | Description | Change Date | Change Description |
|---|---|---|---|---|---|---|
| offset | integer | 0 | Yes | number of records to skip before starting to return results. | ||
| limit | integer | 10 | Yes | determines the maximum number of records to return in the response. | ||
| from_date | Date | Yes | date in Y-m-d format | |||
| to_date | Date | Yes | date in Y-m-d format, both dates must be from same month | |||
| service | int | Optional | id of service | |||
| service_provider | string | Optional | service provider name | |||
| search_by | string | Optional | searching key can be : transaction_number, txn_id, client_id, utr_number | |||
| search_value | string | Optional | search value | |||
| status | string | Optional | SUCCESS, FAILED, PENDING, REFUND |
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"
- data: (object):
- sn (string): Serail Number
- txn_id (string): Transaction id (T20240320110632ASFC).
- status (string): Transaction status (PENDING).
- enc_txn_id (string): Encrypted Transaction id.
- enc_user_id (string): Encrypted user id.
- logo (string): Logo of service provider.
- service_name (string): Serive Name (Airtel).
- service_category (string): Serive Category (Prepaid).
- client_id (string): Client id (0).
- transaction_number (string): Transaction Number (9660000218).
- amount (string): Transaction amount (19).
- charged_amount (string): Transaction amount (18.53).
- utr_number (string): Transaction status (PENDING).
- comission_surcharge (string): Commision surcharge type (Commission).
- commision_surcharge_amount (string): Commision surcharge amount(0.57).
- closing_balance (string): Closing balance (4331.57).
- complaint_status (string): Complaint Status ().
- complaint_count (string): Complaint Count ().
- 'created_date' (string): "date of record created"
- 'created_time' (string): "time of record created"
- 'updated_date' (string): "date of record updated"
- 'updated_time' (string): "time of record updated"
{"status_code": 2, "message": "from_date 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.