Add Payment Request Api
Add Payment Request
Description :
This API endpoint is used to add a payment request.
Endpoint URL :Request Parameters
| Request Parameter | Data Type | Default Value | Required | Description | Change Date | Change Description |
|---|---|---|---|---|---|---|
| bank_name | integer | Yes | id of bank info | |||
| payment_mode | string | Yes | Cash Deposit,IMPS/UPI,Same Bank Transfer,NEFT/RTGS | |||
| amount | flaot | Yes | amount to be requested | |||
| payment_date | string | Yes | payment date in Y-m-d format | |||
| wallet_type | string | Yes | Pass wallet1 for Main Pass wallet2 for Utility |
25-06-2024 | New parameter added | |
| reference_number | string | Yes | utr no for the payment request | |||
| slip | file | No | payment slip, image type;jpg,jpeg,png |
Request Example
bank_name:6&payment_mode:Cash Deposit&amount:58&payment_date:2023-09-18&reference_number:lkjlkj&slip:
Responses (JSON)
- Status Code 1: records fetched
- Description: payment request made successfully
- 'status_code' (integer): 1
- 'message' (string): "payment request recived"
{"status_code": 2, "message": "reference_number 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": "Payment request already exist with same utr no."}, 400
- 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.