@portone/browser-sdk 0.0.23 → 0.1.0

package/dist/v2/entity/bypass/issueBillingKey/KcpV2.d.ts

@@ -1,6 +1,10 @@
+import { KcpV2BatchSocChoice } from './KcpV2BatchSocChoice.js';
+/**
+ * **KCP bypass 파라미터**
+ */
 export type KcpV2IssueBillingKeyBypass = {
     /**
-     * 결제창에서 주민번호/사업자 번호 고정여부 설정 S: 주민번호만 표시 C: 사업자번호만 표시
+     * 결제창에서 주민번호/사업자 번호 고정여부 설정
      */
-    batch_soc_choice?: 'S' | 'C';
+    batch_soc_choice?: KcpV2BatchSocChoice | undefined;
 };

package/dist/v2/entity/bypass/issueBillingKey/KcpV2BatchSocChoice.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 결제창에서 주민번호/사업자 번호 고정여부 설정
+ */
+export declare const KcpV2BatchSocChoice: {
+    /**
+     * 주민번호만 표시
+     */
+    readonly S: "S";
+    /**
+     * 사업자번호만 표시
+     */
+    readonly C: "C";
+};
+/**
+ * 결제창에서 주민번호/사업자 번호 고정여부 설정
+ */
+export type KcpV2BatchSocChoice = (typeof KcpV2BatchSocChoice)[keyof typeof KcpV2BatchSocChoice];

package/dist/v2/entity/bypass/issueBillingKey/Naverpay.d.ts

@@ -1,8 +1,13 @@
 /**
- * 정규화가 어려운 네이버페이 빌링키 발급 bypass 파라미터
- * 가맹점으로부터 전달 된 값을 PG사로 그대로 전달
+ * **네이버페이 bypass 파라미터**
  */
 export type NaverpayIssueBillingKeyBypass = {
-    subMerchantName?: string;
-    subMerchantId?: string;
+    /**
+     * 하부 가맹점 명
+     */
+    subMerchantName?: string | undefined;
+    /**
+     * 하부 가맹점 ID
+     */
+    subMerchantId?: string | undefined;
 };

package/dist/v2/entity/bypass/issueBillingKey/SmartroV2.d.ts

@@ -1,8 +1,15 @@
+import { SmartroV2SkinColor } from './SmartroV2SkinColor.js';
+import { SmartroV2IsPwdPass } from './SmartroV2IsPwdPass.js';
 /**
- * 정규화가 어려운 스마트로 bypass 파라미터
- * 가맹점으로부터 전달 된 값을 PG사로 그대로 전달
+ * **스마트로 bypass 파라미터**
  */
 export type SmartroV2IssueBillingKeyBypass = {
-    SkinColor?: 'RED' | 'GREEN' | 'BLUE' | 'PURPLE';
-    IsPwdPass?: 'Y' | 'N';
+    /**
+     * UI 스타일(기본: RED)
+     */
+    SkinColor?: SmartroV2SkinColor | undefined;
+    /**
+     * 결제 비밀번호 등록 Skip 여부
+     */
+    IsPwdPass?: SmartroV2IsPwdPass | undefined;
 };

package/dist/v2/entity/bypass/issueBillingKey/SmartroV2IsPwdPass.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 결제 비밀번호 등록 Skip 여부
+ */
+export declare const SmartroV2IsPwdPass: {
+    /**
+     * 비밀번호 설정 미사용
+     */
+    readonly Y: "Y";
+    /**
+     * 비밀번호 설정 사용
+     */
+    readonly N: "N";
+};
+/**
+ * 결제 비밀번호 등록 Skip 여부
+ */
+export type SmartroV2IsPwdPass = (typeof SmartroV2IsPwdPass)[keyof typeof SmartroV2IsPwdPass];

package/dist/v2/entity/bypass/issueBillingKey/SmartroV2SkinColor.d.ts

@@ -0,0 +1,13 @@
+/**
+ * UI 스타일(기본: RED)
+ */
+export declare const SmartroV2SkinColor: {
+    readonly RED: "RED";
+    readonly GREEN: "GREEN";
+    readonly BLUE: "BLUE";
+    readonly PURPLE: "PURPLE";
+};
+/**
+ * UI 스타일(기본: RED)
+ */
+export type SmartroV2SkinColor = (typeof SmartroV2SkinColor)[keyof typeof SmartroV2SkinColor];

package/dist/v2/entity/bypass/issueBillingKey/TosspayV2.d.ts

