Create payout
POST
/trade/payout/createRequest headers
Payment method values
| payoutType |
|---|
BANK |
Wallet |
Request parameters
| Field | Type | Required | Maximum length | Description |
|---|---|---|---|---|
merchantOrderNo | String | Yes | 32 | Merchant order number |
transactionAmount | String | Yes | 20 | Payout amount in VND, integers only |
payoutType | String | Yes | 20 | Payout method |
idType | String | Yes | 32 | Document type: BRBANK |
userIdCard | String | Yes | 32 | Identity document number |
userName | String | Yes | 255 | User name: provide the user’s real first and last name |
userPhone | String | Yes | 50 | Phone number: 10 digits starting with 0 |
userEmail | String | Yes | 50 | Recipient email: provide the user’s real email address |
bankCode | String | Yes | 50 | Bank code; see the bank list |
bankName | String | Yes | 50 | Bank name; see the bank list |
bankAccountNo | String | Yes | 32 | Recipient account: provide the user’s real receiving account information |
description | String | No | 100 | Description |
payoutCallbackUrl | String | No | 200 | Payout callback URL |
Request example
The following example shows the field structure. Before submitting, replace payoutType and the bank details with values confirmed by your VellPay representative.
{ "merchantOrderNo": "PAYOUT202609170001", "transactionAmount": "100000", "payoutType": "BANK", "idType": "BRBANK", "userIdCard": "012345678901", "userName": "Nguyen Van A", "userPhone": "0912345678", "userEmail": "user@example.com", "bankCode": "1043", "bankName": "VCB", "bankAccountNo": "1234567890", "description": "Payout order", "payoutCallbackUrl": "https://merchant.example/payout-callback"}Response parameters
| Field | Type | Required | Maximum length | Description |
|---|---|---|---|---|
code | int | Yes | - | Status code; a value other than 200 indicates an error |
data | Object | Yes | - | Response body |
data.merchantOrderNo | String | Yes | 32 | Merchant order number |
data.tradeNo | String | Yes | 32 | Platform order number |
data.transactionAmount | String | Yes | - | Payout amount in VND, integers only |
data.status | String | Yes | 24 | Order status: PAYING (paying) or FAIL (failed) when created |
data.payoutType | String | Yes | 24 | Payout method |
msg | String | No | - | Error message |
tid | String | Yes | - | Trace ID |
Response example
{ "code": 200, "data": { "merchantOrderNo": "PAYOUT202609170001", "tradeNo": "VF2405220001VN0000508467743993", "transactionAmount": "100000", "status": "PAYING", "payoutType": "BANK" }, "msg": "success", "tid": "747bbf80261844ed85b809212aab0d81"}