결제 취소 요청을 무효 처리하는 API예요. 취소 요청이 승인 또는 거절되기 전에만 철회가 가능해요.
API 엔드포인트
PUT
https://api.bootapi.com/v1/order/cancel/:id/withdrawBasic Auth취소 요청이 '대기' 상태(status: 0)일 때만 철회가 가능해요. 이미 승인/거절된 요청은 철회할 수 없어요.
요청 파라미터
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
order_cancel_request_history_id |
String | 필수 | 취소 요청 고유 번호 (URL 파라미터) |
코드 예제
const { BootpayCommerce } = require('@bootpay/backend-js');
const commerce = new BootpayCommerce({
client_key: '{client_key}',
secret_key: '{secret_key}'
});
const response = await commerce.orderCancel.withdraw({
order_cancel_request_history_id: '687a1b2c3d4e5f6789012345'
});
console.log(response);javascriptfrom bootpay_backend.commerce import BootpayCommerce
commerce = BootpayCommerce('{client_key}', '{secret_key}')
response = commerce.order_cancel.withdraw({
'order_cancel_request_history_id': '687a1b2c3d4e5f6789012345'
})
print(response)pythonuse Bootpay\ServerPhp\BootpayCommerceApi;
$commerce = new BootpayCommerceApi('{client_key}', '{secret_key}');
$response = $commerce->orderCancel->withdraw([
'order_cancel_request_history_id' => '687a1b2c3d4e5f6789012345'
]);
print_r($response);phpimport kr.co.bootpay.store.BootpayStore;
import kr.co.bootpay.store.model.request.TokenPayload;
TokenPayload tp = new TokenPayload("{client_key}", "{secret_key}");
BootpayStore commerce = new BootpayStore(tp);
HashMap<String, Object> params = new HashMap<>();
params.put("order_cancel_request_history_id", "687a1b2c3d4e5f6789012345");
HashMap<String, Object> response = commerce.orderCancel.withdraw(params);
System.out.println(response);javacommerce = BootpayStore::Api.new('{client_key}', '{secret_key}')
response = commerce.order_cancel_withdraw(
order_cancel_request_history_id: '687a1b2c3d4e5f6789012345'
)
puts responserubyimport "github.com/bootpay/backend-go/v2"
commerce := bootpay.NewCommerceApi("{client_key}", "{secret_key}")
response, err := commerce.OrderCancel.Withdraw(bootpay.OrderCancelWithdrawParams{
OrderCancelRequestHistoryId: "687a1b2c3d4e5f6789012345",
})
fmt.Println(response)gousing Bootpay.Commerce;
var commerce = new BootpayCommerceApi("{client_key}", "{secret_key}");
var response = await commerce.OrderCancel.Withdraw(new {
order_cancel_request_history_id = "687a1b2c3d4e5f6789012345"
});
Console.WriteLine(response);csharp응답
{
"id": "687a1b2c3d4e5f6789012345",
"order_id": "68707c59b0eacea5cd974efd",
"status": 3,
"withdrawn_at": "2025-07-11T03:30:00Z"
}json에러 코드
공통 에러
인증·권한 관련 에러는 에러 코드표를 참고해요.
| 코드 | 메시지 | 대처 방법 |
|---|---|---|
ORDER_CANCEL_NOT_REQUESTED |
취소 요청 상태가 아니에요. | 주문의 취소 요청 상태를 확인해요 |
ORDER_CANCEL_REQUEST_WITHDRAW_UNABLE |
취소 요청 철회가 불가능해요. | 요청 상태를 확인해요 |
취소 요청 고유 번호는 주문 상세 조회 또는 취소 요청 목록 조회 API를 통해 확인할 수 있어요.
