@tosspayments/tosspayments-sdk 2.2.0 → 2.2.3

package/CHANGELOG.md

@@ -3,6 +3,39 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.2.3](https://github.com/tosspayments/browser-sdk/compare/@tosspayments/tosspayments-sdk@2.2.2...@tosspayments/tosspayments-sdk@2.2.3) (2024-07-17)
+
+
+### Bug Fixes
+
+* **tosspayments-sdk:** loadTossPayments 반환 타입 변경 ([#118](https://github.com/tosspayments/browser-sdk/issues/118)) ([4b16012](https://github.com/tosspayments/browser-sdk/commit/4b1601206ba77856a1fe0c811f01a4a8700a9f53))
+
+
+
+
+
+## [2.2.2](https://github.com/tosspayments/browser-sdk/compare/@tosspayments/tosspayments-sdk@2.2.1...@tosspayments/tosspayments-sdk@2.2.2) (2024-07-17)
+
+
+### Bug Fixes
+
+* **tosspayments-sdk:** PI 버전 업 ([#117](https://github.com/tosspayments/browser-sdk/issues/117)) ([bd416a0](https://github.com/tosspayments/browser-sdk/commit/bd416a0b0407e4a3bdc4bec6379ba99f5120c13a))
+
+
+
+
+
+## [2.2.1](https://github.com/tosspayments/browser-sdk/compare/@tosspayments/tosspayments-sdk@2.2.0...@tosspayments/tosspayments-sdk@2.2.1) (2024-07-08)
+
+
+### Bug Fixes
+
+* **tosspayments-sdk:** 위젯 연동시 필요한 type export ([#116](https://github.com/tosspayments/browser-sdk/issues/116)) ([724501c](https://github.com/tosspayments/browser-sdk/commit/724501c8ad79e395d29b0b11191d6e296d0f8134))
+
+
+
+
+
 # [2.2.0](https://github.com/tosspayments/browser-sdk/compare/@tosspayments/tosspayments-sdk@2.1.0...@tosspayments/tosspayments-sdk@2.2.0) (2024-07-03)
 
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tosspayments/tosspayments-sdk",
   "description": "TossPayments.js Tosspayments SDK.",
-  "version": "2.2.0",
+  "version": "2.2.3",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "types": "types/index.d.ts",
@@ -21,7 +21,7 @@
     "@rollup/plugin-commonjs": "^21.0.1",
     "@rollup/plugin-typescript": "^8.3.0",
     "@tosspayments/sdk-loader": "2.0.1",
-    "@tosspayments/standard-public-interfaces": "^2.0.0",
+    "@tosspayments/standard-public-interfaces": "2.0.6",
     "happy-dom": "^14.12.3",
     "prettier": "^2.0.2",
     "rollup": "^2.60.0",
@@ -38,5 +38,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a07117f1b6f50632b6c7ce46931becddb1cbe69e"
+  "gitHead": "3033873ff3952ec13030ac054ad91626b0da5a59"
 }

package/types/index.d.ts

@@ -1,12 +1,12 @@
 declare function clearTossPayments(): void;
 
-interface WidgetSelectedPaymentMethod<CustomPaymentMethodCode = WidgetsPaymentMethodCode> {
+interface WidgetSelectedPaymentMethod {
     /**
      * 구매자가 결제 UI에서 선택한 결제수단입니다. 예를 들어, 신용・체크카드를 선택하면 `CARD` 코드가 응답됩니다. [ENUM 코드](/codes/enum-codes) 및 [기관 코드](/codes/org-codes)를 참고하세요.
      */
-    code: WidgetsPaymentMethodCode | CustomPaymentMethodCode;
+    code: WidgetsPaymentMethodCode;
 }
-type WidgetsPaymentMethodCode = 'CARD' | 'VIRTUAL_ACCOUNT' | 'MOBILE_PHONE' | 'TRANSFER' | 'CULTURE_GIFT_CERTIFICATE' | 'GAME_GIFT_CERTIFICATE' | 'BOOK_GIFT_CERTIFICATE' | 'TOSSPAY' | 'NAVERPAY' | 'SAMSUNGPAY' | 'LPAY' | 'KAKAOPAY' | 'PAYCO' | 'SSG' | 'APPLEPAY' | 'PINPAY' | 'KBPAY' | 'PAYPAL' | 'GCASH' | 'TOUCHNGO' | 'BOOST' | 'BPI' | 'BILLEASE' | 'DANA' | 'ALIPAYHK' | 'TRUEMONEY' | 'RABBIT_LINE_PAY' | 'ALIPAY' | 'SHINHAN' | 'HYUNDAI' | 'SAMSUNG' | 'WOORI' | 'KOOKMIN' | 'LOTTE' | 'NONGHYEOP' | 'HANA' | 'BC' | 'KDBBANK' | 'TOSSBANK' | 'KAKAOBANK' | 'SUHYEOP' | 'JEONBUKBANK' | 'KBANK' | 'POST' | 'SAEMAUL' | 'CITI' | 'SAVINGBANK' | 'JEJUBANK' | 'GWANGJUBANK' | 'SHINHYEOP' | 'JCB' | 'UNIONPAY' | 'MASTER' | 'VISA' | 'DINERS' | 'DISCOVER' | 'IBK_BC' | 'AMEX' | 'TOSS_PAYMENTS' | 'BANKPAY' | 'BRANDPAY' | 'KEYIN';
+type WidgetsPaymentMethodCode = 'CARD' | 'VIRTUAL_ACCOUNT' | 'MOBILE_PHONE' | 'TRANSFER' | 'CULTURE_GIFT_CERTIFICATE' | 'GAME_GIFT_CERTIFICATE' | 'BOOK_GIFT_CERTIFICATE' | 'TOSSPAY' | 'NAVERPAY' | 'SAMSUNGPAY' | 'LPAY' | 'KAKAOPAY' | 'PAYCO' | 'SSG' | 'APPLEPAY' | 'PINPAY' | 'KBPAY' | 'PAYPAL' | 'GCASH' | 'TOUCHNGO' | 'BOOST' | 'BPI' | 'BILLEASE' | 'DANA' | 'ALIPAYHK' | 'TRUEMONEY' | 'RABBIT_LINE_PAY' | 'ALIPAY' | 'SHINHAN' | 'HYUNDAI' | 'SAMSUNG' | 'WOORI' | 'KOOKMIN' | 'LOTTE' | 'NONGHYEOP' | 'HANA' | 'BC' | 'KDBBANK' | 'TOSSBANK' | 'KAKAOBANK' | 'SUHYEOP' | 'JEONBUKBANK' | 'KBANK' | 'POST' | 'SAEMAUL' | 'CITI' | 'SAVINGBANK' | 'JEJUBANK' | 'GWANGJUBANK' | 'SHINHYEOP' | 'JCB' | 'UNIONPAY' | 'MASTER' | 'VISA' | 'DINERS' | 'DISCOVER' | 'IBK_BC' | 'AMEX' | 'TOSS_PAYMENTS' | 'BANKPAY' | 'BRANDPAY' | 'KEYIN' | (NonNullable<unknown> & string);
 
 interface WidgetPaymentMethodWidget {
     /**
@@ -14,18 +14,18 @@ interface WidgetPaymentMethodWidget {
      *
      * @example
      *  ```javascript
-     *  widgets.on('paymentMethodSelect', selectedPaymentMethod => {
-          if (paymentMethodSelected.code === '문화바우처') {
-            // 문화바우처 안내사항 노출
-          }
-          
-          if (paymentMethodSelected.code === '카드') {
+     *  paymentMethodWidget.on('paymentMethodSelect', selectedPaymentMethod => {
+          if (selectedPaymentMethod.code === '카드') {
             // 카드 안내사항 노출
           }
+          if (selectedPaymentMethod.code === '문화바우처') {
+            // 커스텀 결제수단 (결제위젯 Pro 플랜 기능)
+            // 문화바우처 안내사항 노출
+          }
         });
      * ```
      *
-     * @param {'paymentMethodSelect'} eventName 구독할 이벤트입니다. `paymentMethodSelect` 이벤트로 구매자가 선택한 결제수단 정보를 확인하세요.
+     * @param {'paymentMethodSelect'} eventName 구독할 이벤트입니다. `paymentMethodSelect` 이벤트로 구매자가 선택한 결제수단 코드를 확인하세요. 일반결제는 [결제수단 ENUM 코드](/codes/enum-codes#결제수단-타입)가 응답돼요. 결제위젯 Pro 플랜으로 [커스텀 결제수단](/guides/v2/payment-widget/pro/integration-custom)을 연동했다면 결제위젯 어드민에서 설정한 `key` 값이 응답돼요.
      * @param {function} callback 이벤트가 일어나면 호출되는 콜백 함수입니다.
      *
      * @throws {@link PublicError.Widgets.InvalidEventParameterError} eventName이 유효하지 않은 경우
@@ -33,7 +33,7 @@ interface WidgetPaymentMethodWidget {
      * @throws {@link PublicError.Widgets.UnknownError} 알 수 없는 오류가 발생한 경우
      */
     on: {
-        (eventName: 'paymentMethodSelect', callback: <CustomPaymentMethodCode>(paymentMethod: WidgetSelectedPaymentMethod<CustomPaymentMethodCode>) => void): void;
+        (eventName: 'paymentMethodSelect', callback: (paymentMethod: WidgetSelectedPaymentMethod) => void): void;
     };
     /**
      * 구매자가 선택한 결제수단을 불러옵니다. [자세히 >](#paymentmethodwidgetgetselectedpaymentmethod)
@@ -45,7 +45,7 @@ interface WidgetPaymentMethodWidget {
      *
      * @throws {@link PublicError.Widgets.UnknownError} 알 수 없는 오류가 발생한 경우
      */
-    getSelectedPaymentMethod: <CustomPaymentMethodCode>() => Promise<WidgetSelectedPaymentMethod<CustomPaymentMethodCode>>;
+    getSelectedPaymentMethod: () => Promise<WidgetSelectedPaymentMethod>;
     /**
      * 결제 UI 객체를 제거합니다. [자세히 >](#paymentmethodwidgetdestroy)
      *
@@ -216,6 +216,9 @@ interface WidgetPaymentRequest {
      * 구매자가 해외간편결제를 선택하면 결제에 적용되는 옵션입니다.
      */
     foreignEasyPay?: {
+        /**
+         * 구매자가 위치한 국가입니다. ISO-3166의 두 자리 국가 코드를 입력하세요.
+         */
         country: string;
         /**
          * 구매 상품 정보입니다. 여러 가지의 상품을 결제했다면 각 상품의 정보를 입력하세요. 예를 들어, 구매자가 세 가지 종류의 상품을 구매했다면 배열의 길이는 3이어야 합니다.
@@ -265,7 +268,7 @@ interface WidgetPaymentRequest {
                  */
                 line1?: string;
                 /**
-                 * 상세 주소입니다. 번지 및 동 호수 정보를 입력하세요.
+                 * 상세 주소입니다. 번지 및 동호수 정보를 입력하세요.
                  */
                 line2?: string;
                 /**
@@ -307,7 +310,7 @@ interface Amount {
      */
     value: number;
     /**
-     * 결제 통화입니다.
+     * 결제 통화입니다. 일반결제는 `KRW`만 지원합니다. 해외 간편결제(PayPal)는 `USD`만 지원합니다.
      */
     currency: string;
 }
@@ -406,7 +409,7 @@ type RenderAgreement = (params: {
      */
     selector: string;
     /**
-     * 렌더링하고 싶은 약과 UI의 `variantKey`입니다. 상점관리자의 결제위젯 어드민에서 확인할 수 있어요.
+     * 렌더링하고 싶은 약관 UI의 `variantKey`입니다. 상점관리자의 결제위젯 어드민에서 확인할 수 있어요.
      */
     variantKey?: string;
 }) => Promise<WidgetAgreementWidget>;
@@ -432,6 +435,7 @@ type RenderAgreement = (params: {
  * @throws {@link PublicError.Widgets.IncorrectFailUrlFormatError} failUrl이 유효하지 않은 경우
  * @throws {@link PublicError.Widgets.PaymentRequestFailError} 결제 요청에 실패한 경우
  * @throws {@link PublicError.Widgets.NotSupportedPromiseError} promise 방식을 지원하지 않는 환경인 경우
+ * @throws {@link PublicError.Widgets.CustomPaymentMethodUnableToPayError} 커스텀 결제수단이 선택된 상태에서 결제요청을 한 경우
  * @throws {@link PublicError.Widgets.InvalidMethodTransactionError} 이미 다른 명령을 수행 중인 경우
  * @throws {@link PublicError.Widgets.InvalidParametersError} 파라미터가 올바르지 않은 경우
  * @throws {@link PublicError.Widgets.UnknownError} 알 수 없는 오류가 발생한 경우
@@ -458,9 +462,9 @@ type RequestPaymentWithPromise$1 = (paymentRequest: WidgetPaymentRequest) => Pro
 /**
  * @docsAlias Redirect 방식
  *
- * @returns 결제 요청이 성공하면 파라미터로 설정한 `successUrl`로 이동해요. 쿼리 파라미터의 `amount` 값이 파라미터로 설정한 `amount`와 같은지 반드시 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해서 결제를 완료하세요.
+ * @returns 결제 요청이 성공하면 파라미터로 설정한 `successUrl`로 이동해요. 쿼리 파라미터의 `amount` 값이 메서드 파라미터로 설정한 `amount`와 같은지 반드시 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해서 결제를 완료하세요.
  * ```plain theme="grey" copyable="false"
- * {successUrl}?amount={AMOUNT}&orderId={ORDER_ID}&paymentKey={PAYMENT_KEY}
+ * {successUrl}?paymentType={PAYMENT_TYPE}&amount={AMOUNT}&orderId={ORDER_ID}&paymentKey={PAYMENT_KEY}
  * ```
  * 결제 요청이 실패하면 파라미터로 설정한 `failUrl`로 이동해요. 쿼리 파라미터로 에러 코드와 메시지를 확인하세요.
  * ```plain theme="grey" copyable="false"
@@ -488,7 +492,7 @@ type RequestPaymentWithRedirection$1 = (paymentRequest: WithRedirection<WidgetPa
 /**
  * 결제 금액을 변경합니다
  *
- * @param {Amount} amount 새로운 결제 금액입니다.
+ * @param {Amount} amount 결제 금액 정보입니다.
  *
  * @example
  *  ```javascript
@@ -526,6 +530,9 @@ interface TossPaymentsWidgets {
 }
 
 interface BrandpayAmount extends Amount {
+    /**
+     * 결제 통화입니다. 브랜드페이는 `KRW` 결제만 지원합니다.
+     */
     currency: 'KRW';
 }
 
@@ -565,6 +572,9 @@ interface BrandpayRequestPaymentResult {
      * 주문번호입니다. 결제를 요청할 때 호출한 `requestPayment()` 메서드로 넘긴 `orderId` 값과 같은지 확인하세요.
      */
     orderId: string;
+    /**
+     * 결제 금액 정보입니다. `requestPayment()` 메서드로 넘긴 `amount` 값과 같은지 확인하세요.
+     */
     amount: BrandpayAmount;
 }
 
@@ -588,7 +598,7 @@ interface BrandpayRequestPaymentResult {
 type RequestPayment$1 = RequestPaymentWithRedirection & RequestPaymentWithPromise;
 /**
  * @docsAlias Redirect 방식
- * @returns 결제 요청이 성공하면 파라미터로 설정한 `successUrl`로 이동해요. 쿼리 파라미터의 `amount` 값이 파라미터로 설정한 `amount`와 같은지 반드시 확인하고 [브랜드페이 결제 승인 API](/reference/brandpay#결제-승인)를 호출해서 결제를 완료하세요.
+ * @returns 결제 요청이 성공하면 파라미터로 설정한 `successUrl`로 이동해요. 쿼리 파라미터의 `amount` 값이 메서드 파라미터로 설정한 `amount`와 같은지 반드시 확인하고 [브랜드페이 결제 승인 API](/reference/brandpay#결제-승인)를 호출해서 결제를 완료하세요.
  * ```plain theme="grey" copyable="false"
  * {successUrl}?amount={AMOUNT}&orderId={ORDER_ID}&paymentKey={PAYMENT_KEY}
  * ```
@@ -799,7 +809,8 @@ interface PaymentRequest {
     taxFreeAmount?: number;
     /**
      * 결제창이 열리는 프레임입니다.
-     * `iframe` 또는 현재 브라우저 화면(`self`)에서 등록창을 열 수 있어요. 기본 값은 `iframe`입니다.
+     * `iframe` 또는 현재 브라우저 화면(`self`)에서 결제창을 열 수 있어요. 기본 값은 `iframe`입니다.
+     * 모바일 웹에서는 `windowTarget` 값이 작동하지 않고 화면이 이동합니다.
      */
     windowTarget?: 'iframe' | 'self';
 }
@@ -840,19 +851,19 @@ interface CardPaymentRequest extends PaymentRequest {
          */
         easyPay?: string;
         /**
-         * 5만원 이상의 신용카드 결제에 적용되는 할부 개월 수입니다.
+         * 신용카드 결제에 적용되는 할부 개월 수입니다.
          * 예를 들어, `6`으로 설정하면 할부 개월 수가 6개월로 고정돼요. 자체창에서는 구매자가 할부 개월 수를 볼 수 없으니 사전에 충분히 안내를 해주세요.
-         * 0(일시불), 2~12 값으로 설정할 수 있고 `maxCardInstallmentPlan` 파라미터와 함께 사용할 수 없어요.
+         * 0(일시불), 2~12 값으로 설정할 수 있고 `maxCardInstallmentPlan` 파라미터와 함께 사용할 수 없어요. 카드사 별로 할부결제가 가능한 [최소 금액](https://pgweb.tosspayments.com/tosspayments/MainPopUp.do)을 확인하세요.
          */
         cardInstallmentPlan?: number;
         /**
-         * 5만원 이상의 신용카드 결제에 적용할 수 있는 최대 할부 개월 수입니다.
-         * 예를 들어, `6`으로 설정하면 구매자는 일시불부터 6개월 할부를 선택할 수 있어요. 0(일시불), 2~12 값으로 설정할 수 있고 `cardInstallmentPlan` 파라미터와 함께 사용할 수 없어요.
+         * 신용카드 결제에 적용할 수 있는 최대 할부 개월 수입니다.
+         * 예를 들어, `6`으로 설정하면 구매자는 일시불부터 6개월 할부를 선택할 수 있어요. 0(일시불), 2~12 값으로 설정할 수 있고 `cardInstallmentPlan` 파라미터와 함께 사용할 수 없어요. 카드사 별로 할부결제가 가능한 [최소 금액](https://pgweb.tosspayments.com/tosspayments/MainPopUp.do)을 확인하세요.
          */
         maxCardInstallmentPlan?: number;
         /**
-         * 5만원 이상의 신용카드 결제에 적용할 수 있는 **상점 부담 무이자** 할부 정보입니다.
-         * 구매자가 선택한 카드, 할부 개월 수가 배열에 등록한 정보와 같다면 무이자가 할부가 자동으로 적용돼요.
+         * 신용카드 결제에 적용할 수 있는 **상점 부담 무이자** 할부 정보입니다.
+         * 구매자가 선택한 카드, 할부 개월 수가 배열에 등록한 정보와 같다면 무이자가 할부가 자동으로 적용돼요. 카드사 별로 할부결제가 가능한 [최소 금액](https://pgweb.tosspayments.com/tosspayments/MainPopUp.do)을 확인하세요.
          */
         freeInstallmentPlans?: Array<{
             /**
@@ -871,7 +882,7 @@ interface CardPaymentRequest extends PaymentRequest {
          */
         useCardPoint?: boolean;
         /**
-         * 앱카드 단독 사용 여부입니다. 'true'로 설정하면 카드사의 앱카드만 열려요. 국민, 농협, 롯데, 삼성, 신한, 우리, 현대 카드 결제에 적용할 수 있어요.
+         * 앱카드 단독 사용 여부입니다. `true`로 설정하면 카드사의 앱카드만 열려요. 국민, 농협, 롯데, 삼성, 신한, 우리, 현대 카드 결제에 적용할 수 있어요.
          */
         useAppCardOnly?: boolean;
         /**
@@ -879,12 +890,12 @@ interface CardPaymentRequest extends PaymentRequest {
          */
         discountCode?: string;
         /**
-         * 시간으로 설정하는 결제가 기한입니다. 설정할 수 있는 최대 값은 2160시간(90일)입니다.
+         * 시간으로 설정하는 결제 기한입니다. 설정할 수 있는 최대 값은 2160시간(90일)입니다.
          * 기한이 지나고 시도하는 결제는 실패해요. 예를 들어 `24`로 설정하면, 결제 요청 시점으로부터 24시간 동안 결제할 수 있어요.
          */
         validHours?: number;
         /**
-         * 특정일로 설정하는 결제 기한입니다. `yyyy-MM-dd'T'HH:mm:ss` ISO 8601 형식입니다.
+         * 특정 날짜로 설정하는 결제 기한입니다. `yyyy-MM-dd'T'HH:mm:ss` ISO 8601 형식입니다.
          * 기한이 지나고 시도하는 결제는 실패해요. 예를 들어 `2025-01-01T00:00:00`으로 설정하면, 2024년 12월 31일 23:59까지 결제할 수 있어요.
          */
         dueDate?: string;
@@ -959,12 +970,12 @@ interface VirtualAccountPaymentRequest extends PaymentRequest {
             quantity?: number;
         }>;
         /**
-         * 시간으로 설정하는 결제가 기한입니다. 설정할 수 있는 최대 값은 2160시간(90일)입니다.
+         * 시간으로 설정하는 결제 기한입니다. 설정할 수 있는 최대 값은 2160시간(90일)입니다.
          * 기한이 지나고 시도하는 결제는 실패해요. 예를 들어 `24`로 설정하면, 결제 요청 시점으로부터 24시간 동안 결제할 수 있어요.
          */
         validHours?: number;
         /**
-         * 특정일로 설정하는 결제 기한입니다. `yyyy-MM-dd'T'HH:mm:ss` ISO 8601 형식입니다.
+         * 특정 날짜로 설정하는 결제 기한입니다. `yyyy-MM-dd'T'HH:mm:ss` ISO 8601 형식입니다.
          * 기한이 지나고 시도하는 결제는 실패해요. 예를 들어 `2025-01-01T00:00:00`으로 설정하면, 2024년 12월 31일 23:59까지 결제할 수 있어요.
          */
         dueDate?: string;
@@ -1025,12 +1036,12 @@ interface TransferPaymentRequest extends PaymentRequest {
             quantity?: number;
         }>;
         /**
-         * 시간으로 설정하는 결제가 기한입니다. 설정할 수 있는 최대 값은 2160시간(90일)입니다.
+         * 시간으로 설정하는 결제 기한입니다. 설정할 수 있는 최대 값은 2160시간(90일)입니다.
          * 기한이 지나고 시도하는 결제는 실패해요. 예를 들어 `24`로 설정하면, 결제 요청 시점으로부터 24시간 동안 결제할 수 있어요.
          */
         validHours?: number;
         /**
-         * 특정일로 설정하는 결제 기한입니다. `yyyy-MM-dd'T'HH:mm:ss` ISO 8601 형식입니다.
+         * 특정 날짜로 설정하는 결제 기한입니다. `yyyy-MM-dd'T'HH:mm:ss` ISO 8601 형식입니다.
          * 기한이 지나고 시도하는 결제는 실패해요. 예를 들어 `2025-01-01T00:00:00`으로 설정하면, 2024년 12월 31일 23:59까지 결제할 수 있어요.
          */
         dueDate?: string;
@@ -1065,7 +1076,7 @@ interface ForeignEasyPayPaymentRequest extends PaymentRequest {
          */
         provider: string;
         /**
-         * 구매자가 결제한 국가입니다. ISO-3166의 두 자리 국가 코드를 입력하세요.
+         * 구매자가 위치한 국가입니다. ISO-3166의 두 자리 국가 코드를 입력하세요.
          */
         country: string;
         /**
@@ -1116,7 +1127,7 @@ interface ForeignEasyPayPaymentRequest extends PaymentRequest {
                  */
                 line1?: string;
                 /**
-                 * 상세 주소입니다. 번지 및 동 호수 정보를 입력하세요.
+                 * 상세 주소입니다. 번지 및 동호수 정보를 입력하세요.
                  */
                 line2?: string;
                 /**
@@ -1169,7 +1180,7 @@ interface RequestPaymentResult {
 
 interface BillingAuthRequest {
     /**
-     * 자동결제(빌링)에 등록할 결제수단입니다. 토스페이먼츠는 현재 신용·체크카드만 자동결제만 지원해요.
+     * 자동결제(빌링)에 등록할 결제수단입니다. 토스페이먼츠 자동결제는 현재 신용·체크카드만 지원해요.
      *
      */
     method: 'CARD';
@@ -1194,8 +1205,9 @@ interface BillingAuthRequest {
      */
     customerEmail?: string;
     /**
-     * 카드 등록창이 열리는 프레임입니다. iframe 또는 현재 브라우저 화면(self)에서 등록창을 열 수 있습니다. 기본 값은 `iframe`입니다.
-     * 모바일 웹에서는 windowTarget 값과 상관없이 항상 새로운 결제창으로 이동합니다.
+     * 결제창이 열리는 프레임입니다.
+     * `iframe` 또는 현재 브라우저 화면(`self`)에서 등록창을 열 수 있어요. 기본 값은 `iframe`입니다.
+     * 모바일 웹에서는 `windowTarget` 값이 작동하지 않고 화면이 이동합니다.
      *
      * @default 'iframe'
      */
@@ -1204,18 +1216,18 @@ interface BillingAuthRequest {
 
 /**
  *
- * @throws {@link PublicError.PaymentGateway.UserCancelError} 사용자가 결제창을 닫은 경우
- * @throws {@link PublicError.PaymentGateway.InvalidAmountValueError} 결제 금액이 유효하지 않은 경우
- * @throws {@link PublicError.PaymentGateway.InvalidAmountCurrencyError} 결제 금액의 통화가 유효하지 않은 경우
- * @throws {@link PublicError.PaymentGateway.BelowZeroAmountError} 결제 금액이 0 미만인 경우
- * @throws {@link PublicError.PaymentGateway.NotSupportedPromiseError} promise 방식을 지원하지 않는 환경인 경우
- * @throws {@link PublicError.PaymentGateway.NotSupportedMethodError} 가맹점에서 정의되지 않은 method를 넘겨준 경우
- * @throws {@link PublicError.PaymentGateway.IncorrectSuccessUrlFormatError} 가맹점에서 유효하지 않은 successUrl을 넘겨준 경우
- * @throws {@link PublicError.PaymentGateway.IncorrectFailUrlFormatError} 가맹점에서 유효하지 않은 failUrl을 넘겨준 경우
- * @throws {@link PublicError.PaymentGateway.PaymentRequestFailError} 결제에 실패한 경우
- * @throws {@link PublicError.PaymentGateway.InvalidMethodTransactionError} 이미 다른 명령을 수행 중인 경우
- * @throws {@link PublicError.PaymentGateway.InvalidParametersError} 파라미터가 올바르지 않은 경우
- * @throws {@link PublicError.PaymentGateway.UnknownError} 알 수 없는 오류가 발생한 경우
+ * @throws {@link PublicError.Payment.UserCancelError} 사용자가 결제창을 닫은 경우
+ * @throws {@link PublicError.Payment.InvalidAmountValueError} 결제 금액이 유효하지 않은 경우
+ * @throws {@link PublicError.Payment.InvalidAmountCurrencyError} 결제 금액의 통화가 유효하지 않은 경우
+ * @throws {@link PublicError.Payment.BelowZeroAmountError} 결제 금액이 0 미만인 경우
+ * @throws {@link PublicError.Payment.NotSupportedPromiseError} promise 방식을 지원하지 않는 환경인 경우
+ * @throws {@link PublicError.Payment.NotSupportedMethodError} 가맹점에서 정의되지 않은 method를 넘겨준 경우
+ * @throws {@link PublicError.Payment.IncorrectSuccessUrlFormatError} 가맹점에서 유효하지 않은 successUrl을 넘겨준 경우
+ * @throws {@link PublicError.Payment.IncorrectFailUrlFormatError} 가맹점에서 유효하지 않은 failUrl을 넘겨준 경우
+ * @throws {@link PublicError.Payment.PaymentRequestFailError} 결제에 실패한 경우
+ * @throws {@link PublicError.Payment.InvalidMethodTransactionError} 이미 다른 명령을 수행 중인 경우
+ * @throws {@link PublicError.Payment.InvalidParametersError} 파라미터가 올바르지 않은 경우
+ * @throws {@link PublicError.Payment.UnknownError} 알 수 없는 오류가 발생한 경우
  */
 type RequestPayment = RequestCardPaymentWithRedirection & RequestCardPaymentWithPromise & RequestVirtualAccountPaymentWithRedirection & RequestVirtualAccountPaymentWithPromise & RequestTransferPaymentWithRedirection & RequestTransferPaymentWithPromise & RequestMobilePhonePaymentWithRedirection & RequestMobilePhonePaymentWithPromise & RequestGiftCertificatePaymentWithRedirection & RequestGiftCertificatePaymentWithPromise & RequestForeignEasyPayPaymentWithRedirection & RequestForeignEasyPayPaymentWithPromise;
 /**
@@ -1249,7 +1261,7 @@ type RequestPayment = RequestCardPaymentWithRedirection & RequestCardPaymentWith
 type RequestCardPaymentWithPromise = (paymentRequest: CardPaymentRequest) => Promise<RequestPaymentResult>;
 /**
  * @docsAlias 카드(Redirect 방식)
- * @returns 결제 요청이 성공하면 파라미터로 설정한 `successUrl`로 이동해요. 쿼리 파라미터의 `amount` 값이 파라미터로 설정한 `amount`와 같은지 반드시 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해서 결제를 완료하세요.
+ * @returns 결제 요청이 성공하면 파라미터로 설정한 `successUrl`로 이동해요. 쿼리 파라미터의 `amount` 값이 메서드 파라미터로 설정한 `amount`와 같은지 반드시 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해서 결제를 완료하세요.
  * ```plain theme="grey" copyable="false"
  * {successUrl}?amount={AMOUNT}&orderId={ORDER_ID}&paymentKey={PAYMENT_KEY}
  * ```
@@ -1318,7 +1330,7 @@ type RequestCardPaymentWithRedirection = (paymentRequest: WithRedirection<CardPa
 type RequestVirtualAccountPaymentWithPromise = (paymentRequest: VirtualAccountPaymentRequest) => Promise<RequestPaymentResult>;
 /**
  * @docsAlias 가상계좌(Redirect 방식)
- * @returns 결제 요청이 성공하면 파라미터로 설정한 `successUrl`로 이동해요. 쿼리 파라미터의 `amount` 값이 파라미터로 설정한 `amount`와 같은지 반드시 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해서 결제를 완료하세요.
+ * @returns 결제 요청이 성공하면 파라미터로 설정한 `successUrl`로 이동해요. 쿼리 파라미터의 `amount` 값이 메서드 파라미터로 설정한 `amount`와 같은지 반드시 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해서 결제를 완료하세요.
  * ```plain theme="grey" copyable="false"
  * {successUrl}?amount={AMOUNT}&orderId={ORDER_ID}&paymentKey={PAYMENT_KEY}
  * ```
@@ -1386,7 +1398,7 @@ type RequestVirtualAccountPaymentWithRedirection = (paymentRequest: WithRedirect
 type RequestTransferPaymentWithPromise = (paymentRequest: TransferPaymentRequest) => Promise<RequestPaymentResult>;
 /**
  * @docsAlias 계좌이체(Redirect 방식)
- * @returns 결제 요청이 성공하면 파라미터로 설정한 `successUrl`로 이동해요. 쿼리 파라미터의 `amount` 값이 파라미터로 설정한 `amount`와 같은지 반드시 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해서 결제를 완료하세요.
+ * @returns 결제 요청이 성공하면 파라미터로 설정한 `successUrl`로 이동해요. 쿼리 파라미터의 `amount` 값이 메서드 파라미터로 설정한 `amount`와 같은지 반드시 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해서 결제를 완료하세요.
  * ```plain theme="grey" copyable="false"
  * {successUrl}?amount={AMOUNT}&orderId={ORDER_ID}&paymentKey={PAYMENT_KEY}
  * ```
@@ -1447,7 +1459,7 @@ type RequestTransferPaymentWithRedirection = (paymentRequest: WithRedirection<Tr
 type RequestMobilePhonePaymentWithPromise = (paymentRequest: MobilePhonePaymentRequest) => Promise<RequestPaymentResult>;
 /**
  * @docsAlias 휴대폰 결제(Redirect 방식)
- * @returns 결제 요청이 성공하면 파라미터로 설정한 `successUrl`로 이동해요. 쿼리 파라미터의 `amount` 값이 파라미터로 설정한 `amount`와 같은지 반드시 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해서 결제를 완료하세요.
+ * @returns 결제 요청이 성공하면 파라미터로 설정한 `successUrl`로 이동해요. 쿼리 파라미터의 `amount` 값이 메서드 파라미터로 설정한 `amount`와 같은지 반드시 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해서 결제를 완료하세요.
  * ```plain theme="grey" copyable="false"
  * {successUrl}?amount={AMOUNT}&orderId={ORDER_ID}&paymentKey={PAYMENT_KEY}
  * ```
@@ -1502,7 +1514,7 @@ type RequestMobilePhonePaymentWithRedirection = (paymentRequest: WithRedirection
 type RequestGiftCertificatePaymentWithPromise = (paymentRequest: GiftCertificatePaymentRequest) => Promise<RequestPaymentResult>;
 /**
  * @docsAlias 상품권(Redirect 방식)
- * @returns 결제 요청이 성공하면 파라미터로 설정한 `successUrl`로 이동해요. 쿼리 파라미터의 `amount` 값이 파라미터로 설정한 `amount`와 같은지 반드시 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해서 결제를 완료하세요.
+ * @returns 결제 요청이 성공하면 파라미터로 설정한 `successUrl`로 이동해요. 쿼리 파라미터의 `amount` 값이 메서드 파라미터로 설정한 `amount`와 같은지 반드시 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해서 결제를 완료하세요.
  * ```plain theme="grey" copyable="false"
  * {successUrl}?amount={AMOUNT}&orderId={ORDER_ID}&paymentKey={PAYMENT_KEY}
  * ```
@@ -1561,7 +1573,7 @@ type RequestGiftCertificatePaymentWithRedirection = (paymentRequest: WithRedirec
 type RequestForeignEasyPayPaymentWithPromise = (paymentRequest: ForeignEasyPayPaymentRequest) => Promise<RequestPaymentResult>;
 /**
  * @docsAlias 해외 간편결제(Redirect 방식)
- * @returns 결제 요청이 성공하면 파라미터로 설정한 `successUrl`로 이동해요. 쿼리 파라미터의 `amount` 값이 파라미터로 설정한 `amount`와 같은지 반드시 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해서 결제를 완료하세요.
+ * @returns 결제 요청이 성공하면 파라미터로 설정한 `successUrl`로 이동해요. 쿼리 파라미터의 `amount` 값이 메서드 파라미터로 설정한 `amount`와 같은지 반드시 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해서 결제를 완료하세요.
  * ```plain theme="grey" copyable="false"
  * {successUrl}?amount={AMOUNT}&orderId={ORDER_ID}&paymentKey={PAYMENT_KEY}
  * ```
@@ -1618,17 +1630,17 @@ type RequestForeignEasyPayPaymentWithRedirection = (paymentRequest: WithRedirect
  * });
  * ```
  *
- * @throws {@link PublicError.PaymentGateway.UserCancelError} 사용자가 자동결제 인증창을 닫은 경우
- * @throws {@link PublicError.PaymentGateway.NotSupportedMethodError} 가맹점에서 정의되지 않은 method를 넘겨준 경우
- * @throws {@link PublicError.PaymentGateway.IncorrectSuccessUrlFormatError} 가맹점에서 유효하지 않은 successUrl을 넘겨준 경우
- * @throws {@link PublicError.PaymentGateway.IncorrectFailUrlFormatError} 가맹점에서 유효하지 않은 failUrl을 넘겨준 경우
- * @throws {@link PublicError.PaymentGateway.InvalidMethodTransactionError} 이미 다른 명령을 수행 중인 경우
- * @throws {@link PublicError.PaymentGateway.InvalidParametersError} 파라미터가 올바르지 않은 경우
- * @throws {@link PublicError.PaymentGateway.UnknownError} 알 수 없는 오류가 발생한 경우
+ * @throws {@link PublicError.Payment.UserCancelError} 사용자가 자동결제 인증창을 닫은 경우
+ * @throws {@link PublicError.Payment.NotSupportedMethodError} 가맹점에서 정의되지 않은 method를 넘겨준 경우
+ * @throws {@link PublicError.Payment.IncorrectSuccessUrlFormatError} 가맹점에서 유효하지 않은 successUrl을 넘겨준 경우
+ * @throws {@link PublicError.Payment.IncorrectFailUrlFormatError} 가맹점에서 유효하지 않은 failUrl을 넘겨준 경우
+ * @throws {@link PublicError.Payment.InvalidMethodTransactionError} 이미 다른 명령을 수행 중인 경우
+ * @throws {@link PublicError.Payment.InvalidParametersError} 파라미터가 올바르지 않은 경우
+ * @throws {@link PublicError.Payment.UnknownError} 알 수 없는 오류가 발생한 경우
  */
 type RequestBillingAuth = (billingAuthRequest: BillingAuthRequest) => Promise<void>;
 
-interface TossPaymentsPaymentGateway {
+interface TossPaymentsPayment {
     /**
      * 결제창을 띄웁니다. [자세히 >](#paymentrequestpayment)
      */
@@ -1638,7 +1650,7 @@ interface TossPaymentsPaymentGateway {
      */
     requestBillingAuth: RequestBillingAuth;
 }
-interface TossPaymentsInstance {
+interface TossPaymentsSDK {
     /**
      *
      * 결제위젯을 초기화합니다. [자세히 >](#결제위젯)
@@ -1652,13 +1664,18 @@ interface TossPaymentsInstance {
      * ```javascript
      * // 회원 결제
      * const widgets = tossPayments.widgets({ customerKey });
+     *
      * // 비회원 결제
-     * // const payment = tossPayments.widgets({ customerKey: TossPayments.ANONYMOUS });
+     * // 스크립트 태그 연동방식
+     * const widgets = tossPayments.widgets({ customerKey: TossPayments.ANONYMOUS });
+     * // 모듈 임포트 연동방식
+     * import { ANONYMOUS } from "@tosspayments/tosspayments-sdk";
+     * const widgets = tossPayments.widgets({ customerKey: ANONYMOUS });
      * ```
-     * @param {WidgetSDKInitParams} params 결제위젯 초기화 정보입니다.
+     * @param {WidgetInitParams} params 결제위젯 초기화 정보입니다.
      *
      */
-    widgets: (params: WidgetSDKInitParams) => TossPaymentsWidgets;
+    widgets: (params: WidgetInitParams) => TossPaymentsWidgets;
     /**
      * 브랜드페이를 초기화합니다. [자세히 >](#브랜드페이)
      *
@@ -1674,10 +1691,10 @@ interface TossPaymentsInstance {
      * });
      * ```
      * @returns 아래 메서드를 호출할 수 있는 브랜드페이 객체를 반환합니다.
-     * @param {BrandpaySDKInitParams} params 브랜드페이 초기화 정보입니다.
+     * @param {BrandpayInitParams} params 브랜드페이 초기화 정보입니다.
      *
      */
-    brandpay: (params: BrandpaySDKInitParams) => TossPaymentsBrandpay;
+    brandpay: (params: BrandpayInitParams) => TossPaymentsBrandpay;
     /**
      * 결제창을 초기화합니다. [자세히 >](#결제창)
      *
@@ -1687,23 +1704,25 @@ interface TossPaymentsInstance {
      * @throw {@link PublicError.Brandpay.UnknownError} 알 수 없는 오류가 발생한 경우
      * @example
      * ```javascript
-     * // 회원 결제
      * const payment = tossPayments.payment({ customerKey });
-     *
-     * //비회원 결제
-     * // const payment = tossPayments.payment({ customerKey: TossPayments.ANONYMOUS });
      * ```
+     * @param {PaymentInitParams} params 결제창 초기화 정보입니다.
      * @returns 아래 메서드를 호출할 수 있는 결제창 객체를 반환합니다.
-     * @param {PaymentGatewaySDKInitParams} 결제창 초기화 정보입니다.
      *
      */
-    payment: (params: PaymentGatewaySDKInitParams) => TossPaymentsPaymentGateway;
+    payment: (params: PaymentInitParams) => TossPaymentsPayment;
 }
 /**
  * @example
  * ```javascript
+ * // 스크립트 태그 연동방식
  * const tossPayments = TossPayments("<WidgetClientKey />");
+ *
+ * // 모듈 임포트 연동방식
+ * import { loadTossPayments } from "@tosspayments/tosspayments-sdk"
+ * const tossPayments = await loadTossPayments("<WidgetClientKey />");
  * ```
+ *
  * @param {string} clientKey 토스페이먼츠 발급하는 클라이언트 키입니다. 개발자센터의 [API 키 메뉴](https://developers.tosspayments.com/my/api-keys)에서 확인할 수 있어요.
  *
  * 결제위젯을 연동한다면 [결제위젯 연동 키](/reference/using-api/api-keys#결제위젯-연동-키)를 사용하세요. 결제창, 자동결제(빌링)을 연동한다면 [API 개별 연동 키](/reference/using-api/api-keys#api-개별-연동-키)를 사용하세요.
@@ -1711,8 +1730,8 @@ interface TossPaymentsInstance {
  * @returns
  * 아래 메서드를 호출할 수 있는 토스페이먼츠 객체를 반환합니다.
  */
-type TossPayments = (clientKey: string) => TossPaymentsInstance;
-interface BrandpaySDKInitParams {
+type TossPayments = (clientKey: string) => TossPaymentsSDK;
+interface BrandpayInitParams {
     /**
      * 구매자를 식별하는 고유 아이디입니다.
      * 이메일・전화번호나 자동 증가하는 숫자와 같이 유추가 가능한 값은 안전하지 않아요. UUID와 같이 충분히 무작위적인 고유 값으로 생성해주세요.
@@ -1722,14 +1741,14 @@ interface BrandpaySDKInitParams {
     /**
      * 브랜드페이 결제 과정에서 [Access Token 발급](/guides/v2/brandpay/auth)을 위해 필요한 URL입니다. Access Token은 브랜드페이 고객을 식별하고 고객의 결제 권한을 증명합니다. 값을 넣지 않으면 개발자센터의 브랜드페이 메뉴에 최초로 등록한 리다이렉트 URL이 기본값으로 들어갑니다.
      *
-     * \* 브랜드페이 메뉴에 두 개 이상의 리다이렉트 URL을 등록한 상점은 각 도메인에 맞는 redirectUrl 값을 필수로 추가하세요.
+     * \* 브랜드페이 메뉴에 두 개 이상의 리다이렉트 URL을 등록한 상점은 각 도메인에 맞는 `redirectUrl` 값을 필수로 추가하세요.
      */
     redirectUrl?: string;
 }
 /**
  * @returns 아래 메서드를 호출할 수 있는 토스페이먼츠 객체를 반환합니다.
  */
-interface WidgetSDKInitParams {
+interface WidgetInitParams {
     /**
      * 구매자를 식별하는 고유 아이디입니다.
      * 이메일・전화번호나 자동 증가하는 숫자와 같이 유추가 가능한 값은 안전하지 않아요. UUID와 같이 충분히 무작위적인 고유 값으로 생성해주세요.
@@ -1743,12 +1762,12 @@ interface WidgetSDKInitParams {
         /**
          * 브랜드페이 결제 과정에서 [Access Token 발급](/guides/v2/brandpay/auth)을 위해 필요한 URL입니다. Access Token은 브랜드페이 고객을 식별하고 고객의 결제 권한을 증명합니다. 값을 넣지 않으면 개발자센터의 브랜드페이 메뉴에 최초로 등록한 리다이렉트 URL이 기본값으로 들어갑니다.
          *
-         * \* 브랜드페이 메뉴에 두 개 이상의 리다이렉트 URL을 등록한 상점은 각 도메인에 맞는 redirectUrl 값을 필수로 추가하세요.
+         * \* 브랜드페이 메뉴에 두 개 이상의 리다이렉트 URL을 등록한 상점은 각 도메인에 맞는 `redirectUrl` 값을 필수로 추가하세요.
          */
         redirectUrl?: string;
     };
 }
-interface PaymentGatewaySDKInitParams {
+interface PaymentInitParams {
     /**
      * 구매자를 식별하는 고유 아이디입니다.
      * 이메일・전화번호나 자동 증가하는 숫자와 같이 유추가 가능한 값은 안전하지 않아요. UUID와 같이 충분히 무작위적인 고유 값으로 생성해주세요.
@@ -1760,8 +1779,8 @@ interface PaymentGatewaySDKInitParams {
 type TosspaymentsParams = Parameters<TossPayments>;
 declare function loadTossPayments(clientKey: TosspaymentsParams[0], loadOptions?: {
     src?: string;
-}): Promise<TossPaymentsInstance>;
+}): Promise<TossPaymentsSDK>;
 
 declare const ANONYMOUS = "@@ANONYMOUS";
 
-export { ANONYMOUS, clearTossPayments, loadTossPayments };
+export { ANONYMOUS, type TossPaymentsBrandpay, type TossPaymentsPayment, type TossPaymentsSDK, type TossPaymentsWidgets, type WidgetAgreementStatus, type WidgetAgreementWidget, type WidgetPaymentMethodWidget, type WidgetSelectedPaymentMethod, clearTossPayments, loadTossPayments };