API REFERENCE

Vietnam · Create payout

Endpoint, parameters and examples for Vietnam: Create payout.

Endpoint#

POSThttps://YOUR_GATEWAY_HOST/Payment_Dfpay_add.html

application/x-www-form-urlencoded

Parameters#

Parameter	Meaning	Required	Signed	Description
`mchid`	Merchant ID	Yes	Yes	Assigned merchant ID
`out_trade_no`	Merchant payout order ID	Yes	Yes	length 20
`money`	Payout amount	Yes	Yes
`bankname`	Bank code	Yes	Yes	Bank code
`subbranch`	Bank branch	No	Yes	Bank branch
`accountname`	Account holder name	Yes	Yes	Account holder name
`cardnumber`	Account number	Yes	Yes	Account number
`province`	Province	No	Yes	Province
`city`	City	No	Yes	City
`notifyurl`	Webhook URL	No	Yes	Valid callback URL; may include query parameters. Notification is sent by POST.
`pay_md5sign`	MD5 signature	Yes	No	See signing and verification

Examples#

cURL · replace placeholders before use

curl --request POST 'https://YOUR_GATEWAY_HOST/Payment_Dfpay_add.html' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'mchid=10000' \
  --data-urlencode 'out_trade_no=DEMO_PAYOUT_001' \
  --data-urlencode 'money=100.00' \
  --data-urlencode 'bankname=Vietcombank' \
  --data-urlencode 'subbranch=bank_branch' \
  --data-urlencode 'accountname=DEMO CUSTOMER' \
  --data-urlencode 'cardnumber=000000000000' \
  --data-urlencode 'province=-' \
  --data-urlencode 'city=-' \
  --data-urlencode 'notifyurl=https://merchant.example/payout/notify' \
  --data-urlencode 'pay_md5sign=CALCULATE_WITH_YOUR_APIKEY'

Request fields · submit as form

{
  "mchid": "10000",
  "out_trade_no": "DEMO_PAYOUT_001",
  "money": "100.00",
  "bankname": "Vietcombank",
  "subbranch": "bank_branch",
  "accountname": "DEMO CUSTOMER",
  "cardnumber": "000000000000",
  "province": "-",
  "city": "-",
  "notifyurl": "https://merchant.example/payout/notify",
  "pay_md5sign": "CALCULATE_WITH_YOUR_APIKEY"
}

Response example

{
  "status": "success",
  "msg": "代付申请成功",
  "transaction_id": "DEMO_PLATFORM_PAYOUT"
}

Response example

{
  "status": "error",
  "msg": "金额错误，可用余额不足!",
  "data": []
}

Signing & result handling#

Compute the signature over the operation-specific field set, not every example field.

Open signing guide