代付订单创建
POST
{{HOST}}/api/v1/payout/order/create特别声明
代付订单创建发起时,若 HTTP 响应状态码非 200 的情况,一定要通过商户管理后台或者订单查询接口二次核验订单状态,若订单存在且状态为"生成订单"和“交易异常”,则当前订单暂处于进行中状态,不要进行任何订单变更行为,否则将有可能发生不必要的资损,因此请谨慎操作。如果是创建接口返回业务 code 为 400 且有明确的参数验证失败的情况,可以无需查询,直接判定订单失败。若有任何疑问请第一时间向 BetcatPay 团队确认,查询接口一定要以订单状态(orderStatus)为订单判断依据,若是其他任何异常情况,请不要私自修改订单状态,需要向 BetcatPay 团队人工参与进行后续确认,请不要对订单中的提现信息进行二次提现操作,以避免不必要的资金损失。
请求参数
Body 参数application/json
appId
string
应用号
merOrderNo
string
商户订单号
currency
string
金额币种
3位字符
amount
number
订单金额
保留2位小数(若需保留 .00, .0类无效小数位,请转换为字符串格式,避免签名数据不一致)
notifyUrl
string
异步通知地址
extra
object
扩展信息
bankCode
string
PIX账号类型
[CPF, CNPJ, PHONE, EMAIL]
accountNo
string
PIX账号
accountName
string
持卡人姓名
document
string
CPF号码
11位数字串
attach
string
附加信息
商户附加信息,原样返回
sign
string
签名
示例
{
"appId": "f8edb563e97e388112c59f87e8824c82",
"merOrderNo": "202202231234566",
"currency": "BRL",
"amount": 1,
"notifyUrl": "https://www.betcatpay.net/",
"extra": {
"bankCode": "CPF",
"accountNo": "08943810911",
"accountName": "Anderson Cardoso"
},
"sign": "35cad174f71f5771f1709a9a075fc26394b3c41df626c6ed039cd80e55ebf8dc"
}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
code
integer
响应状态码
0为成功
data
object
返回数据
orderStatus
integer
订单状态
0生成订单,1支付中,2支付未通知,3支付已通知,-1交易失败,-2交易过期,-3交易退还,-4交易异常
orderNo
string
交易订单号
merOrderNo
string
商户订单号
amount
integer
订单金额
currency
string
金额币种
createTime
integer
必需
updateTime
integer
必需
message
string
描述信息
订单异常时会返回此字段,用作异常描述
sign
string
签名
msg
string
返回文字描述
示例成功示例
{
"code": 0,
"data": {
"orderStatus": 1,
"orderNo": "202204191703308526031",
"merOrderNo": "202204191703302152",
"amount": 10,
"currency": "CNY",
"attach": null,
"createTime": 1650359010851,
"updateTime": 1650359011745,
"sign": "5503398e9641807870e035fb2d50e2fb75858477336caa9aa5447934ddd682df"
},
"msg": "请求成功"
}
最后修改时间: 10 个月前