@tosspayments/tosspayments-sdk 2.4.1 → 2.5.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tosspayments/tosspayments-sdk",
   "description": "TossPayments.js Tosspayments SDK.",
-  "version": "2.4.1",
+  "version": "2.5.0",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "types": "types/index.d.ts",
@@ -26,7 +26,7 @@
     "@rollup/plugin-commonjs": "^21.0.1",
     "@rollup/plugin-typescript": "^8.3.0",
     "@tosspayments/sdk-loader": "workspace:packages/sdk-loader",
-    "@tosspayments/standard-public-interfaces": "2.4.2",
+    "@tosspayments/standard-public-interfaces": "2.5.0",
     "happy-dom": "^14.12.3",
     "prettier": "^2.0.2",
     "rollup": "^2.60.0",

package/types/index.d.ts

@@ -277,7 +277,7 @@ interface WidgetPaymentRequest {
          */
         products?: Array<{
             /**
-             * 상품명입니다.
+             * 상품명입니다. 최대 길이는 100자입니다.
              */
             name: string;
             /**
@@ -1317,7 +1317,7 @@ interface ForeignEasyPayPaymentRequest extends PaymentRequest {
          */
         products?: Array<{
             /**
-             * 상품명입니다.
+             * 상품명입니다. 최대 길이는 100자입니다.
              */
             name: string;
             /**
@@ -1409,20 +1409,19 @@ interface RequestPaymentResult {
     amount: Amount;
 }
 
-interface BillingAuthRequest {
-    /**
-     * 자동결제(빌링)에 등록할 결제수단입니다. 토스페이먼츠 자동결제는 현재 신용·체크카드만 지원해요.
-     */
-    method: 'CARD' | 'TRANSFER';
+/**
+ * 자동결제(빌링) 등록 요청의 공통 필드입니다.
+ */
+interface BaseBillingAuthRequest {
     /**
-     * 카드 등록이 성공하면 리다이렉트되는 URL입니다. 리다이렉트되면 URL의 쿼리 파라미터로 `authKey`, `customerKey`가 추가돼요. 값을 검증하고 [빌링키 발급 API](/reference#authkey로-카드-빌링키-발급)를 호출하세요.
+     * 등록이 성공하면 리다이렉트되는 URL입니다. 리다이렉트되면 URL의 쿼리 파라미터로 `authKey`, `customerKey`가 추가돼요. 값을 검증하고 [빌링키 발급 API](/reference#authkey로-카드-빌링키-발급)를 호출하세요.
      * 반드시 오리진을 포함해야 합니다.
      *
      * @example https://www.example.com/success
      */
     successUrl: string;
     /**
-     * 카드 등록이 실패하면 리다이렉트되는 URL입니다. 리다이렉트되면 URL의 쿼리 파라미터로 에러 코드와 메시지를 확인할 수 있어요.
+     * 등록이 실패하면 리다이렉트되는 URL입니다. 리다이렉트되면 URL의 쿼리 파라미터로 에러 코드와 메시지를 확인할 수 있어요.
      * 반드시 오리진을 포함해야 합니다.
      */
     failUrl: string;
@@ -1444,11 +1443,49 @@ interface BillingAuthRequest {
      * @default 'iframe'
      */
     windowTarget?: 'iframe' | 'self' | null;
+}
+/**
+ * 카드 자동결제(빌링) 등록 요청 정보입니다.
+ */
+interface CardBillingAuthRequest extends BaseBillingAuthRequest {
+    /**
+     * 자동결제(빌링)에 등록할 결제수단입니다.
+     */
+    method: 'CARD';
     /**
      * 결제화면에 노출할 카드 타입입니다. `PERSONAL`(개인카드), `CORPORATE`(법인카드) 값을 배열 형태로 전달할 수 있습니다. 입력한 순서대로 화면에 노출되며, 첫 번째로 입력한 카드 타입이 기본 선택됩니다.
      */
     selectableCardTypes?: Array<'PERSONAL' | 'CORPORATE'> | null;
+    /**
+     * 결제창을 여는 방법입니다. `DEFAULT`는 기존 카드 빌링창을 열고, `DIRECT`는 easyPay로 전달된 간편결제의 자체창을 엽니다.
+     * 기본 값은 `DEFAULT`입니다.
+     */
+    flowMode?: 'DIRECT' | 'DEFAULT';
+    /**
+     * 간편결제사 코드입니다. 현재 빌링을 지원하는 간편결제사는 토스페이, 네이버페이가 있습니다.
+     * `flowMode: 'DIRECT'`일 때만 사용할 수 있습니다.
+     */
+    easyPay?: '토스페이' | 'TOSSPAY' | '네이버페이' | 'NAVERPAY';
+    /**
+     * 간편결제에서 특정 카드사만 노출할 수 있도록 파라미터를 제공합니다.
+     * `flowMode: 'DIRECT'`일 때만 사용할 수 있습니다.
+     */
+    cardCompany?: string;
 }
+/**
+ * 계좌이체 자동결제(빌링) 등록 요청 정보입니다.
+ */
+interface TransferBillingAuthRequest extends BaseBillingAuthRequest {
+    /**
+     * 자동결제(빌링)에 등록할 결제수단입니다.
+     */
+    method: 'TRANSFER';
+}
+/**
+ * 자동결제(빌링) 등록 요청 정보입니다. 토스페이먼츠 자동결제는 신용·체크카드, 계좌이체를 지원해요.
+ * `method` 필드에 따라 사용 가능한 필드가 달라집니다.
+ */
+type BillingAuthRequest = CardBillingAuthRequest | TransferBillingAuthRequest;
 
 /**
  *
@@ -1812,7 +1849,7 @@ type RequestForeignEasyPayPaymentWithRedirection = (paymentRequest: WithRedirect
 /**
  * 자동결제(빌링) 결제창을 열어 구매자의 카드 등록을 요청하는 메서드입니다.
  *
- * @param {BillingAuthRequest} billingAuthRequest 자동결제(빌링) 카드 등록에 필요한 정보입니다.
+ * @param {BillingAuthRequest} billingAuthRequest 자동결제(빌링) 등록에 필요한 정보입니다.
  * @returns URL이 이동하기 때문에 `void`가 응답됩니다. 파라미터로 설정한 `successUrl` 또는 `failUrl`에서 카드 등록 결과를 확인하고 [빌링키 발급 API](/reference#authkey로-카드-빌링키-발급)를 호출해야 자동결제를 할 수 있어요.
  *
  * @example