申请退款
200 OK
refund_id 必填 string(32)
【微信支付退款单号】申请退款受理成功时,该笔退款单在微信支付侧生成的唯一标识。
out_refund_no 必填 string(64)
【商户退款单号】 服务商申请退款时传的服务商系统内部退款单号。
transaction_id 必填 string(32)
【微信支付订单号】微信支付侧订单的唯一标识。
out_trade_no 必填 string(32)
【商户订单号】 服务商下单时传入的服务商系统内部订单号。
channel 必填 string
【退款渠道】 订单退款渠道以下枚举:
ORIGINAL: 原路退款
BALANCE: 退回到余额
OTHER_BALANCE: 原账户异常退到其他余额账户
OTHER_BANKCARD: 原银行卡异常退到其他银行卡(发起异常退款成功后返回)
user_received_account 必填 string(64)
【退款入账账户】 取当前退款单的退款入账方,有以下几种情况:1)退回银行卡:{银行名称}{卡类型}{卡尾号}2)退回支付用户零钱:支付用户零钱3)退还商户:商户基本账户商户结算银行账户4)退回支付用户零钱通:支付用户零钱通5)退回支付用户银行电子账户:支付用户银行电子账户6)退回支付用户零花钱:支付用户零花钱7)退回用户经营账户:用户经营账户8)退回支付用户来华零钱包:支付用户来华零钱包9)退回企业支付商户:企业支付商户10)退回支付用户小金罐:支付用户小金罐
success_time 选填 string(64)
【退款成功时间】
1、定义:退款成功的时间,该字段在退款状态status为SUCCESS(退款成功)时返回。
2、格式:遵循rfc3339标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONE。yyyy-MM-DD 表示年月日;T 字符用于分隔日期和时间部分;HH:mm:ss 表示具体的时分秒;TIMEZONE 表示时区(例如,+08:00 对应东八区时间,即北京时间)。
示例:2015-05-20T13:29:35+08:00 表示北京时间2015年5月20日13点29分35秒。
create_time 必填 string(64)
【退款创建时间】
1、定义:提交退款申请成功,微信受理退款申请单的时间。
2、格式:遵循rfc3339标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONE。yyyy-MM-DD 表示年月日;T 字符用于分隔日期和时间部分;HH:mm:ss 表示具体的时分秒;TIMEZONE 表示时区(例如,+08:00 对应东八区时间,即北京时间)。
示例: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
【商品退货数量】 申请退款的商品退货数量。