@portone/browser-sdk 0.0.22 → 0.0.24

package/dist/v2/entity/Address.d.ts

@@ -1,8 +1,28 @@
-import { Entity } from '../index.js';
+import { Country } from './Country.js';
+/**
+ * **주소 정보**
+ */
 export type Address = {
-    country?: Entity.Country;
+    /**
+     * **국가**
+     *
+     * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) 코드입니다.
+     */
+    country?: Country | undefined;
+    /**
+     * **주소 첫째 줄**
+     */
     addressLine1: string;
+    /**
+     * **주소 둘째 줄**
+     */
     addressLine2: string;
-    city?: string;
-    province?: string;
+    /**
+     * **도시**
+     */
+    city?: string | undefined;
+    /**
+     * **주, 도, 시**
+     */
+    province?: string | undefined;
 };

package/dist/v2/entity/Bank.d.ts

@@ -1,78 +1,352 @@
+/**
+ * 가상계좌 발급시 사용되는 은행 코드
+ */
 export declare const Bank: {
+    /**
+     * 한국은행
+     */
     readonly BANK_OF_KOREA: "BANK_BANK_OF_KOREA";
+    /**
+     * 산업은행
+     */
     readonly KOREA_DEVELOPMENT_BANK: "BANK_KOREA_DEVELOPMENT_BANK";
+    /**
+     * 기업은행
+     *
+     * - KCP
+     * - 스마트로
+     */
     readonly INDUSTRIAL_BANK_OF_KOREA: "BANK_INDUSTRIAL_BANK_OF_KOREA";
+    /**
+     * 국민은행
+     *
+     * - KCP
+     * - 스마트로
+     */
     readonly KOOKMIN_BANK: "BANK_KOOKMIN_BANK";
+    /**
+     * 수협은행
+     *
+     * - KCP
+     * - 스마트로
+     */
     readonly SUHYUP_BANK: "BANK_SUHYUP_BANK";
+    /**
+     * 수출입은행
+     */
     readonly EXPORT_IMPORT_BANK_OF_KOREA: "BANK_EXPORT_IMPORT_BANK_OF_KOREA";
+    /**
+     * NH농협은행
+     *
+     * - KCP
+     * - 스마트로
+     */
     readonly NH_NONGHYUP_BANK: "BANK_NH_NONGHYUP_BANK";
+    /**
+     * 지역농․축협
+     */
     readonly LOCAL_NONGHYUP: "BANK_LOCAL_NONGHYUP";
+    /**
+     * 우리은행
+     *
+     * - KCP
+     * - 스마트로
+     */
     readonly WOORI_BANK: "BANK_WOORI_BANK";
+    /**
+     * SC제일은행
+     *
+     * - KCP
+     * - 스마트로
+     */
     readonly SC_BANK_KOREA: "BANK_SC_BANK_KOREA";
+    /**
+     * 한국씨티은행
+     */
     readonly CITI_BANK_KOREA: "BANK_CITI_BANK_KOREA";
+    /**
+     * 대구은행
+     *
+     * - KCP
+     * - 스마트로
+     */
     readonly DAEGU_BANK: "BANK_DAEGU_BANK";
+    /**
+     * 부산은행
+     *
+     * - KCP
+     * - 스마트로
+     */
     readonly BUSAN_BANK: "BANK_BUSAN_BANK";
+    /**
+     * 광주은행
+     *
+     * - KCP
+     * - 스마트로
+     */
     readonly GWANGJU_BANK: "BANK_GWANGJU_BANK";
+    /**
+     * 제주은행
+     */
     readonly JEJU_BANK: "BANK_JEJU_BANK";
+    /**
+     * 전북은행
+     *
+     * - 스마트로
+     */
     readonly JEONBUK_BANK: "BANK_JEONBUK_BANK";
+    /**
+     * 경남은행
+     *
+     * - KCP
+     * - 스마트로
+     */
     readonly KYONGNAM_BANK: "BANK_KYONGNAM_BANK";
+    /**
+     * 새마을금고
+     */
     readonly KFCC: "BANK_KFCC";
+    /**
+     * 신협
+     */
     readonly SHINHYUP: "BANK_SHINHYUP";
+    /**
+     * 저축은행
+     */
     readonly SAVINGS_BANK_KOREA: "BANK_SAVINGS_BANK_KOREA";
+    /**
+     * 모건스탠리은행
+     */
     readonly MORGAN_STANLEY_BANK: "BANK_MORGAN_STANLEY_BANK";
+    /**
+     * HSBC은행
+     */
     readonly HSBC_BANK: "BANK_HSBC_BANK";
+    /**
+     * 도이치은행
+     */
     readonly DEUTSCHE_BANK: "BANK_DEUTSCHE_BANK";
+    /**
+     * 제이피모간체이스은행
+     */
     readonly JP_MORGAN_CHASE_BANK: "BANK_JP_MORGAN_CHASE_BANK";
+    /**
+     * 미즈호은행
+     */
     readonly MIZUHO_BANK: "BANK_MIZUHO_BANK";
+    /**
+     * 엠유에프지은행
+     */
     readonly MUFG_BANK: "BANK_MUFG_BANK";
+    /**
+     * BOA은행
+     */
     readonly BANK_OF_AMERICA_BANK: "BANK_BANK_OF_AMERICA_BANK";
+    /**
+     * 비엔피파리바은행
+     */
     readonly BNP_PARIBAS_BANK: "BANK_BNP_PARIBAS_BANK";
+    /**
+     * 중국공상은행
+     */
     readonly ICBC: "BANK_ICBC";
+    /**
+     * 중국은행
+     */
     readonly BANK_OF_CHINA: "BANK_BANK_OF_CHINA";
+    /**
+     * 산림조합중앙회
+     */
     readonly NATIONAL_FORESTRY_COOPERATIVE_FEDERATION: "BANK_NATIONAL_FORESTRY_COOPERATIVE_FEDERATION";
+    /**
+     * 대화은행
+     */
     readonly UNITED_OVERSEAS_BANK: "BANK_UNITED_OVERSEAS_BANK";
+    /**
+     * 교통은행
+     */
     readonly BANK_OF_COMMUNICATIONS: "BANK_BANK_OF_COMMUNICATIONS";
+    /**
+     * 중국건설은행
+     */
     readonly CHINA_CONSTRUCTION_BANK: "BANK_CHINA_CONSTRUCTION_BANK";
+    /**
+     * 우체국
+     *
+     * - KCP
+     * - 스마트로
+     */
     readonly EPOST: "BANK_EPOST";
+    /**
+     * 신용보증기금
+     */
     readonly KODIT: "BANK_KODIT";
+    /**
+     * 기술보증기금
+     */
     readonly KIBO: "BANK_KIBO";
+    /**
+     * 하나은행
+     *
+     * - KCP
+     * - 스마트로
+     */
     readonly HANA_BANK: "BANK_HANA_BANK";
+    /**
+     * 신한은행
+     *
+     * - KCP
+     * - 스마트로
+     */
     readonly SHINHAN_BANK: "BANK_SHINHAN_BANK";
+    /**
+     * 케이뱅크
+     *
+     * - 스마트로
+     */
     readonly K_BANK: "BANK_K_BANK";
+    /**
+     * 카카오뱅크
+     */
     readonly KAKAO_BANK: "BANK_KAKAO_BANK";
+    /**
+     * 토스뱅크
+     */
     readonly TOSS_BANK: "BANK_TOSS_BANK";
+    /**
+     * 한국신용정보원
+     */
     readonly KCIS: "BANK_KCIS";
+    /**
+     * 대신저축은행
+     */
     readonly DAISHIN_SAVINGS_BANK: "BANK_DAISHIN_SAVINGS_BANK";
+    /**
+     * 에스비아이저축은행
+     */
     readonly SBI_SAVINGS_BANK: "BANK_SBI_SAVINGS_BANK";
+    /**
+     * 에이치케이저축은행
+     */
     readonly HK_SAVINGS_BANK: "BANK_HK_SAVINGS_BANK";
+    /**
+     * 웰컴저축은행
+     */
     readonly WELCOME_SAVINGS_BANK: "BANK_WELCOME_SAVINGS_BANK";
+    /**
+     * 신한저축은행
+     */
     readonly SHINHAN_SAVINGS_BANK: "BANK_SHINHAN_SAVINGS_BANK";
+    /**
+     * 교보증권
+     */
     readonly KYOBO_SECURITIES: "BANK_KYOBO_SECURITIES";
+    /**
+     * 대신증권
+     */
     readonly DAISHIN_SECURITIES: "BANK_DAISHIN_SECURITIES";
+    /**
+     * 메리츠증권
+     */
     readonly MERITZ_SECURITIES: "BANK_MERITZ_SECURITIES";
+    /**
+     * 미래에셋증권
+     */
     readonly MIRAE_ASSET_SECURITIES: "BANK_MIRAE_ASSET_SECURITIES";
+    /**
+     * 부국증권
+     */
     readonly BOOKOOK_SECURITIES: "BANK_BOOKOOK_SECURITIES";
+    /**
+     * 삼성증권
+     */
     readonly SAMSUNG_SECURITIES: "BANK_SAMSUNG_SECURITIES";
+    /**
+     * 신영증권
+     */
     readonly SHINYOUNG_SECURITIES: "BANK_SHINYOUNG_SECURITIES";
+    /**
+     * 신한금융투자
+     */
     readonly SHINHAN_FINANCIAL_INVESTMENT: "BANK_SHINHAN_FINANCIAL_INVESTMENT";
+    /**
+     * 유안타증권
+     */
     readonly YUANTA_SECURITIES: "BANK_YUANTA_SECURITIES";
+    /**
+     * 유진투자증권
+     */
     readonly EUGENE_INVESTMENT_SECURITIES: "BANK_EUGENE_INVESTMENT_SECURITIES";
+    /**
+     * 카카오페이증권
+     */
     readonly KAKAO_PAY_SECURITIES: "BANK_KAKAO_PAY_SECURITIES";
+    /**
+     * 토스증권
+     */
     readonly TOSS_SECURITIES: "BANK_TOSS_SECURITIES";
+    /**
+     * 한국포스증권
+     */
     readonly KOREA_FOSS_SECURITIES: "BANK_KOREA_FOSS_SECURITIES";
+    /**
+     * 하나금융투자
+     */
     readonly HANA_FINANCIAL_INVESTMENT: "BANK_HANA_FINANCIAL_INVESTMENT";
+    /**
+     * 하이투자증권
+     */
     readonly HI_INVESTMENT_SECURITIES: "BANK_HI_INVESTMENT_SECURITIES";
+    /**
+     * 한국투자증권
+     */
     readonly KOREA_INVESTMENT_SECURITIES: "BANK_KOREA_INVESTMENT_SECURITIES";
+    /**
+     * 한화투자증권
+     */
     readonly HANWHA_INVESTMENT_SECURITIES: "BANK_HANWHA_INVESTMENT_SECURITIES";
+    /**
+     * 현대차증권자
+     */
     readonly HYUNDAI_MOTOR_SECURITIES: "BANK_HYUNDAI_MOTOR_SECURITIES";
+    /**
+     * DB금융투자자
+     */
     readonly DB_FINANCIAL_INVESTMENT: "BANK_DB_FINANCIAL_INVESTMENT";
+    /**
+     * KB증권
+     */
     readonly KB_SECURITIES: "BANK_KB_SECURITIES";
+    /**
+     * KTB투자증권
+     */
     readonly KTB_INVESTMENT_SECURITIES: "BANK_KTB_INVESTMENT_SECURITIES";
+    /**
+     * NH투자증권
+     */
     readonly NH_INVESTMENT_SECURITIES: "BANK_NH_INVESTMENT_SECURITIES";
+    /**
+     * SK증권
+     */
     readonly SK_SECURITIES: "BANK_SK_SECURITIES";
-    readonly SCI: "BANK_SGI";
+    /**
+     * 서울보증보험
+     */
+    readonly SCI: "BANK_SCI";
+    /**
+     * 키움증권
+     */
     readonly KIWOOM_SECURITIES: "BANK_KIWOOM_SECURITIES";
+    /**
+     * 이베스트증권
+     */
     readonly EBEST_INVESTMENT_SECURITIES: "BANK_EBEST_INVESTMENT_SECURITIES";
+    /**
+     * 케이프투자증권
+     */
     readonly CAPE_INVESTMENT_CERTIFICATE: "BANK_CAPE_INVESTMENT_CERTIFICATE";
 };
