當交易發生之後一段時間內，由於買家或者賣家的原因需要退款時，賣家可以通過退款介面將支付款退還給買家，平台將在收到退款請求並且驗證成功之後，按照退款規則將支付款按原路退到買家帳號上。
同一筆交易累計提交的退款金額不能超過原始交易總金額。
公用請求參數
參數 | 類型 | 是否必選 | 最大長度 | 描述 | 樣本值 |
app_id | String | 必選 | 32 | 小程式 id | 2014072300007148 |
method | String | 必選 | 128 | 介面名稱 | 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 | 發送請求的時間，格式 | 2014-07-24 03:07:50 |
version | String | 必選 | 3 | 調用的介面版本，固定為：1.0 | 1.0 |
biz_content | String | 必選 | - | 請求參數的集合，最大長度不限，除公用參數外所有請求參數都必須放在這個參數中傳遞，具體參照各產品快速接入文檔 | - |
業務請求參數
參數 | 類型 | 是否必選 | 最大長度 | 描述 | 樣本值 |
refund_amount | String | 必選 | 16 | 退款金額。需要退款的金額，該金額不能大於訂單金額，單位根據業務自行定義，支援兩位小數。 說明 如果正向交易使用了營銷，該退款金額包含營銷金額，平台會按商務規則分配營銷和買家自有資金分別退多少，預設優先退買家的自有資金。如交易總金額 100 美元，使用者支付時使用了 80 美元自有資金和 20 美元無資金流的營銷券，商家實際收款 80 美元。如果首次請求退款 60 美元，則 60 美元全部從商家收款資金扣除退回給使用者自有資產；如果再請求退款 40 美元，則從商家收款資金扣除 20 美元退回使用者資產以及把 20 美元的營銷券退回給使用者（券是否可再使用取決於券的規則配置）。 | 200.12 |
out_trade_nostring | String | 可選 | 64 | 商戶訂單號。訂單支付時傳入的商戶訂單號，商家自訂且保證商家系統中唯一。與平台交易號 trade_no 不能同時為空白。 | 20150320010101001 |
trade_no | String | 可選 | 64 | 平台交易號。和商戶訂單號 out_trade_no 不能同時為空白，兩者同時存在時，優先取值trade_no | 2014112611001004680073956707 |
refund_reason | String | 可選 | 256 | 退款原因說明。商家自訂，將在會在商戶和使用者的 pc 退款賬單詳情中展示 | 正常退款 |
out_request_no | String | 可選 | 64 | 退款請求號。標識一次退款請求，需要保證在交易號下唯一，如需部分退款，則此參數必傳。 說明 針對同一次退款請求，如果調用介面失敗或異常了，重試時需要保證退款請求號不能變更，防止該筆交易重複退款。平台會保證同樣的退款請求號多次請求只會退一次。 部分退款時必選 | HZ01RF001 |
buyer_open_id | String | 必選 | 128 | 買家使用者唯一標識 | 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 |
body | string | 可選 | 128 | 訂單附加資訊。 如果請求時傳遞了該參數，將在非同步通知、對賬單中原樣返回，同時會在商戶和使用者的 pc 賬單詳情中作為交易描述展示 | iPhone6 16G |
常見請求樣本
預設樣本：
curl 'https://xxx/gateway.do?charset=UTF-8&method=trade.refund&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=RSA2×tamp=${now}' \
-F 'biz_content={
"out_trade_no":"20150320010101001",
"trade_no":"2014112611001004680073956707",
"refund_amount":"200.12",
"refund_reason":"正常退款",
"out_request_no":"HZ01RF001",本樣本僅供參考。
公用響應參數
參數 | 類型 | 是否必選 | 最大長度 | 描述 | 樣本值 |
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= |
業務響應參數
參數 | 類型 | 是否必選 | 最大長度 | 描述 | 樣本值 |
out_trade_no | String | 必選 | 64 | 商戶訂單號 | 20150423001001 |
trade_no | String | 必選 | 64 | Payme 交易號 | 2015042321001004720200028594 |
buyer_open_id | String | 必選 | 100 | 買家使用者唯一標識 | 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 |
refund_fee | String | 必選 | 11 | 退款總金額。單位根據業務自行定義。 指該筆交易累計已經退款成功的金額 | 88.88 |
響應樣本
{
"trade_refund_response": {
"code": "10000",
"msg": "Success",
"trade_no": "2013112011001004330000121536",
"out_trade_no": "6823789339978248",
"refund_fee": "88.88",
"buyer_open_id": "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}