Skip to content

DeriveIdempotencyKeyInput — @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.

import { DeriveIdempotencyKeyInput } from '@gj-kit/toss-payments';
/** Input for {@link deriveIdempotencyKey}. */
interface DeriveIdempotencyKeyInput {
/** Logical operation name, e.g. `'billing_initial_charge'` or `'subscription_renewal'`. */
readonly operation: string;
/**
* Identity of the logical business event — ids and period markers that make the key
* deterministic (subscription id, period start epoch, quote id, …). Never put raw
* billing/auth keys, card or account numbers here: the key travels in request headers and
* audit logs.
*/
readonly parts: readonly string[];
/**
* Optional attempt discriminator. Omit it for the first submission; supply a fresh value
* (e.g. a UUID) for a *new* attempt after a definitive 4xx, because Toss replays the original
* 4xx for the same key for 15 days. Keep it **absent** when you intend a replay
* (transport failure, `IDEMPOTENT_REQUEST_PROCESSING`).
*/
readonly attempt?: string | undefined;
}

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.

  • Package: @gj-kit/toss-payments
  • Version: 0.6.1
  • Public entry: .
  • Source: GitHub