Skip to content

Create payout

API TEST CONSOLE

Test request

TEST ONLY

Configure parameters and send a request to the test environment

POST/trade/payout/create

Authentication

Not configured

The private key is used only in your browser to generate authorization. It is never sent or stored.

Request headers

Request body application/json

Response

Response
After you send the request, the status, duration, and JSON response appear here.

Authentication details remain only in this page's memory and are not written to local storage.

Copying cURL does not send a request

POST/trade/payout/create

Request headers

Common request headers.

Payment method values

payoutType
BANK
Wallet

Request parameters

FieldTypeRequiredMaximum lengthDescription
merchantOrderNoStringYes32Merchant order number
transactionAmountStringYes20Payout amount in VND, integers only
payoutTypeStringYes20Payout method
idTypeStringYes32Document type: BRBANK
userIdCardStringYes32Identity document number
userNameStringYes255User name: provide the user’s real first and last name
userPhoneStringYes50Phone number: 10 digits starting with 0
userEmailStringYes50Recipient email: provide the user’s real email address
bankCodeStringYes50Bank code; see the bank list
bankNameStringYes50Bank name; see the bank list
bankAccountNoStringYes32Recipient account: provide the user’s real receiving account information
descriptionStringNo100Description
payoutCallbackUrlStringNo200Payout 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

FieldTypeRequiredMaximum lengthDescription
codeintYes-Status code; a value other than 200 indicates an error
dataObjectYes-Response body
data.merchantOrderNoStringYes32Merchant order number
data.tradeNoStringYes32Platform order number
data.transactionAmountStringYes-Payout amount in VND, integers only
data.statusStringYes24Order status: PAYING (paying) or FAIL (failed) when created
data.payoutTypeStringYes24Payout method
msgStringNo-Error message
tidStringYes-Trace ID

Response example

{
"code": 200,
"data": {
"merchantOrderNo": "PAYOUT202609170001",
"tradeNo": "VF2405220001VN0000508467743993",
"transactionAmount": "100000",
"status": "PAYING",
"payoutType": "BANK"
},
"msg": "success",
"tid": "747bbf80261844ed85b809212aab0d81"
}