@portone/browser-sdk 0.0.23 → 0.1.0

package/dist/v2/request/LoadPaymentUIRequest.d.ts

@@ -0,0 +1,198 @@
+import { PaymentUIType } from '../entity/PaymentUIType.js';
+import type { StoreId } from '../entity/StoreId.js';
+import type { PaymentOrderName } from '../entity/PaymentOrderName.js';
+import type { PaymentTotalAmount } from '../entity/PaymentTotalAmount.js';
+import type { ChannelKey } from '../entity/ChannelKey.js';
+import type { TaxFreeAmount } from '../entity/TaxFreeAmount.js';
+import type { VatAmount } from '../entity/VatAmount.js';
+import type { Customer } from '../entity/Customer.js';
+import type { RedirectUrl } from '../entity/RedirectUrl.js';
+import type { Product } from '../entity/Product.js';
+import { Currency } from '../entity/Currency.js';
+import { Locale } from '../entity/Locale.js';
+import type { OfferPeriod } from '../entity/OfferPeriod.js';
+import { ProductType } from '../entity/ProductType.js';
+import type { StoreDetails } from '../entity/StoreDetails.js';
+import type { LoadPaymentUIBypass } from '../entity/bypass/LoadPaymentUIBypass.js';
+import { Country } from '../entity/Country.js';
+import type { Address } from '../entity/Address.js';
+export type LoadPaymentUIRequest = {
+    uiType: PaymentUIType;
+    /**
+     * **상점 아이디**
+     *
+     * 포트원 계정에 생성된 상점을 식별하는 고유한 값으로 [관리자 콘솔 > 연동 정보](https://admin.portone.io/integration-v2/manage/channel) 우측 상단에서 확인할 수 있습니다.
+     */
+    storeId: StoreId;
+    /**
+     * **결제 ID**
+     *
+     * 고객사에서 임의로 ID를 정합니다.
+     *
+     * 이미 결제 완료된 `paymentId`로 결제를 요청하는 경우 실패합니다.
+     */
+    paymentId: string;
+    /**
+     * **주문명**
+     */
+    orderName: PaymentOrderName;
+    /**
+     * **결제 금액**
+     *
+     * 결제 금액을 정수로 나타냅니다.
+     *
+     * 해외 통화의 경우 통화의 최소 단위(minor unit)를 기준으로 합니다. 예를 들어, USD의 최소 단위는 센트(0.01 USD)이므로, 6 USD의 경우 100배하여 600으로 입력합니다.
+     *
+     * 최소 단위는 [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)에 표준화된 것을 기준으로 합니다.
+     *
+     * - KRW: 1배
+     * - USD: 100배
+     * - JPY: 1배
+     */
+    totalAmount: PaymentTotalAmount;
+    /**
+     * **채널 키**
+     *
+     * 포트원에 등록된 결제 채널 중 하나를 지정합니다.
+     *
+     * [관리자 콘솔 > 연동 정보](https://admin.portone.io/integration-v2/manage/channel)에서 채널 연동 후 채널 키를 확인할 수 있습니다.
+     *
+     * 채널 키와 채널 그룹 ID 중 하나를 지정해야 합니다.
+     */
+    channelKey: ChannelKey;
+    /**
+     * **면세 금액**
+     *
+     * 미입력 시 0으로 취급됩니다.
+     */
+    taxFreeAmount?: TaxFreeAmount | undefined;
+    /**
+     * **부가세 금액**
+     *
+     * 미입력 시 과세 금액의 1/11로 자동 계산됩니다.
+     */
+    vatAmount?: VatAmount | undefined;
+    customer?: Customer | undefined;
+    /**
+     * **리디렉션 방식에서 결제 완료 후 이동할 URL**
+     *
+     * 결제사 페이지로 이동하여 진행하는 리디렉션 방식의 경우 필수로 설정해야 합니다. 대부분의 모바일 환경이 리디렉션 방식에 해당됩니다.
+     */
+    redirectUrl?: RedirectUrl | undefined;
+    /**
+     * 웹훅 URL
+     */
+    noticeUrls?: string[] | undefined;
+    /**
+     * Confirm URL
+     */
+    confirmUrl?: string | undefined;
+    /**
+     * 앱 URL Scheme
+     */
+    appScheme?: string | undefined;
+    /**
+     * 에스크로 결제 여부
+     */
+    isEscrow?: boolean | undefined;
+    /**
+     * **구매 상품 정보**
+     */
+    products?: Product[] | undefined;
+    /**
+     * 문화비 지출 여부
+     */
+    isCulturalExpense?: boolean | undefined;
+    /**
+     * **화폐**
+     *
+     * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 화폐 코드
+     *
+     * 대한민국 원, 일본 엔이 아닌 화폐를 사용할 때에는 금액을 minor unit 단위로 입력해야 함에 유의하세요.
+     */
+    currency: Currency;
+    /**
+     * **UI 언어**
+     *
+     * KG이니시스, 스마트로, KSNET, 웰컴페이먼츠 (PC), 한국결제네트웍스, 엑심베이에서 설정 가능하며, PG마다 지원하는 언어 목록은 차이가 있습니다.
+     */
+    locale?: Locale | undefined;
+    /**
+     * **결제 정보와 함께 관리하고 싶은 고객사 커스텀 JSON 데이터**
+     */
+    customData?: Record<string, any> | undefined;
+    /**
+     * **서비스 제공 기간**
+     *
+     * range와 interval 중 하나를 입력해주세요.
+     *
+     * - range: 제공 기간 범위
+     * - interval: 제공 기간 주기
+     *
+     * 예1) 2023년 1월 1일 00시 00분 00초(KST) ~
+     *
+     * ```js
+     * range: {
+     *  from: '2023-01-01T00:00:00+09:00'
+     * }
+     * ```
+     *
+     * 예2) ~ 2023년 1월 1일 00시 00분 00초(KST)
+     *
+     * ```js
+     * range: {
+     *  to: '2023-01-01T00:00:00+09:00'
+     * }
+     * ```
+     *
+     * 예3) 2023년 1월 1일 00시 00분 00초(KST) ~ 2023년 12월 31일 23시 59분 59초(KST)
+     *
+     * ```js
+     * range: {
+     *  from: '2023-12-31T23:59:59+09:00'
+     *  to: '2023-01-01T00:00:00+09:00'
+     * }
+     * ```
+     *
+     * 예4) 30일 주기
+     * `interval: '30d'`
+     *
+     * 예5) 6개월 주기
+     * `interval: '6m'`
+     *
+     * 예6) 1년 주기
+     * `interval: '1y'`
+     */
+    offerPeriod?: OfferPeriod | undefined;
+    /**
+     * **상품 유형**
+     */
+    productType?: ProductType | undefined;
+    /**
+     * **상점 정보**
+     *
+     * - KSNET 카카오페이의 경우 필수 입력
+     * - 나이스페이먼츠의 경우 매출 전표에 표기 할 용도로 선택 입력
+     * - KG이니시스 일본결제의 경우 JPPG(gmoPayment) 결제의 상점정보로 사용되거나 편의점 결제 시 영수증 표시 정보로 사용됨.
+     */
+    storeDetails?: StoreDetails | undefined;
+    bypass?: LoadPaymentUIBypass | undefined;
+    /**
+     * **국가**
+     *
+     * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) 코드입니다.
+     */
+    country?: Country | undefined;
+    /**
+     * 배송지 주소
+     */
+    shippingAddress?: Address | undefined;
+    /**
+     * 프로모션 그룹 ID
+     */
+    promotionGroupId?: string | undefined;
+    /**
+     * 프로모션 ID 목록
+     */
+    promotionIds?: string[] | undefined;
+};

