Direct Deposit¶

Tip

All requests use POST
Content type is application/json

Brief Description¶

Use this API to create a Vietnam deposit order and obtain the payment instructions required for the payer to complete the transfer.

Request URL¶

/v1/vexora/deposits

Request Method¶

Method: POST
Content-Type: application/json

Headers¶

Header	Required	Type	Description
merchantNo	Yes	String	Merchant number

Body¶

Parameter	Required	Type	Description
sign	Yes	String	The sign field is generated by sorting all fields except sign in alphabetical order and concatenating them as key1=value1key2=value2. Use app secret as salt for MD5 encryption. The sign field should be in lowercase.
timestamp	Yes	String	Timestamp (e.g. 1715941383720)
tradeNo	Yes	String	Unique transaction number (recommended format: yyyymmddhhmmss + random number)
amount	Yes	String	Transaction amount (integer only)
name	Yes	String	Payer's name
mobile	Yes	String	Payer's mobile
email	Yes	String	Payer's email (should use gmail.com domain, e.g., abc@gmail.com)
channelCode	Yes	String	Payment method: `QR`
wayCode	Yes	String	Payment route code: `QR`
notifyUrl	Yes	String	Asynchronous callback URL
remark	No	String	Remarks (this field will be returned as‑is)

Request Body Example¶

{
  "sign": "a8f5f167f44f4964e6c998dee827110c",
  "timestamp": "1719876543210",
  "tradeNo": "VX20260331000125",
  "amount": "300",
  "name": "Rizky Pratama",
  "mobile": "09123456789",
  "email": "123@gmail.com",
  "channelCode": "QR",
  "wayCode": "QR",
  "notifyUrl": "https://merchant-api.com/vexora/payment/notify",
  "remark": "order_vx_000125"
}

Response¶

Parameter	Required	Type	Description
msg	Yes	String	Request result (success only indicates successful request, not for merchant logic judgment)
code	Yes	String	Request response code (0000 indicates successful request, not for merchant logic judgment). For specific error codes, refer to the business error code enumeration
timestamp	Yes	String	Transaction time
success	Yes	String	Transaction result
data	Yes	Object	Response object
data.tradeNo	Yes	String	Merchant transaction number
data.platFormTradeNo	Yes	String	Unique transaction number
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.message	Yes	String	Error description
data.remark	Yes	String	Returned content of the request (as is)
data.payInfo	Yes	Object	Payment instruction details
data.payInfo.qrString	Yes	String	QR payment string to be displayed to the payer
data.payInfo.accountName	Yes	String	Beneficiary account name
data.payInfo.bankName	Yes	String	Beneficiary bank name
data.payInfo.accountNumber	Yes	String	Beneficiary account number
data.payInfo.remarks	Yes	String	Transfer remark or reference

Successful Response Example¶

{
    "msg": "success",
    "code": "0000",
    "timestamp": 1728609277476,
    "success": true,
    "data": {
        "tradeNo": "428c430ce59b47138674c971ff07a711",
        "platFormTradeNo": "c167o1itir0fypid",
        "status": "0015",
        "message": "Paying",
        "remark": "order_vx_000125",
        "payInfo": {
          "qrString": "00020101021238570010A000000727012700069704540111111111111111111111111110208QRIBFTTA53037045405300.005802VN5910NGUYEN VAN A6005HANOI62100506VX12346304ABCD",
          "accountName": "NGUYEN VAN A",
          "bankName": "Vietcombank",
          "accountNumber": "0222222222",
          "remarks": "VX20260331000125"
        }
    }
}