@@ -1,7 +1,9 @@
 /**
- * 정규화가 어려운 토스페이 V2 bypass 파라미터
- * 가맹점으로부터 전달 된 값을 PG사로 그대로 전달
+ * **토스페이 bypass 파라미터**
  */
 export type TosspayV2IssueBillingKeyBypass = {
-    encryptedUserCi?: string;
+    /**
+     * 암호화된 사용자 CI
+     */
+    encryptedUserCi?: string | undefined;
 };

package/dist/v2/entity/bypass/issueBillingKey/Welcome.d.ts

@@ -1,6 +1,13 @@
-export type WelcomeIssueBillingKeyBypass = WelcomeIssueBillingKeyBypassOnPc;
-type WelcomeIssueBillingKeyBypassOnPc = {
-    logo_url?: string;
-    logo_2nd?: string;
+/**
+ * **웰컴페이먼츠 bypass 파라미터**
+ */
+export type WelcomeIssueBillingKeyBypass = {
+    /**
+     * 메인 로고 URL (크기: 89x19)
+     */
+    logo_url?: string | undefined;
+    /**
+     * 서브 로고 URL (크기: 64x13)
+     */
+    logo_2nd?: string | undefined;
 };
-export {};

package/dist/v2/entity/bypass/issueBillingKey/index.d.ts

@@ -1,16 +1,10 @@
-import { KakaopayPaymentBypass } from '../payment/Kakaopay.js';
-import { SmartroV2IssueBillingKeyBypass } from './SmartroV2.js';
-import { NaverpayIssueBillingKeyBypass } from './Naverpay.js';
-import { WelcomeIssueBillingKeyBypass } from './Welcome.js';
-import { TosspayV2IssueBillingKeyBypass } from './TosspayV2.js';
-import { InicisV2IssueBillingKeyBypass } from './InicisV2.js';
-import { KcpV2IssueBillingKeyBypass } from './KcpV2.js';
-export type IssueBillingKeyBypass = {
-    kakaopay?: KakaopayPaymentBypass;
-    smartro_v2?: SmartroV2IssueBillingKeyBypass;
-    naverpay?: NaverpayIssueBillingKeyBypass;
-    welcome?: WelcomeIssueBillingKeyBypass;
-    tosspay_v2?: TosspayV2IssueBillingKeyBypass;
-    inicis_v2?: InicisV2IssueBillingKeyBypass;
-    kcp_v2?: KcpV2IssueBillingKeyBypass;
-};
+export * from './SmartroV2.js';
+export * from './InicisV2.js';
+export * from './KcpV2.js';
+export * from './Naverpay.js';
+export * from './TosspayV2.js';
+export * from './Welcome.js';
+export * from './SmartroV2SkinColor.js';
+export * from './SmartroV2IsPwdPass.js';
+export * from './InicisV2CardUse.js';
+export * from './KcpV2BatchSocChoice.js';

package/dist/v2/entity/bypass/issueBillingKeyAndPay/EximbayV2.d.ts

@@ -1,30 +1,27 @@
+import type { EximbayV2Payment } from './EximbayV2Payment.js';
+import type { EximbayV2Merchant } from './EximbayV2Merchant.js';
+import type { EximbayV2Surcharge } from './EximbayV2Surcharge.js';
+import type { EximbayV2ShipTo } from './EximbayV2ShipTo.js';
+import type { EximbayV2BillTo } from './EximbayV2BillTo.js';
+/**
+ * **엑심베이 bypass 파라미터**
+ */
 export type EximbayV2IssueBillingKeyAndPayBypass = {
-    merchant?: {
-        shop?: string;
-    };
-    surcharge?: {
-        name?: string;
-        quantity?: string;
-        unit_price?: string;
-    }[];
-    ship_to?: {
-        city?: string;
-        country?: string;
-        first_name?: string;
-        last_name?: string;
-        phone_number?: string;
-        postal_code?: string;
-        state?: string;
-        street1?: string;
-    };
-    bill_to?: {
-        city?: string;
-        country?: string;
-        first_name?: string;
-        last_name?: string;
-        phone_number?: string;
-        postal_code?: string;
-        state?: string;
-        street1?: string;
-    };
+    /**
+     * 결제 정보
+     */
+    payment?: EximbayV2Payment | undefined;
+    merchant?: EximbayV2Merchant | undefined;
+    /**
+     * **최대 3개의 추가 비용 목록**
+     */
+    surcharge?: EximbayV2Surcharge[] | undefined;
+    /**
+     * **배송지 정보**
+     */
+    shipTo?: EximbayV2ShipTo | undefined;
+    /**
+     * **청구지 정보**
+     */
+    billTo?: EximbayV2BillTo | undefined;
 };

package/dist/v2/entity/bypass/issueBillingKeyAndPay/EximbayV2BillTo.d.ts

@@ -0,0 +1,37 @@
+/**
+ * **청구지 정보**
+ */
+export type EximbayV2BillTo = {
+    /**
+     * **청구지 도시**
+     */
+    city: string;
+    /**
+     * **청구지 국가 (ISO 3166 두 자리 국가 코드)**
+     */
+    country: string;
+    /**
+     * **청구 카드 명의자의 성을 제외한 이름**
+     */
+    first_name: string;
+    /**
+     * **청구 카드 명의자의 성**
+     */
+    last_name: string;
+    /**
+     * **청구 카드 명의자의 전화번호**
+     */
+    phone_number: string;
+    /**
+     * **청구지 우편번호**
+     */
+    postal_code: string;
+    /**
+     * **청구지가 미국 혹은 캐나다인 경우, 청구지 주 정보**
+     */
+    state: string;
+    /**
+     * **청구지 상세 주소**
+     */
+    street1: string;
+};

package/dist/v2/entity/bypass/issueBillingKeyAndPay/EximbayV2Merchant.d.ts

@@ -0,0 +1,6 @@
+export type EximbayV2Merchant = {
+    /**
+     * **상점명**
+     */
+    shop: string;
+};

package/dist/v2/entity/bypass/issueBillingKeyAndPay/EximbayV2Payment.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 결제 정보
+ */
+export type EximbayV2Payment = {
+    /**
+     * 결제수단 단독 노출
+     */
+    payment_method?: string | undefined;
+    /**
+     * 결제수단 노출 목록
+     */
+    multi_payment_method?: string[] | undefined;
+};

package/dist/v2/entity/bypass/issueBillingKeyAndPay/EximbayV2ShipTo.d.ts

@@ -0,0 +1,37 @@
+/**
+ * **배송지 정보**
+ */
+export type EximbayV2ShipTo = {
+    /**
+     * **배송지 도시**
+     */
+    city: string;
+    /**
+     * **배송지 국가 (ISO 3166 두 자리 국가 코드)**
+     */
+    country: string;
+    /**
+     * **수신인의 성을 제외한 이름**
+     */
+    first_name: string;
+    /**
+     * **수신인의 성**
+     */
+    last_name: string;
+    /**
+     * **수신인 전화번호**
+     */
+    phone_number: string;
+    /**
+     * **배송지 우편번호**
+     */
+    postal_code: string;
+    /**
+     * **배송지가 미국 혹은 캐나다인 경우, 배송지 주 정보**
+     */
+    state: string;
+    /**
+     * **배송지 상세 주소**
+     */
+    street1: string;
+};

package/dist/v2/entity/bypass/issueBillingKeyAndPay/EximbayV2Surcharge.d.ts

@@ -0,0 +1,14 @@
+export type EximbayV2Surcharge = {
+    /**
+     * **항목명**
+     */
+    name: string;
+    /**
+     * **수량**
+     */
+    quantity: string;
+    /**
+     * **단가 (음수 가능)**
+     */
+    unit_price: string;
+};

package/dist/v2/entity/bypass/issueBillingKeyAndPay/PayletterGlobal.d.ts

@@ -1,10 +1,20 @@
 /**
- * 정규화가 어려운 Payletter Global bypass 파라미터
- * 가맹점으로부터 전달 된 값을 PG사로 그대로 전달
+ * **페이레터 해외결제 bypass 파라미터**
  */
 export type PayletterGlobalIssueBillingKeyAndPayBypass = {
-    pginfo?: PayletterGlobalPgInfo;
-    servicename?: string;
+    /**
+     * **결제수단 지정용 파라미터**
+     *
+     * - 해외카드 인증 : `PLCreditCard`
+     * - 해외카드 비인증(3DS) : `PLCreditCardMpi`
+     * - 유니온페이 : `PLUnionPay_HC`
+     * - 위챗페이 PC결제: `WeChatPayQRCodePayment`
+     * - 위챗페이 모바일결제 : `WeChatPayH5Payment`
+     * - 알리페이 : `ICBAlipay`
+     */
+    pginfo?: string | undefined;
+    /**
+     * 고객사 서비스명, WeChatPay, Alipay 이용 시 필수 입력
+     */
+    servicename?: string | undefined;
 };
-type PayletterGlobalPgInfo = 'PLCreditCard' | 'PLCreditCardMpi' | 'PLUnionPay' | 'PLUnionPay_HC' | 'WeChatPayH5Payment' | 'WeChatPayQRCodePayment' | 'ICBAlipay';
-export {};

package/dist/v2/entity/bypass/issueBillingKeyAndPay/Welcome.d.ts

@@ -1,55 +1,53 @@
-type WelcomeCarrier = 'SKT' | 'KTF' | 'LGT' | 'MVNO' | 'CJH' | 'KCT' | 'SKL';
-export type WelcomeIssueBillingKeyAndPayBypass = WelcomeIssueBillingKeyAndPayBypassOnPc & WelcomeIssueBillingKeyAndPayBypassOnMobile;
-type WelcomeIssueBillingKeyAndPayBypassOnPc = {
-    acceptmethod?: AcceptMethodKey[];
-};
-type AcceptMethodKey = 
-/**
- * 휴대폰 소액결제시 기본 선택 되어있는 통신사
- * 기본) 기본 선택되어있는 통신사 없음
- * 예시) KT 기본 선택 → hppdefaultcorp(KT) 전달
- *
- * - SKT: SKT
- * - KT: KTF
- * - LG 유플러스: LGT
- * - 알뜰폰 전체: MVNO
- * - 알뜰폰 CJ 헬로 모바일: CJH
- * - 알뜰폰 티플러스: KCT
- * - 알뜰폰 SK 세븐 모바일: SKL
- */
-`hppdefaultcorp(${WelcomeCarrier})`
 /**
- * 휴대폰 소액결제창에 자동 입력되는 buyer_tel값을 수정할 수 있는지 여부
- * 기본) 수정 가능
- *
- * - Y: 수정 불가능
- * - N: 수정 가능
+ * **웰컴페이먼츠 bypass 파라미터**
  */
- | `hppnofix(${'Y' | 'N'})`;
-type WelcomeIssueBillingKeyAndPayBypassOnMobile = {
-    P_RESERVED?: PReservedKey[];
+export type WelcomeIssueBillingKeyAndPayBypass = {
+    /**
+     * `acceptmethod` 파라미터는 휴대폰 소액결제 시 기본 선택할 통신사를 설정하며, 추가로 `buyer_tel` 값의 수정 가능 여부를 지정할 수 있습니다.
+     *
+     * **통신사 기본 선택 설정:**
+     *
+     * - 특정 통신사를 기본 선택하려면 `hppdefaultcorp(통신사코드)` 형식으로 전달합니다.
+     * - 예시: KT를 기본 선택 → `hppdefaultcorp(KTF)`
+     *
+     * **가능한 통신사 코드:**
+     *
+     * - `SKT`: SK 텔레콤
+     * - `KTF`: KT
+     * - `LGT`: LG 유플러스
+     * - `MVNO`: 알뜰폰 전체
+     * - `CJH`: 알뜰폰 CJ 헬로 모바일
+     * - `KCT`: 알뜰폰 티플러스
+     * - `SKL`: 알뜰폰 SK 세븐 모바일
+     *
+     * **휴대폰 소액결제창에 자동 입력되는 `buyer_tel` 수정 가능 여부 설정:**
+     *
+     * - 수정 불가능으로 설정하려면 `hppnofix(Y)`를 전달합니다.
+     * - 수정 가능으로 설정하려면 `hppnofix(N)`를 전달합니다. (기본값)
+     */
+    acceptmethod?: string[] | undefined;
+    /**
+     * `P_RESERVED` 파라미터는 휴대폰 소액결제 시 기본 선택할 통신사를 설정하며, 추가로 `buyer_tel` 값의 수정 가능 여부를 지정할 수 있습니다.
+     *
+     * **통신사 기본 선택 설정:**
+     *
+     * - 특정 통신사를 기본 선택하려면 `hpp_default_corp=통신사코드` 형식으로 전달합니다.
+     * - 예시: KT를 기본 선택 → `hpp_default_corp=KTF`
+     *
+     * **가능한 통신사 코드:**
+     *
+     * - `SKT`: SK 텔레콤
+     * - `KTF`: KT
+     * - `LGT`: LG 유플러스
+     * - `MVNO`: 알뜰폰 전체
+     * - `CJH`: 알뜰폰 CJ 헬로 모바일
+     * - `KCT`: 알뜰폰 티플러스
+     * - `SKL`: 알뜰폰 SK 세븐 모바일
+     *
+     * **휴대폰 소액결제창에 자동 입력되는 `buyer_tel` 수정 가능 여부 설정:**
+     *
+     * - 수정 불가능으로 설정하려면 `hpp_nofix=Y`를 전달합니다.
+     * - 수정 가능으로 설정하려면 `hpp_nofix=N`를 전달합니다. (기본값)
+     */
+    P_RESERVED?: string[] | undefined;
 };
-type PReservedKey = 
-/**
- * 휴대폰 소액결제시 기본 선택 되어있는 통신사
- * 기본) 기본 선택 되어있는 통신사 없음
- * 예시) KT 기본 선택 → hpp_default_corp=KT 전달
- *
- * - SKT: SKT
- * - KT: KTF
- * - LG 유플러스: LGT
- * - 알뜰폰 전체: MVNO
- * - 알뜰폰 CJ 헬로 모바일: CJH
- * - 알뜰폰 티플러스: KCT
- * - 알뜰폰 SK 세븐 모바일: SKL
- */
-`hpp_default_corp=${WelcomeCarrier}`
-/**
- * 휴대폰 소액결제창에 자동 입력되는 buyer_tel값을 수정할 수 있는지 여부
- * 기본) 수정 가능
- *
- * - Y: 수정 불가능
- * - N: 수정 가능
- */
- | `hpp_nofix=${'Y' | 'N'}`;
-export {};

package/dist/v2/entity/bypass/issueBillingKeyAndPay/index.d.ts

@@ -1,8 +1,8 @@
-import { PayletterGlobalIssueBillingKeyAndPayBypass } from './PayletterGlobal.js';
-import { WelcomeIssueBillingKeyAndPayBypass } from './Welcome.js';
-import { EximbayV2IssueBillingKeyAndPayBypass } from './EximbayV2.js';
-export type IssueBillingKeyAndPayBypass = {
-    welcome?: WelcomeIssueBillingKeyAndPayBypass;
-    payletter_global?: PayletterGlobalIssueBillingKeyAndPayBypass;
-    eximbay_v2?: EximbayV2IssueBillingKeyAndPayBypass;
-};
+export * from './Welcome.js';
+export * from './EximbayV2.js';
+export * from './EximbayV2Payment.js';
+export * from './EximbayV2Merchant.js';
+export * from './EximbayV2Surcharge.js';
+export * from './EximbayV2ShipTo.js';
+export * from './EximbayV2BillTo.js';
+export * from './PayletterGlobal.js';

package/dist/v2/entity/bypass/loadIssueBillingKeyUI/PaypalV2.d.ts

@@ -1,24 +1,17 @@
-import { PaypalV2Country } from '../PaypalV2Country.js';
+import type { PaypalV2Style } from './PaypalV2Style.js';
+import type { PaypalV2ShippingAddress } from './PaypalV2ShippingAddress.js';
+import type { PaypalV2AdditionalData } from './PaypalV2AdditionalData.js';
+/**
+ * **Paypal bypass 파라미터**
+ */
 export type PaypalV2LoadIssueBillingKeyUIBypass = {
-    style?: {
-        color?: 'gold' | 'blue' | 'silver' | 'white' | 'black';
-        height?: number;
-        label?: 'paypal' | 'checkout' | 'buynow' | 'pay' | 'installment' | 'subscribe' | 'donate';
-        layout?: 'vertical' | 'horizontal';
-        shape?: 'rect' | 'pill';
-        tagline?: boolean;
-    };
-    shipping_address?: {
-        recipient_name?: string;
-        line1: string;
-        line2?: string;
-        city: string;
-        state?: string;
-        postal_code?: string;
-        country_code: PaypalV2Country;
-    };
-    additional_data?: {
-        key: string;
-        value: string;
-    }[];
+    /**
+     * 페이팔 빌링키 발급 UI 호출 시 필요한 파라미터
+     */
+    style?: PaypalV2Style | undefined;
+    shipping_address?: PaypalV2ShippingAddress | undefined;
+    /**
+     * STC 파라미터
+     */
+    additional_data?: PaypalV2AdditionalData[] | undefined;
 };

package/dist/v2/entity/bypass/loadIssueBillingKeyUI/PaypalV2AdditionalData.d.ts

@@ -0,0 +1,4 @@
+export type PaypalV2AdditionalData = {
+    key: string;
+    value: string;
+};