@portone/browser-sdk/dist/v2/entity/Installment.d.ts

PortOne SDK for browser

import type { FreeInstallmentPlan } from './FreeInstallmentPlan.js';
import type { InstallmentMonthOption } from './InstallmentMonthOption.js';
/**
 * **할부 설정**
 *
 * 신용카드 결제 시 할부 관련 설정을 제어합니다.
 *
 * ## 사용 예시
 *
 * ### 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사가 있습니다
 * - 무이자 할부는 가맹점이 수수료를 부담하는 방식입니다
 */
export type Installment = {
    /**
     * **무이자 할부 설정**
     */
    freeInstallmentPlans?: FreeInstallmentPlan[] | undefined;
    /**
     * **할부 개월 수 설정**
     */
    monthOption?: InstallmentMonthOption | undefined;
};