-export type Bank = typeof Bank[keyof typeof Bank];
+/**
+ * 가상계좌 발급시 사용되는 은행 코드
+ */
+export type Bank = (typeof Bank)[keyof typeof Bank];

package/dist/v2/entity/BillingKeyAndPayMethod.d.ts

@@ -1,4 +1,13 @@
+/**
+ * 빌링키 발급 및 초회결제 수단
+ */
 export declare const BillingKeyAndPayMethod: {
+    /**
+     * 휴대전화
+     */
     readonly MOBILE: "MOBILE";
 };
-export type BillingKeyAndPayMethod = typeof BillingKeyAndPayMethod[keyof typeof BillingKeyAndPayMethod];
+/**
+ * 빌링키 발급 및 초회결제 수단
+ */
+export type BillingKeyAndPayMethod = (typeof BillingKeyAndPayMethod)[keyof typeof BillingKeyAndPayMethod];

package/dist/v2/entity/BillingKeyMethod.d.ts

@@ -1,7 +1,25 @@
+/**
+ * 빌링키 발급 수단
+ */
 export declare const BillingKeyMethod: {
+    /**
+     * 카드
+     */
     readonly CARD: "CARD";
+    /**
+     * 휴대전화
+     */
     readonly MOBILE: "MOBILE";
+    /**
+     * 간편결제
+     */
     readonly EASY_PAY: "EASY_PAY";
+    /**
+     * 페이팔(RT)
+     */
     readonly PAYPAL: "PAYPAL";
 };
