Skip to content

PaymentLookup — @gj-kit/toss-payments

A public interface from @gj-kit/toss-payments/webhook. The signature below is taken directly from the 0.6.1 release declaration.

import { PaymentLookup } from '@gj-kit/toss-payments/webhook';
/**
* {@link Unverified.refetch}가 요구하는 최소 조회 능력 — 구조적 인터페이스.
*
* `@gj-kit/toss-payments/server`의 `TossServerClient`가 그대로 구조 호환된다.
* webhook 엔트리는 Edge 등에서 서버 클라이언트 없이 단독 사용 가능해야 하므로
* server 모듈을 import하지 않고 여기서 구조적으로 정의한다.
*/
interface PaymentLookup {
getPayment(key: PaymentKey, options?: {
readonly signal?: AbortSignal;
}): Promise<Result<Payment, LookupError>>;
getPaymentByOrderId(orderId: OrderId, options?: {
readonly signal?: AbortSignal;
}): Promise<Result<Payment, LookupError>>;
}

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: ./webhook
  • Source: GitHub