CancelStatusChangedEvent — @gj-kit/toss-payments

A public interface from @gj-kit/toss-payments/webhook. The signature below is taken directly from the 0.6.1 release declaration.

Verified import example

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

Signature, parameters, and return type

/**
 * 해외 간편결제(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;
    };
}

This declaration is the source of truth for parameters, optionality, generics, return values, and public union/type contracts. Check the package golden path and this subpath’s import conditions for required environment, permission, and error boundaries before calling it.

Release context

• Package: @gj-kit/toss-payments
• Version: 0.6.1
• Public entry: ./webhook
• Source: GitHub