创建代付请求
提交地址:https://openapi.basicex.com/v2/payouts
请求方式:POST
Content-Type:
application/json
请求传参
参数 | 是否必填 | 类型 | 描述 |
---|---|---|---|
amount | 是 | BigInteger | 金额字段,与precision 精度字段结合,采用整数格式。即:如果precision 为2(amount÷10²),向用户代付2.00 ,则需传入200 。 |
precision | 是 | Integer | 金额精度,推荐精度2-6位。 |
currency | 是 | String | 加密货币币种,例如:BCNY(推荐,CNY 1:1),USDT, BTC等, 查看币种列表 |
customerEmail | 否 | String | 商户侧的客户邮箱,如传入,则在代付成功后向该邮箱发送邮件 |
notificationUrl | 是 | String | 用于向商户指定地址推送Webhook通知的网址,必须为HTTPS |
description | 是 | String | 该代付订单的描述,例如“工资” |
metadata | 否 | Map | 传入的结构化元数据,用于商户本身记录相应的数据。该字段将在后续原样返回 |
physical | 否 | Boolean | 是否为实物商品,默认为false ,如为实物商品时为true |
targetType | 是 | String | 代付对象类型: * 币趣钱包ID: BEID * 外部钱包地址: ADDRESS |
target | 是 | String | 代付对象(币趣钱包ID/外部钱包地址) |
merOrderNo | 是 | String | 商户侧商户订单号 |
network | 否 | String | 转账网络,支持TRC20 ,ERC20 ,Polygon ,BSC 注:当代付对象为钱包地址( targetType 为ADDRESS )时必填 |
请求示例:
注:发送请求的时候必须保证和构造签名的时候的参数完全一致 否则无法通过平台的验签
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",
}
返回参数:
字段 | 类型 | 描述 |
---|---|---|
orderNo | String | 系统订单号 |
merOrderNo | String | 商户侧商户订单号 |
amount | BigInteger | 金额字段 |
conversion | BigDecimal | 平台计算出来的币种数量 |
currency | String | 币种 |
metadata | Map | 传入的结构化元数据,用于商户本身记录相应的数据。该字段将在后续原样返回 |
响应示例:
订单请求成功后,响应code为0000
json
{
"code": "0000",
"message": "",
"data": {
"orderNo": "40820230826113242806480394240189",
"merOrderNo": "ADADWWR",
"amount": 10000,
"conversion": "10.00",
"currency": "USDT",
"metadata": null
}
}