LedgerRefundShortfall — @gj-kit/toss-payments

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

Verified import example

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

Signature, parameters, and return type

/**
 * Sub-classification of a `'provider-below-ledger'` mismatch, present only when the ledger
 * supplied {@link LedgerRefundTarget.requestedAmount}.
 *
 * - `'at-prior-state'` — the provider's confirmed amount equals
 *   `expectedRefundedAmount - requestedAmount` and no cancel is in flight: the provider is
 *   exactly where it was before the reconciling refund request, so that request most likely
 *   never reached it. Replaying the persisted (sealed, idempotent) cancel request is safe.
 * - `'unexplained'` — any other shortfall (or one with cancels still in flight). Do not
 *   auto-replay; escalate.
 */
type LedgerRefundShortfall = "at-prior-state" | "unexplained";

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