查询退款

Header HTTP头参数

Authorization 　必填　string

请参考签名认证生成认证信息

Accept 　必填　string

请设置为application/json

path 路径参数

out_refund_no 　必填 string(64)

【商户退款单号】商户系统内部的退款单号，商户系统内部唯一，只能是数字、大小写字母_-|@ ，同一退款单号多次请求只退一笔。

请求示例

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/refund/domestic/refunds/1217752501201407033233368018 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json"
5

refund_id 　必填 string(32)

【微信支付退款号】微信侧返回的退款单唯一标识，由数字组成，50或52开头。

out_refund_no 　必填 string(64)

transaction_id 　必填 string(32)

【微信支付订单号】微信支付分扣款单的唯一标识，非0元结单且支付分渠道扣款成功后支付成功回调和查询支付分订单返回的收款信息明细collection.details中包含该字段。

out_trade_no 　必填 string(32)

【商户订单号】支付分轮询扣款时生成的商户订单号。

channel 　必填 string

• ORIGINAL: 原路退款

• BALANCE: 退回到余额

• OTHER_BALANCE: 原账户异常退到其他余额账户

• OTHER_BANKCARD: 原银行卡异常退到其他银行卡

user_received_account 　必填 string(64)

【退款入账账户】退款单入账方。
取值有以下几种情况:
退回银行卡：{银行名称}{卡类型}{卡尾号}
退回支付用户零钱：支付用户零钱
退还商户：商户基本账户商户结算银行账户
退回支付用户零钱通：支付用户零钱通
退回支付用户银行电子账户：支付用户银行电子账户
退回支付用户零花钱：支付用户零花钱
退回用户经营账户：用户经营账户
退回支付用户来华零钱包：支付用户来华零钱包
退回企业支付商户：企业支付商户

success_time 　选填 string(64)

【退款成功时间】退款成功时间，退款状态status为SUCCESS（退款成功）时，返回该字段。遵循rfc3339标准格式，格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE，YYYY-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35+08:00表示，北京时间2015年5月20日13点29分35秒。

create_time 　必填 string(64)

【退款创建时间】退款受理时间，遵循rfc3339标准格式，格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE，YYYY-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35+08:00表示，北京时间2015年5月20日13点29分35秒。

status 　必填 string

• SUCCESS: 退款成功

• CLOSED: 退款关闭

• PROCESSING: 退款处理中

• ABNORMAL: 退款异常，需商户平台手动处理，参考交易退款方法介绍

funds_account 　选填 string

• UNSETTLED: 未结算资金

• AVAILABLE: 可用余额

• UNAVAILABLE: 不可用余额

• OPERATION: 运营户

• BASIC: 基本账户（含可用余额和不可用余额）

• ECNY_BASIC: 数字人民币基本账户

amount 　必填 object

【金额信息】金额详细信息

属性

total 　必填 integer 【订单金额】原支付交易的订单总金额，单位为分，只能为整数。 refund 　必填 integer 【退款金额】申请退款时传的退款金额，整型，单位为分。 from 　选填 array[object] 【退款出资账户及金额】申请退款时传的出资账户类型及出资金额。 属性 account 　必填 string 【出资账户类型】出资账户类型 可选取值： AVAILABLE: 可用余额 UNAVAILABLE: 不可用余额 amount 　必填 integer 【出资金额】对应账户出资金额，单位为分 payer_total 　必填 integer 【用户支付金额】用户现金支付金额，整型，单位为分，例如10元订单用户使用了2元代金券，则该金额为用户实际支付的8元。 payer_refund 　必填 integer 【用户退款金额】指用户实际收到的现金退款金额，数据类型为整型，单位为分。例如在一个10元的订单中，用户使用了2元的代金券，若商户申请退款5元，则用户将收到4元的现金退款(即该字段所示金额)和1元的代金券退款。 注：部分退款用户无法继续使用代金券，只有在订单全额退款且代金券未过期的情况下，用户才能继续使用代金券。 详情参考含优惠退款说明 settlement_refund 　必填 integer 【应结退款金额】去掉免充值代金券退款金额后的退款金额，整型，单位为分，例如10元订单用户使用了2元代金券(一张免充值1元 + 一张预充值1元)，商户申请退款5元，则该金额为 退款金额5元 - 0.5元免充值代金券退款金额 = 4.5元。 settlement_total 　必填 integer 【应结订单金额】去除免充值代金券金额后的订单金额，整型，单位为分，例如10元订单用户使用了2元代金券(一张免充值1元 + 一张预充值1元)，则该金额为 订单金额10元 - 免充值代金券金额1元 = 9元。 discount_refund 　必填 integer 【优惠退款金额】申请退款后用户收到的代金券退款金额，整型，单位为分，例如10元订单用户使用了2元代金券，商户申请退款5元，用户收到的是4元现金 + 1元代金券退款金额(该字段) currency 　必填 string(16) 【退款币种】固定值CNY，代表人民币。 refund_fee 　选填 integer 【手续费退款金额】订单退款时退还的手续费金额，整型，单位为分，例如一笔100元的订单收了0.6元手续费，商户申请退款50元，该金额为等比退还的0.3元手续费

