Payment Request Api
Payment Request
Description :
This API endpoint is used to get the records of all the payment request made by the user.
Endpoint URL :Request Parameters
| Request Parameter | Data Type | Default Value | Required | Description | Change Date | Change Description |
|---|---|---|---|---|---|---|
| from_date | Date | Yes | date in Y-m-d format | |||
| to_date | Date | Yes | date in Y-m-d format | |||
| status | string | Optional | Approve, Reject, Pending | |||
| 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"
- 'sr_no' (integer): "serial no of the record"
- 'id' (integer): "unique id of the record"
- 'status' (string): "status of payment request"
- 'created_at' (string): "date or record created"
- 'bank_name' (string): "bank name"
- 'account_number' (string): "account number"
- 'wallet_type' (string): "type of wallet"
- 'payment_mode' (string): "mode of payment"
- 'utr' (string): "utr no of transaction"
- 'amount' (string): "amount of payment"
- 'remark' (string): "remark of payment"
- 'attachment' (string): "image url of slip uploaded by user"
- 'created_date' (string): "date of record created"
- 'created_time' (string): "time of record created"
- 'approve_reject_date' (string): "date of apprve or reject"
- 'approve_reject_time' (string): "time of apprve or reject"
{"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.