API Document

# 2、Create a Payout

API Description

Merchants can use this API to initiate a payout order, transferring specified encrypted assets from the platform to the target user's address. It supports multiple blockchain assets such as USDT on ETH/TRON/BSC.

Request Method

POST

Request URL

/api/v3/wallet/transfer

Request Header

Content-Type: application/json;charset=utf-8
Parameter Name Description Example Value
access_key Merchant's backend key pFqV75X3
timestamp Unix timestamp (13 digits) 1679724896223
nonce UUID V4 794c26b0-d33c-4394-b2bb-c485eca16d9e
sign HMAC-SHA1 signature kAXyh+eerqrefyaF8dyFB0M4FVo=

Request Parameters (JSON)

{
  "externalOrderId": "622257420681202921",
  "addressTo": "0x13666442fA7583F12369CC9F5449ec660295E8",
  "chainType": "ETH",
  "tokenType": "USDT",
  "currencyType": "USD",
  "cryptoAmount": "1",
  "notifyUrl": "http://192.168.1.135:30002/url",
  "remark": "http://192.168.1.135:30002/url"
}

Parameter Explanation

Parameter Name Type Description Required
externalOrderId String(64) Merchant's order ID Yes
addressTo String(64) Recipient's address (user wallet address) Yes
chainType String Blockchain type, enum values: ETH, TRON, BSC Yes
tokenType String Cryptocurrency type, enum values: ETH: USDT, BUSD, TUSD, USDC, PUSD, ETH, TRX, TON, LINK, DAI, SHIB, UNI, LEO, OKB, PEPE; TRON: USDT, TUSD, USDC, PUSD, TRX; BSC: USDT, BUSD, TUSD, USDC, PUSD, BNB, XRP, ADA, DOGE, DOT, LTC, BCH, ETC, FIL, XTZ, CAT, PXP, GOUT, PEPE Yes
cryptoAmount String Cryptocurrency amount, precision based on the token (either this or currencyAmount is required) No
currencyType String Fiat currency type, enum values: USD, BRL, CNY (if currencyAmount is provided, this is required) No
currencyAmount String Fiat amount, precision ≤ 2 digits (either this or cryptoAmount is required; calculated based on real-time exchange rates) No
notifyUrl String Callback notification URL (if provided, this URL will be called; otherwise, the callback URL configured in the merchant's backend will be used) No
remark String(1024) Order remark No

Response Type

Header:

Content-Type: application/json;charset=utf-8

Response Data Example

{
  "code": "200",
  "success": true,
  "msg": "成功",
  "msgEn": "SUCCESS",
  "data": {
    "orderId": "OCRYPDRAW202307310902401690794160841DOCKER020000000200001109",
    "orderStatus": "Accepted",
    "addressTo": "0xa8666442fA7583F783a169CC9F5449ec660295E8",
    "chainType": "ETH",
    "tokenType": "USDT",
    "tokenAmount": 1,
    "externalOrderId": "622257420681202921"
  }
}

Response Parameter Explanation

Parameter Name Type Description
orderId String Platform order ID
orderStatus String Order status (e.g., Accepted)
addressTo String Target address
chainType String Blockchain type
tokenType String Cryptocurrency type
tokenAmount Float64 Actual paid cryptocurrency amount
externalOrderId String Merchant's order number

← 3、Order Inquiry →