Skip to content

TossServerClient — @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 { 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>;
}

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