创建代收订单
HTTP请求信息
TIP
POST baseUrl + /api/payIn
HTTP请求头
| 请求头 | 必选 | 值 |
|---|---|---|
Content-Type | Y | application/json |
MerchantId | Y | MerchantId |
Sign | Y | Sign |
TIP
HTTP请求体
| 参数名 | 必选 | 类型 | 示例值 | 字段说明 |
|---|---|---|---|---|
currency | Y | string(32) | USD | 货币代码(USD) |
payType | Y | int | 300 | 请查看 代收PayType枚举 |
amount | Y | decimal(20,2) | [1,500] | 金额 |
reusableStatus | Y | boolean | false | 目前只能是false |
mchOrderNo | Y | string(32) | mch12345 | 商户订单号（不允许重复） |
expireTime | Y | long | 3600 | 过期时间（单位：秒）（实际上游没有固定过期时间）默认3600秒 不一定有效,部分通道支持 |
notifyUrl | Y | string(250) | https://acb.com/ | 回调地址 |
nonceStr | Y | string(32) | 162838128 | 随机数 |
remark | Y | string(32) | remark | 备注 （请使用英文字符或不带重音的西语） |
realName | Y | string(32) | Jack | 付款人名称 （请传递全名） （全名）限制最长64个字符 |
phone | Y | string(32) | +593xxxxxxx | 手机号 ，请勿使用重复的手机号 |
email | Y | string(64) | example@maildomain.com | 邮箱 ,请勿使用重复的邮箱 |
idType | Y | string(32) | 1 | 代收付款人证件类型 |
idCard | Y | string(32) | 付款人证件号 (身份证1=CC 长度10位) | |
goodsSubject | N | string(32) | apple | 商户标题 |
goodsBody | N | string(32) | apple | 商品描述 |
TIP
注意回调地址仅支持https或者http协议的地址，如果地址是ip地址，请务必使用公网域名。
HTTP响应体
JSON 示例
{
"msg": "SUCCESS",
"code": 200,
"data": {
"merchantId": "100001",
"mchOrderNo": "M1656908719283",
"orderNo": "PAYIN8232154612109344768",
"payCode": "646012000000015942",
"payUrl": "https://xxxxx.xxxxx/pay.html",
"amount": 100
}
}2
3
4
5
6
7
8
9
10
11
12
| 参数名 | 类型 | 说明 |
|---|---|---|
merchantId | long | 商户Id |
mchOrderNo | string(32) | 商户订单号 |
orderNo | string(32) | 平台订单号 |
amount | decimal(20,2) | 金额 |
orderFee | decimal(20,2) | 手续费 |
payCode | string(32) | 付款账户VA |
payUrl | string(250) | 收银台支付地址 |
查询代收订单
HTTP请求信息
TIP
POST baseUrl + /api/payInQuery
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响应体
{
"msg": "SUCCESS",
"code": 200,
"data": {
"merchantId": "100001",
"mchOrderNo": "M1656752128806",
"orderNo": "PAYIN8231497473279467520",
"payType": "1",
"payCode": "646012000000015887",
"payUrl": null,
"payDeskUrl": null,
"amount": 100.0,
"patchOrderNo": "PAYIN82xxxxxxxxx",
"orderType": "PATCH",
"fee": null,
"orderStatus": "PAYING",
"completionTime": null
}
}2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
| 参数名 | 类型 | 字段说明 |
|---|---|---|
merchantId | int | 商户Id |
mchOrderNo | string(32) | 商户订单号 |
orderNo | string(32) | 平台订单号 |
channelOrderNo | string(32) | 渠道订单号 |
payType | string(32) | 请查看 代收PayType枚举 |
payCode | string(32) | 支付码 |
payUrl | string(250) | 付款二维码 |
payDeskUrl | string(250) | 收银台地址 |
amount | decimal(20,2) | 金额 |
fee | decimal(20,4) | 手续费 |
orderStatus | string(32) | 订单状态 代收订单状态枚举 |
completionTime | date | 完成时间 |
patchOrderNo | string(32) | 关联的原订单的平台订单号 |
patchMchOrderNo | string(32) | 关联的原订单的商户订单号 |
orderType | string(32) | API=API接口 MCH=商户后台 DESK=收银台 PATCH=补单 |
关于orderType为PATCH时的补充说明
用户不按照订单金额付款或者重复付款会出现补单订单，此时补单订单的orderType为PATCH:
orderNo是针对这笔订单新生成的平台订单号。patchOrderNo为关联的原订单的平台订单号，patchMchOrderNo为关联的原订单的商户订单号。mchOrderNo为关联的原订单的商户订单号(带序列号标识)。注意，此时回调返回的mchOrderNo末尾会增加序列号标识，用于区分多笔部分还款的订单。
例如您的商户订单号是MCH20230088，当产生第一笔部分支付时，我们会在原订单的商户订单号mchOrderNo末尾增加序列号00001 ，您收到的回调的mchOrderNo就是MCH2023008800001，以此类推。
当发生补单行为时，我们的机器人也会在对应的商户群进行通知，通知会包含所有您需要的信息。
订单的orderType为API时:
patchOrderNo和orderNo相同patchMchOrderNo和mchOrderNo相同
此时上述参数没有额外的意义。
TIP
fee 和 completionTime 仅在订单成功支付时有值。completionTime的格式为 yyyy-MM-dd HH:mm:ss。
异步回调通知
异步通知请求
TIP
POST : notifyUrl
回调地址由商户提供或透传。
异步通知请求头
| HeaderName | Required | Value |
|---|---|---|
Content-Type | Y | application/json |
MerchantId | Y | MerchantId |
Sign | Y | Sign |
异步通知请求体
{
"orderStatus": "SUCCESS",
"amount": 10000.0,
"fee": 0,
"mchOrderNo": "2a6421c4-3758-4d1a-b47e-f7d0e7133f9e",
"merchantId": "100001",
"payDeskUrl": null,
"orderNo": "PAYDESKxxxxxxxxxxx",
"payUrl": "xxxxxxxxxxxx",
"patchOrderNo": "PAYIN82xxxxxxxxx",
"orderType": "PATCH",
"completionTime": "2022-08-08 08:08:08",
"nonceStr": "xxxxxxxxxx"
}2
3
4
5
6
7
8
9
10
11
12
13
14
| 参数名 | 类型 | 说明 |
|---|---|---|
merchantId | int | 商户Id |
mchOrderNo | string(32) | 商户订单号 |
orderNo | string(32) | 平台订单号 |
amount | decimal(20,2) | 金额 |
fee | decimal(20,4) | 手续费 |
payUrl | string(32) | 收银台Url |
payDeskUrl | string(250) | 收银台地址 |
orderStatus | string(32) | 订单状态,请参考代收订单状态枚举 |
completionTime | date | 完成时间 |
nonceStr | string(32) | 随机数 |
patchOrderNo | string(32) | 关联的原订单的平台订单号 |
patchMchOrderNo | string(32) | 关联的原订单的商户订单号 |
orderType | string(32) | API=API接口 MCH=商户后台 DESK=收银台 PATCH=补单 |
TIP
fee 和 completionTime 仅在订单成功支付时有值。completionTime的格式为 yyyy-MM-dd HH:mm:ss。patchMchOrderNo 字段目前仅墨西哥有，其他国家暂不支持。
关于orderType为PATCH时的补充说明
用户不按照订单金额付款或者重复付款会出现补单订单，此时补单订单的orderType为PATCH:
orderNo是针对这笔订单新生成的平台订单号。patchOrderNo为关联的原订单的平台订单号，patchMchOrderNo为关联的原订单的商户订单号。mchOrderNo为关联的原订单的商户订单号(带序列号标识)。注意，此时回调返回的mchOrderNo末尾会增加序列号标识，用于区分多笔部分还款的订单。
例如您的商户订单号是MCH20230088，当产生第一笔部分支付时，我们会在原订单的商户订单号mchOrderNo末尾增加序列号00001 ，您收到的回调的mchOrderNo就是MCH2023008800001，以此类推。
当发生补单行为时，我们的机器人也会在对应的商户群进行通知，通知会包含所有您需要的信息。
订单的orderType为API时:
patchOrderNo和orderNo相同patchMchOrderNo和mchOrderNo相同
此时上述参数没有额外的意义。
TIP
Http响应状态码为200、301或302表示已正常发送回调,其它状态码我们会认为回调失败。回调失败后会在1,2,4,8,16,32,64,128,256,512分钟 重试，一共重试回调10次。