Fetch Beneficiaries Api
Fetch Beneficiaries
Developer should know !
The said API will provide list of beneficiary which has been registered with the remitter's mobile number.
Endpoint URL :
Request Parameters
| Request Parameter | Data Type | Default Value | Required | Description | Change Date | Change Description |
|---|---|---|---|---|---|---|
| mobile_no | integer | Yes | Remitter mobile number |
Request Example [JSON]
Responses (JSON)
- status_code (integer): The status code of the response.
- status (string): Indicates whether the operation was a success or a failure.
- message (string): A message describing the result of the operation.
- remitter_mobile (string): The mobile number of the remitter.
- data (array): An array of beneficiary objects.
- beneficiary_id (string): The unique identifier of the beneficiary.
- bank_id (string): The unique identifier of the bank.
- bank_name (string): The name of the bank where the beneficiary holds an account.
- beneficiary_name (string): The name of the beneficiary.
- account_no (string): The account number of the beneficiary.
- ifsc_code (string): The IFSC code of the beneficiary's bank branch.
- is_verified (string): Indicates whether the beneficiary is verified ('Y' for Yes, 'N' for No).
{"status_code": 2, "status":"FAILED", "message": "token is required"}
- status_code (integer): 2
- message (string): "A specific validation error message."
- status (string): "FAILED"
{"status_code": 0, "status":"FAILED", "message": "Unable to proccess your request"}
- status_code (integer): 0
- message (string): "Unable to proccess your request"
- status (string): "FAILED"
Note
- The API endpoint should be accessed via a POST request.
- All requests must include a Bearer Token in the Authorization header to authenticate the request.
- Please always update your transaction with status key and SUCCESS, PENDING, FAILED value.
- Implement proper error handling on the client side to display user-friendly error messages based on the 'status' and 'message' fields in the response.