Void

Voids payment confirmation. If payment confirmation and capture have been separated, call this API to void the confirmed payment. Once a payment has been captured, it can no longer be voided and must be refunded instead.

POST /v3/payments/authorizations/{transactionId}/void

Set the read timeout to at least 20 seconds.

Request

Response

Path

Name	Description	Required
`transactionId`	Payment transaction ID. You may need to process the transaction ID as a string depending on the platform. For more information, see the Transaction ID.

Query

None

Body

None

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" \
     https://sandbox-api-pay.line.me/v3/payments/authorizations/2018082512345678910/void

Name	Type	Length	Description	Included
`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.