package/dist/v2/request/PaymentRequest.d.ts

@@ -0,0 +1,3 @@
+import type { PaymentRequestBase } from './PaymentRequestBase.js';
+import type { PaymentRequestUnion } from './PaymentRequestUnion.js';
+export type PaymentRequest = PaymentRequestBase & PaymentRequestUnion;

package/dist/v2/request/PaymentRequestBase.d.ts

@@ -0,0 +1,253 @@
+import type { StoreId } from '../entity/StoreId.js';
+import type { PaymentOrderName } from '../entity/PaymentOrderName.js';
+import type { PaymentTotalAmount } from '../entity/PaymentTotalAmount.js';
+import type { PaymentCurrency } from '../entity/PaymentCurrency.js';
+import { PaymentPayMethod } from '../entity/PaymentPayMethod.js';
+import type { ChannelKey } from '../entity/ChannelKey.js';
+import type { ChannelGroupId } from '../entity/ChannelGroupId.js';
+import type { TaxFreeAmount } from '../entity/TaxFreeAmount.js';
+import type { VatAmount } from '../entity/VatAmount.js';
+import type { Customer } from '../entity/Customer.js';
+import type { WindowTypes } from '../entity/WindowTypes.js';
+import type { RedirectUrl } from '../entity/RedirectUrl.js';
+import type { Product } from '../entity/Product.js';
+import { Locale } from '../entity/Locale.js';
+import type { PaymentBypass } from '../entity/bypass/PaymentBypass.js';
+import { Country } from '../entity/Country.js';
+import { ProductType } from '../entity/ProductType.js';
+import type { OfferPeriod } from '../entity/OfferPeriod.js';
+import type { StoreDetails } from '../entity/StoreDetails.js';
+import type { Address } from '../entity/Address.js';
+import type { Popup } from '../entity/Popup.js';
+import type { Iframe } from '../entity/Iframe.js';
+export type PaymentRequestBase = {
+    /**
+     * **상점 아이디**
+     *
+     * 포트원 계정에 생성된 상점을 식별하는 고유한 값으로 [관리자 콘솔 > 연동 정보](https://admin.portone.io/integration-v2/manage/channel) 우측 상단에서 확인할 수 있습니다.
+     */
+    storeId: StoreId;
+    /**
+     * **결제 ID**
+     *
+     * 고객사에서 임의로 ID를 정합니다.
+     *
+     * 이미 결제 완료된 `paymentId`로 결제를 요청하는 경우 실패합니다.
+     */
+    paymentId: string;
+    /**
+     * **주문명**
+     */
+    orderName: PaymentOrderName;
+    /**
+     * **결제 금액**
+     *
+     * 결제 금액을 정수로 나타냅니다.
+     *
+     * 해외 통화의 경우 통화의 최소 단위(minor unit)를 기준으로 합니다. 예를 들어, USD의 최소 단위는 센트(0.01 USD)이므로, 6 USD의 경우 100배하여 600으로 입력합니다.
+     *
+     * 최소 단위는 [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)에 표준화된 것을 기준으로 합니다.
+     *
+     * - KRW: 1배
+     * - USD: 100배
+     * - JPY: 1배
+     */
+    totalAmount: PaymentTotalAmount;
+    /**
+     * **결제 통화**
+     *
+     * 원화 결제 시 `KRW`입니다.
+     */
+    currency: PaymentCurrency;
+    /**
+     * **결제수단 구분코드**
+     *
+     * PG사별 지원되는 결제수단이 모두 상이합니다.
+     *
+     * [각 PG사별 결제 연동 가이드](https://developers.portone.io/opi/ko/integration/pg/v2/readme?v=v2)를 참고하세요
+     */
+    payMethod: PaymentPayMethod;
+    /**
+     * **채널 키**
+     *
+     * 포트원에 등록된 결제 채널 중 하나를 지정합니다.
+     *
+     * [관리자 콘솔 > 연동 정보](https://admin.portone.io/integration-v2/manage/channel)에서 채널 연동 후 채널 키를 확인할 수 있습니다.
+     *
+     * 채널 키와 채널 그룹 ID 중 하나를 지정해야 합니다.
+     */
+    channelKey?: ChannelKey | undefined;
+    /**
+     * **채널 그룹 ID**
+     *
+     * 채널 그룹 ID를 지정하여 결제창을 호출하면, 채널 그룹 내 설정된 비율에 따라 확률적으로 하나의 채널이 선택됩니다. [관리자 콘솔 > 연동 관리 > 스마트 라우팅](https://admin.portone.io/integration-v2/smart-routing)에서 설정합니다.
+     *
+     * 채널 키와 채널 그룹 ID 중 하나를 지정해야 합니다.
+     */
+    channelGroupId?: ChannelGroupId | undefined;
+    /**
+     * **면세 금액**
+     *
+     * 미입력 시 0으로 취급됩니다.
+     */
+    taxFreeAmount?: TaxFreeAmount | undefined;
+    /**
+     * **부가세 금액**
+     *
+     * 미입력 시 과세 금액의 1/11로 자동 계산됩니다.
+     */
+    vatAmount?: VatAmount | undefined;
+    customer?: Customer | undefined;
+    /**
+     * **환경 별 제공되는 결제/본인인증 창 유형**
+     *
+     * - PG사에 따라 가능한 창 유형이 다릅니다.
+     * - 전달되지 않았을 때 결정되는 기본 창이 다릅니다.
+     * - 미입력 시, 해당 PG사의 기본 창 방식을 따릅니다.
+     */
+    windowType?: WindowTypes | undefined;
+    /**
+     * **리디렉션 방식에서 결제 완료 후 이동할 URL**
+     *
+     * 결제사 페이지로 이동하여 진행하는 리디렉션 방식의 경우 필수로 설정해야 합니다. 대부분의 모바일 환경이 리디렉션 방식에 해당됩니다.
+     */
+    redirectUrl?: RedirectUrl | undefined;
+    /**
+     * **웹훅 수신 URL**
+     *
+     * 포트원 관리자 콘솔에 설정한 웹훅 URL 대신 사용할 웹훅 URL을 결제시마다 설정할 수 있습니다.
+     *
+     * 올바른 HTTP(S) URL이어야 합니다.
+     */
+    noticeUrls?: string[] | undefined;
+    /**
+     * **결제 승인 여부 확인 URL**
+     *
+     * 컨펌 프로세스 웹훅을 수신할 URL입니다.
+     *
+     * 올바른 HTTP(S) URL이어야 합니다.
+     *
+     * 별도 요청이 필요합니다. (<tech.support@portone.io>)
+     */
+    confirmUrl?: string | undefined;
+    /**
+     * **모바일 결제 후 고객사 앱으로 복귀를 위한 URL scheme**
+     *
+     * - WebView 환경 결제시 필수설정 항목 입니다.
+     * - ISP/앱카드 앱에서 결제정보인증 후 기존 앱으로 복귀할 때 사용합니다.
+     */
+    appScheme?: string | undefined;
+    /**
+     * **에스크로 결제 여부**
+     *
+     * 미입력 시 기본값: `false`
+     *
+     * - 에스크로 설정은 PG사와 협의 이후 진행되어야 합니다.
+     */
+    isEscrow?: boolean | undefined;
+    /**
+     * **구매 상품 정보**
+     */
+    products?: Product[] | undefined;
+    /**
+     * **문화비 지출 여부**
+     *
+     * 도서, 공연, 박물관 등 문화비 지출 여부
+     */
+    isCulturalExpense?: boolean | undefined;
+    /**
+     * **UI 언어**
+     *
+     * KG이니시스, 스마트로, KSNET, 웰컴페이먼츠 (PC), 한국결제네트웍스, 엑심베이에서 설정 가능하며, PG마다 지원하는 언어 목록은 차이가 있습니다.
+     */
+    locale?: Locale | undefined;
+    /**
+     * **결제 정보에 포함할 고객사 커스텀 JSON 데이터**
+     */
+    customData?: Record<string, any> | undefined;
+    /**
+     * **PG사 결제창 호출 시 PG사로 그대로 bypass할 값들의 모음**
+     */
+    bypass?: PaymentBypass | undefined;
+    /**
+     * **국가**
+     *
+     * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) 코드입니다.
+     */
+    country?: Country | undefined;
+    /**
+     * **상품 유형**
+     */
+    productType?: ProductType | undefined;
+    /**
+     * **서비스 제공 기간**
+     *
+     * range와 interval 중 하나를 입력해주세요.
+     *
+     * - range: 제공 기간 범위
+     * - interval: 제공 기간 주기
+     *
+     * 예1) 2023년 1월 1일 00시 00분 00초(KST) ~
+     *
+     * ```js
+     * range: {
+     *  from: '2023-01-01T00:00:00+09:00'
+     * }
+     * ```
+     *
+     * 예2) ~ 2023년 1월 1일 00시 00분 00초(KST)
+     *
+     * ```js
+     * range: {
+     *  to: '2023-01-01T00:00:00+09:00'
+     * }
+     * ```
+     *
+     * 예3) 2023년 1월 1일 00시 00분 00초(KST) ~ 2023년 12월 31일 23시 59분 59초(KST)
+     *
+     * ```js
+     * range: {
+     *  from: '2023-12-31T23:59:59+09:00'
+     *  to: '2023-01-01T00:00:00+09:00'
+     * }
+     * ```
+     *
+     * 예4) 30일 주기
+     * `interval: '30d'`
+     *
+     * 예5) 6개월 주기
+     * `interval: '6m'`
+     *
+     * 예6) 1년 주기
+     * `interval: '1y'`
+     */
+    offerPeriod?: OfferPeriod | undefined;
+    /**
+     * **상점 정보**
+     *
+     * - KSNET 카카오페이의 경우 필수 입력
+     * - 나이스페이먼츠의 경우 매출 전표에 표기 할 용도로 선택 입력
+     * - KG이니시스 일본결제의 경우 JPPG(gmoPayment) 결제의 상점정보로 사용되거나 편의점 결제 시 영수증 표시 정보로 사용됨.
+     */
+    storeDetails?: StoreDetails | undefined;
+    /**
+     * 배송지 주소 (토스 브랜드페이의 FDS를 위해 사용됨)
+     */
+    shippingAddress?: Address | undefined;
+    /**
+     * **프로모션 아이디**
+     *
+     * 포트원의 프로모션 기능 이용시 지정합니다.
+     */
+    promotionId?: string | undefined;
+    /**
+     * **팝업 관련 필드**
+     *
+     * UI가 팝업 창으로 열릴 때 적용되는 속성입니다.
+     */
+    popup?: Popup | undefined;
+    /**
+     * **결제창이 iframe 방식일 경우 결제창에 적용할 속성**
+     */
+    iframe?: Iframe | undefined;
+};

