Skip to content

WidgetPaymentRequest — @gj-kit/toss-payments

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

import { WidgetPaymentRequest } from '@gj-kit/toss-payments/browser';
interface WidgetPaymentRequest {
/** 스마트 생성자 산출물만 — 서버 createOrder가 발급한 값은 JSON 경계에서 orderId(raw)로 재파싱한다. */
readonly orderId: OrderId;
readonly orderName: OrderName;
/** origin을 포함한 완전 URL (SDK 문서 요구 — 런타임 검증). */
readonly successUrl: string;
readonly failUrl: string;
readonly customerEmail?: string;
readonly customerName?: string;
readonly customerMobilePhone?: string;
readonly taxFreeAmount?: number;
/** 최대 5쌍 (문서: metadata 최대 5개 key-value — 런타임 검증). */
readonly metadata?: Readonly<Record<string, string>>;
}

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