Skip to content

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 None
Body
Parameter Required Type Description
sign Yes String Except for the sign field, all remaining fields should be sorted alphabetically by their first letter, combined into key1=value1key2=value2, and encrypted using the app secret as salt via MD5. The final sign value should be in lowercase.
timestamp Yes long Timestamp (1715941383720)
tradeNo Yes String Transaction number (uniqueness recommended: year, month, day, hour, minute, second + random number)
amount Yes String Payment amount (adjustable from a minimum of 100 to a maximum of 10,000, No decimal points supported)
wayCode Yes String PAYID、BSB
accountNo Yes String Account information (PayID account / BSB account)
customerName Yes String Account name
customerName Yes String customerName
mobile Yes String User's mobile phone number
email Yes String email account
remark Yes String Remark, this field will be returned as-is
notifyUrl Yes String Asynchronous callback URL
Request Parameter Example
{
  "sign": "363b4674a1c1772e8a50295dc19d6727",
  "timestamp": "1732988442913",
  "tradeNo": "39fa354542824ee789faf526f27c024f",
  "amount": 100000,
  "wayCode": "BSB",
  "bsb": "081-252",
  "accountNo": "836383478",
  "mobile": "6281245907765",
  "email": "user@gmail.com",
  "customerName": "jack",
  "notifyUrl": "https://google.com",
  "remark": "test"
}
Response Result
Parameter Required Type Description
msg Yes String Request result (when returning success, it only indicates that the request was successful and cannot be used for merchant-side logic judgment)
code Yes String Request response code (when returning 0000, it only indicates that the request was successful and cannot be used for merchant-side logic judgment). For specific error codes, please refer to the business error code enumeration.
timestamp Yes String Transaction time
success Yes String Transaction result
data Yes Object Return object
data.tradeNo Yes String merchant request trade N o
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 The returned content of the request (returned in the original path)
Successful Response Example
{
    "msg": "success",
    "code": "0000",
    "timestamp": 1728611805322,
    "success": true,
    "data": {
        "tradeNo": "test_111",
        "platFormTradeNo": "2tjba3vz6wm6hx3l",
        "status": "0015",
        "desc": "CREATED",
            "remark":"test"
    }
}