Disbursement¶
Tip
Disbursement 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) |
| tradeNo | Yes | String | Unique disbursement ID which partner put on the request. |
| amount | Yes | String | Payment amount (ecimals are not recommended) |
| accountName | Yes | String | Account holder name |
| bankName | Yes | String | Bank name (Refer to the bank code field of the Disbursement Bank Codes) |
| bankNumber | Yes | String | Recipient, bank account number, or recipient phone number |
| notifyUrl | Yes | String | Asynchronous callback URL |
| remark | No | String | Remarks, this field will be returned in the callback |
Request Parameter Example¶
{
"amount": "100",
"bankName": "Maya",
"bankNumber": "09539077075",
"accountName": "09539077075",
"tradeNo": "993332112131",
"notifyUrl": "https://www.111.com/",
"sign": "801b55d19b3b99b49704adcd4751c4bf",
"timestamp": 1729947433293
}
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 disbursement ID from vexora, partners can use this ID for reconciliation. |
| 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 |