DepositCallbackEvent — @gj-kit/toss-payments

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

검증된 import 예제

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

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

/**
 * 가상계좌 입금/입금취소 통지 — 원문은 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;
}

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

Release context

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

구현 주석

가상계좌 입금/입금취소 통지 — 원문은 eventType 필드가 없는 평탄 구조라 파서가 구조 판별 후 eventType을 합성한다.

⚠ paymentKey가 없다 — orderId가 1급 키다(승인 시 orderId↔secret 저장 필수). 원문의 secret은 검증에 소비된 뒤 이벤트에서 제거된다(로그 유출 방지) — 타입에도 없다.