PaymentStateSnapshot — @gj-kit/toss-payments

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

Verified import example

import { PaymentStateSnapshot } from '@gj-kit/toss-payments/server';

Signature, parameters, and return type

/**
 * 저장·로그하기 안전한 결제 상태 요약.
 *
 * Payment.secret, Payment.raw, 카드/계좌 상세 및 취소 사유는 포함하지 않는다.
 */
interface PaymentStateSnapshot {
    /** 영속 스키마 진화를 위한 고정 버전. */
    readonly schemaVersion: 1;
    readonly paymentKey: PaymentKey;
    readonly orderId: OrderId;
    readonly status: PaymentStatus;
    readonly lifecycle: PaymentLifecycle;
    readonly totalAmount: number;
    readonly balanceAmount: number;
    readonly lastTransactionKey: string | null;
    /** totalAmount - balanceAmount. 비정상 응답에서는 음수일 수 있으며 consistencyIssues에 남는다. */
    readonly canceledAmount: number;
    readonly amountState: PaymentAmountState;
    readonly hasPendingCancellation: boolean;
    readonly hasAbortedCancellation: boolean;
    /** 현재 스냅샷에서 새 취소 요청을 시도할 수 있는지에 대한 보수적 힌트. */
    readonly isCancelable: boolean;
    /** 입금 전·비동기 취소 진행 중을 제외하고 부분취소가 가능한지에 대한 보수적 힌트. */
    readonly isPartiallyCancelable: boolean;
    readonly cancels: readonly PaymentCancelTransactionSnapshot[];
    readonly consistencyIssues: readonly PaymentStateConsistencyIssue[];
}

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: ./server
• Source: GitHub