Skip to content

TossClientOptions — @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 { TossClientOptions } from '@gj-kit/toss-payments/server';
interface TossClientOptions {
/** 기본 globalThis.fetch (Node 20+ 내장). 테스트에서는 모킹 주입 지점. */
readonly fetch?: typeof fetch;
/** 기본 https://api.tosspayments.com */
readonly baseUrl?: string;
/**
* live 키로 공식 API 호스트 외 주소를 사용하는 위험한 탈출구.
* 일반 운영에서는 절대 켜지 말 것.
*/
readonly dangerouslyAllowCustomLiveBaseUrl?: true;
/** 기본 30_000ms — AbortSignal.timeout과 호출자 signal을 결합해 적용한다(재시도 시 시도별 독립 적용). */
readonly timeoutMs?: number;
/** §3.2 아웃바운드 req/res 증거 기록 — 기본 꺼짐. 시도 1건 = AuditEntry 1건. */
readonly audit?: AuditOptions;
/** §3.4 자동 재시도 — 기본 꺼짐(미설정 시 1회 시도, 현행 동작과 동일). */
readonly retry?: RetryOptions;
/** §3.3 이벤트 버스 — 'api.call' 전용(논리 요청당 최종 1회). createTossEvents 산출물만 발행이 흐른다. */
readonly events?: TossEvents;
/** 취소 transport 실패 티켓을 프로세스 재시작 후에도 재실행하기 위한 영속 저장소. */
readonly cancelRetries?: CancelRetryStore;
}

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