Disbursement¶
Tip
Payout API is used to initiate transfer requests to e-wallets or bank accounts.
- All requests are
Postrequests, and the data format isjson
Brief Description¶
(This section is intentionally left blank for brevity.)
Request URL¶
/v1/vexora/disbursements
Request Method¶
- Method: POST
- Content-Type: application/json
Header¶
| Header | Required | Type | Description |
|---|---|---|---|
| merchantNo | Yes | String | N/A |
Request Body Parameters¶
| Parameter | Required | Type | Description |
|---|---|---|---|
| sign | Yes | String | Compose the remaining fields (excluding sign) in alphabetical order as key1=value1key2=value2, use the app secret as the salt for MD5 encryption, and the final sign should be in lowercase letters. |
| timestamp | Yes | String | Timestamp (e.g., 1715941383720) |
| ipAddress | Yes | String | Payer's ipAddress |
| tradeNo | Yes | String | Uniqueness (recommended format: YYYYMMDDHHMMSS+random number) |
| amount | Yes | String | Payment amount (ecimals are not recommended) |
| name | Yes | String | Payer's name |
| mobile | Yes | String | Mobile number of the payee (10 digits beginning with 6, 7, 8, or 9; omit the 91 country code). |
| Yes | String | Payer's email (should use gmail.com domain, e.g., abc@gmail.com) | |
| bankNumber | Yes | String | Recipient, bank account number |
| bankNCode | Yes | String | IFSC code (India): 11-digit alphanumeric. |
| notifyUrl | Yes | String | Asynchronous callback URL |
| remark | No | String | Remarks, this field will be returned in the callback |
Request Parameter Example¶
{
"sign": "677550dd9156c8ba942bcf096f57df50",
"timestamp": "1724149702962",
"tradeNo": "123231222",
"amount": "300",
"name": "abc",
"mobile": "918234567890",
"email": "123@qq.com",
"bankNumber": "10094038292",
"bankCode": "IDFB0043121",
"notifyUrl": "xxxxxx",
"remark": "000000"
}
Response Result¶
| Parameter | Required | Type | Description |
|---|---|---|---|
| msg | Yes | String | Request result (when "success" is returned, it only indicates the success of this request and cannot be used for merchant-side logical judgment) |
| code | Yes | String | Request response code (when "0000" is returned, it only indicates the success of this request and cannot be used for merchant-side logical judgment). For specific error codes, please refer to the business error code enumeration. |
| timestamp | Yes | String | Transaction timestamp |
| success | Yes | String | Transaction result |
| data | Yes | Object | Returned object |
| data.platFormTradeNo | Yes | String | Unique platform order number |
| data.status | Yes | String | Transaction results,Merchants can process subsequent workflows based on the returned status in the transaction result. For details, please refer to the status code reference table. |
| data.desc | Yes | String | Error description |
| data.remark | Yes | String | Remarks |