package/dist/v2/request/PaymentRequestUnion.d.ts

@@ -0,0 +1,35 @@
+import type { PaymentRequestUnionCard } from './PaymentRequestUnionCard.js';
+import type { PaymentRequestUnionVirtualAccount } from './PaymentRequestUnionVirtualAccount.js';
+import type { PaymentRequestUnionTransfer } from './PaymentRequestUnionTransfer.js';
+import type { PaymentRequestUnionMobile } from './PaymentRequestUnionMobile.js';
+import type { PaymentRequestUnionGiftCertificate } from './PaymentRequestUnionGiftCertificate.js';
+import type { PaymentRequestUnionEasyPay } from './PaymentRequestUnionEasyPay.js';
+import type { PaymentRequestUnionPaypal } from './PaymentRequestUnionPaypal.js';
+import type { PaymentRequestUnionAlipay } from './PaymentRequestUnionAlipay.js';
+import type { PaymentRequestUnionConvenienceStore } from './PaymentRequestUnionConvenienceStore.js';
+export type PaymentRequestUnion = {
+    /**
+     * **카드 결제 설정**
+     */
+    card?: PaymentRequestUnionCard | undefined;
+    /**
+     * **가상계좌 결제 설정**
+     */
+    virtualAccount?: PaymentRequestUnionVirtualAccount | undefined;
+    /**
+     * **계좌이체 결제 설정**
+     */
+    transfer?: PaymentRequestUnionTransfer | undefined;
+    /**
+     * **휴대전화 결제 설정**
+     */
+    mobile?: PaymentRequestUnionMobile | undefined;
+    /**
+     * **상품권 결제 설정**
+     */
+    giftCertificate?: PaymentRequestUnionGiftCertificate | undefined;
+    easyPay?: PaymentRequestUnionEasyPay | undefined;
+    paypal?: PaymentRequestUnionPaypal | undefined;
+    alipay?: PaymentRequestUnionAlipay | undefined;
+    convenienceStore?: PaymentRequestUnionConvenienceStore | undefined;
+};

