Skip to content

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

import { RefundEntitlement } from '@gj-kit/toss-payments/server';
/** custom 정책이 반환하는 누적 환불 entitlement. 현재 실행액은 기존 환불을 차감해 계산한다. */
type RefundEntitlement = {
readonly kind: "rate";
readonly rateBps: number;
readonly reason?: string;
readonly details?: Readonly<Record<string, RefundCalculationDetail>>;
} | {
readonly kind: "amount";
/** 이번 환불액이 아니라 정책상 누적 환불 가능 총액. */
readonly amount: number;
readonly reason?: string;
readonly details?: Readonly<Record<string, RefundCalculationDetail>>;
};

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