promotion_detail 　选填 array[object]

【优惠退款信息】代金券信息，当订单支付时，有使用代金券时，该字段将返回所使用的代金券信息。

属性

promotion_id 　必填 string(32) 【券ID】券或者立减优惠id scope 　必填 string 【优惠范围】优惠活动中代金券的适用范围，分为两种类型： GLOBAL: 全场代金券-以订单整体可优惠的金额为优惠门槛的代金券； SINGLE: 单品优惠-以订单中具体某个单品的总金额为优惠门槛的代金券； type 　必填 string 【优惠类型】代金券资金类型，优惠活动中代金券的结算资金类型，分为两种类型： CASH: 预充值-带有结算资金的代金券，会随订单结算给订单收款商户； NOCASH: 免充值-不带有结算资金的代金券，无资金结算给订单收款商户； amount 　必填 integer 【优惠券面额】代金券优惠的金额 refund_amount 　必填 integer 【优惠退款金额】优惠退款金额<=退款金额，退款金额-代金券或立减优惠退款金额为用户支付的现金，说明详见代金券或立减优惠，单位为分 goods_detail 　选填 array[object] 【商品列表】优惠商品发生退款时返回商品信息 属性 merchant_goods_id 　必填 string(32) 【商户侧商品编码】商品编码，由半角的大小写字母、数字、中划线、下划线中的一种或几种组成。 wechatpay_goods_id 　选填 string(32) 【微信侧商品编码】微信支付定义的统一商品编号（没有可不传） goods_name 　选填 string(256) 【商品名称】商品的实际名称 unit_price 　必填 integer 【商品单价】商品单价金额，单位为分 refund_amount 　必填 integer 【商品退款金额】商品退款金额，单位为分 refund_quantity 　必填 integer 【商品退货数量】对应商品的退货数量

应答示例

1{
2  "refund_id" : "50000000382019052709732678859",
3  "out_refund_no" : "1217752501201407033233368018",
4  "transaction_id" : "1217752501201407033233368018",
5  "out_trade_no" : "1217752501201407033233368018",
6  "channel" : "ORIGINAL",
7  "user_received_account" : "招商银行信用卡0403",
8  "success_time" : "2020-12-01T16:18:12+08:00",
9  "create_time" : "2020-12-01T16:18:12+08:00",
10  "status" : "SUCCESS",
11  "funds_account" : "UNSETTLED",
12  "amount" : {
13    "total" : 100,
14    "refund" : 100,
15    "from" : [
16      {
17        "account" : "AVAILABLE",
18        "amount" : 444
19      }
20    ],
21    "payer_total" : 90,
22    "payer_refund" : 90,
23    "settlement_refund" : 100,
24    "settlement_total" : 100,
25    "discount_refund" : 10,
26    "currency" : "CNY",
27    "refund_fee" : 100
28  },
29  "promotion_detail" : [
30    {
31      "promotion_id" : "109519",
32      "scope" : "GLOBAL",
33      "type" : "COUPON",
34      "amount" : 5,
35      "refund_amount" : 100,
36      "goods_detail" : [
37        {
38          "merchant_goods_id" : "1217752501201407033233368018",
39          "wechatpay_goods_id" : "1001",
40          "goods_name" : "iPhone6s 16G",
41          "unit_price" : 528800,
42          "refund_amount" : 528800,
43          "refund_quantity" : 1
44        }
45      ]
46    }
47  ]
48}