Skip to content

创建收银台订单

  • 代收(收银台)聚合了所有开通的支付方式

HTTP请求信息

TIP

POST baseUrl + /api/payDesk

HTTP请求头

请求头必选
Content-TypeYapplication/json
MerchantIdYMerchantId
SignYSign

HTTP请求体

参数名必选类型示例值字段说明
currencyYstring(32)CLP货币代码(CLP)
amountYdecimal(20,2)10000金额1000-5000000
reusableStatusYbooleanfalse(false=不允许 true=允许)
该字段智利无效
mchOrderNoYstring(32)P123456商户订单号(不允许重复)
expireTimeYlong3600收银台链接过期时间 单位/秒
notifyUrlYstring(250)http://abc.com/回调地址
nonceStrYstring(32)1628381288000随机数
realNameYstring(32)Jack付款人姓名 ,不做真实性校验限制最长64个字符
phoneYstring(32)569NNNNNNNN付款人手机号 ,用户真实手机号
emailYstring(64)example@maildomain.com付款人邮箱 ,请尽量提供真实邮箱地址
idTypeYstring(32)请参考代收付款人证件类型代收付款人证件类型
idCardYstring(32)例如:11.111.111-1付款人证件号 ,会进行格式校验
returnUrlNstring(250)http://abc.com/同步跳转地址(预留字段,暂不生效,支付成功后会跳到商户指定页面)
goodsSubjectNstring(32)apple商户标题
goodsBodyNstring(32)apple商品描述
remarkYstring(32)remark备注 (请使用英文字符或不带重音的西语)

TIP

注意回调/同步跳转地址仅支持https或者http协议的地址,如果地址是ip地址,请务必使用公网域名。

HTTP响应体说明

json
{
  "msg": "SUCCESS",
  "code": 200,
  "data": {
    "merchantId": "100001",
    "mchOrderNo": "M165690800000001",
    "orderNo": "PAYDESKxxxxxxxxxxxxxxx",
    "payUrl": "http://paydesk.testpage.com/PAYDESKxxxxxxxxxxxxxxx",
    "amount": "100000",
    "expireTime": "2022-12-06 17:48:40"
  }
}
参数名类型参数说明
merchantIdint商户Id
mchOrderNostring(32)商户订单号
orderNostring(32)平台订单号
amountdecimal(20,2)金额
payUrlstring(250)收银台页面地址
expireTimedate收银台页面过期时间

收银台订单查询

HTTP请求信息

TIP

POST baseUrl + /api/payDeskQuery

HTTP请求头

请求头必选
Content-TypeYapplication/json
MerchantIdYMerchantId
SignYSign

HTTP请求体

参数名必选类型示例值字段说明
mchOrderNoNstring(32)P123456商户订单号
orderNoNstring(32)PAYDESKxxxxxxxxxx平台订单号
nonceStrYstring(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
  }
}
参数名类型字段说明
merchantIdint商户Id
mchOrderNostring(32)商户订单号
orderNostring(32)平台订单号
payTypeint支付类型,请参考代收paytype枚举
payUrlstring(250)收银台URL地址
amountdecimal(20,2)金额
feedecimal(20,4)手续费
orderStatusstring(32)订单状态 收银台代收订单状态枚举
completionTimedate完成时间

TIP

feecompletionTime 仅在订单成功被支付时有值。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"
}
参数名类型说明
merchantIdint商户Id
mchOrderNostring(32)商户订单号
orderNostring(32)平台订单号
payTypeint支付类型,请参考代收paytype枚举
amountdecimal(20,2)金额
feedecimal(20,4)手续费
payUrlstring(32)收银台Url
orderStatusstring(32)订单状态 代收订单状态枚举
completionTimedate完成时间
nonceStrstring(32)随机数

TIP

feecompletionTime 仅在订单成功支付时有值。completionTime的格式为 yyyy-MM-dd HH:mm:ss

TIP

Http响应状态码为200、301或302表示已正常发送回调,其它状态码我们会认为回调失败。 回调失败后会在1,2,4,8,16,32,64,128,256,512分钟重试,一共重试回调10次。

Released under the MIT License.