-export type BillingKeyMethod = typeof BillingKeyMethod[keyof typeof BillingKeyMethod];
+/**
+ * 빌링키 발급 수단
+ */
+export type BillingKeyMethod = (typeof BillingKeyMethod)[keyof typeof BillingKeyMethod];

package/dist/v2/entity/CardCompany.d.ts

@@ -1,26 +1,101 @@
+/**
+ * 카드 결제시 사용되는 카드사 코드
+ */
 export declare const CardCompany: {
+    /**
+     * KDB산업은행 카드
+     */
     readonly KOREA_DEVELOPMENT_BANK: "CARD_COMPANY_KOREA_DEVELOPMENT_BANK";
+    /**
+     * 새마을금고 카드
+     */
     readonly KFCC: "CARD_COMPANY_KFCC";
+    /**
+     * 신협 카드
+     */
     readonly SHINHYUP: "CARD_COMPANY_SHINHYUP";
+    /**
+     * 우체국 카드
+     */
     readonly EPOST: "CARD_COMPANY_EPOST";
+    /**
+     * 저축은행 카드
+     */
     readonly SAVINGS_BANK_KOREA: "CARD_COMPANY_SAVINGS_BANK_KOREA";
+    /**
+     * 카카오뱅크 카드
+     */
     readonly KAKAO_BANK: "CARD_COMPANY_KAKAO_BANK";
+    /**
+     * 우리카드
+     */
     readonly WOORI_CARD: "CARD_COMPANY_WOORI_CARD";
+    /**
+     * BC카드
+     */
     readonly BC_CARD: "CARD_COMPANY_BC_CARD";
+    /**
+     * 광주카드
+     */
     readonly GWANGJU_CARD: "CARD_COMPANY_GWANGJU_CARD";
+    /**
+     * 삼성카드
+     */
     readonly SAMSUNG_CARD: "CARD_COMPANY_SAMSUNG_CARD";
+    /**
+     * 신한카드
+     */
     readonly SHINHAN_CARD: "CARD_COMPANY_SHINHAN_CARD";
+    /**
+     * 현대카드
+     */
     readonly HYUNDAI_CARD: "CARD_COMPANY_HYUNDAI_CARD";
+    /**
+     * 롯데카드
+     */
     readonly LOTTE_CARD: "CARD_COMPANY_LOTTE_CARD";
+    /**
+     * 수협카드
+     */
     readonly SUHYUP_CARD: "CARD_COMPANY_SUHYUP_CARD";
+    /**
+     * 씨티카드
+     */
     readonly CITI_CARD: "CARD_COMPANY_CITI_CARD";
+    /**
+     * NH 농협카드
+     */
     readonly NH_CARD: "CARD_COMPANY_NH_CARD";
+    /**
+     * 전북카드
+     */
     readonly JEONBUK_CARD: "CARD_COMPANY_JEONBUK_CARD";
+    /**
+     * 제주카드
+     */
     readonly JEJU_CARD: "CARD_COMPANY_JEJU_CARD";
+    /**
+     * 하나카드
+     */
     readonly HANA_CARD: "CARD_COMPANY_HANA_CARD";
+    /**
+     * 국민카드
+     */
     readonly KOOKMIN_CARD: "CARD_COMPANY_KOOKMIN_CARD";
+    /**
+     * K뱅크 카드
+     */
     readonly K_BANK: "CARD_COMPANY_K_BANK";
+    /**
+     * 토스뱅크 카드
+     */
     readonly TOSS_BANK: "CARD_COMPANY_TOSS_BANK";
+    /**
+     * 미래에셋증권 카드
+     */
     readonly MIRAE_ASSET_SECURITIES: "CARD_COMPANY_MIRAE_ASSET_SECURITIES";
 };
