콘텐츠로 이동

BillingAuthRequest — @gj-kit/toss-payments

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

import { BillingAuthRequest } from '@gj-kit/toss-payments/browser';
/**
* 빌링 등록 인증창 — SDK payment({customerKey}).requestBillingAuth 래퍼.
*
* 빌링은 API 개별 키(ck) 전용 — 위젯 키(gck)는 컴파일 에러.
* customer는 WidgetCustomerKey만 — ANONYMOUS는 파라미터 타입에서 배제된다
* (빌링은 고유 customerKey 전제, SDK 문서에 ANONYMOUS 빌링 언급 없음 — 연구문서 §빌링).
*/
/**
* SDK v2.7.1 타입 정의로 확정(Phase 0): method 'CARD' | 'TRANSFER' 판별 유니언.
* selectableCardTypes는 CARD 전용 — TRANSFER 쪽은 `?: never`로 변수 경유 전달까지 차단한다.
*/
type BillingAuthRequest = {
readonly method: 'CARD';
/** origin을 포함한 완전 URL — 성공 시 쿼리로 authKey, customerKey가 붙는다. */
readonly successUrl: string;
readonly failUrl: string;
readonly customerName?: string;
readonly customerEmail?: string;
readonly windowTarget?: 'self' | 'iframe';
/** 결제화면에 노출할 카드 타입 — 입력 순서대로 노출, 첫 항목이 기본 선택. */
readonly selectableCardTypes?: readonly ('PERSONAL' | 'CORPORATE')[];
} | {
readonly method: 'TRANSFER';
readonly successUrl: string;
readonly failUrl: string;
readonly customerName?: string;
readonly customerEmail?: string;
readonly windowTarget?: 'self' | 'iframe';
/** 카드 전용 파라미터 (SDK v2.7.1 타입 정합) — TRANSFER에서는 존재 자체가 컴파일 에러. */
readonly selectableCardTypes?: never;
};

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

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

SDK v2.7.1 타입 정의로 확정(Phase 0): method ‘CARD’ | ‘TRANSFER’ 판별 유니언. selectableCardTypes는 CARD 전용 — TRANSFER 쪽은 ?: never로 변수 경유 전달까지 차단한다.