@tosspayments/tosspayments-sdk 2.3.4 → 2.3.6

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.3.6](https://github.com/tosspayments/browser-sdk/compare/@tosspayments/tosspayments-sdk@2.3.5...@tosspayments/tosspayments-sdk@2.3.6) (2025-08-13)
+
+
+### Bug Fixes
+
+* **tosspayments-sdk:** @tosspayments/standard-public-interfaces 버전업 ([#132](https://github.com/tosspayments/browser-sdk/issues/132)) ([282947a](https://github.com/tosspayments/browser-sdk/commit/282947a03ecdd1e969e2c7a42e432285c2126c5e))
+
+
+
+
+
+## [2.3.5](https://github.com/tosspayments/browser-sdk/compare/@tosspayments/tosspayments-sdk@2.3.4...@tosspayments/tosspayments-sdk@2.3.5) (2025-05-16)
+
+
+### Bug Fixes
+
+* **tosspayments-sdk:** @tosspayments/standard-public-interfaces 버전업 ([#131](https://github.com/tosspayments/browser-sdk/issues/131)) ([006451e](https://github.com/tosspayments/browser-sdk/commit/006451e3cb508b851433e11019aa0bc5d2179f16))
+
+
+
+
+
 ## [2.3.4](https://github.com/tosspayments/browser-sdk/compare/@tosspayments/tosspayments-sdk@2.3.3...@tosspayments/tosspayments-sdk@2.3.4) (2024-12-12)
 
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tosspayments/tosspayments-sdk",
   "description": "TossPayments.js Tosspayments SDK.",
-  "version": "2.3.4",
+  "version": "2.3.6",
   "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.45",
+    "@tosspayments/standard-public-interfaces": "2.1.4",
     "happy-dom": "^14.12.3",
     "prettier": "^2.0.2",
     "rollup": "^2.60.0",
@@ -38,5 +38,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "793c235208215386fb73996cbd93250201974f78"
+  "gitHead": "e1bef43ea888b8474f865a318177cf74087a6d83"
 }

package/types/index.d.ts

@@ -1,11 +1,17 @@
 declare function clearTossPayments(): void;
 
-interface WidgetSelectedPaymentMethod {
+type WidgetSelectedPaymentMethod = {
     /**
      * 구매자가 결제 UI에서 선택한 결제수단입니다. 예를 들어, 신용・체크카드를 선택하면 `CARD` 코드가 응답됩니다. [ENUM 코드](/codes/enum-codes) 및 [기관 코드](/codes/org-codes)를 참고하세요.
      */
-    code: WidgetsPaymentMethodCode;
-}
+    code: Exclude<WidgetsPaymentMethodCode, 'BRANDPAY'>;
+} | {
+    code: 'BRANDPAY';
+    /**
+     * 현재 브랜드페이에서 선택되어 있는 결제수단의 ID입니다.
+     */
+    methodId?: string;
+};
 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 {
@@ -32,9 +38,7 @@ interface WidgetPaymentMethodWidget {
      * @throws {@link PublicError.Widgets.InvalidCallbackParameterError} callback이 유효하지 않은 경우
      * @throws {@link PublicError.Widgets.UnknownError} 알 수 없는 오류가 발생한 경우
      */
-    on: {
-        (eventName: 'paymentMethodSelect', callback: (paymentMethod: WidgetSelectedPaymentMethod) => void): void;
-    };
+    on: (eventName: 'paymentMethodSelect', callback: (paymentMethod: WidgetSelectedPaymentMethod) => void) => void;
     /**
      * 구매자가 선택한 결제수단을 불러옵니다. [자세히 >](#paymentmethodwidgetgetselectedpaymentmethod)
      *
@@ -147,6 +151,15 @@ interface WidgetPaymentRequest {
      * 결제 관련 정보를 추가할 수 있는 객체입니다. 최대 5개의 키-값(key-value) 쌍을 자유롭게 추가해주세요. 키는 `[` , `]` 를 사용하지 않는 최대 40자의 문자열, 값은 최대 500자의 문자열입니다.
      */
     metadata?: Record<string | symbol | number, unknown> | null;
+    /**
+     * @ignore
+     */
+    sandbox?: {
+        /**
+         * @ignore
+         */
+        paymentResult: 'SUCCESS' | 'FAIL';
+    };
     /**
      * 구매자가 카드를 선택하면 결제에 적용되는 옵션입니다.
      */
@@ -196,6 +209,10 @@ interface WidgetPaymentRequest {
              */
             quantity?: number | null;
         }> | null;
+        /**
+         * 문화비(도서, 공연 티켓, 박물관·미술관 입장권 등) 지출 여부입니다.
+         */
+        isCulturalExpenses?: boolean | null;
     } | null;
     /**
      * 구매자가 가상계좌를 선택하면 결제에 적용되는 옵션입니다.
@@ -240,6 +257,10 @@ interface WidgetPaymentRequest {
              */
             type: '소득공제' | '지출증빙' | '미발행';
         } | null;
+        /**
+         * 문화비(도서, 공연 티켓, 박물관·미술관 입장권 등) 지출 여부입니다.
+         */
+        isCulturalExpenses?: boolean | null;
     } | null;
     /**
      * 구매자가 해외간편결제를 선택하면 결제에 적용되는 옵션입니다.
@@ -590,6 +611,10 @@ interface BrandpayPaymentRequest {
      * 결제 금액 중 면세 금액입니다. 면세 상점 혹은 복합 과세 상점으로 계약된 상점만 사용하세요. 자세한 내용은 세금 처리 가이드에서 확인하세요.
      */
     taxFreeAmount?: number | null;
+    /**
+     * 결제수단의 ID입니다. 결제수단 ID 입니다. 등록되어 있는 결제수단 중 하나를 지정해서 바로 결제하고 싶을 때 사용합니다.
+     */
+    methodId?: string | null;
     /**
      * 결제 관련 정보를 추가할 수 있는 객체입니다. 최대 5개의 키-값(key-value) 쌍을 자유롭게 추가해주세요. 키는 `[` , `]` 를 사용하지 않는 최대 40자의 문자열, 값은 최대 500자의 문자열입니다.
      */
@@ -784,6 +809,21 @@ type IsOneTouchPayEnabled = () => Promise<{
     isEnabled: boolean;
 }>;
 
+/**
+ * 자동결제(빌링) 약관 동의와 비밀번호 인증을 수행합니다
+ *
+ * @example
+ * ```javascript
+ * brandpay.requestBillingAuth();
+ * ```
+ *
+ * @throws {@link PublicError.Brandpay.UserCancelError} 사용자가 자동결제 인증창을 닫은 경우
+ * @throws {@link PublicError.Brandpay.NotRegisteredRedirectUrlError} redirectUrl이 등록되지 않은 경우
+ * @throws {@link PublicError.Brandpay.InvalidMethodTransactionError} 이미 다른 명령을 수행 중인 경우
+ * @throws {@link PublicError.Brandpay.UnknownError} 알 수 없는 오류가 발생한 경우
+ */
+type RequestBillingAuth$1 = () => Promise<void>;
+
 interface TossPaymentsBrandpay {
     /**
      * 브랜드페이 결제창을 띄웁니다. [자세히 >](#brandpayrequestpayment)
@@ -809,6 +849,17 @@ interface TossPaymentsBrandpay {
      * 원터치결제 활성화 여부를 확인합니다. [자세히 >](#brandpayisonetouchpayenabled)
      */
     isOneTouchPayEnabled: IsOneTouchPayEnabled;
+    /**
+     * 자동결제(빌링) 약관 동의와 비밀번호 인증을 수행합니다 [자세히 >](#brandpayrequestbillingauth)
+     */
+    /**
+     * @ignore
+     */
+    /**
+     * 브랜드페이 빌링은 sales 가맹점 중 rm 검토된 곳에만 제한적으로 제공되기 때문에 docs에서 노출하지 않습니다.
+     * @link https://tossteam.slack.com/archives/C06ENN7PJK1/p1752207105929219
+     */
+    requestBillingAuth: RequestBillingAuth$1;
 }
 
 interface PaymentRequest {
@@ -856,6 +907,15 @@ interface PaymentRequest {
      * 결제 관련 정보를 추가할 수 있는 객체입니다. 최대 5개의 키-값(key-value) 쌍을 자유롭게 추가해주세요. 키는 `[` , `]` 를 사용하지 않는 최대 40자의 문자열, 값은 최대 500자의 문자열입니다.
      */
     metadata?: Record<string | symbol | number, unknown> | null;
+    /**
+     * @ignore
+     */
+    sandbox?: {
+        /**
+         * @ignore
+         */
+        paymentResult: 'SUCCESS' | 'FAIL';
+    };
 }
 
 interface CardPaymentRequest extends PaymentRequest {
@@ -896,21 +956,21 @@ interface CardPaymentRequest extends PaymentRequest {
         /**
          * 신용카드 결제에 적용되는 할부 개월 수입니다.
          * 예를 들어, `6`으로 설정하면 할부 개월 수가 6개월로 고정돼요. 자체창에서는 구매자가 할부 개월 수를 볼 수 없으니 사전에 충분히 안내를 해주세요.
-         * 0(일시불), 2~12 값으로 설정할 수 있고 `maxCardInstallmentPlan` 파라미터와 함께 사용할 수 없어요. 카드사 별로 할부결제가 가능한 [최소 금액](https://pgweb.tosspayments.com/tosspayments/MainPopUp.do)을 확인하세요.
+         * 0(일시불), 2~12 값으로 설정할 수 있고 `maxCardInstallmentPlan` 파라미터와 함께 사용할 수 없어요. 카드사 별로 할부결제가 가능한 [최소 금액](https://consumer.tosspayments.com/notice/free-installment)을 확인하세요.
          */
         cardInstallmentPlan?: number | null;
         /**
          * 신용카드 결제에 적용할 수 있는 최대 할부 개월 수입니다.
-         * 예를 들어, `6`으로 설정하면 구매자는 일시불부터 6개월 할부를 선택할 수 있어요. 0(일시불), 2~12 값으로 설정할 수 있고 `cardInstallmentPlan` 파라미터와 함께 사용할 수 없어요. 카드사 별로 할부결제가 가능한 [최소 금액](https://pgweb.tosspayments.com/tosspayments/MainPopUp.do)을 확인하세요.
+         * 예를 들어, `6`으로 설정하면 구매자는 일시불부터 6개월 할부를 선택할 수 있어요. 0(일시불), 2~12 값으로 설정할 수 있고 `cardInstallmentPlan` 파라미터와 함께 사용할 수 없어요. 카드사 별로 할부결제가 가능한 [최소 금액](https://consumer.tosspayments.com/notice/free-installment)을 확인하세요.
          */
         maxCardInstallmentPlan?: number | null;
         /**
          * 신용카드 결제에 적용할 수 있는 **상점 부담 무이자** 할부 정보입니다.
-         * 구매자가 선택한 카드, 할부 개월 수가 배열에 등록한 정보와 같다면 무이자가 할부가 자동으로 적용돼요. 카드사 별로 할부결제가 가능한 [최소 금액](https://pgweb.tosspayments.com/tosspayments/MainPopUp.do)을 확인하세요.
+         * 구매자가 선택한 카드, 할부 개월 수가 배열에 등록한 정보와 같다면 무이자가 할부가 자동으로 적용돼요. 카드사 별로 할부결제가 가능한 [최소 금액](https://consumer.tosspayments.com/notice/free-installment)을 확인하세요.
          */
         freeInstallmentPlans?: Array<{
             /**
-             * 상점 부담 무이자를 적용할 카드사 코드](/codes/org-codes#카드사-코드)입니다.
+             * 상점 부담 무이자를 적용할 [카드사 코드](/codes/org-codes#카드사-코드)입니다.
              */
             company: string;
             /**
@@ -972,6 +1032,15 @@ interface CardPaymentRequest extends PaymentRequest {
          * 페이북/ISP 앱에서 상점 앱으로 돌아올 때 사용됩니다. 상점의 앱 스킴을 지정하면 됩니다. 예를 들면 testapp://같은 형태입니다.
          */
         appScheme?: string | null;
+        /**
+         * 키인 결제정보입니다.
+         */
+        keyin?: {
+            /**
+             * 결제화면에 노출할 카드 타입입니다. `PERSONAL`(개인카드), `CORPORATE`(법인카드), `FOREIGN`(해외카드) 값을 배열 형태로 전달할 수 있습니다. 입력한 순서대로 화면에 노출되며, 첫 번째로 입력한 카드 타입이 기본 선택됩니다.
+             */
+            selectableCardTypes?: Array<'PERSONAL' | 'CORPORATE' | 'FOREIGN'> | null;
+        } | null;
     } | null;
 }
 
@@ -1037,6 +1106,10 @@ interface VirtualAccountPaymentRequest extends PaymentRequest {
          * 기한이 지나고 시도하는 결제는 실패해요. 예를 들어 `2025-01-01T00:00:00`으로 설정하면, 2024년 12월 31일 23:59까지 결제할 수 있어요.
          */
         dueDate?: string | null;
+        /**
+         * 문화비(도서, 공연 티켓, 박물관·미술관 입장권 등) 지출 여부입니다.
+         */
+        isCulturalExpenses?: boolean | null;
     } | null;
 }
 
@@ -1054,11 +1127,11 @@ interface TransferPaymentRequest extends PaymentRequest {
          */
         taxExemptionAmount?: number | null;
         /**
-         * @ignore
+         * 현금영수증 정보입니다.
          */
         cashReceipt?: {
             /**
-             * @ignore
+             *  type을 '미발행' 으로 보내면 현금영수증을 발행하지 않습니다.
              */
             type: '소득공제' | '지출증빙' | '미발행';
         } | null;
@@ -1103,6 +1176,10 @@ interface TransferPaymentRequest extends PaymentRequest {
          * 기한이 지나고 시도하는 결제는 실패해요. 예를 들어 `2025-01-01T00:00:00`으로 설정하면, 2024년 12월 31일 23:59까지 결제할 수 있어요.
          */
         dueDate?: string | null;
+        /**
+         * 문화비(도서, 공연 티켓, 박물관·미술관 입장권 등) 지출 여부입니다.
+         */
+        isCulturalExpenses?: boolean | null;
     } | null;
 }
 
@@ -1239,7 +1316,6 @@ interface RequestPaymentResult {
 interface BillingAuthRequest {
     /**
      * 자동결제(빌링)에 등록할 결제수단입니다. 토스페이먼츠 자동결제는 현재 신용·체크카드만 지원해요.
-     *
      */
     method: 'CARD' | 'TRANSFER';
     /**
@@ -1272,6 +1348,10 @@ interface BillingAuthRequest {
      * @default 'iframe'
      */
     windowTarget?: 'iframe' | 'self' | null;
+    /**
+     * 결제화면에 노출할 카드 타입입니다. `PERSONAL`(개인카드), `CORPORATE`(법인카드), `FOREIGN`(해외카드) 값을 배열 형태로 전달할 수 있습니다. 입력한 순서대로 화면에 노출되며, 첫 번째로 입력한 카드 타입이 기본 선택됩니다.
+     */
+    selectableCardTypes?: Array<'PERSONAL' | 'CORPORATE'> | null;
 }
 
 /**
@@ -1293,7 +1373,7 @@ interface BillingAuthRequest {
 type RequestPayment = RequestCardPaymentWithRedirection & RequestCardPaymentWithPromise & RequestVirtualAccountPaymentWithRedirection & RequestVirtualAccountPaymentWithPromise & RequestTransferPaymentWithRedirection & RequestTransferPaymentWithPromise & RequestMobilePhonePaymentWithRedirection & RequestMobilePhonePaymentWithPromise & RequestGiftCertificatePaymentWithRedirection & RequestGiftCertificatePaymentWithPromise & RequestForeignEasyPayPaymentWithRedirection;
 /**
  * @docsAlias 카드(Promise 방식)
- * @returns `WidgetPaymentResult` 객체가 응답됩니다. 객체 필드를 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해야 결제가 최종적으로 완료돼요.
+ * @returns `RequestPaymentResult` 객체가 응답됩니다. 객체 필드를 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해야 결제가 최종적으로 완료돼요.
  * @param {RequestCardPaymentWithPromise} paymentRequest 결제 요청 정보입니다.
  *
  * @example
@@ -1359,7 +1439,7 @@ type RequestCardPaymentWithPromise = (paymentRequest: CardPaymentRequest) => Pro
 type RequestCardPaymentWithRedirection = (paymentRequest: WithRedirection<CardPaymentRequest>) => Promise<void>;
 /**
  * @docsAlias 가상계좌(Promise 방식)
- * @returns `WidgetPaymentResult` 객체가 응답됩니다. 객체 필드를 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해야 결제가 최종적으로 완료돼요.
+ * @returns `RequestPaymentResult` 객체가 응답됩니다. 객체 필드를 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해야 결제가 최종적으로 완료돼요.
  * @param {VirtualAccountPaymentRequest} paymentRequest 결제 요청 정보입니다.
  *
  * @example
@@ -1427,7 +1507,7 @@ type RequestVirtualAccountPaymentWithPromise = (paymentRequest: VirtualAccountPa
 type RequestVirtualAccountPaymentWithRedirection = (paymentRequest: WithRedirection<VirtualAccountPaymentRequest>) => Promise<void>;
 /**
  * @docsAlias 계좌이체(Promise 방식)
- * @returns `WidgetPaymentResult` 객체가 응답됩니다. 객체 필드를 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해야 결제가 최종적으로 완료돼요.
+ * @returns `RequestPaymentResult` 객체가 응답됩니다. 객체 필드를 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해야 결제가 최종적으로 완료돼요.
  * @param {RequestTransferPaymentWithPromise} paymentRequest 결제 요청 정보입니다.
  *
  * @example
@@ -1492,7 +1572,7 @@ type RequestTransferPaymentWithPromise = (paymentRequest: TransferPaymentRequest
 type RequestTransferPaymentWithRedirection = (paymentRequest: WithRedirection<TransferPaymentRequest>) => Promise<void>;
 /**
  * @docsAlias 휴대폰 결제(Promise 방식)
- * @returns `WidgetPaymentResult` 객체가 응답됩니다. 객체 필드를 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해야 결제가 최종적으로 완료돼요.
+ * @returns `RequestPaymentResult` 객체가 응답됩니다. 객체 필드를 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해야 결제가 최종적으로 완료돼요.
  * @param {RequestMobilePhonePaymentWithPromise} paymentRequest 결제 요청 정보입니다.
  *
  * @example
@@ -1545,7 +1625,7 @@ type RequestMobilePhonePaymentWithPromise = (paymentRequest: MobilePhonePaymentR
 type RequestMobilePhonePaymentWithRedirection = (paymentRequest: WithRedirection<MobilePhonePaymentRequest>) => Promise<void>;
 /**
  * @docsAlias 상품권(Promise 방식)
- * @returns `WidgetPaymentResult` 객체가 응답됩니다. 객체 필드를 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해야 결제가 최종적으로 완료돼요.
+ * @returns `RequestPaymentResult` 객체가 응답됩니다. 객체 필드를 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해야 결제가 최종적으로 완료돼요.
  * @param {RequestGiftCertificatePaymentWithPromise} paymentRequest 결제 요청 정보입니다.
  *
  * @example