@portone/browser-sdk 0.0.23 → 0.1.0

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

@@ -1,43 +1,40 @@
+import type { EximbayV2Payment } from './EximbayV2Payment.js';
+import type { EximbayV2Merchant } from './EximbayV2Merchant.js';
+import type { EximbayV2Tax } from './EximbayV2Tax.js';
+import type { EximbayV2Surcharge } from './EximbayV2Surcharge.js';
+import type { EximbayV2ShipTo } from './EximbayV2ShipTo.js';
+import type { EximbayV2BillTo } from './EximbayV2BillTo.js';
+import type { EximbayV2Settings } from './EximbayV2Settings.js';
+/**
+ * 엑심베이 V2 bypass 파라미터
+ */
 export type EximbayV2Bypass = {
-    payment?: {
-        payment_method?: string;
-        multi_payment_method?: string[];
-    };
-    merchant?: {
-        shop?: string;
-        partner_code?: string;
-    };
-    tax?: {
-        receipt_status?: 'Y' | 'N';
-    };
-    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;
-    };
-    settings?: {
-        call_from_app?: 'Y' | 'N';
-        issuer_country?: string;
-        virtualaccount_expiry_date?: string;
-    };
+    /**
+     * 결제 정보
+     */
+    payment?: EximbayV2Payment | undefined;
+    /**
+     * 상점 정보
+     */
+    merchant?: EximbayV2Merchant | undefined;
+    /**
+     * 세금 정보
+     */
+    tax?: EximbayV2Tax | undefined;
+    /**
+     * 최대 3개의 추가 비용 목록
+     */
+    surcharge?: EximbayV2Surcharge[] | undefined;
+    /**
+     * 배송지 정보
+     */
+    ship_to?: EximbayV2ShipTo | undefined;
+    /**
+     * 청구지 정보
+     */
+    bill_to?: EximbayV2BillTo | undefined;
+    /**
+     * 설정 정보
+     */
+    settings?: EximbayV2Settings | undefined;
 };

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

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

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

@@ -0,0 +1,13 @@
+/**
+ * 상점 정보
+ */
+export type EximbayV2Merchant = {
+    /**
+     * 상점명
+     */
+    shop?: string | undefined;
+    /**
+     * 파트너 코드
+     */
+    partner_code?: string | undefined;
+};

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

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

package/dist/v2/entity/bypass/payment/EximbayV2Settings.d.ts

@@ -0,0 +1,18 @@
+import { EximbayV2SettingsCallFromApp } from './EximbayV2SettingsCallFromApp.js';
+/**
+ * 설정 정보
+ */
+export type EximbayV2Settings = {
+    /**
+     * 인앱 웹뷰 여부
+     */
+    call_from_app?: EximbayV2SettingsCallFromApp | undefined;
+    /**
+     * 해외 결제 가맹점에서 국내 결제를 사용할 경우 `KR`
+     */
+    issuer_country?: string | undefined;
+    /**
+     * 입금 만료 일자 (yyyyMMddHH)
+     */
+    virtualaccount_expiry_date?: string | undefined;
+};

package/dist/v2/entity/bypass/payment/EximbayV2SettingsCallFromApp.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 인앱 웹뷰 여부
+ */
+export declare const EximbayV2SettingsCallFromApp: {
+    readonly Y: "Y";
+    readonly N: "N";
+};
+/**
+ * 인앱 웹뷰 여부
+ */
+export type EximbayV2SettingsCallFromApp = (typeof EximbayV2SettingsCallFromApp)[keyof typeof EximbayV2SettingsCallFromApp];

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

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

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

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

package/dist/v2/entity/bypass/payment/EximbayV2Tax.d.ts

@@ -0,0 +1,10 @@
+import { EximbayV2TaxReceiptStatus } from './EximbayV2TaxReceiptStatus.js';
+/**
+ * 세금 정보
+ */
+export type EximbayV2Tax = {
+    /**
+     * 현금영수증 발급 여부
+     */
+    receipt_status?: EximbayV2TaxReceiptStatus | undefined;
+};

