创建代付订单
HTTP请求信息
TIP
POST baseUrl + /api/payOut
HTTP请求头
| 请求头 | 必选 | 值 |
|---|---|---|
Content-Type | Y | application/json |
MerchantId | Y | MerchantId |
Sign | Y | Sign |
HTTP请求体
| 参数名 | 必选 | 类型 | 示例值 | 字段说明 |
|---|---|---|---|---|
accountName | Y | string(32) | John | 收款人名称限制最长64个字符 |
accountNo | Y | string(32) | 721323213 | 收款人账户(移动钱包号) |
accountType | Y | int | 请参考代付账户类型 | 账户类型 |
currency | Y | string(32) | TZS | 货币代码 |
amount | Y | decimal(20,0) | 10000 | 金额(整数),最小500,最大3000000 |
mchOrderNo | Y | string(32) | P123456 | 商户订单号 |
notifyUrl | Y | string(250) | http://abc.com/ | 回调地址 |
nonceStr | Y | string(32) | 16283812xxxx | 随机数 |
idType | N | string(32) | 暂不区分类型 | 收款人证件类型 |
idCard | N | string(32) | 用户真实证件号 | 收款人证件号 |
phone | N | string(32) | +255xxxxxxx | 收款人手机号 |
email | N | string(64) | example@maildomain.com | 收款人邮箱 |
remark | Y | string(32) | remark | 备注 （请使用英文字符或不带重音的西语） |
TIP
注意回调地址仅支持https或者http协议的地址，如果地址是ip地址，请务必使用公网域名。
HTTP响应体
| 参数名 | 类型 | 参数说明 |
|---|---|---|
merchantId | int | 商户Id |
mchOrderNo | string(32) | 商户订单号 |
orderNo | string(32) | 平台订单号 |
amount | decimal(20,0) | 金额 |
fee | decimal(20,0) | 手续费 |
orderStatus | string | 订单状态 请参考代付订单状态枚举 |
json
{
"msg": "SUCCESS",
"code": 200,
"data": {
"merchantId": "100001",
"mchOrderNo": "M1656907083234",
"orderNo": "PAYOUT8232147367892025344",
"amount": 100,
"fee": 0,
"orderStatus": "PROCESSING"
}
}查询代付订单
HTTP请求信息
TIP
POST baseUrl + /api/payOutQuery
HTTP请求头
| 请求头 | 必选 | 值 |
|---|---|---|
Content-Type | Y | application/json |
MerchantId | Y | MerchantId |
Sign | Y | Sign |
HTTP请求体
| 参数名 | 必选 | 类型 | 示例值 | 字段说明 |
|---|---|---|---|---|
mchOrderNo | N | string(32) | P123456 | 商户订单号 |
orderNo | N | string(32) | PAYIN12345 | 平台订单号 |
nonceStr | Y | string(32) | 1628381288000 | 随机数 |
TIP
我们建议优先使用orderNo（平台订单号），平台订单号和商户订单号至少需要传递一个。
HTTP响应体
json
{
"msg": "SUCCESS",
"code": 200,
"data": {
"merchantId": "100001",
"mchOrderNo": "M1656756338536",
"orderNo": "PAYOUT8231515112790892544",
"amount": 100.0,
"fee": null,
"orderStatus": "PAYING",
"completionTime": null,
"resultDesc": "SUCCESS"
}
}| 参数名 | 类型 | 说明 |
|---|---|---|
merchantId | int | 商户Id |
mchOrderNo | string(32) | 商户订单号 |
orderNo | string(32) | 平台订单号 |
channelOrderNo | string(32) | 渠道订单号 |
amount | decimal(20,2) | 金额 |
fee | decimal(20,2) | 手续费 |
orderStatus | string(32) | 订单状态 请参考代付订单状态枚举 |
completionTime | date | 完成时间（未成功时，此值为空） yyyy-MM-dd HH:mm:ss |
resultDesc | string(64) | 订单结果描述 ,请参考订单状态具体描述 |
异步回调通知
异步通知请求
TIP
POST : notifyUrl
回调地址由商户提供或透传。
异步通知请求头
| HeaderName | Required | Value |
|---|---|---|
Content-Type | Y | application/json |
MerchantId | Y | MerchantId |
Sign | Y | Sign |
异步通知请求体
json
{
"orderStatus": "SUCCESS",
"amount": 100.0,
"fee": 0,
"mchOrderNo": "2a6421c4-3758-4d1a-b47e-f7d0e7133f9e",
"merchantId": "100001",
"orderNo": "PAYOUT8388679728902370944",
"completionTime": "2022-08-08 08:08:08",
"resultDesc": "SUCCESS"
}| 参数名 | 类型 | 说明 |
|---|---|---|
merchantId | int | 商户Id |
mchOrderNo | string(32) | 商户订单号 |
orderNo | string(32) | 平台订单号 |
channelOrderNo | string(32) | 渠道订单号 |
amount | decimal(20,2) | 金额 |
fee | decimal(20,4) | 手续费 |
orderStatus | string(32) | 请参考代付订单状态 |
resultDesc | string(64) | 请参考订单状态描述 |
completionTime | date | 完成时间 |
TIP
fee 和 completionTime 仅在订单成功支付时有值。completionTime的格式为 yyyy-MM-dd HH:mm:ss。
TIP
Http响应状态码为200、301或302表示已正常发送回调,其它状态码我们会认为回调失败。 回调失败后会在1,2,4,8,16,32,64,128,256,512分钟重试，一共重试回调10次