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 | integer | Timestamp (e.g., 1715941383720) |
| tradeNo | Yes | String | Uniqueness (recommended format: YYYYMMDDHHMMSS+random number) |
| amount | Yes | String | Payment amount (ecimals are not recommended) |
| bankCode | yes | String | Bank code ๏ผBank List๏ผ |
| bankAccountNo | yes | String | Bank Account Number |
| customerName | yes | String | User Name |
| mobile | yes | String | Userโs mobile phone number |
| yes | String | email account | |
| notifyUrl | Yes | String | Asynchronous callback URL |
| remark | No | String | Remarks, this field will be returned in the callback |
Request Parameter Example¶
{
"sign": "29604bf1662fd6acddfbd33eaee0179f",
"timestamp": 1748248240605,
"tradeNo": "rgB36f2n9AElhTeY",
"amount": "500",
"bankCode": "0001",
"bankAccountNo": "123456789",
"mobile": "15875595997",
"email": "jack@gmail.com",
"customerName": "jack",
"notifyUrl": "http://www.google.com",
"remark": "remark"
}
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.message | Yes | String | Error description |
| data.remark | Yes | String | Remarks |