DepositCallbackEvent — @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 { DepositCallbackEvent } from '@gj-kit/toss-payments/webhook';

Signature, parameters, and return type

/**
 * 가상계좌 입금/입금취소 통지 — 원문은 eventType 필드가 없는 평탄 구조라
 * 파서가 구조 판별 후 eventType을 합성한다.
 *
 * ⚠ paymentKey가 없다 — orderId가 1급 키다(승인 시 orderId↔secret 저장 필수).
 * 원문의 secret은 검증에 소비된 뒤 이벤트에서 제거된다(로그 유출 방지) — 타입에도 없다.
 */
interface DepositCallbackEvent {
    readonly envelope: 'flat';
    readonly eventType: 'DEPOSIT_CALLBACK';
    /** ±hh:mm 오프셋 형식 — 구형(legacy) 이벤트의 마이크로초 형식과 다르다(문서 예시). */
    readonly createdAt: string;
    readonly orderId: string;
    /** DONE → WAITING_FOR_DEPOSIT 역전이(입금 오류) 케이스가 존재한다. */
    readonly status: 'WAITING_FOR_DEPOSIT' | 'DONE' | 'CANCELED' | 'PARTIAL_CANCELED';
    readonly transactionKey: string;
}

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