Refund

Refunds payments that are requested or captured.

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

Set the read timeout to at least 20 seconds.

Request

Response

Path

Name	Length	Description	Required
`orderId`	100	Order ID. Enter the ID generated by the merchant to manage orders. Apply URL encoding when entering the ID.

Query

None

Body

Name	Type	Description	Required
`refundAmount`	number	Refund amount. Specify an amount for a partial refund. If this field is omitted, the full paid amount is refunded.
`promotionRestriction`	object	Promotion restriction information. Enter the price for products where promotions cannot be applied due to laws or regulations. If this field is specified, partial refunds are not supported and the full amount will be refunded.

Headers

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

For more information, see Request header.

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		Result information
`returnCode`	String	4	Result code. When the API call is successful, the code `0000` is returned. Other result codes indicate errors. If you attempt a partial refund on a transaction involving coupons or fees, error code `1115` may be returned. In that case, the refund must be processed as a full refund. If a full refund is not possible or other issues arise, request technical support.
`returnMessage`	String		Result message. For more information on result messages, see Result code.