Refunds 退款

refund 对象允许你可以对已经支付的 charge 对象发起退款请求。

属性描述
id string退款对象 id,由 Ping++ 生成,27 位长度字符串。
object string值为 "refund"。
order_no string退款的订单号,由 Ping++ 生成。
amount int退款金额大于 0,单位为对应币种的最小货币单位,例如:人民币为分(如退款金额为 1 元,此处请填 100)。
created timestamp退款创建的时间,用 Unix 时间戳表示。
succeed boolean退款是否成功。
status string退款状态(目前支持三种状态: pending: 处理中; succeeded: 成功; failed: 失败)。
time_succeed timestamp退款成功的时间,用 Unix 时间戳表示。
description string退款详情,最多 255 个 Unicode 字符。针对 cmb_wallet & cmb_pc_qr 渠道最多支持 99 字节;针对 jdpay_wap 渠道最多支持 128 字节。
failure_code string退款的错误码,详见错误中的错误码。
failure_msg string退款消息的描述。
metadata hash参考元数据
charge stringrefund 对象的所在 charge 对象的 id
charge_order_no string商户订单号,这边返回的是 charge 对象中的 order_no 参数。
transaction_no string支付渠道返回的交易流水号,部分渠道返回该字段为空。
funding_source string微信及 QQ 类退款资金来源。取值范围:unsettled_funds:使用未结算资金退款;recharge_funds:微信-使用可用余额退款,QQ-使用可用现金账户资金退款。注:默认值 unsettled_funds,该参数对于微信渠道的退款来说仅适用于微信老资金流商户使用,包括 wxwx_pubwx_pub_qrwx_litewx_wapwx_pub_scan 六个渠道;新资金流退款资金默认从基本账户中扣除。该参数仅在请求退款,传入该字段时返回。
extra hash退款成功时额外返回的渠道信息。目前支持显示wx、wx_pub、wx_pub_qr、wx_lite、wx_wap、wx_pub_scan、cb_alipay、cb_alipay_wap、cb_alipay_pc_direct渠道以及自定义渠道 custom 的返回信息。详情见下方 extra 参数说明。
extra 参数说明
参数描述
device_info string设备号:微信支付分配的终端设备号
refund_count int退款笔数:退款记录数
cash_fee int现金支付金额,单位为分,只能为整数
cash_refund_fee int现金退款金额,单位为分,只能为整数
coupon_refund_fee int代金券或立减优惠退款金额:代金券或立减优惠退款金额 = 订单金额 - 现金退款金额。注意:立减优惠金额不会退回
coupon_refund_count int代金券或立减优惠使用数量
coupon_refund_id string代金券或立减优惠 ID
refund_channel_$n string退款渠道。ORIGINAL:原路退款;BALANCE:退回到余额;OTHER_BALANCE:原账户异常退到其他余额账户;OTHER_BANKCARD:原银行卡异常退到其他银行卡
refund_fee_$n int申请退款金额:退款总金额,单位为分,可以做部分退款
settlement_refund_fee_$n int退款金额:退款金额=申请退款金额-非充值代金券退款金额。退款金额<=申请退款金额
coupon_type_$n string代金券类型。CASH:充值代金券;NO_CASH:非充值代金券。订单使用代金券时有返回(取值:CASHNO_CASH)。$n为下标,从0开始编号,举例:coupon_type_$0
coupon_refund_fee_$n int总代金券退款金额:代金券退款金额 <= 退款金额,退款金额 - 代金券或立减优惠退款金额为现金,说明详见代金券或立减优惠
coupon_refund_count_$n int退款代金券使用数量:退款代金券使用数量,$n为下标,从0开始编号
coupon_refund_id_$n_$m string退款代金券ID:退款代金券ID,$n$m为下标,从0开始编号
coupon_refund_fee_$n_$m int单个退款代金券支付金额,$n$m为下标,从0开始编号
user string用户 ID,仅在渠道为 custom 时返回
split_fund_info array退分账列表,上送格式为: [{"account": "2088866088886666","amount": 1,"desc": "split_desc desc"}] ,详情参考下方 split_fund_info参数说明

split_fund_info 参数说明

参数说明
account required, string接受退分账资金的支付宝账户ID
amount required, string退分账的金额
desc optional, string退分账描述信息

示例对象

{
  "id": "re_y1u944PmfnrTHyvnL0nD0iD1",
  "object": "refund",
  "order_no": "y1u944PmfnrTHyvnL0nD0iD1",
  "amount": 1,
  "created": 1409634160,
  "succeed": true,
  "status": "succeeded",
  "time_succeed": 1409634192,
  "description": "Refund Description",
  "failure_code": null,
  "failure_msg": null,
  "metadata": {},
  "charge": "ch_L8qn10mLmr1GS8e5OODmHaL4",
  "charge_order_no": "123456789",
  "transaction_no": "2004450349201512090096425284",
  "funding_source": null,
  "extra": {}
}