Appearance
退款订单查询接口 ¶
提示
用于发起退款订单后,可以通过该接口主动查询退款订单的状态和信息,完成下一步的业务逻辑。
接口说明 ¶
参数 | 说明 |
---|---|
请求URL | /unipay/query/refundOrder |
请求方式 | 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 |
业务参数 ¶
字段名 | 变量名 | 必填 | 类型 | 长度 | 示例值 | 描述 |
---|---|---|---|---|---|---|
退款号 | refundNo | 否 | String | 32 | R00123 | 退款号和商户退款号不能同时为空,同时传输时以退款号为准 |
商户退款号 | bizRefundNo | 否 | String | 100 | DEVR24051019590563000001 | 退款号和商户退款号不能同时为空,同时传输时以退款号为准 |
响应结果 ¶
通用响应参数 ¶
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 | DEVP1753370980523384832 | |
商户支付订单号 | bizOrderNo | 是 | String | ||
通道支付订单号 | outOrderNo | 是 | String | ||
支付标题 | title | 是 | String | ||
退款号 | refundNo | 是 | String | R0001 | |
商户退款号 | bizRefundNo | 是 | String | ||
通道退款交易号 | outRefundNo | 是 | String | ||
退款通道 | channel | 是 | String | ali_pay | |
订单金额 | orderAmount | 是 | BigDecimal | 10.12 | 单位为元,保留两位小数 |
退款金额 | amount | 是 | BigDecimal | 10.12 | 单位为元,保留两位小数 |
退款原因 | reason | 否 | String | 测试退款 | |
退款完成时间 | finishTime | 否 | String | 2024-10-24 12:00:00 | 时间格式 yyyy-MM-dd HH:mm:ss |
退款状态 | status | 是 | String | success | 见退款状态状态说明 |
商户扩展参数 | attach | 否 | String | 500 | 商户传入的扩展参数 |
错误信息 | errorMsg | 否 | String | 退款订单不存在 | 返回订单的错误信息 |
HTTP请求示例 ¶
请求参数 ¶
json
响应参数(成功) ¶
json
响应参数(失败) ¶
json
SDK请求示例 ¶
提示
使用SDK可以简化接入支付的速度
java