CancelStatusChangedEvent — @gj-kit/toss-payments

@gj-kit/toss-payments/webhook에서 공개하는 interface입니다. package version 0.6.1의 release declaration을 그대로 표시합니다.

검증된 import 예제

import { CancelStatusChangedEvent } from '@gj-kit/toss-payments/webhook';

시그니처, 매개변수, 반환 타입

/**
 * 해외 간편결제(PayPal 등) 전용 — 국내 결제 취소에는 발송되지 않는다(문서).
 *
 * data는 문서상 'Cancel 객체'이며 상세 필드 구성은 열린 질문이다 — 문서화된 Cancel 필드
 * 목록에 paymentKey/orderId가 없어 **nullable**로 둔다(필수 요구 시 정상 웹훅이 UNKNOWN
 * 강등). 판별 기준은 cancelStatus만이다. Phase 5 실측 후 재협착 예정.
 */
interface CancelStatusChangedEvent {
    readonly envelope: 'legacy';
    readonly eventType: 'CANCEL_STATUS_CHANGED';
    readonly createdAt: string;
    readonly data: {
        /** 문서 근거 없음(Cancel 객체 필드 아님) — 있으면 refetch 1순위 키로만 활용. */
        readonly paymentKey: string | null;
        /** 문서 근거 없음(Cancel 객체 필드 아님) — 있으면 refetch 2순위 키로만 활용. */
        readonly orderId: string | null;
        readonly cancelStatus: 'IN_PROGRESS' | 'DONE' | 'ABORTED';
        readonly cancelRequestId: string | null;
        /** Cancel 객체의 취소 건 구분 키(문서) — 최대 64자, nullable 수용. */
        readonly transactionKey: string | null;
    };
}

이 선언은 매개변수, optionality, 제네릭, 반환값, 공개 union/type 계약의 정본입니다. 호출 전 필요한 환경·권한·오류 경계는 패키지 Golden path와 이 subpath의 import 조건을 함께 확인하세요.

Release context

• 패키지: @gj-kit/toss-payments
• 버전: 0.6.1
• 공개 entry: ./webhook
• 소스: GitHub

구현 주석

해외 간편결제(PayPal 등) 전용 — 국내 결제 취소에는 발송되지 않는다(문서).

data는 문서상 ’Cancel 객체’이며 상세 필드 구성은 열린 질문이다 — 문서화된 Cancel 필드 목록에 paymentKey/orderId가 없어 nullable로 둔다(필수 요구 시 정상 웹훅이 UNKNOWN 강등). 판별 기준은 cancelStatus만이다. Phase 5 실측 후 재협착 예정.