package/dist/v2/entity/bypass/payment/EximbayV2TaxReceiptStatus.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 현금영수증 발급 여부
+ */
+export declare const EximbayV2TaxReceiptStatus: {
+    readonly Y: "Y";
+    readonly N: "N";
+};
+/**
+ * 현금영수증 발급 여부
+ */
+export type EximbayV2TaxReceiptStatus = (typeof EximbayV2TaxReceiptStatus)[keyof typeof EximbayV2TaxReceiptStatus];

package/dist/v2/entity/bypass/payment/Hyphen.d.ts

@@ -1,3 +1,7 @@
+import type { HyphenDesignCd } from './HyphenDesignCd.js';
+/**
+ * 하이픈 bypass 파라미터
+ */
 export type HyphenBypass = {
-    designCd?: string;
+    designCd?: HyphenDesignCd | undefined;
 };

package/dist/v2/entity/bypass/payment/HyphenDesignCd.d.ts

@@ -0,0 +1 @@
+export type HyphenDesignCd = string;

package/dist/v2/entity/bypass/payment/InicisJp.d.ts

@@ -1,25 +1,10 @@
+import type { InicisJpPaymentUI } from './InicisJpPaymentUI.js';
+/**
+ * 이니시스 일본 bypass 파라미터
+ */
 export type InicisJpBypass = {
-    paymentUI?: {
-        /**
-         * 결제창 색상
-         * Allowed values
-         *   - "red1"
-         *   - "red2"
-         *   - "red3"
-         *   - "red4"
-         *   - "orange"
-         *   - "yellow"
-         *   - "black"
-         *   - "purple"
-         *   - "green"
-         *   - "blue1"
-         *   - "blue2":
-         *   - "blue3"
-         *   - "blue4"
-         *   - "blue5"
-         *   - "blue6"
-         */
-        colorTheme?: string;
-        logoUrl?: string;
-    };
+    /**
+     * 결제창 UI 설정
+     */
+    paymentUI?: InicisJpPaymentUI | undefined;
 };

package/dist/v2/entity/bypass/payment/InicisJpPaymentUI.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 결제창 UI 설정
+ */
+export type InicisJpPaymentUI = {
+    /**
+     * **결제창 색상**
+     *
+     * 가능한 값:
+     *
+     * - `red1`
+     * - `red2`
+     * - `red3`
+     * - `red4`
+     * - `orange`
+     * - `yellow`
+     * - `black`
+     * - `purple`
+     * - `green`
+     * - `blue1`
+     * - `blue2`
+     * - `blue3`
+     * - `blue4`
+     * - `blue5`
+     * - `blue6`
+     */
+    colorTheme?: string | undefined;
+    /**
+     * **가맹점 로고 이미지 URL**
+     *
+     * 69 \* 20 픽셀 크기의 이미지 URL
+     */
+    logoUrl?: string | undefined;
+};

package/dist/v2/entity/bypass/payment/InicisV2.d.ts

