| 环境 | HTTPS请求地址 |
|---|---|
| 正式环境 | https://openapi.alipay.com/gateway.do |
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| app_id | String | 是 | 32 | 支付宝分配给开发者的应用ID | 2014072300007148 |
| method | String | 是 | 128 | 接口名称 | alipay.trade.refund |
| format | String | 否 | 40 | 仅支持JSON | JSON |
| charset | String | 是 | 10 | 请求使用的编码格式，如utf-8,gbk,gb2312等 | utf-8 |
| sign_type | String | 是 | 10 | 商户生成签名字符串所使用的签名算法类型，目前支持RSA2和RSA，推荐使用RSA2 | RSA2 |
| sign | String | 是 | 344 | 商户请求参数的签名串，详见签名 | 详见示例 |
| timestamp | String | 是 | 19 | 发送请求的时间，格式"yyyy-MM-dd HH:mm:ss" | 2014-07-24 03:07:50 |
| version | String | 是 | 3 | 调用的接口版本，固定为：1.0 | 1.0 |
| app_auth_token | String | 否 | 40 | 详见应用授权概述 | |
| biz_content | String | 是 | 请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递，具体参照各产品快速接入文档 |
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| out_trade_no | String | 特殊可选 | 64 | 订单支付时传入的商户订单号,不能和 trade_no同时为空。 | 20150320010101001 |
| trade_no | String | 特殊可选 | 64 | 支付宝交易号，和商户订单号不能同时为空 | 2014112611001004680073956707 |
| refund_amount | Price | 必选 | 9 | 需要退款的金额，该金额不能大于订单金额,单位为元，支持两位小数 | 200.12 |
| refund_currency | String | 可选 | 8 | 订单退款币种信息 | USD |
| refund_reason | String | 可选 | 256 | 退款的原因说明 | 正常退款 |
| out_request_no | String | 可选 | 64 | 标识一次退款请求，同一笔交易多次退款需要保证唯一，如需部分退款，则此参数必传。 | HZ01RF001 |
| operator_id | String | 可选 | 30 | 商户的操作员编号 | OP001 |
| store_id | String | 可选 | 32 | 商户的门店编号 | NJ_S_001 |
| terminal_id | String | 可选 | 32 | 商户的终端编号 | NJ_T_001 |
| goods_detail | GoodsDetail[] | 可选 | 退款包含的商品列表信息，Json格式。 其它说明详见：“商品明细说明” |
||
| refund_royalty_parameters | OpenApiRoyaltyDetailInfoPojo[] | 可选 | 退分账明细信息 | ||
| org_pid | String | 可选 | 16 | 银行间联模式下有用，其它场景请不要使用； 双联通过该参数指定需要退款的交易所属收单机构的pid; |
2088101117952222 |
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| code | String | 是 | - | 网关返回码,详见文档 | 40004 |
| msg | String | 是 | - | 网关返回码描述,详见文档 | Business Failed |
| sub_code | String | 否 | - | 业务返回码，参见具体的API接口文档 | ACQ.TRADE_HAS_SUCCESS |
| sub_msg | String | 否 | - | 业务返回码描述，参见具体的API接口文档 | 交易已被支付 |
| sign | String | 是 | - | 签名,详见文档 | DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo= |
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| trade_no | String | 必填 | 64 | 2013112011001004330000121536 | 支付宝交易号 |
| out_trade_no | String | 必填 | 64 | 商户订单号 | 6823789339978248 |
| buyer_logon_id | String | 必填 | 100 | 用户的登录id | 159****5620 |
| fund_change | String | 必填 | 1 | 本次退款是否发生了资金变化 | Y |
| refund_fee | Price | 必填 | 11 | 退款总金额 | 88.88 |
| refund_currency | String | 选填 | 8 | 退款币种信息 | USD |
| gmt_refund_pay | Date | 必填 | 32 | 退款支付时间 | 2014-11-27 15:45:57 |
| refund_detail_item_list | TradeFundBill | 选填 | 退款使用的资金渠道 | ||
| store_name | String | 选填 | 512 | 交易在支付时候的门店名称 | 望湘园联洋店 |
| buyer_user_id | String | 必填 | 28 | 买家在支付宝的用户id | 2088101117955611 |
| refund_preset_paytool_list | PresetPayToolInfo | 选填 | 退回的前置资产列表 | ||
| refund_charge_amount | String | 选填 | 11 | 本次退款针对收款方的退收费金额； 默认不返回该信息，需与支付宝约定后配置返回； |
8.88 |
| refund_settlement_id | String | 选填 | 64 | 退款清算编号，用于清算对账使用； 只在银行间联交易场景下返回该信息； |
2018101610032004620239146945 |
| present_refund_buyer_amount | String | 选填 | 11 | 本次退款金额中买家退款金额 | 88.88 |
| present_refund_discount_amount | String | 选填 | 11 | 本次退款金额中平台优惠退款金额 | 88.88 |
| present_refund_mdiscount_amount | String | 选填 | 11 | 本次退款金额中商家优惠退款金额 | 88.88 |