Payout API

Tips

Payout API is used to initiate transfer requests to e-wallets or bank accounts.

• All requests are Post requests, and the data format is json

Brief Description

This API allows merchants to initiate a payout transaction in Vietnam.

Request URL

• /v1/payproVN/payout

Request Method

• POST

Header

Parameter	Required	Type	Description
merchantNo	Yes	string	Merchant number

Request Body Parameters

Name	Required	Type	Description
sign	Yes	string	Use all fields except sign, sort them alphabetically, and concatenate as key1=value1key2=value2.... Then use the app secret as a salt for MD5 encryption. The sign should be in lowercase.
timestamp	Yes	integer	Timestamp of the transaction.
tradeNo	Yes	string	Unique transaction ID (recommended format: yyyymmddhhmmss+random number).
amount	Yes	string	Payment amount (minimum 50000, no decimals).
accountName	Yes	string	Account holder's name (English characters only, no Vietnamese).
bankName	Yes	string	Bank name (refer to the "List of Supported Banks for Vietnam Payout" in the documentation).
bankNumber	Yes	string	Bank account number.
notifyUrl	Yes	string	Asynchronous callback URL.
remark	No	string	Additional remarks (will be returned as is).

Request Example

{
  "accountName": "NGUYEN THE VIET",
  "amount": "50000",
  "bankName": "ACB",
  "bankNumber": "18199852",
  "tradeNo": "933323381",
  "notifyUrl": "1",
  "sign": "cd38b94e681767052426f880c89dc111",
  "timestamp": "1729152493114",
  "remark":"test"
}

Response Parameters

Parameter Name	Required	Type	Description
msg	Yes	string	Request result (only indicates the success of the current request, not for merchant-side logic).
code	Yes	string	Response code (only indicates the success of the current request, not for merchant-side logic). For specific error codes, 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 transaction number.
data.status	Yes	string	Request result. "0000" indicates success, "0015" indicates processing, and other values indicate error codes for failure handling.
data.desc	Yes	string	Error description.
data.remark	Yes	string	Remark.

Successful Response Example

{
    "msg": "success",
    "code": "0000",
    "timestamp": 1729152525414,
    "success": true,
    "data": {
        "platFormTradeNo": "9g5fe3hykz4c7b2b",
        "status": "0100119",
        "desc": "fail",
        "remark": "test"
    }
}