Skip to content

Vexora API Documentation

Disbursement

Disbursement¶

Tip

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

Request URL¶

/v1/vexora/disbursements

Request Method¶

Method: POST
Content-Type: application/json

header	Required	Type	Description
merchantNo	yes	String	no

Request Body Parameters¶

Parameter name	Required	Type	Description
sign	yes	String	Except for sign, the remaining fields are sorted by first letter to form key1=value1key2=value2, and app secrect is used as salt for md5 encryption. The sign is finally lowercase.
timestamp	yes	String	Timestamp（1715941383720）
tradeNo	yes	String	Transaction number (unique (recommended year month day hour minute second + random number))
subMerchantNo	Yes	String	Terminal merchant. Please consult your operations personnel and submit terminal merchant information to obtain it.
amount	Yes	String	Payment amount (integer only, unit: yuan, minimum value: 100)
bankCode	Yes	String	Beneficiary bank code: refer to the Bank Code field in the bank list
bankNumber	Yes	String	Beneficiary bank account number
mobile	Yes	String	Beneficiary’s actual mobile number (10‑digit number starting with 0, without country code), e.g., 09XXXXXXXX
email	Yes	String	Beneficiary’s email address
name	Yes	String	Beneficiary name (must be the actual/legal name)
notifyUrl	Yes	String	Asynchronous callback URL
remark	No	String	Remarks (this field will be returned as‑is)

Request Parameter Example¶

{
  "amount": "100",
  "bankCode": "004",
  "bankNumber": "3560123456789012",
  "mobile": "0912345678",
  "email": "123@gmail.com",
  "name": "abc",
  "tradeNo": "tn1740632538919",
  "subMerchantNo": "TW_SUB_MERCHANT_001",
  "notifyUrl": "https://www.google.com/",
  "sign": "1e0131318d1834890807a48e17929ec0",
  "timestamp": "1740632538919"
}

Response Results¶

Parameter name	Required	Type	Description
msg	yes	String	Request result (when success is returned, it only means that the request for this time is successful and cannot be used for merchant-side logical judgment)
code	yes	String	Request response code (when 0000 is returned, it only means that the request for this time is successful, and cannot be used for merchant-side logical judgment). For specific status/error codes, please check the status/error code directory
timestamp	yes	String	Transaction timestamp
success	yes	String	Transaction result
data	yes	Object	Return Object
data.tradeNo	yes	String	Merchant transaction number
data.platFormTradeNo	yes	String	vexora transaction number, unique
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	remark

Successful Returned Example¶

{
    "msg": "success",
    "code": "0000",
    "timestamp": 1728611805322,
    "success": true,
    "data": {
        "tradeNo": "test_111",
        "platFormTradeNo": "2tjba3vz6wm6hx3l",
        "status": "0015",
        "message": "Paying",
        "remark":"test"
    }
}