콘텐츠로 이동

RefundQuoteInput — @gj-kit/toss-payments

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

import { RefundQuoteInput } from '@gj-kit/toss-payments/server';
/**
* 모든 정책 quote의 공통 입력.
*
* basisAmount/alreadyRefundedAmount/expectedBalanceAmount는 프로젝트 장부가 제공한다.
* 라이브러리는 expectedBalanceAmount를 최신 Payment.balanceAmount와 대조하므로 외부
* 부분취소나 장부 drift가 있으면 계산 전에 멈춘다.
*/
interface RefundQuoteInput {
readonly payment: Payment;
/** 정책 비율을 곱할 프로젝트 장부 기준 금액. */
readonly basisAmount: number;
/** 프로젝트 장부에 provider 완료로 확정된 누적 환불액. */
readonly alreadyRefundedAmount: number;
/** 프로젝트 장부가 기대하는 현재 Toss 환불 가능 잔액. */
readonly expectedBalanceAmount: number;
/** 정책을 평가한 시각. 테스트 가능한 명시 입력이며 quote에 ISO로 남는다. */
readonly evaluatedAt: Date;
/**
* 프로젝트 상태가 반드시 다시 평가되어야 하는 더 이른 경계(선택).
* 예: 잔여 달력 일수는 다음 현지 자정. 정책 TTL/시간 구간 경계와의 최솟값이 적용된다.
*/
readonly validUntil?: Date;
}

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

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

모든 정책 quote의 공통 입력.

basisAmount/alreadyRefundedAmount/expectedBalanceAmount는 프로젝트 장부가 제공한다. 라이브러리는 expectedBalanceAmount를 최신 Payment.balanceAmount와 대조하므로 외부 부분취소나 장부 drift가 있으면 계산 전에 멈춘다.