PaymentStateConsistencyIssue — @gj-kit/toss-payments

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

검증된 import 예제

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

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

type PaymentStateConsistencyIssue = {
    readonly kind: "invalid-amount";
    readonly field: "totalAmount" | "balanceAmount";
    readonly value: number;
    readonly reason: "not-safe-integer" | "negative";
} | {
    readonly kind: "balance-exceeds-total";
    readonly totalAmount: number;
    readonly balanceAmount: number;
} | {
    readonly kind: "zero-balance-with-non-canceled-status";
    readonly status: Exclude<PaymentStatus, "CANCELED" | "PARTIAL_CANCELED">;
} | {
    readonly kind: "cancellation-status-without-history";
    readonly status: "CANCELED" | "PARTIAL_CANCELED";
} | {
    readonly kind: "canceled-status-with-balance";
    readonly balanceAmount: number;
} | {
    readonly kind: "partial-status-without-canceled-amount";
    readonly totalAmount: number;
    readonly balanceAmount: number;
} | {
    readonly kind: "partial-status-without-effective-cancellation";
} | {
    readonly kind: "paid-status-with-canceled-amount";
    readonly totalAmount: number;
    readonly balanceAmount: number;
} | {
    readonly kind: "full-cancellation-status-mismatch";
    readonly status: Exclude<PaymentStatus, "CANCELED" | "PARTIAL_CANCELED">;
} | {
    readonly kind: "completed-cancel-status-mismatch";
    readonly status: Exclude<PaymentStatus, "CANCELED" | "PARTIAL_CANCELED">;
} | {
    readonly kind: "latest-cancel-balance-mismatch";
    readonly transactionKey: string;
    readonly cancelRefundableAmount: number;
    readonly paymentBalanceAmount: number;
} | {
    readonly kind: "duplicate-cancel-transaction-key";
    readonly transactionKey: string;
};

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

Release context

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