@tosspayments/tosspayments-sdk 2.8.0 → 2.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +59 -50
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@tosspayments/tosspayments-sdk",
3
3
  "description": "TossPayments.js Tosspayments SDK.",
4
- "version": "2.8.0",
4
+ "version": "2.9.0",
5
5
  "main": "dist/index.cjs.js",
6
6
  "module": "dist/index.esm.js",
7
7
  "types": "types/index.d.ts",
package/types/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  declare function clearTossPayments(): void;
2
2
 
3
- // standard-public-interfaces 2.17.1 — 자동 생성 파일입니다. 직접 수정하지 마세요.
3
+ // standard-public-interfaces 2.19.0 — 자동 생성 파일입니다. 직접 수정하지 마세요.
4
4
 
5
5
  type WidgetSelectedPaymentMethod = {
6
6
  /**
@@ -27,13 +27,13 @@ interface WidgetPaymentMethodWidget {
27
27
  // 카드 안내사항 노출
28
28
  }
29
29
  if (selectedPaymentMethod.code === '문화바우처') {
30
- // 커스텀 결제수단 (결제위젯 Pro 플랜 기능)
30
+ // 커스텀 결제수단 (결제 Pro 플랜 기능)
31
31
  // 문화바우처 안내사항 노출
32
32
  }
33
33
  });
34
34
  * ```
35
35
  *
36
- * @param {'paymentMethodSelect'} eventName 구독할 이벤트입니다. `paymentMethodSelect` 이벤트로 구매자가 선택한 결제수단 코드를 확인하세요. 일반결제는 [결제수단 ENUM 코드](/codes/enum-codes#결제수단-타입)가 응답돼요. 결제위젯 Pro 플랜으로 [커스텀 결제수단](/guides/v2/payment-widget/pro/integration-custom)을 연동했다면 결제위젯 어드민에서 설정한 `key` 값이 응답돼요.
36
+ * @param {'paymentMethodSelect'} eventName 구독할 이벤트입니다. `paymentMethodSelect` 이벤트로 구매자가 선택한 결제수단 코드를 확인하세요. 일반결제는 [결제수단 ENUM 코드](/codes/enum-codes#결제수단-타입)가 응답돼요. 결제 Pro 플랜으로 [커스텀 결제수단](/guides/v2/payment-widget/pro/integration-custom)을 연동했다면 결제 어드민에서 설정한 `key` 값이 응답돼요.
37
37
  * @param {function} callback 이벤트가 일어나면 호출되는 콜백 함수입니다.
38
38
  *
39
39
  * @throws {@link PublicError.Widgets.InvalidEventParameterError} eventName이 유효하지 않은 경우
@@ -78,7 +78,7 @@ interface WidgetAgreementStatus {
78
78
 
79
79
  interface WidgetAgreementWidget {
80
80
  /**
81
- * 약관 UI의 이벤트를 구독합니다. [자세히](#widgetagreementwidgeton)
81
+ * 약관 UI의 이벤트를 구독합니다. [자세히 >](#agreementwidgeton)
82
82
  *
83
83
  * @param {'agreementStatusChange'} eventName 구독할 이벤트입니다. `agreementStatusChange` 이벤트로 구매자가 약관에 동의했는지 확인하세요.
84
84
  * @param {function} callback 이벤트가 일어나면 호출되는 콜백 함수입니다.
@@ -176,13 +176,11 @@ interface WidgetPaymentRequest {
176
176
  */
177
177
  appScheme?: string | null;
178
178
  /**
179
- * 해외카드 결제의 3D Secure 인증 옵션입니다.
179
+ * @ignore
180
180
  */
181
181
  threeDS?: {
182
182
  /**
183
- * 3D Secure 인증에서 구매자에게 챌린지(추가 인증)를 요구할지 여부입니다.
184
- * `CHALLENGE_REQUIRED`로 설정하면 챌린지 인증을 필수로 요청하고, 카드 발급사가 챌린지 없이 인증을 완료하면 인증을 거절하고 `failUrl`로 이동해요.
185
- * 값을 설정하지 않으면 챌린지 여부를 카드 발급사 판단에 맡겨요.
183
+ * @ignore
186
184
  */
187
185
  challengeMode?: 'CHALLENGE_REQUIRED' | null;
188
186
  } | null;
@@ -442,7 +440,7 @@ interface WidgetPaymentRequestWindow extends WidgetPaymentRequest {
442
440
  }
443
441
  interface WidgetPaymentRequestWindowOptions {
444
442
  /**
445
- * 결제위젯 UI의 variantKey 정보입니다. [결제위젯 어드민](https://dashboard.tosspayments.com/payment-widget-service/)에서 확인할 수 있어요.
443
+ * 결제 UI의 variantKey 정보입니다. [결제 어드민](https://dashboard.tosspayments.com/payment-widget-service/)에서 확인할 수 있어요.
446
444
  */
447
445
  variantKey?: {
448
446
  /**
@@ -458,10 +456,10 @@ interface WidgetPaymentRequestWindowOptions {
458
456
 
459
457
  interface WidgetPaymentWindow {
460
458
  /**
461
- * 결제창의 이벤트를 구독합니다.
459
+ * 결제창 이벤트를 구독합니다. [자세히 >](#paymentwindowon)
462
460
  *
463
- * @param {'paymentRequest' | 'cancel'} eventName 구독할 이벤트입니다.
464
- * @param {function} callback 이벤트가 일어나면 호출되는 콜백 함수입니다.
461
+ * @param {'paymentRequest' | 'cancel'} eventName 구독할 이벤트입니다. `paymentRequest`로 구매자의 결제 요청을 받아 [widgets.requestPayment()](#widgetsrequestpayment)를 호출하고, `cancel`로 구매자가 결제를 포기한 순간을 감지할 수 있어요.
462
+ * @param {function} callback 이벤트가 일어나면 호출되는 콜백 함수입니다. `paymentRequest`는 콜백 파라미터로 `paymentMethod` 객체가 전달돼요. 일반 결제수단은 `{ code }`, 브랜드페이는 `{ code: 'BRANDPAY', methodId }` 형태예요. `cancel`은 콜백 파라미터가 없어요.
465
463
  *
466
464
  * @throws {@link PublicError.Widgets.InvalidEventParameterError} eventName이 유효하지 않은 경우
467
465
  * @throws {@link PublicError.Widgets.InvalidCallbackParameterError} callback이 유효하지 않은 경우
@@ -469,7 +467,7 @@ interface WidgetPaymentWindow {
469
467
  */
470
468
  on: WidgetPaymentWindowOnPaymentRequest & WidgetPaymentWindowOnCancel;
471
469
  /**
472
- * 결제창을 제거합니다.
470
+ * 결제창을 제거합니다. [자세히 >](#paymentwindowdestroy)
473
471
  *
474
472
  * @example
475
473
  * ```javascript
@@ -484,7 +482,7 @@ interface WidgetPaymentWindow {
484
482
  * @docsAlias paymentRequest 이벤트
485
483
  *
486
484
  * @param {'paymentRequest'} eventName 구독할 이벤트입니다. `paymentRequest` 이벤트로 구매자의 결제 요청을 수신하세요.
487
- * @param {function} callback 이벤트가 일어나면 호출되는 콜백 함수입니다.
485
+ * @param {function} callback 이벤트가 일어나면 호출되는 콜백 함수입니다. `paymentRequest`는 콜백 파라미터로 `paymentMethod` 객체가 전달돼요. 일반 결제수단은 `{ code }`, 브랜드페이는 `{ code: 'BRANDPAY', methodId }` 형태예요. `cancel`은 콜백 파라미터가 없어요.
488
486
  *
489
487
  * @example
490
488
  * ```javascript
@@ -500,7 +498,7 @@ type WidgetPaymentWindowOnPaymentRequest = (eventName: 'paymentRequest', callbac
500
498
  * @docsAlias cancel 이벤트
501
499
  *
502
500
  * @param {'cancel'} eventName 구독할 이벤트입니다. `cancel` 이벤트로 구매자가 결제를 포기했는지 확인하세요. 구매자가 결제창을 닫으면 결제창이 사라진 뒤에 콜백이 호출돼요. `paymentWindow.destroy()`로 결제창을 닫은 경우에는 호출되지 않아요.
503
- * @param {function} callback 이벤트가 일어나면 호출되는 콜백 함수입니다.
501
+ * @param {function} callback 이벤트가 일어나면 호출되는 콜백 함수입니다. `paymentRequest`는 콜백 파라미터로 `paymentMethod` 객체가 전달돼요. 일반 결제수단은 `{ code }`, 브랜드페이는 `{ code: 'BRANDPAY', methodId }` 형태예요. `cancel`은 콜백 파라미터가 없어요.
504
502
  *
505
503
  * @example
506
504
  * ```javascript
@@ -540,7 +538,7 @@ type RenderPaymentMethods = (params: {
540
538
  */
541
539
  selector: string;
542
540
  /**
543
- * 렌더링하고 싶은 결제 UI의 `variantKey`입니다. 2개 이상의 결제 UI를 사용하고 있다면 설정해주세요. `variantKey`는 [상점관리자의 결제위젯 어드민](/guides/v2/payment-widget#2-결제-ui의-variantkey-확인)에서 확인할 수 있어요. 기본 값은 `DEFAULT`입니다.
541
+ * 렌더링하고 싶은 결제 UI의 `variantKey`입니다. 2개 이상의 결제 UI를 사용하고 있다면 설정해주세요. `variantKey`는 [상점관리자의 결제 어드민](/guides/v2/payment-widget#2-결제-ui의-variantkey-확인)에서 확인할 수 있어요. 기본 값은 `DEFAULT`입니다.
544
542
  */
545
543
  variantKey?: string;
546
544
  }) => Promise<WidgetPaymentMethodWidget>;
@@ -573,7 +571,7 @@ type RenderAgreement = (params: {
573
571
  */
574
572
  selector: string;
575
573
  /**
576
- * 렌더링하고 싶은 약관 UI의 `variantKey`입니다. 상점관리자의 결제위젯 어드민에서 확인할 수 있어요.
574
+ * 렌더링하고 싶은 약관 UI의 `variantKey`입니다. 상점관리자의 결제 어드민에서 확인할 수 있어요.
577
575
  */
578
576
  variantKey?: string;
579
577
  }) => Promise<WidgetAgreementWidget>;
@@ -679,7 +677,7 @@ type SetAmount = (amount: Amount) => Promise<void>;
679
677
  * @docsDefaultSignature RequestPaymentWindowWithRedirection
680
678
  *
681
679
  * @param {WidgetPaymentRequestWindow} paymentRequest - 결제 요청 정보입니다.
682
- * @param {WidgetPaymentRequestWindowOptions} options - 위젯 결제창 옵션입니다.
680
+ * @param {WidgetPaymentRequestWindowOptions} [options] - 위젯 결제창 옵션입니다.
683
681
  *
684
682
  * @returns 결제 결과
685
683
  *
@@ -703,7 +701,7 @@ type RequestPaymentWindow = RequestPaymentWindowWithPromise & RequestPaymentWind
703
701
  * @docsAlias Promise 방식
704
702
  * @returns `WidgetPaymentResult` 객체가 응답됩니다. 객체 필드를 확인하고 [결제 승인 API](/reference#결제-승인)를 호출해야 결제가 최종적으로 완료돼요.
705
703
  * @param {WidgetPaymentRequestWindow} paymentRequest 결제 요청 정보입니다.
706
- * @param {WidgetPaymentRequestWindowOptions} options 위젯 결제창 옵션입니다.
704
+ * @param {WidgetPaymentRequestWindowOptions} [options] 위젯 결제창 옵션입니다.
707
705
  *
708
706
  * @example
709
707
  * ```js
@@ -739,7 +737,7 @@ type RequestPaymentWindowWithPromise = (paymentRequest: WidgetPaymentRequestWind
739
737
  * Redirect 방식에서는 URL이 이동하기 때문에 `void`가 응답됩니다.
740
738
 
741
739
  * @param {WidgetPaymentRequestWindow} paymentRequest 결제 요청 정보입니다.
742
- * @param {WidgetPaymentRequestWindowOptions} options 위젯 결제창 옵션입니다.
740
+ * @param {WidgetPaymentRequestWindowOptions} [options] 위젯 결제창 옵션입니다.
743
741
  *
744
742
  * @example
745
743
  * ```js
@@ -765,13 +763,14 @@ type RequestPaymentWindowWithRedirection = (paymentRequest: WithRedirection<Widg
765
763
 
766
764
  /**
767
765
  * 결제창을 렌더링합니다
768
- * @param {object} params 결제창 렌더링 정보입니다.
766
+ * @param {object} [params] 결제창 렌더링 정보입니다. 생략할 수 있어요.
769
767
  *
770
- * @returns 반환되는 결제창 객체로 아래 메서드를 호출할 수 있어요.
768
+ * @returns 아래 메서드를 호출할 수 있는 결제창 객체를 Promise로 반환해요.
771
769
  *
772
770
  * @example
773
771
  * ```javascript
774
772
  * const paymentWindow = await widgets.renderPaymentWindow({
773
+ * orderName: "토스 티셔츠 외 2건",
775
774
  * variantKey: {
776
775
  * paymentMethod: "CUSTOM-1",
777
776
  * agreement: "AGREEMENT",
@@ -789,7 +788,12 @@ type RequestPaymentWindowWithRedirection = (paymentRequest: WithRedirection<Widg
789
788
  */
790
789
  type RenderPaymentWindow = (params?: {
791
790
  /**
792
- * 결제위젯 UI의 variantKey 정보입니다. [결제위젯 어드민](https://dashboard.tosspayments.com/payment-widget-service/)에서 확인할 수 있어요.
791
+ * 구매상품입니다. 예를 들면 `생수 외 1건` 같은 형식입니다. 최대 길이는 100자입니다.
792
+ * 결제창에 표시돼요. [widgets.requestPayment()](#widgetsrequestpayment)에 전달하는 `orderName`과 같은 값이어야 해요. 다르면 `requestPayment()`에서 `InvalidParametersError`가 발생해요.
793
+ */
794
+ orderName?: string;
795
+ /**
796
+ * 결제 UI의 variantKey 정보입니다. [결제 어드민](https://dashboard.tosspayments.com/payment-widget-service/)에서 확인할 수 있어요.
793
797
  */
794
798
  variantKey?: {
795
799
  /**
@@ -1315,40 +1319,47 @@ interface CardPaymentRequest extends PaymentRequest {
1315
1319
  useEscrow?: boolean | null;
1316
1320
  /**
1317
1321
  * 과세를 제외한 결제 금액(컵 보증금 등)입니다.
1322
+ *
1318
1323
  * 과세 제외 금액이 있는 카드 결제는 부분 취소가 안 됩니다.
1319
1324
  */
1320
1325
  taxExemptionAmount?: number | null;
1321
1326
  /**
1322
1327
  * 결제창을 여는 방법입니다. `DEFAULT`는 카드/간편결제 통합결제창을 열고, `DIRECT`는 카드 또는 간편결제의 자체창을 열어요.
1328
+ *
1323
1329
  * 기본 값은 `DEFAULT`입니다.
1324
1330
  */
1325
1331
  flowMode?: 'DIRECT' | 'DEFAULT' | null;
1326
1332
  /**
1327
1333
  * [카드사 코드](/codes/org-codes#카드사-코드)입니다. `flowMode` 값에 따라 아래와 같이 다르게 동작해요.
1334
+ *
1328
1335
  * `flowMode`가 `DIRECT`일 때는 입력한 코드의 카드사 앱이 열려요.
1329
- * `flowMode`가 `DEFAULT`일 때는 통합결제창에 입력한 코드의 카드사만 보여요.
1336
+ * `flowMode`가 `DEFAULT`일 때는 통합결제창에 입력한 코드의 카드사만 표시돼요. 파이프(`|`)로 구분해서 여러 카드사를 지정할 수 있어요. 예를 들어, `BC|삼성`을 입력하면 BC카드와 삼성카드가 결제창에 표시돼요.
1330
1337
  */
1331
1338
  cardCompany?: string | null;
1332
1339
  /**
1333
1340
  * [간편결제 코드](/codes/org-codes#간편결제사-코드)입니다. `flowMode` 값에 따라 아래와 같이 다르게 동작해요.
1341
+ *
1334
1342
  * `flowMode`가 `DIRECT`일 때는 입력한 코드의 간편결제 앱이 열려요.
1335
1343
  * `flowMode`가 `DEFAULT`일 때는 해당 파라미터와 상관 없이 기본 통합결제창이 열려요.
1336
1344
  */
1337
1345
  easyPay?: string | null;
1338
1346
  /**
1339
1347
  * 신용카드 결제에 적용되는 할부 개월 수입니다.
1348
+ *
1340
1349
  * 예를 들어, `6`으로 설정하면 할부 개월 수가 6개월로 고정돼요. 자체창에서는 구매자가 할부 개월 수를 볼 수 없으니 사전에 충분히 안내를 해주세요.
1341
1350
  * 0(일시불), 2~12 값으로 설정할 수 있고 `maxCardInstallmentPlan` 파라미터와 함께 사용할 수 없어요. 카드사 별로 할부결제가 가능한 [최소 금액](https://consumer.tosspayments.com/notice/free-installment)을 확인하세요.
1342
1351
  */
1343
1352
  cardInstallmentPlan?: number | null;
1344
1353
  /**
1345
1354
  * 신용카드 결제에 적용할 수 있는 최대 할부 개월 수입니다.
1355
+ *
1346
1356
  * 예를 들어, `6`으로 설정하면 구매자는 일시불부터 6개월 할부를 선택할 수 있어요. 0(일시불), 2~12 값으로 설정할 수 있고 `cardInstallmentPlan` 파라미터와 함께 사용할 수 없어요. 카드사 별로 할부결제가 가능한 [최소 금액](https://consumer.tosspayments.com/notice/free-installment)을 확인하세요.
1347
1357
  */
1348
1358
  maxCardInstallmentPlan?: number | null;
1349
1359
  /**
1350
1360
  * 신용카드 결제에 적용할 수 있는 **상점 부담 무이자** 할부 정보입니다.
1351
- * 구매자가 선택한 카드, 할부 개월 수가 배열에 등록한 정보와 같다면 무이자가 할부가 자동으로 적용돼요. 카드사 별로 할부결제가 가능한 [최소 금액](https://consumer.tosspayments.com/notice/free-installment)을 확인하세요.
1361
+ *
1362
+ * 구매자가 선택한 카드, 할부 개월 수가 배열에 등록한 정보와 같다면 무이자 할부가 자동으로 적용돼요. 카드사 별로 할부결제가 가능한 [최소 금액](https://consumer.tosspayments.com/notice/free-installment)을 확인하세요.
1352
1363
  */
1353
1364
  freeInstallmentPlans?: Array<{
1354
1365
  /**
@@ -1376,11 +1387,13 @@ interface CardPaymentRequest extends PaymentRequest {
1376
1387
  discountCode?: string | null;
1377
1388
  /**
1378
1389
  * 시간으로 설정하는 결제 기한입니다. 설정할 수 있는 최대 값은 2160시간(90일)입니다.
1390
+ *
1379
1391
  * 기한이 지나고 시도하는 결제는 실패해요. 예를 들어 `24`로 설정하면, 결제 요청 시점으로부터 24시간 동안 결제할 수 있어요.
1380
1392
  */
1381
1393
  validHours?: number | null;
1382
1394
  /**
1383
1395
  * 특정 날짜로 설정하는 결제 기한입니다. `yyyy-MM-dd'T'HH:mm:ss` ISO 8601 형식입니다.
1396
+ *
1384
1397
  * 기한이 지나고 시도하는 결제는 실패해요. 예를 들어 `2025-01-01T00:00:00`으로 설정하면, 2024년 12월 31일 23:59까지 결제할 수 있어요.
1385
1398
  */
1386
1399
  dueDate?: string | null;
@@ -1407,27 +1420,23 @@ interface CardPaymentRequest extends PaymentRequest {
1407
1420
  quantity?: number | null;
1408
1421
  }> | null;
1409
1422
  /**
1410
- * 해외카드(Visa, MasterCard, JCB, UnionPay 등) 결제 여부입니다. `true`로 설정하면 해외카드 결제가 가능한 [다국어 결제창](/resources/glossary/payment-window#다국어-결제창)이 열립니다.
1423
+ * 해외카드(Visa, MasterCard, JCB, UnionPay 등) 결제 여부입니다. `true`로 설정하면 해외카드 결제가 가능한 [다국어 결제창](/resources/glossary/payment-window#어떤-기능이-있나요)이 열립니다.
1411
1424
  */
1412
1425
  useInternationalCardOnly?: boolean | null;
1413
1426
  /**
1414
- * 결제창 초기 언어입니다. `KO`(한국어), `EN`(영어), `JA`(일본어), `ZH`(중국어) 중 하나로 설정할 수 있어요.
1415
- * 값을 설정하지 않으면 결제 통화에 따라 자동으로 결정됩니다.
1427
+ * 결제창 초기 언어입니다. `KO`(한국어), `EN`(영어), `JA`(일본어), `ZH`(중국어) 중 하나로 설정할 수 있어요. 값을 설정하지 않으면 결제 통화에 따라 자동으로 결정됩니다.
1416
1428
  */
1417
1429
  language?: 'KO' | 'EN' | 'JA' | 'ZH' | null;
1418
1430
  /**
1419
- * 다국어 결제창에서 결제 금액 영역에 함께 표시되는 자국 통화 환산 추정 금액(예: `Estimated amount in USD $ 0.07`)의 노출 여부입니다.
1420
- * `false`로 설정하면 환산 추정 금액이 표시되지 않아요. 값을 설정하지 않으면 `true`로 동작하며, 다국어 결제창이 아닌 경우에는 적용되지 않습니다.
1431
+ * 다국어 결제창에서 예상 결제 금액(USD 환산값) 노출 여부입니다. 기본값은 `true`이고, `false`로 설정하면 예상 결제 금액이 숨겨집니다. `useInternationalCardOnly`가 `true`이고 결제 통화가 `KRW`일 때만 적용됩니다.
1421
1432
  */
1422
1433
  showEstimatedAmount?: boolean | null;
1423
1434
  /**
1424
- * 해외카드 결제의 3D Secure 인증 옵션입니다.
1435
+ * @ignore
1425
1436
  */
1426
1437
  threeDS?: {
1427
1438
  /**
1428
- * 3D Secure 인증에서 구매자에게 챌린지(추가 인증)를 요구할지 여부입니다.
1429
- * `CHALLENGE_REQUIRED`로 설정하면 챌린지 인증을 필수로 요청하고, 카드 발급사가 챌린지 없이 인증을 완료하면 인증을 거절하고 `failUrl`로 이동해요.
1430
- * 값을 설정하지 않으면 챌린지 여부를 카드 발급사 판단에 맡겨요.
1439
+ * @ignore
1431
1440
  */
1432
1441
  challengeMode?: 'CHALLENGE_REQUIRED' | null;
1433
1442
  } | null;
@@ -1445,8 +1454,7 @@ interface CardPaymentRequest extends PaymentRequest {
1445
1454
  selectableCardTypes?: Array<'PERSONAL' | 'CORPORATE' | 'FOREIGN'> | null;
1446
1455
  } | null;
1447
1456
  /**
1448
- * 모바일 결제창 상단 헤더의 노출 여부입니다. `false`로 설정하면 헤더가 표시되지 않아요.
1449
- * 값을 설정하지 않으면 `true`로 동작합니다.
1457
+ * 모바일 결제창 상단 헤더의 노출 여부입니다. `false`로 설정하면 헤더가 표시되지 않아요. 값을 설정하지 않으면 `true`로 동작합니다.
1450
1458
  */
1451
1459
  showMobileAppHeader?: boolean | null;
1452
1460
  /**
@@ -1629,6 +1637,10 @@ interface TransferPaymentRequest extends PaymentRequest {
1629
1637
  * @ignore
1630
1638
  */
1631
1639
  encryptedCustomerCi?: string | null;
1640
+ /**
1641
+ * @ignore
1642
+ */
1643
+ encryptedCustomerKey?: string | null;
1632
1644
  /**
1633
1645
  * @ignore
1634
1646
  */
@@ -1659,10 +1671,7 @@ interface MobilePhonePaymentRequest extends PaymentRequest {
1659
1671
  */
1660
1672
  mobilePhone?: {
1661
1673
  /**
1662
- * 휴대폰 결제창에서 선택할 수 있는 통신사를 제한합니다.
1663
- * `SKT`(SK텔레콤), `KT`(KT), `LGU`(LG유플러스), `HELLO`(LG헬로모바일), `KCT`(티플러스), `SK7`(SK세븐모바일) 값을 배열 형태로 전달할 수 있습니다.
1664
- * 예를 들어 `['KT', 'SKT']`로 설정하면 두 통신사만 선택할 수 있어요. 값을 설정하지 않으면 모든 통신사가 노출됩니다.
1665
- * 전체 목록은 [통신사 코드](https://docs.tosspayments.com/codes/org-codes#통신사-코드)에서 확인하세요.
1674
+ * 휴대폰 결제창에서 선택할 수 있는 통신사를 제한합니다. `SKT`(SK텔레콤), `KT`(KT), `LGU`(LG유플러스), `HELLO`(LG헬로모바일), `KCT`(티플러스), `SK7`(SK세븐모바일) 값을 배열 형태로 전달할 수 있습니다. 예를 들어 `['KT', 'SKT']`로 설정하면 두 통신사만 선택할 수 있어요. 값을 설정하지 않으면 모든 통신사가 노출됩니다. 전체 목록은 [통신사 코드](/codes/org-codes#통신사-코드)에서 확인하세요.
1666
1675
  */
1667
1676
  mobileCarriers?: Array<'KT' | 'LGU' | 'SKT' | 'HELLO' | 'KCT' | 'SK7'> | null;
1668
1677
  } | null;
@@ -2284,14 +2293,14 @@ interface TossPaymentsPayment {
2284
2293
  interface TossPaymentsSDK {
2285
2294
  /**
2286
2295
  *
2287
- * 결제위젯을 초기화합니다. [자세히 >](#결제위젯)
2296
+ * 주문서형, 결제창형 결제를 초기화합니다. [자세히 >](/sdk/v2/js/payment-widget#주문서형-결제)
2288
2297
  *
2289
2298
  * @throw {@link PublicError.Widgets.InvalidClientKeyError} clientKey가 올바르지 않은 경우
2290
2299
  * @throw {@link PublicError.Widgets.InvalidCustomerKeyError} customerKey가 올바르지 않은 경우
2291
2300
  * @throw {@link PublicError.Widgets.InsecureKeyUsageError} customerKey에 시크릿키를 사용한 경우
2292
2301
  * @throw {@link PublicError.Widgets.NotSupportedAPIIndividualKeyError} API 개별 연동 키를 clientKey로 사용한 경우
2293
2302
  * @throw {@link PublicError.Widgets.UnknownError} 알 수 없는 오류가 발생한 경우
2294
- * @returns 아래 메서드를 호출할 수 있는 결제위젯 객체를 반환합니다.
2303
+ * @returns 아래 메서드를 호출할 수 있는 결제 객체를 반환합니다.
2295
2304
  * @example
2296
2305
  * ```javascript
2297
2306
  * // 회원 결제
@@ -2304,17 +2313,17 @@ interface TossPaymentsSDK {
2304
2313
  * import { ANONYMOUS } from "@tosspayments/tosspayments-sdk";
2305
2314
  * const widgets = tossPayments.widgets({ customerKey: ANONYMOUS });
2306
2315
  * ```
2307
- * @param {WidgetInitParams} params 결제위젯 초기화 정보입니다.
2316
+ * @param {WidgetInitParams} params 결제 초기화 정보입니다.
2308
2317
  *
2309
2318
  */
2310
2319
  widgets: (params: WidgetInitParams) => TossPaymentsWidgets;
2311
2320
  /**
2312
- * 브랜드페이를 초기화합니다. [자세히 >](#브랜드페이)
2321
+ * 브랜드페이를 초기화합니다. [자세히 >](/sdk/v2/js/brandpay#브랜드페이)
2313
2322
  *
2314
2323
  * @throw {@link PublicError.Brandpay.InvalidClientKeyError} clientKey가 올바르지 않은 경우
2315
2324
  * @throw {@link PublicError.Brandpay.InvalidCustomerKeyError} customerKey가 올바르지 않은 경우
2316
2325
  * @throw {@link PublicError.Brandpay.InsecureKeyUsageError} customerKey에 시크릿키를 사용한 경우
2317
- * @throw {@link PublicError.Brandpay.NotSupportedWidgetKeyError} 결제위젯 연동 키를 clientKey로 사용한 경우
2326
+ * @throw {@link PublicError.Brandpay.NotSupportedWidgetKeyError} 주문서형, 결제창형 연동 키를 clientKey로 사용한 경우
2318
2327
  * @throw {@link PublicError.Brandpay.UnknownError} 알 수 없는 오류가 발생한 경우
2319
2328
  * @example
2320
2329
  * ```javascript
@@ -2329,12 +2338,12 @@ interface TossPaymentsSDK {
2329
2338
  */
2330
2339
  brandpay: (params: BrandpayInitParams) => TossPaymentsBrandpay;
2331
2340
  /**
2332
- * 결제창을 초기화합니다. [자세히 >](#결제창)
2341
+ * 결제창(구버전)을 초기화합니다. [자세히 >](/sdk/v2/js/payment#결제창구버전)
2333
2342
  *
2334
2343
  * @throw {@link PublicError.Payment.InvalidClientKeyError} clientKey가 올바르지 않은 경우
2335
2344
  * @throw {@link PublicError.Payment.InvalidCustomerKeyError} customerKey가 올바르지 않은 경우
2336
2345
  * @throw {@link PublicError.Payment.InsecureKeyUsageError} customerKey에 시크릿키를 사용한 경우
2337
- * @throw {@link PublicError.Payment.NotSupportedWidgetKeyError} 결제위젯 연동 키를 clientKey로 사용한 경우
2346
+ * @throw {@link PublicError.Payment.NotSupportedWidgetKeyError} 주문서형, 결제창형 연동 키를 clientKey로 사용한 경우
2338
2347
  * @throw {@link PublicError.Payment.UnknownError} 알 수 없는 오류가 발생한 경우
2339
2348
  * @example
2340
2349
  * ```javascript
@@ -2350,7 +2359,7 @@ interface TossPaymentsSDK {
2350
2359
  * @example
2351
2360
  * ```javascript
2352
2361
  * // 스크립트 태그 연동방식
2353
- * const tossPayments = TossPayments("<WidgetClientKey />"); // 결제위젯 연동 키
2362
+ * const tossPayments = TossPayments("<WidgetClientKey />"); // 주문서형, 결제창형 연동 키
2354
2363
  * const tossPayments = TossPayments("<ClientKey />"); // API 개별 연동 키
2355
2364
  *
2356
2365
  * // 모듈 임포트 연동방식
@@ -2360,7 +2369,7 @@ interface TossPaymentsSDK {
2360
2369
  *
2361
2370
  * @param {string} clientKey 토스페이먼츠 발급하는 클라이언트 키입니다. 개발자센터의 [API 키 메뉴](https://developers.tosspayments.com/my/api-keys)에서 확인할 수 있어요.
2362
2371
  *
2363
- * 결제위젯을 연동한다면 [결제위젯 연동 키](/reference/using-api/api-keys#결제위젯-연동-키)를 사용하세요. 브랜드페이, 결제창, 자동결제(빌링)를 연동한다면 [API 개별 연동 키](/reference/using-api/api-keys#api-개별-연동-키)를 사용하세요.
2372
+ * 결제를 연동한다면 [주문서형, 결제창형 연동 키](/reference/using-api/api-keys#주문서형-결제창형-연동-키)를 사용하세요. 브랜드페이, 결제창(구버전), 자동결제(빌링)를 연동한다면 [API 개별 연동 키](/reference/using-api/api-keys#api-개별-연동-키)를 사용하세요.
2364
2373
  *
2365
2374
  * @returns
2366
2375
  * 아래 메서드를 호출할 수 있는 토스페이먼츠 객체를 반환합니다.
@@ -2400,7 +2409,7 @@ interface WidgetInitParams {
2400
2409
  */
2401
2410
  customerKey: string;
2402
2411
  /**
2403
- * 결제위젯으로 브랜드페이로 연동할 때 필요한 정보입니다.
2412
+ * 주문서형, 결제창형으로 브랜드페이를 연동할 때 필요한 정보입니다.
2404
2413
  */
2405
2414
  brandpay?: {
2406
2415
  /**