Payout Initiate Api
Payout Initiate
Description :
This API endpoint is used to initiate payout requests.
Endpoint URL :Request Parameters
| Request Parameter | Data Type | Default Value | Required | Description | Change Date | Change Description |
|---|---|---|---|---|---|---|
| token | string | Yes | Please pass the transaction token in header. | |||
| refid | string | Yes | Please pass static value like a 123456. | |||
| type | string | Yes | Please pass the value from this only - [ACCOUNT / UPI / WALLET] | |||
| amount | integer | Yes | Please pass the transaction amount. | |||
| account_number | integer | Yes | Please pass account number of the beneficiary [Required only when type=ACCOUNT]. | |||
| ifsc_code | string | Yes | Please pass the ifsc code. [Required only when type=ACCOUNT] | |||
| bank_id | string | Yes | Please pass the ifsc code. [Required only when type=ACCOUNT] | |||
| beneficiary_name | string | Yes | Please pass the ifsc code. [Required only when type=ACCOUNT] | |||
| payment_mode | string | Yes | Please pass the value from this only - [IMPS / NEFT / RTGS] | |||
| upi_id | string | Yes | Please pass the beneficiary upi id. [Required only when type=UPI] | |||
| wallet_number | integer | Yes | Please pass the 10 digit wallet number. [Required only when type=WALLET] |
Request Example [JSON]
Responses (JSON)
- Status Code: 1
- Status: PENDING
- Transaction ID: T20240215132837LXRL
- Reference ID: 123
- Message: Transaction under process
- Service Name: Xpress Payout
- Request Time: 2024-02-15 13:28:37
- Response Time: 2024-02-15 01:28:39
- Remaining Amount: 855.21
- Type: ACCOUNT
- Payment Mode: IMPS
- Bank Details:
- Account Number: 9669953727
- IFSC Code: ABHY0065001
- UPI Details:
- UPI ID:
- Wallet Details:
- Wallet Number:
{"status_code": 2, "message": "token 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": "Unable to fetch data"}
- Status Code 0: Error message
- Description: A specific error message.
- 'status_code' (integer): 0
- 'message' (string): "Unable to fetch data"
Note
- The API endpoint should be accessed via a POST 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.