Skip to content

prepareRefund — @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 { prepareRefund } from '@gj-kit/toss-payments/server';
/**
* 순수 정책 견적을 방금 조회한 취소 가능 결제에 결속한다.
*
* core의 canonical quote.kind를 실행 mode로 사용한다. 잔액·정책 산술 불변식은
* parseRefundQuote가 먼저 검증하며, 서버는 현재 Payment와의 결속만 담당한다.
*/
declare function prepareRefund(target: SettledCancelable, quote: RefundQuote): Result<RefundPreparationFor<"settled">, RefundPlanError>;
declare function prepareRefund(target: DepositedVaCancelable, quote: RefundQuote): Result<RefundPreparationFor<"deposited-virtual-account">, RefundPlanError>;
declare function prepareRefund(target: AwaitingDepositCancelable, quote: RefundQuote): Result<RefundPreparationFor<"awaiting-deposit">, RefundPlanError>;
declare function prepareRefund(target: CancelablePayment, quote: RefundQuote): Result<RefundPreparation, RefundPlanError>;

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