Appearance
支付订单查询接口 ¶
提示
用于支付订单创建后,可以通过该接口主动查询订单状态,完成下一步的业务逻辑。
接口说明 ¶
参数 | 说明 |
---|---|
请求URL | /unipay/query/payOrder |
请求方式 | 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 |
业务参数 ¶
字段名 | 变量名 | 必填 | 类型 | 长度 | 示例值 | 描述 |
---|---|---|---|---|---|---|
订单号 | orderNo | 否 | String | 32 | 1753370980523384832 | 订单号与商户订单号不可以同时为空,同时传输是以订单号为准 |
商户订单号 | bizOrderNo | 否 | String | 100 | P0001 | 订单号与商户订单号不可以同时为空,同时传输是以订单号为准 |
响应结果 ¶
通用响应参数 ¶
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
时才会有返回数据。
字段名 | 变量名 | 必传 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
支付订单号 | orderNo | 是 | String | 1753370980523384832 | 系统生成的订单号 |
商户支付订单号 | bizOrderNo | 是 | String | P0001 | 商户传输的订单号 |
通道支付订单号 | outOrderNo | 是 | String | 22212137757334130130 | 三方支付系统返回的交易号 |
标题 | title | 是 | String | 测试支付 | |
描述 | description | 否 | String | 测试描述 | |
支持分账 | allocation | 否 | Boolean | true | 订单是都支持分账 |
自动分账 | description | 否 | Boolean | false | 是否开启自动分账 |
支付通道 | autoAllocation | 是 | String | wechat_pay | |
支付方式 | method | 是 | String | qrcode | |
金额 | amount | 是 | BigDecimal | 10.12 | 支付的金额,单位为元,保留两位小数 |
可退款余额 | refundableBalance | 是 | BigDecimal | 10.12 | 可以进行退款的金额,单位为元,保留两位小数 |
支付状态 | status | 是 | String | progress | 见支付状态说明 |
退款状态 | refundStatus | 是 | String | refunding | 见支付订单退款状态说明 |
分账状态 | allocStatus | 是 | String | progress | 见支付订单分账状态说明 |
支付时间 | payTime | 否 | String | 2024-10-24 12:00:00 | 时间格式 yyyy-MM-dd HH:mm:ss |
过期时间 | expiredTime | 是 | String | 2024-10-24 12:00:00 | 时间格式 yyyy-MM-dd HH:mm:ss |
关闭时间 | closeTime | 否 | String | 2024-10-24 12:00:00 | 时间格式 yyyy-MM-dd HH:mm:ss |
商户扩展参数 | attach | 否 | String | 500 | 商户传入的扩展参数 |
错误信息 | errorMsg | 否 | String | 未启用分账 | 返回订单的错误信息 |
HTTP请求示例 ¶
请求参数 ¶
json
响应参数(成功) ¶
json
响应参数(失败) ¶
json
SDK请求示例 ¶
提示
使用SDK可以简化接入支付的速度
java