Skip to content

创建代付请求

提交地址:https://openapi.basicex.com/v2/payouts

请求方式:POST

Content-Type:application/json

请求传参

参数是否必填类型描述
amountBigInteger金额字段,与precision精度字段结合,采用整数格式。即:如果precision为2(amount÷10²),向用户代付2.00,则需传入200
precisionInteger金额精度,推荐精度2-6位。
currencyString加密货币币种,例如:BCNY(推荐,CNY 1:1),USDT, BTC等, 查看币种列表
customerEmailString商户侧的客户邮箱,如传入,则在代付成功后向该邮箱发送邮件
notificationUrlString用于向商户指定地址推送Webhook通知的网址,必须为HTTPS
descriptionString该代付订单的描述,例如“工资”
metadataMap传入的结构化元数据,用于商户本身记录相应的数据。该字段将在后续原样返回
physicalBoolean是否为实物商品,默认为false,如为实物商品时为true
targetTypeString代付对象类型:
* 币趣钱包ID:BEID
* 外部钱包地址:ADDRESS
targetString代付对象(币趣钱包ID/外部钱包地址)
merOrderNoString商户侧商户订单号
networkString转账网络,支持TRC20,ERC20,Polygon,BSC
注:当代付对象为钱包地址(targetTypeADDRESS)时必填

请求示例:

注:发送请求的时候必须保证和构造签名的时候的参数完全一致 否则无法通过平台的验签

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

返回参数:

字段类型描述
orderNoString系统订单号
merOrderNoString商户侧商户订单号
amountBigInteger金额字段
conversionBigDecimal平台计算出来的币种数量
currencyString币种
metadataMap传入的结构化元数据,用于商户本身记录相应的数据。该字段将在后续原样返回

响应示例:

订单请求成功后,响应code为0000

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