-export type CardCompany = typeof CardCompany[keyof typeof CardCompany];
+/**
+ * 카드 결제시 사용되는 카드사 코드
+ */
+export type CardCompany = (typeof CardCompany)[keyof typeof CardCompany];

package/dist/v2/entity/Carrier.d.ts

@@ -1,18 +1,33 @@
 /**
  * 통신사 코드
- * - SKT: SK 텔레콤
- * - KT: KT
- * - LGU: LG 유플러스
- * - HELLO: CJ 헬로 모바일
- * - KCT: 티플러스
- * - SK7: SK 세븐 모바일
  */
 export declare const Carrier: {
+    /**
+     * SK텔레콤
+     */
     readonly SKT: "CARRIER_SKT";
+    /**
+     * KT
+     */
     readonly KT: "CARRIER_KT";
+    /**
+     * LG U+
+     */
     readonly LGU: "CARRIER_LGU";
+    /**
+     * 헬로모바일
+     */
     readonly HELLO: "CARRIER_HELLO";
+    /**
+     * 티플러스
+     */
     readonly KCT: "CARRIER_KCT";
+    /**
+     * SK 7mobile
+     */
     readonly SK7: "CARRIER_SK7";
 };
-export type Carrier = typeof Carrier[keyof typeof Carrier];
+/**
+ * 통신사 코드
+ */
+export type Carrier = (typeof Carrier)[keyof typeof Carrier];

