文档名称
统一退款查询接口文档
业务模式
对退款的结果进行查询
交互模式
后台系统调用交互模式
请求参数列表
请求url： https://pay.xrtpay.cn/xrtpay/gateway
POST XML 内容体进行请求
| 字段名 | 变量名 | 必填 | 类型 | 说明 |
|---|---|---|---|---|
| 接口类型 | service | 是 | String(32) | unified.trade.refundquery |
| 版本号 | version | 否 | String(8) | 版本号， version 默认值是 2.0。 |
| 字符集 | charset | 否 | String(8) | 可选值 UTF-8 ， 默认为 UTF-8 |
| 签名方式 | sign_type | 否 | String(8) | 签名类型， 取值： MD5或者sm3 默认： MD5 |
| 商户号 | mch_id | 是 | String(32) | 商户号， 由技术部分配 |
| 商户订单号 | out_trade_no | 否 | String(32) | 商户系统内的订单号 , out_trade_no和transaction_id至 少一个必填，同时存在时transaction_id 优先 |
| 平台订单号 | transaction_id | 否 | String(32) | 平台订单号, out_trade_no 和 transaction_id 至少一个必填， 同时存在时 transaction_id 优先 |
| 商户退款单号 | out_refund_no | 否 | String(32) | 商户退款单号， 32 个字符内、 可包含字母,确保在商户系统唯一。 |
| 平台退款单号 | refund_id | 否 | String(32) | 平台退款单号refund_id、 out_refund_no、 out_trade_no 、transaction_id 四个参数必填一个， 如果同事存在优先级为：refund_id>out_refund_no>transaction_id>out_trade_no |
| 随机字符串 | nonce_str | 是 | String(32) | 随机字符串， 不长于 32 位 |
| 签名 | sign | 是 | String(32) | 签名结果， 详见“ 签名规则” |
| 商户退款单号 | out_refund_no | 否 | String(32) | 商户退款单号， 32 个字符内、 可包含字母,确保在商户系统唯一。 |
返回结果
数据按 XML 的格式实时返回
| 字段名 | 变量名 | 必填 | 类型 | 说明 |
|---|---|---|---|---|
| 版本号 | version | 是 | String(8) | 版本号， version 默认值是 2.0。 |
| 字符集 | charset | 是 | String(8) | 可选值 UTF-8 ， 默认为 UTF-8。 |
| 签名方式 | sign_type | 否 | String(8) | 签名类型， 取值： MD5 默认： MD5 |
| 返回状态码 | status | 是 | String(16) | 0 表示成功非 0 表示失败此字段是通信标识， 非交易标识， 交易是否成功需要查看 result_code 来判断 |
| 返回信息 | message | 否 | String(128) | 返回信息， 如非空， 为错误原因签名失败参数格式校验错误 |
| 以 下 字 段 在 status 为 0 的 时 候 有 返 回 |
|---|
| 业务结果 | result_code | 是 | String(16) | 0 表示成功非 0 表示失败 |
|---|---|---|---|---|
| 商户号 | mch_id | 是 | String(32) | 商户号， 由技术部分配 |
| 设备号 | device_info | 否 | String(32) | 终端设备号 |
| 随机字符串 | nonce_str | 是 | String(32) | 随机字符串， 不长于 32 位 |
| 错误代码 | err_code | 否 | String(32) | 具体错误码请看文档最后错误码列表 |
| 签名 | sign | 是 | String(32) | MD5 签名结果， 详见“ 数字签名 MD5 签名规则” |
| 以下字段在status 和 result_code 都为 0 的时候有返回 |
|---|
| …订单号 | transaction_id | 是 | String(32) | …交易号。 |
|---|---|---|---|---|
| 商户订单号 | out_trade_no | 是 | String(32) | 商户系统内部的订单号 |
| 退款笔数 | refund_count | 是 | Int | 退款记录数 |
| 商户退款单号 | out_refund_no_$n | 是 | String(32) | 商户退款单号 |
| …退款单号 | refund_id_$n | 是 | String(32) | …退款单号 |
| 退款渠道 | refund_channel_$n | 是 | String(16) | ORIGINAL—原路退款，默认BALANCE—退回到余额 |
| 退款金额 | refund_fee_$n | 是 | Int | 退款总金额,单位为分,可以做部分退款 |
| 现金券退款金额 | coupon_refund_fee_$n | 否 | Int | 现金券退款金额 <= 退款金额， 退款金额-现金券退款金额为现金 |
| 退款时间 | refund_time_$n | 否 | String(14) | yyyyMMddHHmmss |
| 退款状态 | refund_status_$n | 是 | String(16) | 退款状态：SUCCESS—退款成功FAIL—退款失败PROCESSING—退款处理中NOTSURE—未确定， 需要商户原退单号重新发起CHANGE—转入代发，退款到银行发现用户的卡作废或者冻结了，导致原路退款银行卡失败， 资金回流到商户的现金帐号， 需要商户人工干预， 通过线下或者…转账的方式进行退款 |
| $n 表示记录的序号，取值为 0~($ refund_count -1)， 例如 refund_count 指示返回的退款记录有 2 条。 第一条序号为“0” ， 第二条序号为“ 1” |
|---|
文档更新时间: 2022-03-03 16:42 作者：EricYang
