콘텐츠로 이동

PendingBillingAuth — @gj-kit/toss-payments

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

import { PendingBillingAuth } from '@gj-kit/toss-payments/server';
/**
* 빌링(정기결제) — PendingBillingAuth → confirmPendingAuth → issue → BillingProfile → approve.
*
* - authKey/billingKey는 비공개 심볼(비열거)로 봉인 — 공개 필드·JSON 직렬화·스프레드
* 어디에도 노출되지 않는다. 봉인 소실(복제본)은 명시적 런타임 Err.
* - BillingOrder에는 customerKey 필드가 없다 — 봉인 쌍으로만 승인해
* NOT_MATCHES_CUSTOMER_KEY를 구조적으로 방지한다.
* - 갱신 API는 존재하지 않는다("빌링키를 갱신하는 별도 과정은 없습니다") — refresh류
* 메서드 없음. 재발급 = revoke 후 새 인증부터.
* - '빌링 승인 완료 웹훅'은 존재하지 않는다(BILLING_DELETED만 존재) — approve 반환값 +
* getPayment 재확인이 완결 신호다.
*/
interface PendingBillingAuth extends Brand<'PendingBillingAuth'> {
/** 쿼리스트링으로 돌아온 값 — 신뢰 금지. confirmPendingAuth로 세션 값과 대조 전에는 사용 불가. */
readonly returnedCustomerKey: string;
}

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

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

빌링(정기결제) — PendingBillingAuth → confirmPendingAuth → issue → BillingProfile → approve.

  • authKey/billingKey는 비공개 심볼(비열거)로 봉인 — 공개 필드·JSON 직렬화·스프레드 어디에도 노출되지 않는다. 봉인 소실(복제본)은 명시적 런타임 Err.
  • BillingOrder에는 customerKey 필드가 없다 — 봉인 쌍으로만 승인해 NOT_MATCHES_CUSTOMER_KEY를 구조적으로 방지한다.
  • 갱신 API는 존재하지 않는다(“빌링키를 갱신하는 별도 과정은 없습니다”) — refresh류 메서드 없음. 재발급 = revoke 후 새 인증부터.
  • ’빌링 승인 완료 웹훅’은 존재하지 않는다(BILLING_DELETED만 존재) — approve 반환값 + getPayment 재확인이 완결 신호다.