package/dist/v2/entity/CashReceiptType.d.ts

@@ -1,6 +1,21 @@
+/**
+ * **현금영수증 발급 유형**
+ */
 export declare const CashReceiptType: {
+    /**
+     * 소득공제(개인)
+     */
     readonly PERSONAL: "CASH_RECEIPT_TYPE_PERSONAL";
+    /**
+     * 지출증빙(사업자)
+     */
     readonly CORPORATE: "CASH_RECEIPT_TYPE_CORPORATE";
+    /**
+     * 미발행(PG 설정에 따라 무기명으로 자진 발급될 수 있음)
+     */
     readonly ANONYMOUS: "CASH_RECEIPT_TYPE_ANONYMOUS";
 };
-export type CashReceiptType = typeof CashReceiptType[keyof typeof CashReceiptType];
+/**
+ * **현금영수증 발급 유형**
+ */
+export type CashReceiptType = (typeof CashReceiptType)[keyof typeof CashReceiptType];

package/dist/v2/entity/ChannelGroupId.d.ts

@@ -0,0 +1,8 @@
+/**
+ * **채널 그룹 ID**
+ *
+ * 채널 그룹 ID를 지정하여 결제창을 호출하면, 채널 그룹 내 설정된 비율에 따라 확률적으로 하나의 채널이 선택됩니다. [관리자 콘솔 > 연동 관리 > 스마트 라우팅](https://admin.portone.io/integration-v2/smart-routing)에서 설정합니다.
+ *
+ * 채널 키와 채널 그룹 ID 중 하나를 지정해야 합니다.
+ */
+export type ChannelGroupId = string;

package/dist/v2/entity/ChannelKey.d.ts

@@ -0,0 +1,10 @@
+/**
+ * **채널 키**
+ *
+ * 포트원에 등록된 결제 채널 중 하나를 지정합니다.
+ *
+ * [관리자 콘솔 > 연동 정보](https://admin.portone.io/integration-v2/manage/channel)에서 채널 연동 후 채널 키를 확인할 수 있습니다.
+ *
+ * 채널 키와 채널 그룹 ID 중 하나를 지정해야 합니다.
+ */
+export type ChannelKey = string;