Dispute Report Api
Dispute Report
Description :
This API endpoint is used to get the Dispute report of the user.
Endpoint URL :Request Parameters
| Request Parameter | Data Type | Default Value | Required | Description | Change Date | Change Description |
|---|---|---|---|---|---|---|
| token | string | Yes | a unique token to authorize api request | |||
| from_date | Date | Yes | date in Y-m-d format | |||
| to_date | Date | Yes | date in Y-m-d format | |||
| complaint_status | string | Optional | Resolved-Success, Resolved-Refund, Under Review | |||
| complaint_id | string | No | id of complaint | |||
| txn_id | string | No | transcation id on which complaint raised | |||
| transaction_number | string | No | transaction number | |||
| client_id | string | No | client id of transaction | |||
| 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 1: records fetched
- Description: records successfully fetched.
- 'status_code' (integer): 1
- 'message' (string): "records successfully fetched"
- 'recordsTotal' (integer): "number or total records"
- 'recordsFiltered' (integer): "number or records filtered"
-
'data' (Array): "it contains array of object"
- 'id' (integer): "unique id of record"
- 'txn_id' (string): "txn_id of transaction"
- 'txn_service' (string): "txn_service of transaction"
- 'txn_number' (string): "transaction_number of transaction"
- 'txn_amount' (string): "amount of transaction"
- 'txn_date' (string): "date of txn"
- 'txn_time' (string): "time of txn"
- 'complaint_status' (string): "status of complaint"
- 'complaint_mode' (string): "mode of complaint"
- 'complaint_attempt' (string): "number of times complaint raised"
- 'complaint_remark' (string): "remark of complaint"
- 'complaint_attachment' (string): "image url of attachemnt of complaint"
- 'reject_attachment' (string): "iamge url of reject prrof of complaint"
- 'created_date' (string): "date of record created"
- 'created_time' (string): "time of record created"
- 'updated_date' (string): "date of update complaint"
- 'updated_time' (string): "time of update complaint"
- 'reopened_date' (string): "date of reopen complaint"
- 'reopened_time' (string): "time of reopen complaint"
{"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": "records not found"}, 200
- 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.