创建代付订单
WARNING
注意：如果接口响应超时或者响应了非200的HTTP-CODE，请务必跟我们运营确认过订单状态后再提交
WARNING
必看：姓名+手机号+邮箱+金额为判定不同客户发起依据，所以建议商户对接中注意以下问题，否则容易产生风控误判。
- 不建议姓名、手机号、邮箱都写死
- 同一客户使用同一个姓名+手机号+邮箱
巴西转账账号格式（account）
bankCode | account 格式 |
|---|---|
PIX_CPF | 11 位数字 |
PIX_CNPJ | 14 位数字 |
PIX_EMAIL | 邮箱格式 |
PIX_PHONE | +55 + 11 位数字 |
PIX_EVP | ^[0-9 a-z]{8}-[0-9 a-z]{4}-[0-9 a-z]{4}-[0-9 a-z]{4}-[0-9 a-z]{12}$ |
接口
POST /cashout/bra/order/create
请求头
| 名称 | 必填 | 示例 | 说明 |
|---|---|---|---|
Content-Type | 是 | application/json | |
lang | 否 | en | 返回信息语言：zh中文，en英文，pt葡萄牙语 |
请求参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
name | string | 是 | 付款人姓名 — 越真实，拉起成功率越高。First Name和Last Name请拼在一起 |
phone | string | 是 | 客户手机号 — 越真实，成功率越高，触发风控系数越低，+55开头 |
email | string | 是 | 客户邮箱 — 越真实，成功率越高，触发风控系数越低 |
bankCode | string enum | 是 | 代付编码 — PIX_CPF, PIX_CNPJ, PIX_PHONE, PIX_EMAIL, PIX_EVP |
account | string | 是 | 账号 — 根据bankCode不同，账号也不同bankCode为PIX_CPF则account为 CPF号; bankCode为PIX_PHONE则account为带国际区号的PHONE号,格式为**+55开头**; |
amount | number | 是 | 金额 — 10~49999；最多小数点后两位，超过则四舍五入,带小数点的情况,注意如果是浮点型签名前的拼接中amount的值会省略小数点后末尾的0 |
notifyUrl | string | 是 | 通知回调地址 — 测试环境上支持自动回调，请求参数手机号最后一位奇数回调成功，偶数回调失败 |
sign | string | 是 | 签名 |
appId | string | 是 | 商户appId |
mchOrderNo | string | 是 | 商户订单号 |
mchId | integer | 是 | 商户号 |
txChannel | string | 是 | 交易通道 — 固定值：TX_BAR_001 |
timestamp | integer | 是 | 当前时间戳 — 秒级时间戳 |
taxNumber | string | 是 | 税号，个人主体为CPF，公司主体为CNPJ — 该字段必须真实有效 |
productInfo | string | 否 | 转账备注 — 严禁提交中文，默认：Withdrawal |
请求示例
json
{
"mchId": 10404,
"txChannel": "TX_BAR_001",
"appId": "QByyZWJCFhiNupV1xl",
"timestamp": 16624500121,
"mchOrderNo": "payout_16622125006",
"name": "Matthew Clark",
"phone": "19818970682",
"email": "[email protected]",
"bankCode": "PIX_EMAIL",
"account": "[email protected]",
"amount": "180.50",
"notifyUrl": "http://xmevj.kg/obp",
"sign": "xxxxxxxxx",
"taxNumber": "45920019932",
"productInfo": "Withdrawal123"
}响应参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
status | integer | 是 | 状态 — 200成功 |
msg | string | 是 | 信息 |
data | object | 是 | |
data.applyTime | integer | 是 | 申请时间 |
data.amount | number | 是 | 到账金额 |
data.platOrderNo | string | 是 | 平台订单号 |
data.mchOrderNo | string | 是 | 商户订单号 |
data.orderStatus | string | 是 | 订单状态 |
响应示例
json
{
"status": 200,
"msg": null,
"data": {
"mchOrderNo": "payout_1662104438",
"platOrderNo": "wussXUCOoXO3yptr7rQV",
"applyTime": 1662104742,
"amount": 180.34,
"orderStatus": "PENDING"
}
}