package/dist/v2/request/PaymentRequestUnionAlipay.d.ts

@@ -0,0 +1 @@
+export type PaymentRequestUnionAlipay = Record<string, never>;

package/dist/v2/request/PaymentRequestUnionCard.d.ts

@@ -0,0 +1,79 @@
+import { CardCompany } from '../entity/CardCompany.js';
+import type { Installment } from '../entity/Installment.js';
+/**
+ * **카드 결제 설정**
+ */
+export type PaymentRequestUnionCard = {
+    /**
+     * **카드사 다이렉트 호출 시 필요한 카드사 식별 값**
+     */
+    cardCompany?: CardCompany | undefined;
+    /**
+     * **일부 카드사만 노출 설정**
+     *
+     * 일부 카드사만을 선택 가능하게 하고 싶은 경우 사용하는 옵션입니다.
+     */
+    availableCards?: CardCompany[] | undefined;
+    /**
+     * **상점분담 무이자 활성화 여부**
+     */
+    useFreeInterestFromMall?: boolean | undefined;
+    /**
+     * **할부 설정**
+     *
+     * 신용카드 결제 시 할부 관련 설정을 제어합니다.
+     *
+     * ## 사용 예시
+     *
+     * ### 3개월 고정 할부
+     *
+     * ```typescript
+     * installment: {
+     *   monthOption: {
+     *     fixedMonth: 3
+     *   }
+     * }
+     * ```
+     *
+     * ### 2~6개월 할부 선택
+     *
+     * ```typescript
+     * installment: {
+     *   monthOption: {
+     *     availableMonthList: [2, 3, 4, 5, 6]
+     *   }
+     * }
+     * ```
+     *
+     * ### 무이자 할부 설정 (삼성카드 2,3개월)
+     *
+     * ```typescript
+     * installment: {
+     *   freeInstallmentPlans: [{
+     *     cardCompany: 'CARD_COMPANY_SAMSUNG',
+     *     months: [2, 3]
+     *   }]
+     * }
+     * ```
+     *
+     * ## 주의사항
+     *
+     * - 일반적으로 5만원 이상부터 할부가 가능합니다
+     * - 1개월 할부는 일시불과 동일하게 처리됩니다
+     * - 카드 다이렉트 호출 시 고정 할부만 가능한 PG사가 있습니다
+     * - 무이자 할부는 가맹점이 수수료를 부담하는 방식입니다
+     */
+    installment?: Installment | undefined;
+    /**
+     * **카드 포인트 사용 설정**
+     */
+    useCardPoint?: boolean | undefined;
+    /**
+     * **앱 카드만 허용할지 여부**
+     */
+    useAppCardOnly?: boolean | undefined;
+    /**
+     * 할부 사용 가능 여부
+     */
+    useInstallment?: boolean | undefined;
+};

package/dist/v2/request/PaymentRequestUnionConvenienceStore.d.ts

@@ -0,0 +1,7 @@
+import type { PaymentRequestUnionConvenienceStorePaymentDeadline } from './PaymentRequestUnionConvenienceStorePaymentDeadline.js';
+export type PaymentRequestUnionConvenienceStore = {
+    /**
+     * **편의점결제 지불기한**
+     */
+    paymentDeadline?: PaymentRequestUnionConvenienceStorePaymentDeadline | undefined;
+};

package/dist/v2/request/PaymentRequestUnionConvenienceStorePaymentDeadline.d.ts

@@ -0,0 +1,16 @@
+import type { OneOfType } from '../../utils.js';
+/**
+ * **편의점결제 지불기한**
+ */
+export type PaymentRequestUnionConvenienceStorePaymentDeadline = OneOfType<{
+    /**
+     * **유효 시간 (단위: 시간)**
+     */
+    validHours: number;
+    /**
+     * **만료일시**
+     *
+     * RFC 3339 형식입니다.
+     */
+    dueDate: string;
+}>;