创建收银台订单
- 代收（收银台）
聚合了所有开通的支付方式
HTTP请求信息
TIP
POST baseUrl + /api/payDesk
HTTP请求头
| 请求头 | 必选 | 值 |
|---|---|---|
Content-Type | Y | application/json |
MerchantId | Y | MerchantId |
Sign | Y | Sign |
HTTP请求体
| 参数名 | 必选 | 类型 | 示例值 | 字段说明 |
|---|---|---|---|---|
currency | Y | string(32) | COP | 货币代码(COP) |
amount | Y | decimal(20,2) | 10000 | 金额10000-5000000 |
reusableStatus | N | boolean | 不传默认 false | （false=不允许 true=允许）目前只能是false |
mchOrderNo | Y | string(32) | P123456 | 商户订单号（不允许重复） |
expireTime | N | long | 3600 | 过期时间（单位：秒）不传则默认7天 |
notifyUrl | Y | string(250) | http://abc.com/ | 回调地址 |
nonceStr | Y | string(32) | 1628381288000 | 随机数 |
realName | Y | string(32) | Jeck | 用户姓名 不能有特殊字符、限制最长64个字符 |
phone | Y | string(32) | 52xxxxxxx | 手机号 格式要正确,尽量传真实的手机号 |
email | Y | string(64) | example@maildomain.com | 邮箱 格式要正确,尽量传真实的邮箱 |
idType | Y | 请参考付款人证件类型 | 付款人证件类型 | |
idCard | Y | string(32) | 我们不校验真实性和合法性，错误的证件号可能导致部分交易失败 | 付款人证件号 |
returnUrl | N | string(250) | http://abc.com/ | 支付成功后 同步跳转地址 |
goodsSubject | N | string(32) | apple | 商户标题 |
goodsBody | N | string(32) | apple | 商品描述 |
remark | N | string(32) | 不传默认 remark | 备注 （请使用英文字符或不带重音的西语） |
TIP
注意回调/同步跳转地址仅支持https或者http协议的地址，如果地址是ip地址，请务必使用公网域名。
TIP
用户信息将传送给银行校验，需填写真实且有效信息
HTTP响应体说明
json
{
"msg": "SUCCESS",
"code": 200,
"data": {
"merchantId": "100001",
"mchOrderNo": "M165690800000001",
"orderNo": "PAYDESKxxxxxxxxxxxxxxxxxx",
"payUrl": "http://paydesk.testpage.com/PAYDESKxxxxxxxxxxxxxxx",
"amount": "100000",
"expireTime": "2022-12-06 17:48:40"
}
}| 参数名 | 类型 | 参数说明 |
|---|---|---|
merchantId | int | 商户Id |
mchOrderNo | string(32) | 商户订单号 |
orderNo | string(32) | 平台订单号 |
amount | decimal(20,2) | 金额 |
payUrl | string(250) | 收银台Url |
expireTime | date | 过期时间 |
收银台订单查询
| 名称 | 类型 |
|---|---|
| API端点 | /api/payDeskQuery |
| 请求方式 | POST |
| 请求头 | 参考 通用请求头 |
HTTP请求体
| 参数名 | 必选 | 类型 | 示例值 | 字段说明 |
|---|---|---|---|---|
mchOrderNo | N | string(32) | P123456 | 商户订单号 |
orderNo | N | string(32) | PAYDESKxxxxxxxxxx | 平台订单号 |
nonceStr | Y | string(32) | 1628381288000 | 随机数 |
TIP
我们建议优先使用orderNo（平台订单号），平台订单号和商户订单号至少需要传递一个。
HTTP响应体说明
json
{
"msg": "SUCCESS",
"code": 200,
"data": {
"merchantId": "100001",
"mchOrderNo": "2a6421c4-3758-4d1a-b47e-f7d0e7133f9e",
"orderNo": "PAYDESKxxxxxxxxxx",
"payType": 154,
"payUrl": "http://paydesk.testpage.com/PAYDESKxxxxxxxxxx",
"amount": 10000.0,
"fee": 0,
"orderStatus": "PAYING",
"completionTime": null
}
}| 参数名 | 类型 | 字段说明 |
|---|---|---|
merchantId | int | 商户Id |
mchOrderNo | string(32) | 商户订单号 |
orderNo | string(32) | 平台订单号 |
payType | int | 支付类型,请参考代收paytype枚举 |
payUrl | string(250) | 收银台URL地址 |
amount | decimal(20,2) | 金额 |
fee | decimal(20,4) | 手续费 |
orderStatus | string(32) | 订单状态 收银台代收订单状态枚举 |
| completionTime | date | 完成时间 |
TIP
fee 和 completionTime 仅在订单成功被支付时有值。completionTime的格式为 yyyy-MM-dd HH:mm:ss。
TIP
payType仅在订单成功被支付时有值。
收银台异步回调
| 名称 | 类型 |
|---|---|
| API端点 | 商户提交订单的回调地址notifyUrl |
| 请求方式 | POST |
| 请求头 | 参考 通用请求头 |
异步通知结构
json
{
"orderStatus": "SUCCESS",
"amount": 10000.0,
"fee": 0,
"mchOrderNo": "2a6421c4-3758-4d1a-b47e-f7d0e7133f9e",
"merchantId": "100001",
"payType": 154,
"orderNo": "PAYDESKxxxxxxxxxxx",
"payUrl": "http://paydesk.testpage.com/PAYDESKxxxxxxxxxx",
"completionTime": "2022-08-08 08:08:08",
"nonceStr": "xxxxxxxxxx"
}| 参数名 | 类型 | 说明 |
|---|---|---|
merchantId | int | 商户Id |
mchOrderNo | string(32) | 商户订单号 |
orderNo | string(32) | 平台订单号 |
payType | int | 支付类型,请参考代收paytype枚举 |
amount | decimal(20,2) | 金额 |
fee | decimal(20,4) | 手续费 |
payUrl | string(32) | 收银台Url |
orderStatus | string(32) | 订单状态 收银台代收订单状态枚举 |
| completionTime | date | 完成时间 |
nonceStr | string(32) | 随机数 |
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次。