Void

Voids a confirmed payment. By calling this API, you can void a confirmed payment if payment confirmation and capture are separated after requesting payment. If the payment is completed after capture, you cannot void the payment with this endpoint and must process a refund.

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

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

None

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" \
     https://sandbox-api-pay.line.me/v2/payments/orders/merchant_test_order_1/void

Name	Type	Description	Included
`returnCode`	String	Result code. When the API call is successful, the value `0000` is returned. The other result codes are error codes. For more information, see Result code.
`returnMessage`	String	Result message. For more information on result messages, see Result code.