SerializedPaymentStateSnapshot — @gj-kit/toss-payments

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

Verified import example

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

Signature, parameters, and return type

/**
 * Brand-free, JSON-ready form of {@link PaymentStateSnapshot}.
 *
 * Identical field-for-field, except `paymentKey`/`orderId` are plain `string`s — safe to put
 * in a response DTO, a queue message or a jsonb column without exporting the branded id types
 * across your provider boundary. Every other field is already a JSON primitive, a plain
 * object array, or `null`. A `PaymentStateSnapshot` is assignable to this type (brands are
 * strings underneath); the reverse direction must go through
 * {@link parsePaymentStateSnapshot}.
 *
 * JSON caveat: a snapshot whose `consistencyIssues` include `invalid-amount` with
 * `reason: 'not-safe-integer'` may carry non-finite numbers (`NaN`/`Infinity`), which
 * `JSON.stringify` silently turns into `null` — the later parse then rejects the value
 * honestly instead of resurrecting a fake amount. Check `consistencyIssues` before
 * persisting a snapshot as JSON.
 */
interface SerializedPaymentStateSnapshot {
    readonly schemaVersion: 1;
    readonly paymentKey: string;
    readonly orderId: string;
    readonly status: PaymentStatus;
    readonly lifecycle: PaymentLifecycle;
    readonly totalAmount: number;
    readonly balanceAmount: number;
    readonly lastTransactionKey: string | null;
    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: .
• Source: GitHub