Skip to content

CancelTransaction — @gj-kit/toss-payments

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

import { CancelTransaction } from '@gj-kit/toss-payments/server';
interface CancelTransaction {
readonly transactionKey: string;
readonly cancelAmount: number;
readonly cancelReason: string;
readonly taxFreeAmount: number;
readonly taxExemptionAmount: number;
/** (응답) 이 취소 후 남은 환불 가능액 — 취소 요청 파라미터의 refundableAmount와 이름만 같다. */
readonly refundableAmount: number;
readonly transferDiscountAmount: number;
readonly easyPayDiscountAmount: number;
readonly canceledAt: string;
readonly receiptKey: string | null;
/** 해외 간편결제(PayPal)는 IN_PROGRESS로 시작하는 비동기 취소 — CANCEL_STATUS_CHANGED 웹훅으로 완결. */
readonly cancelStatus: 'DONE' | 'IN_PROGRESS' | 'ABORTED';
/** 비동기 취소 전용. */
readonly cancelRequestId: string | null;
}

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