Appearance
收银台下单接口 ¶
提示
业务系统通过收银台下单接口创建一个收银台链接,然后让用户访问收银台链接完成支付操作。通过此接口,可以简化支付接入的流程,减少开发工作量, 同时也可以提高用户体验。
同样的商户订单号可以重复提交,但重复提交时参数需要与首次下单的数值一致,传输不同的值也不会生效,返回的地址也不会改变。
接口说明 ¶
参数 | 说明 |
---|---|
请求URL | /unipay/checkout/create |
请求方式 | POST |
请求类型 | application/json |
请求参数 ¶
公共参数 ¶
字段名 | 变量名 | 必填 | 类型 | 长度 | 示例值 | 描述 |
---|---|---|---|---|---|---|
应用号 | appId | 否 | String | 32 | A112544225541 | 此次操作所要使用的支付应用号 |
用户IP | clientIp | 否 | String | 64 | 127.0.0.1 | 支持V4和V6,部分支付方式要求必填,如调用微信支付方式时 |
随机数值 | nonceStr | 否 | String | 32 | d112892e382a7093 | |
签名值 | sign | 否 | String | 64 | 072695d112892e382a7093b81e6a52af | |
请求时间 | reqTime | 是 | String | 2024-10-24 12:00:00 | 请求时间和当前时间误差不要超过五分钟,时间格式 yyyy-MM-dd HH:mm:ss |
业务参数 ¶
字段名 | 变量名 | 必填 | 类型 | 长度 | 示例值 | 描述 |
---|---|---|---|---|---|---|
收银台类型 | checkoutType | 是 | String | 32 | pc | 所要生成的收银台类型,见常量和状态表收银台类型相关的描述 , |
商户订单号 | bizOrderNo | 是 | String | 100 | 123 | 支付时客户系统传输的业务单号,需要保证唯一,可以为字符文字组合 |
支付标题 | title | 是 | String | 100 | 测试支付 | |
支付描述 | description | 否 | String | 500 | 测试支付的描述 | |
开启分账 | allocation | 否 | Boolean | true | 订单是否允许分账,不传输为不开启 | |
开启自动分账 | autoAllocation | 否 | Boolean | false | 是否自动对支付订单进行分账,需要开启分账字段为true才会生效 | |
过期时间 | expiredTime | 否 | Long | 2024-10-24 12:00:00 | 订单过期时间,格式为yyyy-MM-dd HH:mm:ss,不传输为默认值,默认为当前时间往后加24小时。 | |
支付金额 | amount | 是 | BigDecimal | 8,2 | 10.12 | 要进行支付的金额,单位为元,保留两位小数 |
商户扩展参数 | attach | 否 | String | 500 | id=123332 | 商户扩展参数,回调时会原样返回 |
同步请求地址 | returnUrl | 否 | String | 200 | http://abc.cn/returnCallback | 支付完成后,会自动跳转到设置的页面 |
异步通知地址 | notifyUrl | 否 | String | 200 | http://abc.cn/noticeCallback | 异步通知地址 |
响应结果 ¶
通用响应参数 ¶
WARNING
状态码返回0只代表受理业务成功,业务是否成功需要看具体业务的返回信息,不为0表示受理失败,具体响应吗可以参考返回状态码
名称 | 字段 | 类型 | 示例值 | 描述 |
---|---|---|---|---|
状态码 | code | Integer | 0 | 默认是0,非0表明请求失败,例如签名错误等 |
提示信息 | msg | String | 发生错误时会有数据返回 | |
业务数据 | data | Json字符串 | json格式数据,不同的接口返回结构不同,可以参考业务公共响应参数 | |
签名 | sign | String | sIV4zJVhZ4Uz | 返回数据的签名值 |
响应时间 | resTime | String | 2024-08-08 12:12:12 | 数据响应的时间, 如果时间与请求时间相差5分钟以上,请排查网络和安全问题 |
追踪ID | traceId | String | sIV4zJVhZ4Uz | 用于查询日志排查问题时进行快速定位 |
业务响应参数 ¶
提示
业务数据包裹在公共响应参数
中的data
字段,在code
为0
时才会有返回数据。
字段名 | 变量名 | 必传 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
收银台链接 | url | 是 | String | https://daxpay.cn/channel/cashier/M1723635576766/M8207639754663343 |
HTTP请求示例 ¶
请求参数 ¶
json
响应参数(成功) ¶
json
响应参数(失败) ¶
json
SDK请求示例 ¶
提示
使用SDK可以简化接入支付的速度
java