退款

完成付款請求或請款付款的退款。

POST /v2/payments/orders/{orderId}/refund

請將Read逾時設定為至少20秒以上。

Request

Response

Path

Name	Length	Description	Required
`orderId`	100	訂單號碼。輸入商家生成的用於管理訂單的ID。輸入時套用URL編碼。

Query

None

Body

Name	Type	Description	Required
`refundAmount`	number	退款金額。請輸入部分退款金額。若省略此欄位，將退還已付款的全部金額。
`promotionRestriction`	object	促銷限制訊息。請輸入因法律、規則等原因不適用促銷的產品金額。指定此欄位時，將不支援部分退款，只能全額退款。

Headers

Content-Type
X-LINE-ChannelId
X-LINE-ChannelSecret
X-LINE-MerchantDeviceProfileId
X-LINE-MerchantDeviceType

詳細內容請參閱請求標頭。

Request examples

bash

curl -X POST \
     -H "Content-Type: application/json" \
     -H "X-LINE-ChannelId: YOUR_CHANNEL_ID" \
     -H "X-LINE-ChannelSecret: YOUR_CHANNEL_SECRET" \
     -H "X-LINE-MerchantDeviceProfileId: YOUR_DEVICE_PROFILE_ID" \
     -d '{ "refundAmount": 100 }' \
      https://sandbox-api-pay.line.me/v2/payments/orders/merchant_test_order_1/refund

Name	Type	Length	Description
`info`	Object		結果訊息
`returnCode`	String	4	結果程式碼。API呼叫成功時，傳回`0000`代碼。其他結果代碼是錯誤代碼。使用優惠券交易或包含手續費的交易進行部分退款時，可能會傳回`1115`錯誤。這種情況，需要採取全額退款處理。如果無法全額退款或有其他問題，請聯絡技術支援尋求協助。
`returnMessage`	String		結果訊息。結果訊息請參閱結果程式碼。