결제 취소 요청
결제된 주문에 대해 전체 또는 부분 취소를 요청하는 API입니다.
취소는 상품 기준 또는 금액 기준으로 진행할 수 있으며, 결제 수단과 카드사 정책에 따라 취소가 실패할 수 있습니다.
POST
https://api.bootapi.com/v1/order/cancel
취소 유형
- 전체 취소 - 결제된 전체 금액을 한 번에 취소
- 부분 취소 - 결제 금액 중 일부만 선택하여 취소 (일부 카드사 미지원)
취소 방식
- 상품 기준 - cancel_products로 특정 상품 선택 취소
- 금액 기준 - cancel_price로 금액 지정 취소
유의사항
취소는 매입 완료 후 진행됩니다. 환불은 영업일 기준 3~5일 이내 결제자에게 반환됩니다.
1
Server
SDK 설치
서버에서 API를 호출하기 위해 Backend SDK를 설치합니다.
SDK 설치 및 설정 방법은 토큰 발급 가이드를 참고하세요.
2
Server
취소 요청
주문 번호와 취소 정보를 담아 API를 호출합니다.
요청 필드
필드명
타입
필수
설명
order_numberstring
필수
주문 생성시 생성한 주문 번호 (상점 고유 식별자)
request_cancel_parametersobject
필수
취소 요청 파라미터
cancel_idstring
가맹점 취소 ID (중복 시 에러)
cancel_pricenumber
취소 금액 (0 또는 미지정 시 전액 취소)
cancel_tax_free_pricenumber
취소 비과세 금액
cancel_requesterstring
취소 요청자명
cancel_messagestring
취소 사유
cancel_productsarray
취소할 상품 목록 (product_id, product_option_id)
cancel_immediatelyboolean
즉시 취소 여부 (false: 요청만 진행)
cancel_order_subscription_billsarray
구독 결제건 취소 정보
3
Server
응답 처리
취소 요청 결과가 반환됩니다.
응답 필드
필드명
타입
설명
order_idstring
주문 고유 번호
statusnumber
주문 상태
cancel_statusnumber
취소 상태 (0: 없음, 1: 요청중, 2: 취소완료)