@tosspayments/tosspayments-sdk 2.8.0 → 2.8.1
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.
- package/package.json +1 -1
- package/types/index.d.ts +41 -63
package/package.json
CHANGED
package/types/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
declare function clearTossPayments(): void;
|
|
2
2
|
|
|
3
|
-
// standard-public-interfaces 2.17.
|
|
3
|
+
// standard-public-interfaces 2.17.4 — 자동 생성 파일입니다. 직접 수정하지 마세요.
|
|
4
4
|
|
|
5
5
|
type WidgetSelectedPaymentMethod = {
|
|
6
6
|
/**
|
|
@@ -27,13 +27,13 @@ interface WidgetPaymentMethodWidget {
|
|
|
27
27
|
// 카드 안내사항 노출
|
|
28
28
|
}
|
|
29
29
|
if (selectedPaymentMethod.code === '문화바우처') {
|
|
30
|
-
// 커스텀 결제수단 (
|
|
30
|
+
// 커스텀 결제수단 (결제 Pro 플랜 기능)
|
|
31
31
|
// 문화바우처 안내사항 노출
|
|
32
32
|
}
|
|
33
33
|
});
|
|
34
34
|
* ```
|
|
35
35
|
*
|
|
36
|
-
* @param {'paymentMethodSelect'} eventName 구독할 이벤트입니다. `paymentMethodSelect` 이벤트로 구매자가 선택한 결제수단 코드를 확인하세요. 일반결제는 [결제수단 ENUM 코드](/codes/enum-codes#결제수단-타입)가 응답돼요.
|
|
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의 이벤트를 구독합니다. [자세히](#
|
|
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
|
-
*
|
|
179
|
+
* @ignore
|
|
180
180
|
*/
|
|
181
181
|
threeDS?: {
|
|
182
182
|
/**
|
|
183
|
-
*
|
|
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
|
-
*
|
|
443
|
+
* 결제 UI의 variantKey 정보입니다. [결제 어드민](https://dashboard.tosspayments.com/payment-widget-service/)에서 확인할 수 있어요.
|
|
446
444
|
*/
|
|
447
445
|
variantKey?: {
|
|
448
446
|
/**
|
|
@@ -458,7 +456,7 @@ interface WidgetPaymentRequestWindowOptions {
|
|
|
458
456
|
|
|
459
457
|
interface WidgetPaymentWindow {
|
|
460
458
|
/**
|
|
461
|
-
*
|
|
459
|
+
* 결제창 이벤트를 구독합니다. [자세히 >](#paymentwindowon)
|
|
462
460
|
*
|
|
463
461
|
* @param {'paymentRequest' | 'cancel'} eventName 구독할 이벤트입니다.
|
|
464
462
|
* @param {function} 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`는 [상점관리자의
|
|
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>;
|
|
@@ -765,9 +763,9 @@ 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
|
|
@@ -789,7 +787,7 @@ type RequestPaymentWindowWithRedirection = (paymentRequest: WithRedirection<Widg
|
|
|
789
787
|
*/
|
|
790
788
|
type RenderPaymentWindow = (params?: {
|
|
791
789
|
/**
|
|
792
|
-
*
|
|
790
|
+
* 결제 UI의 variantKey 정보입니다. [결제 어드민](https://dashboard.tosspayments.com/payment-widget-service/)에서 확인할 수 있어요.
|
|
793
791
|
*/
|
|
794
792
|
variantKey?: {
|
|
795
793
|
/**
|
|
@@ -1314,41 +1312,31 @@ interface CardPaymentRequest extends PaymentRequest {
|
|
|
1314
1312
|
*/
|
|
1315
1313
|
useEscrow?: boolean | null;
|
|
1316
1314
|
/**
|
|
1317
|
-
* 과세를 제외한 결제 금액(컵 보증금 등)입니다.
|
|
1318
|
-
* 과세 제외 금액이 있는 카드 결제는 부분 취소가 안 됩니다.
|
|
1315
|
+
* 과세를 제외한 결제 금액(컵 보증금 등)입니다. 과세 제외 금액이 있는 카드 결제는 부분 취소가 안 됩니다.
|
|
1319
1316
|
*/
|
|
1320
1317
|
taxExemptionAmount?: number | null;
|
|
1321
1318
|
/**
|
|
1322
|
-
* 결제창을 여는 방법입니다. `DEFAULT`는 카드/간편결제 통합결제창을 열고, `DIRECT`는 카드 또는 간편결제의 자체창을 열어요.
|
|
1323
|
-
* 기본 값은 `DEFAULT`입니다.
|
|
1319
|
+
* 결제창을 여는 방법입니다. `DEFAULT`는 카드/간편결제 통합결제창을 열고, `DIRECT`는 카드 또는 간편결제의 자체창을 열어요. 기본 값은 `DEFAULT`입니다.
|
|
1324
1320
|
*/
|
|
1325
1321
|
flowMode?: 'DIRECT' | 'DEFAULT' | null;
|
|
1326
1322
|
/**
|
|
1327
|
-
* [카드사 코드](/codes/org-codes#카드사-코드)입니다. `flowMode` 값에 따라 아래와 같이 다르게 동작해요.
|
|
1328
|
-
* `flowMode`가 `DIRECT`일 때는 입력한 코드의 카드사 앱이 열려요.
|
|
1329
|
-
* `flowMode`가 `DEFAULT`일 때는 통합결제창에 입력한 코드의 카드사만 보여요.
|
|
1323
|
+
* [카드사 코드](/codes/org-codes#카드사-코드)입니다. `flowMode` 값에 따라 아래와 같이 다르게 동작해요. `flowMode`가 `DIRECT`일 때는 입력한 코드의 카드사 앱이 열려요. `flowMode`가 `DEFAULT`일 때는 통합결제창에 입력한 코드의 카드사만 보여요.
|
|
1330
1324
|
*/
|
|
1331
1325
|
cardCompany?: string | null;
|
|
1332
1326
|
/**
|
|
1333
|
-
* [간편결제 코드](/codes/org-codes#간편결제사-코드)입니다. `flowMode` 값에 따라 아래와 같이 다르게 동작해요.
|
|
1334
|
-
* `flowMode`가 `DIRECT`일 때는 입력한 코드의 간편결제 앱이 열려요.
|
|
1335
|
-
* `flowMode`가 `DEFAULT`일 때는 해당 파라미터와 상관 없이 기본 통합결제창이 열려요.
|
|
1327
|
+
* [간편결제 코드](/codes/org-codes#간편결제사-코드)입니다. `flowMode` 값에 따라 아래와 같이 다르게 동작해요. `flowMode`가 `DIRECT`일 때는 입력한 코드의 간편결제 앱이 열려요. `flowMode`가 `DEFAULT`일 때는 해당 파라미터와 상관 없이 기본 통합결제창이 열려요.
|
|
1336
1328
|
*/
|
|
1337
1329
|
easyPay?: string | null;
|
|
1338
1330
|
/**
|
|
1339
|
-
* 신용카드 결제에 적용되는 할부 개월 수입니다.
|
|
1340
|
-
* 예를 들어, `6`으로 설정하면 할부 개월 수가 6개월로 고정돼요. 자체창에서는 구매자가 할부 개월 수를 볼 수 없으니 사전에 충분히 안내를 해주세요.
|
|
1341
|
-
* 0(일시불), 2~12 값으로 설정할 수 있고 `maxCardInstallmentPlan` 파라미터와 함께 사용할 수 없어요. 카드사 별로 할부결제가 가능한 [최소 금액](https://consumer.tosspayments.com/notice/free-installment)을 확인하세요.
|
|
1331
|
+
* 신용카드 결제에 적용되는 할부 개월 수입니다. 예를 들어, `6`으로 설정하면 할부 개월 수가 6개월로 고정돼요. 자체창에서는 구매자가 할부 개월 수를 볼 수 없으니 사전에 충분히 안내를 해주세요. 0(일시불), 2~12 값으로 설정할 수 있고 `maxCardInstallmentPlan` 파라미터와 함께 사용할 수 없어요. 카드사 별로 할부결제가 가능한 [최소 금액](https://consumer.tosspayments.com/notice/free-installment)을 확인하세요.
|
|
1342
1332
|
*/
|
|
1343
1333
|
cardInstallmentPlan?: number | null;
|
|
1344
1334
|
/**
|
|
1345
|
-
* 신용카드 결제에 적용할 수 있는 최대 할부 개월 수입니다.
|
|
1346
|
-
* 예를 들어, `6`으로 설정하면 구매자는 일시불부터 6개월 할부를 선택할 수 있어요. 0(일시불), 2~12 값으로 설정할 수 있고 `cardInstallmentPlan` 파라미터와 함께 사용할 수 없어요. 카드사 별로 할부결제가 가능한 [최소 금액](https://consumer.tosspayments.com/notice/free-installment)을 확인하세요.
|
|
1335
|
+
* 신용카드 결제에 적용할 수 있는 최대 할부 개월 수입니다. 예를 들어, `6`으로 설정하면 구매자는 일시불부터 6개월 할부를 선택할 수 있어요. 0(일시불), 2~12 값으로 설정할 수 있고 `cardInstallmentPlan` 파라미터와 함께 사용할 수 없어요. 카드사 별로 할부결제가 가능한 [최소 금액](https://consumer.tosspayments.com/notice/free-installment)을 확인하세요.
|
|
1347
1336
|
*/
|
|
1348
1337
|
maxCardInstallmentPlan?: number | null;
|
|
1349
1338
|
/**
|
|
1350
|
-
* 신용카드 결제에 적용할 수 있는 **상점 부담 무이자** 할부 정보입니다.
|
|
1351
|
-
* 구매자가 선택한 카드, 할부 개월 수가 배열에 등록한 정보와 같다면 무이자가 할부가 자동으로 적용돼요. 카드사 별로 할부결제가 가능한 [최소 금액](https://consumer.tosspayments.com/notice/free-installment)을 확인하세요.
|
|
1339
|
+
* 신용카드 결제에 적용할 수 있는 **상점 부담 무이자** 할부 정보입니다. 구매자가 선택한 카드, 할부 개월 수가 배열에 등록한 정보와 같다면 무이자 할부가 자동으로 적용돼요. 카드사 별로 할부결제가 가능한 [최소 금액](https://consumer.tosspayments.com/notice/free-installment)을 확인하세요.
|
|
1352
1340
|
*/
|
|
1353
1341
|
freeInstallmentPlans?: Array<{
|
|
1354
1342
|
/**
|
|
@@ -1375,13 +1363,11 @@ interface CardPaymentRequest extends PaymentRequest {
|
|
|
1375
1363
|
*/
|
|
1376
1364
|
discountCode?: string | null;
|
|
1377
1365
|
/**
|
|
1378
|
-
* 시간으로 설정하는 결제 기한입니다. 설정할 수 있는 최대 값은 2160시간(90일)입니다.
|
|
1379
|
-
* 기한이 지나고 시도하는 결제는 실패해요. 예를 들어 `24`로 설정하면, 결제 요청 시점으로부터 24시간 동안 결제할 수 있어요.
|
|
1366
|
+
* 시간으로 설정하는 결제 기한입니다. 설정할 수 있는 최대 값은 2160시간(90일)입니다. 기한이 지나고 시도하는 결제는 실패해요. 예를 들어 `24`로 설정하면, 결제 요청 시점으로부터 24시간 동안 결제할 수 있어요.
|
|
1380
1367
|
*/
|
|
1381
1368
|
validHours?: number | null;
|
|
1382
1369
|
/**
|
|
1383
|
-
* 특정 날짜로 설정하는 결제 기한입니다. `yyyy-MM-dd'T'HH:mm:ss` ISO 8601 형식입니다.
|
|
1384
|
-
* 기한이 지나고 시도하는 결제는 실패해요. 예를 들어 `2025-01-01T00:00:00`으로 설정하면, 2024년 12월 31일 23:59까지 결제할 수 있어요.
|
|
1370
|
+
* 특정 날짜로 설정하는 결제 기한입니다. `yyyy-MM-dd'T'HH:mm:ss` ISO 8601 형식입니다. 기한이 지나고 시도하는 결제는 실패해요. 예를 들어 `2025-01-01T00:00:00`으로 설정하면, 2024년 12월 31일 23:59까지 결제할 수 있어요.
|
|
1385
1371
|
*/
|
|
1386
1372
|
dueDate?: string | null;
|
|
1387
1373
|
escrowProducts?: Array<{
|
|
@@ -1411,23 +1397,19 @@ interface CardPaymentRequest extends PaymentRequest {
|
|
|
1411
1397
|
*/
|
|
1412
1398
|
useInternationalCardOnly?: boolean | null;
|
|
1413
1399
|
/**
|
|
1414
|
-
* 결제창 초기 언어입니다. `KO`(한국어), `EN`(영어), `JA`(일본어), `ZH`(중국어) 중 하나로 설정할 수 있어요.
|
|
1415
|
-
* 값을 설정하지 않으면 결제 통화에 따라 자동으로 결정됩니다.
|
|
1400
|
+
* 결제창 초기 언어입니다. `KO`(한국어), `EN`(영어), `JA`(일본어), `ZH`(중국어) 중 하나로 설정할 수 있어요. 값을 설정하지 않으면 결제 통화에 따라 자동으로 결정됩니다.
|
|
1416
1401
|
*/
|
|
1417
1402
|
language?: 'KO' | 'EN' | 'JA' | 'ZH' | null;
|
|
1418
1403
|
/**
|
|
1419
|
-
* 다국어 결제창에서 결제 금액
|
|
1420
|
-
* `false`로 설정하면 환산 추정 금액이 표시되지 않아요. 값을 설정하지 않으면 `true`로 동작하며, 다국어 결제창이 아닌 경우에는 적용되지 않습니다.
|
|
1404
|
+
* 다국어 결제창에서 예상 결제 금액(USD 환산값) 노출 여부입니다. 기본값은 `true`이고, `false`로 설정하면 예상 결제 금액이 숨겨집니다. `useInternationalCardOnly`가 `true`이고 결제 통화가 `KRW`일 때만 적용됩니다.
|
|
1421
1405
|
*/
|
|
1422
1406
|
showEstimatedAmount?: boolean | null;
|
|
1423
1407
|
/**
|
|
1424
|
-
*
|
|
1408
|
+
* @ignore
|
|
1425
1409
|
*/
|
|
1426
1410
|
threeDS?: {
|
|
1427
1411
|
/**
|
|
1428
|
-
*
|
|
1429
|
-
* `CHALLENGE_REQUIRED`로 설정하면 챌린지 인증을 필수로 요청하고, 카드 발급사가 챌린지 없이 인증을 완료하면 인증을 거절하고 `failUrl`로 이동해요.
|
|
1430
|
-
* 값을 설정하지 않으면 챌린지 여부를 카드 발급사 판단에 맡겨요.
|
|
1412
|
+
* @ignore
|
|
1431
1413
|
*/
|
|
1432
1414
|
challengeMode?: 'CHALLENGE_REQUIRED' | null;
|
|
1433
1415
|
} | null;
|
|
@@ -1445,8 +1427,7 @@ interface CardPaymentRequest extends PaymentRequest {
|
|
|
1445
1427
|
selectableCardTypes?: Array<'PERSONAL' | 'CORPORATE' | 'FOREIGN'> | null;
|
|
1446
1428
|
} | null;
|
|
1447
1429
|
/**
|
|
1448
|
-
* 모바일 결제창 상단 헤더의 노출 여부입니다. `false`로 설정하면 헤더가 표시되지 않아요.
|
|
1449
|
-
* 값을 설정하지 않으면 `true`로 동작합니다.
|
|
1430
|
+
* 모바일 결제창 상단 헤더의 노출 여부입니다. `false`로 설정하면 헤더가 표시되지 않아요. 값을 설정하지 않으면 `true`로 동작합니다.
|
|
1450
1431
|
*/
|
|
1451
1432
|
showMobileAppHeader?: boolean | null;
|
|
1452
1433
|
/**
|
|
@@ -1659,10 +1640,7 @@ interface MobilePhonePaymentRequest extends PaymentRequest {
|
|
|
1659
1640
|
*/
|
|
1660
1641
|
mobilePhone?: {
|
|
1661
1642
|
/**
|
|
1662
|
-
* 휴대폰 결제창에서 선택할 수 있는 통신사를 제한합니다.
|
|
1663
|
-
* `SKT`(SK텔레콤), `KT`(KT), `LGU`(LG유플러스), `HELLO`(LG헬로모바일), `KCT`(티플러스), `SK7`(SK세븐모바일) 값을 배열 형태로 전달할 수 있습니다.
|
|
1664
|
-
* 예를 들어 `['KT', 'SKT']`로 설정하면 두 통신사만 선택할 수 있어요. 값을 설정하지 않으면 모든 통신사가 노출됩니다.
|
|
1665
|
-
* 전체 목록은 [통신사 코드](https://docs.tosspayments.com/codes/org-codes#통신사-코드)에서 확인하세요.
|
|
1643
|
+
* 휴대폰 결제창에서 선택할 수 있는 통신사를 제한합니다. `SKT`(SK텔레콤), `KT`(KT), `LGU`(LG유플러스), `HELLO`(LG헬로모바일), `KCT`(티플러스), `SK7`(SK세븐모바일) 값을 배열 형태로 전달할 수 있습니다. 예를 들어 `['KT', 'SKT']`로 설정하면 두 통신사만 선택할 수 있어요. 값을 설정하지 않으면 모든 통신사가 노출됩니다. 전체 목록은 [통신사 코드](https://docs.tosspayments.com/codes/org-codes#통신사-코드)에서 확인하세요.
|
|
1666
1644
|
*/
|
|
1667
1645
|
mobileCarriers?: Array<'KT' | 'LGU' | 'SKT' | 'HELLO' | 'KCT' | 'SK7'> | null;
|
|
1668
1646
|
} | null;
|
|
@@ -2284,14 +2262,14 @@ interface TossPaymentsPayment {
|
|
|
2284
2262
|
interface TossPaymentsSDK {
|
|
2285
2263
|
/**
|
|
2286
2264
|
*
|
|
2287
|
-
*
|
|
2265
|
+
* 주문서형, 결제창형 결제를 초기화합니다. [자세히 >](/sdk/v2/js/payment-widget#주문서형-결제)
|
|
2288
2266
|
*
|
|
2289
2267
|
* @throw {@link PublicError.Widgets.InvalidClientKeyError} clientKey가 올바르지 않은 경우
|
|
2290
2268
|
* @throw {@link PublicError.Widgets.InvalidCustomerKeyError} customerKey가 올바르지 않은 경우
|
|
2291
2269
|
* @throw {@link PublicError.Widgets.InsecureKeyUsageError} customerKey에 시크릿키를 사용한 경우
|
|
2292
2270
|
* @throw {@link PublicError.Widgets.NotSupportedAPIIndividualKeyError} API 개별 연동 키를 clientKey로 사용한 경우
|
|
2293
2271
|
* @throw {@link PublicError.Widgets.UnknownError} 알 수 없는 오류가 발생한 경우
|
|
2294
|
-
* @returns 아래 메서드를 호출할 수 있는
|
|
2272
|
+
* @returns 아래 메서드를 호출할 수 있는 결제 객체를 반환합니다.
|
|
2295
2273
|
* @example
|
|
2296
2274
|
* ```javascript
|
|
2297
2275
|
* // 회원 결제
|
|
@@ -2304,17 +2282,17 @@ interface TossPaymentsSDK {
|
|
|
2304
2282
|
* import { ANONYMOUS } from "@tosspayments/tosspayments-sdk";
|
|
2305
2283
|
* const widgets = tossPayments.widgets({ customerKey: ANONYMOUS });
|
|
2306
2284
|
* ```
|
|
2307
|
-
* @param {WidgetInitParams} params
|
|
2285
|
+
* @param {WidgetInitParams} params 결제 초기화 정보입니다.
|
|
2308
2286
|
*
|
|
2309
2287
|
*/
|
|
2310
2288
|
widgets: (params: WidgetInitParams) => TossPaymentsWidgets;
|
|
2311
2289
|
/**
|
|
2312
|
-
* 브랜드페이를 초기화합니다. [자세히 >](#브랜드페이)
|
|
2290
|
+
* 브랜드페이를 초기화합니다. [자세히 >](/sdk/v2/js/brandpay#브랜드페이)
|
|
2313
2291
|
*
|
|
2314
2292
|
* @throw {@link PublicError.Brandpay.InvalidClientKeyError} clientKey가 올바르지 않은 경우
|
|
2315
2293
|
* @throw {@link PublicError.Brandpay.InvalidCustomerKeyError} customerKey가 올바르지 않은 경우
|
|
2316
2294
|
* @throw {@link PublicError.Brandpay.InsecureKeyUsageError} customerKey에 시크릿키를 사용한 경우
|
|
2317
|
-
* @throw {@link PublicError.Brandpay.NotSupportedWidgetKeyError}
|
|
2295
|
+
* @throw {@link PublicError.Brandpay.NotSupportedWidgetKeyError} 주문서형, 결제창형 연동 키를 clientKey로 사용한 경우
|
|
2318
2296
|
* @throw {@link PublicError.Brandpay.UnknownError} 알 수 없는 오류가 발생한 경우
|
|
2319
2297
|
* @example
|
|
2320
2298
|
* ```javascript
|
|
@@ -2329,12 +2307,12 @@ interface TossPaymentsSDK {
|
|
|
2329
2307
|
*/
|
|
2330
2308
|
brandpay: (params: BrandpayInitParams) => TossPaymentsBrandpay;
|
|
2331
2309
|
/**
|
|
2332
|
-
*
|
|
2310
|
+
* 결제창(구버전)을 초기화합니다. [자세히 >](/sdk/v2/js/payment#결제창구버전)
|
|
2333
2311
|
*
|
|
2334
2312
|
* @throw {@link PublicError.Payment.InvalidClientKeyError} clientKey가 올바르지 않은 경우
|
|
2335
2313
|
* @throw {@link PublicError.Payment.InvalidCustomerKeyError} customerKey가 올바르지 않은 경우
|
|
2336
2314
|
* @throw {@link PublicError.Payment.InsecureKeyUsageError} customerKey에 시크릿키를 사용한 경우
|
|
2337
|
-
* @throw {@link PublicError.Payment.NotSupportedWidgetKeyError}
|
|
2315
|
+
* @throw {@link PublicError.Payment.NotSupportedWidgetKeyError} 주문서형, 결제창형 연동 키를 clientKey로 사용한 경우
|
|
2338
2316
|
* @throw {@link PublicError.Payment.UnknownError} 알 수 없는 오류가 발생한 경우
|
|
2339
2317
|
* @example
|
|
2340
2318
|
* ```javascript
|
|
@@ -2350,7 +2328,7 @@ interface TossPaymentsSDK {
|
|
|
2350
2328
|
* @example
|
|
2351
2329
|
* ```javascript
|
|
2352
2330
|
* // 스크립트 태그 연동방식
|
|
2353
|
-
* const tossPayments = TossPayments("<WidgetClientKey />"); //
|
|
2331
|
+
* const tossPayments = TossPayments("<WidgetClientKey />"); // 주문서형, 결제창형 연동 키
|
|
2354
2332
|
* const tossPayments = TossPayments("<ClientKey />"); // API 개별 연동 키
|
|
2355
2333
|
*
|
|
2356
2334
|
* // 모듈 임포트 연동방식
|
|
@@ -2360,7 +2338,7 @@ interface TossPaymentsSDK {
|
|
|
2360
2338
|
*
|
|
2361
2339
|
* @param {string} clientKey 토스페이먼츠 발급하는 클라이언트 키입니다. 개발자센터의 [API 키 메뉴](https://developers.tosspayments.com/my/api-keys)에서 확인할 수 있어요.
|
|
2362
2340
|
*
|
|
2363
|
-
*
|
|
2341
|
+
* 결제를 연동한다면 [주문서형, 결제창형 연동 키](/reference/using-api/api-keys#주문서형-결제창형-연동-키)를 사용하세요. 브랜드페이, 결제창(구버전), 자동결제(빌링)를 연동한다면 [API 개별 연동 키](/reference/using-api/api-keys#api-개별-연동-키)를 사용하세요.
|
|
2364
2342
|
*
|
|
2365
2343
|
* @returns
|
|
2366
2344
|
* 아래 메서드를 호출할 수 있는 토스페이먼츠 객체를 반환합니다.
|
|
@@ -2400,7 +2378,7 @@ interface WidgetInitParams {
|
|
|
2400
2378
|
*/
|
|
2401
2379
|
customerKey: string;
|
|
2402
2380
|
/**
|
|
2403
|
-
*
|
|
2381
|
+
* 주문서형, 결제창형으로 브랜드페이를 연동할 때 필요한 정보입니다.
|
|
2404
2382
|
*/
|
|
2405
2383
|
brandpay?: {
|
|
2406
2384
|
/**
|