Create Payout Request

Submission URL: https://openapi.basicex.com/v2/payouts

Request Method: POST

Content-Type: application/json

Request Parameters

Parameter	Required	Type	Description
amount	Yes	BigInteger	The amount field, combined with the precision precision field, in integer format. For example, if precision is 2 (amount ÷ 10²), to pay out 2.00, you need to pass 200.
precision	Yes	Integer	Amount precision, recommended precision of 2-6 digits.
currency	Yes	String	Cryptocurrency, for example: BCNY (recommended, 1:1 with CNY), USDT, BTC, etc. View currency list
customerEmail	No	String	Customer email on the merchant's side. If provided, an email will be sent to this address after the payout is successful.
notificationUrl	Yes	String	The URL for webhook notifications to be sent to the merchant's specified address, must be HTTPS.
description	Yes	String	Description of the payout order, e.g., "Salary".
metadata	No	Map	Structured metadata passed in for the merchant's own record, this field will be returned as-is in subsequent responses.
physical	No	Boolean	Whether it is a physical product, default is false, set to true if it's a physical product.
targetType	Yes	String	Payout object type: * BasicEx Wallet ID: BEID * External wallet address: ADDRESS
target	Yes	String	Payout object (BasicEx Wallet ID / External wallet address)
merOrderNo	Yes	String	Merchant order number on the merchant's side.
network	No	String	Transfer network, supports TRC20, ERC20, Polygon, BSC. Note: Required when the payout object is a wallet address (targetType is ADDRESS).

WARNING

When docking BCNY, BVND, or BINR, do not pass the network parameter.

For payments to BasicEx users, set targetType to BEID and do not pass the network parameter.

For payments to non-BasicEx wallets, set targetType to ADDRESS, and the network parameter is required. TRC20 is recommended.

Request Example:

Note: When sending a request, it must be consistent with the parameters used for constructing the signature; otherwise, signature verification will fail.

{
    "merOrderNo": "ADADWWR",
    "amount": "10000",
    "precision": "2",
    "currency": "USDT",
    "customerEmail": "XXXXX",
    "notificationUrl": "https://google.com",
    "description": "TEST_PAYOUT_API",
    "targetType": "ADDRESS",
    "target": "XXXXXXXXXXXXXXXXXXX",
    "network": "TRC20"
}

Response Parameters:

Field	Type	Description
orderNo	String	System order number
merOrderNo	String	Merchant order number on the merchant's side.
amount	BigInteger	Amount field
conversion	BigDecimal	The amount calculated by the platform in cryptocurrency.
currency	String	Cryptocurrency
metadata	Map	Structured metadata passed in for the merchant's own record, this field will be returned as-is in subsequent responses.

Response Example:

After a successful order request, the response code is 0000.

{
    "code": "0000",
    "message": "",
    "data": {
        "orderNo": "40820230826113242806480394240189",
        "merOrderNo": "ADADWWR",
        "amount": 10000,
        "conversion": "10.00",
        "currency": "USDT",
        "metadata": null
    }
}