创建收银台订单
- 收银台代收,注意收银台代收只支持部分单次还款的支付产品。
HTTP请求信息
TIP
POST baseUrl
+ /api/payDesk
HTTP请求头
请求头 | 必选 | 值 |
---|---|---|
Content-Type | Y | application/json |
MerchantId | Y | MerchantId |
Sign | Y | Sign |
HTTP请求体
参数名 | 必选 | 类型 | 示例值 | 字段说明 |
---|---|---|---|---|
currency | Y | string(32) | PHP | 货币代码(PHP ) |
amount | Y | decimal(20,2) | 10000 | 金额100-5000000 |
reusableStatus | Y | boolean | false | (false=不允许 true=允许) 该字段在菲律宾无效 |
mchOrderNo | Y | string(32) | P123456 | 商户订单号(不允许重复) |
expireTime | Y | long | 3600 | 收银台链接过期时间 单位/秒 |
notifyUrl | Y | string(250) | http://abc.com/ | 回调地址 |
nonceStr | Y | string(32) | 1628381288000 | 随机数 |
realName | Y | string(32) | firstName-middleName-lastName | 用户姓名 |
phone | Y | string(32) | 09123456789 | 手机号 |
email | Y | string(64) | example@maildomain.com | 邮箱 |
idType | Y | string(32) | 请参考代收付款人证件类型 | 代收付款人证件类型 |
idCard | Y | string(32) | 付款人证件号 | |
returnUrl | N | string(250) | http://abc.com/ | 同步跳转地址(预留字段,暂不生效,支付成功后会跳到商户指定页面) |
goodsSubject | N | string(32) | apple | 商户标题 |
goodsBody | N | string(32) | apple | 商品描述 |
remark | Y | string(32) | remark | 备注 (请使用英文字符或不带重音的西语) |
INFO
realName的firstName,middleName,lastName请使用-连接。若没有middleName可以使用空字符串代替。
INFO
注意,收银台代收只支持单次还款且固定金额的还款产品,如果需要使用RefNo(BillPayments),BankTransfer,请移步至 payin接口 。
TIP
注意回调/同步跳转地址仅支持https
或者http
协议的地址,如果地址是ip
地址,请务必使用公网域名。
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 | 过期时间 |
收银台订单查询
HTTP请求信息
TIP
POST baseUrl
+ /api/payDeskQuery
HTTP请求头
请求头 | 必选 | 值 |
---|---|---|
Content-Type | Y | application/json |
MerchantId | Y | MerchantId |
Sign | Y | Sign |
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次。