해당 주문에 대한 결제 취소 요청 내역을 조회해요. 조회된 요청은 승인, 거절, 철회 등의 처리에 활용돼요.
API 엔드포인트
GET
https://api.bootapi.com/v1/order/cancel-refund/cancelBasic Auth취소 요청 상태
| 값 | 상태 | 설명 |
|---|---|---|
| 0 | 대기 | 취소 요청이 접수되어 승인 대기 중 |
PROCESS_DUPLICATED |
이미 처리된 요청이에요 | 관리자가 취소 요청을 승인함 |
| 2 | 거절 | 관리자가 취소 요청을 거절함 |
| 3 | 철회 | 사용자가 취소 요청을 철회함 |
요청 파라미터
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
order_id |
String | 선택 | 부트페이에서 발급한 주문 고유 번호 |
order_number |
String | 선택 | 주문 생성 시 생성한 주문 번호 (상점 고유 식별자) |
order_id 또는 order_number 중 하나를 필수로 지정해야 해요.
코드 예제
const { BootpayCommerce } = require('@bootpay/backend-js');
const commerce = new BootpayCommerce({
client_key: '{client_key}',
secret_key: '{secret_key}'
});
const response = await commerce.orderCancel.list({
order_number: 'ORDER_12345'
});
console.log(response);javascriptfrom bootpay_backend.commerce import BootpayCommerce
commerce = BootpayCommerce('{client_key}', '{secret_key}')
response = commerce.order_cancel.list({
'order_number': 'ORDER_12345'
})
print(response)pythonuse Bootpay\ServerPhp\BootpayCommerceApi;
$commerce = new BootpayCommerceApi('{client_key}', '{secret_key}');
$response = $commerce->orderCancel->list([
'order_number' => 'ORDER_12345'
]);
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_number", "ORDER_12345");
HashMap<String, Object> response = commerce.orderCancel.list(params);
System.out.println(response);javacommerce = BootpayStore::Api.new('{client_key}', '{secret_key}')
response = commerce.order_cancel_list(
order_number: 'ORDER_12345'
)
puts responserubyimport "github.com/bootpay/backend-go/v2"
commerce := bootpay.NewCommerceApi("{client_key}", "{secret_key}")
response, err := commerce.OrderCancel.List(bootpay.OrderCancelListParams{
OrderNumber: "ORDER_12345",
})
fmt.Println(response)gousing Bootpay.Commerce;
var commerce = new BootpayCommerceApi("{client_key}", "{secret_key}");
var response = await commerce.OrderCancel.List(new {
order_number = "ORDER_12345"
});
Console.WriteLine(response);csharp응답
성공 응답
[
{
"id": "687a1b2c3d4e5f6789012345",
"order_id": "68707c59b0eacea5cd974efd",
"cancel_id": "CANCEL_001",
"cancel_price": 10000,
"cancel_message": "고객 요청에 의한 취소",
"cancel_requester": "홍길동",
"status": 0,
"created_at": "2025-07-11T02:52:09Z"
},
{
"id": "687a1b2c3d4e5f6789012346",
"order_id": "68707c59b0eacea5cd974efd",
"cancel_id": "CANCEL_002",
"cancel_price": 5000,
"cancel_message": "상품 불량",
"cancel_requester": "김철수",
"status": 1,
"approved_at": "2025-07-11T03:30:00Z",
"created_at": "2025-07-11T03:00:00Z"
}
]json에러 코드
공통 에러
인증·권한 관련 에러는 에러 코드표를 참고해요.
| 코드 | 메시지 | 대처 방법 |
|---|---|---|
ORDER_NOT_FOUND |
주문내역을 찾지 못했어요. | order_id를 확인해요 |
