2.2. 退款接口
接口介绍:
描述:退款交易将支付的金额返回持卡人的账户。
API endpoint: {api_domain}/api/giftcard/v1/ trade/refund
Verb: POST
请求参数:
参数 | 必填 | 类型 | 约束 | 描述 |
---|---|---|---|---|
brand_code | 1 | String | 数字,最大 6 位 | 品牌编号, 由收钱吧提供 |
out_request_no | 1 | String | 字符串,最大 64 位 | 退款请求编号,作为商户的退款交易编号 |
trade_no | 0-1 | String | 字符串,最大 64 位 | 收钱吧生成的原始交易编号,从 trade_no 和out_trade_no 中选择一个 |
out_trade_no | 0-1 | String | 字符串,最大 64 位 | 商户系统中的原始交易编号,从 trade_no 和out_trade_no 中选择一个 |
refund_amount | 0-1 | String | 数字,最大 10 位 | 订单将根据商家配置进行退款。如果此字段为空,则按默认方式进行退款。 示例:当退款金额少于订单金额时,将优先退款至礼品卡 |
notify_url | 1 | String | 字符串,最大 128 位 | 退款完成后接收通知的地址 |
reflect | 0-1 | String | 字符串,最大 256 位 | 反射参数 |
返回参数:
参数 | 必填 | 类型 | 约束 | 描述 |
---|---|---|---|---|
brand_code | 1 | String | 数字最大 6 位 | 品牌编号, 由收钱吧提供 |
store_sn | 1 | String | 字符串,最大 36 位 | 商户门店编号 |
workstation_sn | 1 | String | 字符串,最大 36 位 | 门店收银机编号, 如果商户系统没有此参数,则设置为 0 |
check_sn | 1 | String | 字符串,最大 36 位 | 商户核对账单号码或商户订单号 |
out_request_no | 1 | String | 字符串,最大 64 位 | 退款请求编号,作为商户的退款交易编号 |
trade_no | 1 | String | 字符串,最大 64 位 | 收钱吧为此交易生成的退款交易编号 |
out_trade_no | 1 | String | 字符串,最大 64 位 | 商户系统的原始交易号 |
refund_status | 1 | String | 字符串,最大 32 位 | 退款结果状态码,具体参考 3.1 |
subject | 1 | String | 字符串,最大 64 位 | 交易的概述 |
trade_detail | 0-1 | String | 对象 | 如果退款状态为“部分退款/退款”,则返回 |
external_trade_detail | 0-1 | String | 对象 | 当礼品卡余额不足以支付订单金额时,可由礼品卡收银台采用微信或支付宝小程序付款的方式代为收取剩余金额。此功能是可选项,当启用此功能时,该字段会随“trade_detail ”一起返回 |
reflect | 0-1 | String | 字符串,最大 256 位 | 反射参数 |
trade_detail的结构定义:
参数 | 必填 | 类型 | 约束 | 描述 |
---|---|---|---|---|
payer_uid | 0-1 | String | 字符串,最大 64 位 | 付款人 ID |
total_amount | 1 | String | 数字,最大 10 位 | 订单价格,精确到分,金额应为负数 |
pay_amount | 1 | String | 数字,最大 10 位 | 实际支付的返回价格,精确到分,金额应为负数 |
collect_amount | 1 | String | 数字,最大 10 位 | 实际收款的返回价格,精确到分,金额应为负数 |
payment_list | 0-1 | String | 数组 | 付款成功后,返回该订单的各支付渠道 |
finish_time | 0-1 | String | 时间 | 交易完成时间 |
payment_list的结构定义:
参数 | 必填 | 类型 | 约束 | 描述 |
---|---|---|---|---|
total_amount | 1 | String | 数字,最大 10 位 | 订单价格,精确到分,金额应为负数 |
pay_amount | 1 | String | 数字,最大 10 位 | 实际支付的返回价格,精确到分,金额应为负数 |
collect_amount | 1 | String | 数字,最大 10 位 | 实际收款的返回价格,精确到分,金额应为负数 |
type | 1 | String | 字符串,最大 64 位 | 用于支付的卡类型,详见 3.2 |
pay_account_id | 1 | String | 字符串,最大 64 位 | 此参数值表示卡号 |
External_trade_detail的结构定义:
参数 | 必填 | 类型 | 约束 | 描述 |
---|---|---|---|---|
trade_no | 1 | String | 字符串,最大 64 位 | 收钱吧为此交易生成的交易编号 |
payer_uid | 1 | String | 字符串,最大 64 位 | 付款人 ID,微信 Openid 或支付宝 userid |
total_amount | 1 | String | 数字,最大 10 位 | 订单价格,精确到分,金额应为负数 |
pay_amount | 1 | String | 数字,最大 10 位 | 实际支付的返回价格,精确到分,金额应为负数 |
collect_amount | 1 | String | 数字,最大 10 位 | 实际收款的返回价格,精确到分,金额应为负数 |
channel_type | 1 | String | 字符串,最大 64 位 | 用于支付的渠道类型,详见 3.3 |
finish_time | 0-1 | String | 时间 | 交易完成时间 |