@@ -1,98 +1,131 @@
-export type InicisV2Bypass = InicisV2BypassOnPc & InicisV2BypassOnMobile;
-type InicisV2BypassOnPc = {
+/**
+ * KG이니시스 bypass 파라미터
+ *
+ * KG이니시스는 PC 결제 모듈과 모바일 결제 모듈이 분리되어 있기 때문에 bypass 파라미터 또한 PC용과 모바일용이 분리되어 있습니다.
+ */
+export type InicisV2Bypass = {
     /**
-     * 메인로고 삽입 [size: 89*18]
+     * **PC용 파라미터**
+     *
+     * 결제창에 삽입할 메인 로고 url
+     *
+     * 결제창 중앙 상단에 표시됩니다.
+     * 이미지 권장 사이즈는 89\*18 입니다.
      */
-    logo_url?: string;
+    logo_url?: string | undefined;
     /**
-     * 서브로고 삽입 [size: 64*13]
+     * **PC용 파라미터**
+     *
+     * 결제창에 삽입할 서브 로고 url
+     *
+     * 결제창 우측 상단에 표시됩니다.
+     * 이미지 권장 사이즈는 64\*13 입니다.
      */
-    logo_2nd?: string;
+    logo_2nd?: string | undefined;
     /**
-     * 보호자 이메일주소
-     * 14세 미만 필수, "@", "." 외 특수문자 입력불가
+     * **PC용 파라미터**
+     *
+     * 보호자 이메일 주소
+     *
+     * 14세 미만 고객의 경우 필수 입력입니다.
+     * "@", "." 외의 특수문자는 입력 불가합니다.
      */
-    parentemail?: string;
+    parentemail?: string | undefined;
     /**
-     * SSGPAY 결제요청 시 PUSH전송 휴대폰번호
-     * 숫자만 허용
+     * **PC용 파라미터**
+     *
+     * SSGPAY 결제요청 시 PUSH 전송 휴대폰번호
+     *
+     * `-` 없이 숫자만 허용합니다.
      */
-    Ini_SSGPAY_MDN?: string;
+    Ini_SSGPAY_MDN?: string | undefined;
     /**
-     * 지불수단별 추가옵션
+     * **PC용 파라미터**
+     *
+     * 추가 옵션
+     *
+     * 아래 string 중 원하는 옵션들을 골라 array 형태로 입력합니다.
+     *
+     * - **SKIN(#색상코드)**
+     *
+     *   결제창 배경색상 설정 \[기본값: #C1272C]
+     *
+     *   예시: `SKIN(#fc6b2d)`
+     *
+     * - **below1000**
+     *
+     *   (카드결제 & 간편결제 시) 1000원 미만 결제 허용 옵션
+     *
+     * - **ocb**
+     *
+     *   (카드결제 시) 카드 메인화면에 OCB 적립을 위한 카드번호 창 표시옵션 (별도 계약시 이용 가능)
+     *
+     * - **paypopup**
+     *
+     *   (카드결제 시) 안심클릭계열 신용카드 POPUP 형태 표시옵션
+     *
+     * - **hidebar**
+     *
+     *   (카드결제 시) 프로그레스바 미노출 옵션
+     *
+     * - **noeasypay**
+     *
+     *   (카드결제 시) 간편결제 미노출 옵션
+     *
+     * - **slimquota(코드-개월:개월^코드-개월:개월)**
+     *
+     *   부분 무이자 설정 (별도 계약시 이용 가능)
+     *
+     *   `string` 부분에는 `코드-개월:개월^코드-개월:개월` 와 같은 형식으로 입력합니다. (ex. `slimquota(11-2:3^34-2:3)`)
+     *   카드사 코드는 [KG이니시스 통합 코드](https://manual.inicis.com/pay/code.html) 페이지에서
+     *   "결제요청 시 카드코드" 섹션을 참고하시기 바랍니다.
+     *
+     * - **mallpoint(카드코드:카드코드)**
+     *
+     *   몰포인트 (별도 계약시 이용 가능)
+     *
+     *   `string` 부분에는 `카드코드:카드코드` 와 같은 형식으로 입력합니다. (ex. `mallpoint(11:34)`)
+     *   카드사 코드는 [KG이니시스 통합 코드](https://manual.inicis.com/pay/code.html) 페이지에서
+     *   "결제요청 시 카드코드" 섹션을 참고하시기 바랍니다.
      */
-    acceptmethod?: AcceptMethodKeyFromBypass[];
-};
-type InicisV2BypassOnMobile = {
+    acceptmethod?: string[] | undefined;
     /**
+     * **모바일용 파라미터**
+     *
      * 신용카드 우선선택 옵션
-     * 설정한 카드코드에 해당하는 카드가 선택된 채로 Display 됨
      *
-     * 형식) selcode=카드코드
-     * 예시) selcode=14
+     * 설정한 카드코드에 해당하는 카드가 선택된 채로 Display 됩니다.
+     * `selcode=카드코드` 형식으로 입력합니다. (ex. `selcode=14`)
      */
-    P_CARD_OPTION?: string;
+    P_CARD_OPTION?: string | undefined;
     /**
+     * **모바일용 파라미터**
+     *
      * 가맹점 이름
      */
-    P_MNAME?: string;
+    P_MNAME?: string | undefined;
     /**
-     * 지불수단별 추가옵션
+     * **모바일용 파라미터**
+     *
+     * 추가 옵션
+     *
+     * 아래 string 중 원하는 옵션들을 골라 array 형태로 입력합니다.
+     *
+     * - **below1000=Y**
+     *
+     *   (카드결제 & 간편결제 시) 1000원 미만 결제 허용 옵션
+     *
+     * - **noeasypay=Y**
+     *
+     *   (카드결제 시) 간편결제 미노출 옵션
+     *
+     * - **global\_visa3d=Y**
+     *
+     *   해외카드 노출 옵션
+     *
+     * - **apprun\_check=Y**
+     *
+     *   (android의 경우) custom url scheme 대신 intent schema(intent://) 호출
      */
-    P_RESERVED?: ReservedKeyFromBypass[];
+    P_RESERVED?: string[] | undefined;
 };
-type AcceptMethodKeyFromBypass = 
-/**
- * 결제창 배경색상 [Default: #C1272C]
- */
-`SKIN(${string})`
-/**
- * 신용카드 결제 시 1000원 이하금액 결제가능 옵션
- */
- | `below1000`
-/**
- * 카드 메인화면에 OCB 적립을 위한 카드번호 창 표시옵션
- */
- | `ocb`
-/**
- * 안심클릭계열 신용카드 POPUP 형태 표시옵션
- */
- | `paypopup`
-/**
- * 프로그래스바 미노출 옵션
- */
- | `hidebar`
-/**
- * 간편결제 미노출 옵션
- */
- | `noeasypay`
-/**
- * 부분 무이자 설정. 슬림 할부
- * 형식) slimquota(코드-개월:개월^코드-개월:개월)
- * 예시) slimquota(11-2:3^34-2:3)
- */
- | `slimquota(${string})`
-/**
- * 형식) mallpoint(카드코드:카드코드)
- * 예시) mallpoint(11:34)
- */
- | `mallpoint(${string})`;
-type ReservedKeyFromBypass = 
-/**
- * 신용카드 결제 시 1000원 이하금액 결제가능 옵션
- */
-`below1000=Y`
-/**
- * 간편결제 미노출 옵션
- */
- | `noeasypay=Y`
-/**
- * 해외카드 노출 옵션
- */
- | `global_visa3d=Y`
-/**
- * 안드로이드 앱 내 웹뷰에서 ISP 결제 진행 시
- * custom url scheme(ispmobile://) 대신 intent:// 로 처리할 지 여부
- */
- | `apprun_check=Y`;
-export {};

package/dist/v2/entity/bypass/payment/Kakaopay.d.ts

@@ -1,3 +1,9 @@
+/**
+ * 카카오페이 bypass 파라미터
+ */
 export type KakaopayPaymentBypass = {
-    custom_message?: string;
+    /**
+     * 카카오페이 결제창에 띄워줄 사용자 정의 문구
+     */
+    custom_message?: string | undefined;
 };

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

@@ -1,15 +1,28 @@
+import { KcpV2ComplexPnt } from './KcpV2ComplexPnt.js';
+import { KcpV2DispTax } from './KcpV2DispTax.js';
 /**
- * 정규화가 어려운 KCP V2 bypass 파라미터
- * 가맹점으로부터 전달 된 값을 PG사로 그대로 전달
+ * NHN KCP bypass 파라미터
  */
 export type KcpV2Bypass = {
-    skin_indx?: string;
-    site_logo?: string;
+    skin_indx?: string | undefined;
+    site_logo?: string | undefined;
     shop_user_id: string;
-    kcp_pay_title?: string;
-    complex_pnt_yn?: 'Y' | 'N';
-    pt_memcorp_cd?: string;
-    disp_tax_yn?: 'Y' | 'N' | 'R' | 'E';
-    site_name?: string;
-    deli_term?: string;
+    kcp_pay_title?: string | undefined;
+    /**
+     * 포인트 결제의 경우 신용카드 + 포인트 결제인데, N으로 설정 시 포인트로만 결제가 이루어짐
+     */
+    complex_pnt_yn?: KcpV2ComplexPnt | undefined;
+    pt_memcorp_cd?: string | undefined;
+    /**
+     * 가상계좌, 계좌이체 시 현금영수증 노출 여부
+     */
+    disp_tax_yn?: KcpV2DispTax | undefined;
+    /**
+     * 결제창에 노출될 고객사 상호명
+     */
+    site_name?: string | undefined;
+    /**
+     * 에스크로 배송 예상 소요일
+     */
+    deli_term?: string | undefined;
 };

package/dist/v2/entity/bypass/payment/KcpV2ComplexPnt.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 포인트 결제의 경우 신용카드 + 포인트 결제인데, N으로 설정 시 포인트로만 결제가 이루어짐
+ */
+export declare const KcpV2ComplexPnt: {
+    readonly Y: "Y";
+    readonly N: "N";
+};
+/**
+ * 포인트 결제의 경우 신용카드 + 포인트 결제인데, N으로 설정 시 포인트로만 결제가 이루어짐
+ */
+export type KcpV2ComplexPnt = (typeof KcpV2ComplexPnt)[keyof typeof KcpV2ComplexPnt];

package/dist/v2/entity/bypass/payment/KcpV2DispTax.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 가상계좌, 계좌이체 시 현금영수증 노출 여부
+ */
+export declare const KcpV2DispTax: {
+    readonly Y: "Y";
+    readonly N: "N";
+    readonly R: "R";
+    readonly E: "E";
+};
+/**
+ * 가상계좌, 계좌이체 시 현금영수증 노출 여부
+ */
+export type KcpV2DispTax = (typeof KcpV2DispTax)[keyof typeof KcpV2DispTax];

package/dist/v2/entity/bypass/payment/Kpn.d.ts

@@ -1,15 +1,13 @@
+import { KpnCardSelect } from './KpnCardSelect.js';
 /**
- * 정규화가 어려운 KPN bypass 파라미터
- * 가맹점으로부터 전달 된 값을 PG사로 그대로 전달
+ * KPN bypass 파라미터
  */
 export type KpnBypass = {
     /**
-     * GLOBAL('09') : 해외카드 (VISA + MASTER + JCB)
-     * 11PAY('96') : 11Pay (SKPay)
-     * LEGACY_AUTH('98') : 구인증
-     * KEY_IN('99') : 키인
-     * 'W2' : 페이코 (now Unsupported!!)
-     * 'X4' : 카카오페이 (now Unsupported!!)
+     * - 해외카드 (VISA + MASTER + JCB) : `GLOBAL`
+     * - 11Pay (SKPay) : `11PAY`
+     * - 구인증 : `LEGACY_AUTH`
+     * - 키인 : `KEY_IN`
      */
-    CardSelect: Array<'GLOBAL' | '11PAY' | 'LEGACY_AUTH' | 'KEY_IN'>;
+    CardSelect?: KpnCardSelect[] | undefined;
 };

package/dist/v2/entity/bypass/payment/KpnCardSelect.d.ts

@@ -0,0 +1,19 @@
+export declare const KpnCardSelect: {
+    /**
+     * 해외카드
+     */
+    readonly GLOBAL: "GLOBAL";
+    /**
+     * 11Pay
+     */
+    readonly '11PAY': "11PAY";
+    /**
+     * 구인증
+     */
+    readonly LEGACY_AUTH: "LEGACY_AUTH";
+    /**
+     * 키인
+     */
+    readonly KEY_IN: "KEY_IN";
+};
+export type KpnCardSelect = (typeof KpnCardSelect)[keyof typeof KpnCardSelect];