Payment Collection From Child Api
Payment Collection From Child
Description :
This API endpoint is used to collect payment from child
Endpoint URL :Request Parameters
| Request Parameter | Data Type | Default Value | Required | Description | Change Date | Change Description |
|---|---|---|---|---|---|---|
| user | integer | Yes | user_id whom to transfer | |||
| amount | integer | Yes | amount to transfer | |||
| payment_mode | string | Yes | Cash In-Hand | |||
| bank_name | string | Yes/No | required_if payment_mode - Cash Deposit, Bank Transfer, IMPS/UPI, NEFT/RTGS | |||
| reference_number | string | Yes/No | required_if payment_mode - Cash Deposit, Bank Transfer, IMPS/UPI, NEFT/RTGS | |||
| remark | string | Yes | remarks here |
Request Example
Responses (JSON)
- Status Code 1: records fetched
- Description: Payment collection successfully
- 'status_code' (integer): 1
- 'message' (string): "payment collected and total due of user"
{"status_code": 2, "message": "payment_mode is required"}
- 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": "You can not collect more then due amount"}
- 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.