CancelablePayment — @gj-kit/toss-payments

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

검증된 import 예제

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

시그니처, 매개변수, 반환 타입

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

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

Release context

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

구현 주석

asCancelable을 통과해야만 얻는 3-변형 판별 유니언.

취소 가능 상태 집합 DONE|PARTIAL_CANCELED|WAITING_FOR_DEPOSIT는 비공식 유도다 — 문서는 집합을 명시적으로 열거하지 않으며, DONE 취소 가능 명시 + “가상계좌 입금 전에는 일반 결제와 똑같이 취소” 서술 + 부분취소 잔액 흐름에서 유도했다. 서버 정책 변경 시 과잉/과소 차단 가능성이 있다 (설계 문서 부록 A).