승인 취소
승인된 결제를 취소합니다. 본 API를 호출하면 결제 승인과 매입을 분리한 상태에서 결제를 요청해 승인된 결제를 취소할 수 있습니다. 매입 후 결제가 완료됐다면, 이 엔드포인트로 결제를 취소할 수 없고, 환불 처리를 해야 합니다.
POST /v2/payments/orders/{orderId}/void
Read 타임아웃은 최소 20 초 이상으로 설정하세요.
Request
Response
Path
Name | Length | Description | Required |
|---|---|---|---|
orderId | 100 | 주문 번호. 가맹점에서 주문을 관리하기 위해 생성한 ID를 입력하세요. 입력할 때 URL 인코딩을 적용하세요. |
Query
None
Body
None
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" \
https://sandbox-api-pay.line.me/v2/payments/orders/merchant_test_order_1/void