Refund

Refunds a payment that has been settled.

POST /v3/payments/{transactionId}/refund

Set the read timeout to at least 20 seconds.

Request

Response

Path

Name	Description	Required
`transactionId`	Payment transaction ID. For more information, see the Transaction ID.

Query

None

Body

Name	Type	Description	Required
`refundAmount`	number	Refund amount. You can enter any amount in this field for a partial refund. If you omit the field, the full payment amount is refunded.

Headers

Content-Type
X-LINE-Authorization
X-LINE-Authorization-Nonce
X-LINE-ChannelId
X-LINE-MerchantDeviceProfileId

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-Authorization-Nonce: GENERATED_NONCE" \
     -H "X-LINE-Authorization: PROCESSED_SIGNATURE" \
     -H "X-LINE-MerchantDeviceProfileId: YOUR_DEVICE_PROFILE_ID"\
     -d '{ "refundAmount": 1000 }'
     https://sandbox-api-pay.line.me/v3/payments/2018082512345678910/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. The other result codes are error codes, and if the codes `1900`, `1902`, or `1999` are returned, you may retry the API call. For more information, see Result code.
`returnMessage`	String		Result message. For more information on result messages, see Result code.