Skip to content

summarizePaymentState — @gj-kit/toss-payments

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

import { summarizePaymentState } from '@gj-kit/toss-payments/server';
/**
* Payment에서 민감 필드를 제거한 현재 상태 스냅샷을 만든다.
*
* Accepts the structural {@link PaymentStateInput} (the eight fields the summary actually
* reads) rather than a full `Payment`, so app-owned reduced payment views can produce
* snapshots too. Full `Payment` values remain assignable unchanged — the explicit
* `| Payment` union member keeps fresh inline full-`Payment` literals free of
* excess-property errors.
*/
declare function summarizePaymentState(payment: PaymentStateInput | Payment): PaymentStateSnapshot;

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