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

Short Description

For specific bank enumeration values, please go to the bank list.

Request URL

  • /v1/vexora/disbursements

Request method

  • Method: POST
  • Content-Type: application/json
header required type description
merchantNo Yes String No

Request Parameters

Parameter Required Type Description
sign Yes string Lowercase MD5 signature. See Signature.
timestamp Yes string Request timestamp in milliseconds.
tradeNo Yes string Merchant transaction ID. Must be unique; a timestamp plus a random suffix is recommended.
subMerchantNo Yes string Sub-merchant number. Obtain it from operations after submitting the sub-merchant information.
currency Yes string Only USDT is supported.
amount Yes string Payout amount in USDT, with up to two decimal places.
bankCode Yes string Recipient institution code; see Payout Bank Codes.
bankNumber Yes string Recipient account identifier. For bankCode 0001 (BINANCE_PAY), provide the Binance ID.
mobile Yes string Recipient mobile number, including country code.
email Yes string Recipient email. For BINANCE_PAY, it must match the email on the Binance account.
name Yes string Recipient name.
notifyUrl Yes string Merchant webhook URL.
remark Yes string Optional merchant note returned in the response and webhook.

Example Request

{
  "tradeNo": "tn1740632538919",
  "remark": "payout-0001",
  "subMerchantNo": "982773727848278231",
  "currency": "USDT",
  "amount": "100.00",
  "bankCode": "0001",
  "bankNumber": "1060123456789012",
  "mobile": "65812345678",
  "email": "recipient@example.com",
  "name": "Alex Example",
  "notifyUrl": "https://merchant.example.com/webhooks/vexora",
  "timestamp": "1740632538919",
  "sign": "<lowercase-md5-signature>"
}

Response

Field Type Description
msg string API message. A successful message does not establish the transaction outcome.
code string Top-level API result code. See Response Codes.
timestamp number/string Response timestamp.
success boolean API-level result.
data.tradeNo string Merchant transaction ID.
data.platFormTradeNo string Vexora platform transaction ID.
data.status string Transaction status. 0000 means success and 0015 means processing.
data.message string Transaction status description.
data.remark string Merchant note returned from the request.

Example Response

{
  "msg": "success",
  "code": "0000",
  "timestamp": 1740632539408,
  "success": true,
  "data": {
    "tradeNo": "tn1740632538919",
    "platFormTradeNo": "b4z0uwlq2ci8quf0",
    "status": "0015",
    "message": "Paying",
    "remark": "payout-0001"
  }
}