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

Verified import example

import { CancelablePayment } from '@gj-kit/toss-payments/server';

Signature, parameters, and return type

/**
 * 결제 취소 — 조회 → asCancelable → 실행 3단계 강제.
 *
 * paymentKey 문자열이나 Payment로 바로 취소하는 API는 존재하지 않는다 — asCancelable
 * 검증 통과가 브랜드 획득의 유일한 경로이고, 실행은 kind 내로잉 없이는 컴파일 에러다.
 */
/**
 * asCancelable을 통과해야만 얻는 3-변형 판별 유니언.
 *
 * 취소 가능 상태 집합 DONE|PARTIAL_CANCELED|WAITING_FOR_DEPOSIT는 **비공식 유도**다 —
 * 문서는 집합을 명시적으로 열거하지 않으며, DONE 취소 가능 명시 + "가상계좌 입금 전에는
 * 일반 결제와 똑같이 취소" 서술 + 부분취소 잔액 흐름에서 유도했다. 서버 정책 변경 시
 * 과잉/과소 차단 가능성이 있다 (설계 문서 부록 A).
 */
type CancelablePayment = SettledCancelable | DepositedVaCancelable | AwaitingDepositCancelable;

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.

Release context

• Package: @gj-kit/toss-payments
• Version: 0.6.1
• Public entry: ./server
• Source: GitHub