콘텐츠로 이동

TossServerClient — @gj-kit/toss-payments

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

import { TossServerClient } from '@gj-kit/toss-payments/server';
interface TossServerClient<E extends Env = Env, K extends KeyKind = KeyKind> {
readonly env: E;
readonly keyKind: K;
getPayment(key: PaymentKey, options?: Pick<CallOptions<E>, 'signal'>): Promise<Result<Payment, LookupError$1>>;
/** DEPOSIT_CALLBACK에는 paymentKey가 없다 — orderId 재조회가 1급 경로. */
getPaymentByOrderId(orderId: OrderId, options?: Pick<CallOptions<E>, 'signal'>): Promise<Result<Payment, LookupError$1>>;
readonly cancels: TossCancels<E>;
}

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

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