WebhookHandlers — @gj-kit/toss-payments

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

검증된 import 예제

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

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

/**
 * 핸들러 키 = 구독 가능한 전체 이벤트.
 * `onBillingApproved`는 존재하지 않는다 — 토스가 빌링 승인 웹훅을 제공하지 않는다
 * (BILLING_DELETED만 존재). approve 반환값 + getPayment 재확인이 완결 신호다.
 */
interface WebhookHandlers {
    onDepositCallback?: (w: SecretVerified) => void | Promise<void>;
    onPaymentStatusChanged?: (w: Unverified & {
        event: PaymentStatusChangedEvent;
    }) => void | Promise<void>;
    /** 해외 간편결제 전용. */
    onCancelStatusChanged?: (w: Unverified & {
        event: CancelStatusChangedEvent;
    }) => void | Promise<void>;
    onBillingDeleted?: (w: Unverified & {
        event: BillingDeletedEvent;
    }) => void | Promise<void>;
    onMethodUpdated?: (w: Unverified & {
        event: MethodUpdatedEvent;
    }) => void | Promise<void>;
    onCustomerStatusChanged?: (w: Unverified & {
        event: CustomerStatusChangedEvent;
    }) => void | Promise<void>;
    onOrderPaymentStatusChanged?: (w: Unverified & {
        event: OrderPaymentStatusChangedEvent;
    }) => void | Promise<void>;
    onPayoutChanged?: (w: SignatureVerified & {
        event: PayoutChangedEvent;
    }) => void | Promise<void>;
    onSellerChanged?: (w: SignatureVerified & {
        event: SellerChangedEvent;
    }) => void | Promise<void>;
    onArsReservationChanged?: (w: Unverified & {
        event: ArsReservationChangedEvent;
    }) => void | Promise<void>;
    /** 전방 호환 — 새 이벤트가 와도 여기로 흐른다. */
    onUnknownEvent?: (w: Unverified & {
        event: UnknownWebhookEvent;
    }) => void | Promise<void>;
}

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

Release context

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

구현 주석

핸들러 키 = 구독 가능한 전체 이벤트. onBillingApproved는 존재하지 않는다 — 토스가 빌링 승인 웹훅을 제공하지 않는다 (BILLING_DELETED만 존재). approve 반환값 + getPayment 재확인이 완결 신호다.