개발자센터

requestPayment 요청 형식

requestPayment 호출 시 사용되는 파라미터의 형식을 확인할 수 있습니다.

requestPayment 요청 데이터 정의

request: PaymentRequest
storeId: string

상점 아이디

포트원 계정에 생성된 상점을 식별하는 고유한 값으로 관리자 콘솔 > 연동 정보 우측 상단에서 확인할 수 있습니다.

paymentId: string

결제 ID

고객사에서 임의로 ID를 정합니다.

이미 결제 완료된 paymentId로 결제를 요청하는 경우 실패합니다.

orderName: string

주문명

나이스페이먼츠나이스페이먼츠

나이스페이먼츠의 경우 최대 40바이트까지 입력할 수 있으며, 사용 가능한 특수문자는 아래와 같습니다.

  • 사용 가능: _
  • 사용 불가: % & | $ - + = [ ]
  • 사용 가능하나 권장하지 않음: ( )
NHN KCPNHN KCP

NHN KCP에서는 최대 100바이트까지 입력할 수 있습니다.

스마트로스마트로

스마트로에서는 최대 40바이트까지 입력할 수 있습니다.

한국결제네트웍스한국결제네트웍스

한국결제네트웍스에서는 최대 256바이트까지 입력할 수 있습니다.

KG이니시스KG이니시스

KG이니시스에서는 최대 40바이트까지 입력할 수 있으며, 40바이트 초과시 37바이트에서 잘리고 "..."가 추가됩니다.

웰컴페이먼츠웰컴페이먼츠

웰컴페이먼츠에서는 최대 40바이트까지 입력할 수 있으며, 40바이트 초과시 37바이트에서 잘리고 "..."가 추가됩니다.

네이버페이네이버페이

네이버페이에서는 bypass.naverpay.productItems의 개수에 따라 주문명 뒤에 외 X개가 붙으므로, 주문명을 bypass.naverpay.productItems[0].name과 똑같이 입력하는 것이 권장됩니다.

하이픈하이픈

하이픈에서는 최대 1000바이트까지 입력할 수 있습니다.

totalAmount: number

결제 금액

결제 금액을 정수로 나타냅니다.

해외 통화의 경우 통화의 최소 단위(minor unit)를 기준으로 합니다. 예를 들어, USD의 최소 단위는 센트(0.01 USD)이므로, 6 USD의 경우 100배하여 600으로 입력합니다.

최소 단위는 ISO 4217에 표준화된 것을 기준으로 합니다.

  • KRW: 1배
  • USD: 100배
  • JPY: 1배
currency: Currency

결제 통화

원화 결제 시 KRW입니다.

payMethod: PaymentPayMethod

결제수단 구분코드

PG사별 지원되는 결제수단이 모두 상이합니다.

각 PG사별 결제 연동 가이드를 참고하세요

"CARD"

카드

"VIRTUAL_ACCOUNT"

가상계좌

"TRANSFER"

계좌이체

"MOBILE"

휴대폰 소액결제

"GIFT_CERTIFICATE"

상품권

"EASY_PAY"

간편 결제

"PAYPAL"

페이팔(SPB)

"ALIPAY"

알리페이

"CONVENIENCE_STORE"

편의점 결제

channelKey?: string

채널 키

포트원에 등록된 결제 채널 중 하나를 지정합니다.

관리자 콘솔 > 연동 정보에서 채널 연동 후 채널 키를 확인할 수 있습니다.

채널 키와 채널 그룹 ID 중 하나를 지정해야 합니다.

channelGroupId?: string

채널 그룹 ID

채널 그룹 ID를 지정하여 결제창을 호출하면, 채널 그룹 내 설정된 비율에 따라 확률적으로 하나의 채널이 선택됩니다. 관리자 콘솔 > 연동 관리 > 스마트 라우팅에서 설정합니다.

채널 키와 채널 그룹 ID 중 하나를 지정해야 합니다.

taxFreeAmount?: number

면세 금액

미입력 시 0으로 취급됩니다.

vatAmount?: number

부가세 금액

미입력 시 과세 금액의 1/11로 자동 계산됩니다.

customer?: Customer
customerId?: string

구매자 ID

스마트로, KG이니시스 SBPS 일본결제에서 사용합니다.

토스페이먼츠와 스마트로의 빌링키 발급에서 사용합니다.

스마트로스마트로

스마트로에서는 20자 이내여야 합니다.

스마트로 간편결제에서 필수입니다. PINPAY 결제의 경우 고객별로 고유한 값이 필요합니다.

스마트로 빌링키 발급에서 필수입니다. 로마자, 숫자 사용 가능하며, 특수문자는 사용 불가능합니다.

KG이니시스KG이니시스

KG이니시스 SBPS 일본결제에서 필수입니다. 이 경우 30자 이내여야 합니다.

fullName?: string

구매자 전체 이름

fullName이 사용되는 PG에서 fullName이 없고 firstName과 lastName이 있는 경우 ${lastName} ${firstName}이 대신 사용됩니다.

나이스페이먼츠나이스페이먼츠

NICE페이먼츠에 전달됩니다. 최대 30바이트입니다. 알리페이 결제의 경우 필수입니다.

KG이니시스KG이니시스
웰컴페이먼츠웰컴페이먼츠

KG이니시스, 웰컴페이먼츠에서는 필수입니다. 최대 30바이트입니다.

NHN KCPNHN KCP

NHN KCP에 전달됩니다. 최대 30자입니다. 모바일에서 카드사 UI를 직접 호출할 경우 필수입니다.

스마트로스마트로

스마트로에서는 최대 30자입니다.

KSNETKSNET

KSNET에서는 필수입니다. 최대 50바이트입니다.

한국결제네트웍스한국결제네트웍스

한국결제네트웍스에 전달됩니다. 최대 100자입니다.

하이픈하이픈

하이픈에서는 필수입니다.

firstName?: string

구매자 성이 아닌 이름

페이팔에서 구매자 페이팔 계정 소유자의 이름을 지정합니다.

lastName?: string

구매자 성

페이팔에서 구매자 페이팔 계정 소유자의 성을 지정합니다.

phoneNumber?: string

구매자 휴대전화 번호

숫자만 입력합니다.

나이스페이먼츠나이스페이먼츠

NICE페이먼츠에 전달됩니다.

KG이니시스KG이니시스
웰컴페이먼츠웰컴페이먼츠

KG이니시스, 웰컴페이먼츠에서는 필수입니다.

NHN KCPNHN KCP

NHN KCP에 전달됩니다.

스마트로스마트로

스마트로에 전달됩니다.

email?: string

구매자 이메일 주소

올바른 형식의 이메일 주소여야 합니다.

나이스페이먼츠나이스페이먼츠

NICE페이먼츠에 전달됩니다.

KG이니시스KG이니시스
웰컴페이먼츠웰컴페이먼츠

KG이니시스, 웰컴페이먼츠에서는 필수입니다.

NHN KCPNHN KCP

NHN KCP에 전달됩니다. PC에서 카드사 UI를 직접 호출할 경우 필수입니다.

스마트로스마트로

스마트로에 전달됩니다. 최대 60자입니다.

address?: Address

구매자 주소

country?: Country

국가

ISO 3166-1 alpha-2 코드입니다.

addressLine1: string

주소 첫째 줄

addressLine2: string

주소 둘째 줄

city?: string

도시

province?: string

주, 도, 시

zipcode?: string

구매자 우편번호

gender?: Gender

구매자 성별

정보성 필드입니다.

"GENDER_MALE"

남성

"GENDER_FEMALE"

여성

"GENDER_OTHER"

기타

birthYear?: string

구매자 출생년도

"1990"과 같은 형식입니다.

KG이니시스 통합인증에서 flgFixedUser가 Y인 경우 필수입니다.

birthMonth?: string

구매자 출생월

"12", "07"과 같은 형식입니다.

KG이니시스 통합인증에서 flgFixedUser가 Y인 경우 필수입니다.

birthDay?: string

구매자 출생일

"25", "08"과 같은 형식입니다.

KG이니시스 통합인증에서 flgFixedUser가 Y인 경우 필수입니다.

firstNameKana?: string

구매자 일본어 성이 아닌 이름 후리가나(읽는 법)

KG이니시스 JPPG 일본 편의점 결제에서 필수입니다. 최대 20바이트입니다.

lastNameKana?: string

구매자 일본어 성 후리가나(읽는 법)

KG이니시스 JPPG 일본 편의점 결제에서 필수입니다. 최대 20바이트입니다.

windowType?: WindowTypes

환경 별 제공되는 결제/본인인증 창 유형

  • PG사에 따라 가능한 창 유형이 다릅니다.
  • 전달되지 않았을 때 결정되는 기본 창이 다릅니다.
  • 미입력 시, 해당 PG사의 기본 창 방식을 따릅니다.
pc?: WindowType

PC에서의 결제창 유형 IFRAME, REDIRECTION, POPUP 중 하나를 입력해주세요.

"IFRAME"
"POPUP"
"REDIRECTION"
"UI"
mobile?: WindowType

모바일에서의 결제창 유형 IFRAME, REDIRECTION, POPUP 중 하나를 입력해주세요.

"IFRAME"
"POPUP"
"REDIRECTION"
"UI"
redirectUrl?: string

리디렉션 방식에서 결제 완료 후 이동할 URL

결제사 페이지로 이동하여 진행하는 리디렉션 방식의 경우 필수로 설정해야 합니다. 대부분의 모바일 환경이 리디렉션 방식에 해당됩니다.

noticeUrls?: Array<string>

웹훅 수신 URL

포트원 관리자 콘솔에 설정한 웹훅 URL 대신 사용할 웹훅 URL을 결제시마다 설정할 수 있습니다.

올바른 HTTP(S) URL이어야 합니다.

confirmUrl?: string

결제 승인 여부 확인 URL

컨펌 프로세스 웹훅을 수신할 URL입니다.

올바른 HTTP(S) URL이어야 합니다.

별도 요청이 필요합니다. (tech.support@portone.io)

appScheme?: string

모바일 결제 후 고객사 앱으로 복귀를 위한 URL scheme

  • WebView 환경 결제시 필수설정 항목 입니다.
  • ISP/앱카드 앱에서 결제정보인증 후 기존 앱으로 복귀할 때 사용합니다.
isEscrow?: boolean

에스크로 결제 여부

미입력 시 기본값: false

  • 에스크로 설정은 PG사와 협의 이후 진행되어야 합니다.
products?: Array<Product>

구매 상품 정보

엑심베이엑심베이

엑심베이에서 알리페이, 위챗페이 등 해외 간편결제 사용 시 필수로 입력해야 합니다.

id: string

상품 ID

name: string

상품명

code?: string

상품 코드

amount: number

상품 단위 가격

결제를 원하는 통화(currency)별 scale factor(소수점 몇번째 자리까지 유효한지)를 고려한 number 형식만 허용됩니다.

  • 1000 만큼 원화(KRW) 결제를 하는 경우, scale factor가 0이기 때문에 1000 * (10의 0승) = 1000을 전달해야 합니다.
  • 1.50 만큼 달러(USD) 결제를 하는 경우, scale factor가 2이기 때문에 1.50 * (10의 2승) = 150을 전달해야 합니다.

이렇게 전달 된 값은 실제로 PG사에 결제를 요청할때 currency에 따라 올바른 값으로 변환되기 때문에 반드시 currency값을 필수로 입력해야 합니다.

quantity: number

상품 수량

tag?: string

상품 태그

link?: string

상품 판매 URL

엑심베이엑심베이

엑심베이에서 products 파라미터를 사용하는 경우 필수로 입력해야 합니다.

isCulturalExpense?: boolean

문화비 지출 여부

도서, 공연, 박물관 등 문화비 지출 여부

locale?: Locale

UI 언어

KG이니시스, 스마트로, KSNET, 웰컴페이먼츠 (PC), 한국결제네트웍스, 엑심베이에서 설정 가능하며, PG마다 지원하는 언어 목록은 차이가 있습니다.

"KO_KR"

한국어

  • KG이니시스
  • 스마트로
  • KSNET
  • 웰컴페이먼츠 (PC)
  • 한국결제네트웍스
  • 엑심베이
"EN_US"

영어

  • KG이니시스
  • 스마트로
  • KSNET
  • 웰컴페이먼츠 (PC)
  • 한국결제네트웍스
  • 엑심베이
"ZH_CN"

중국어 (중국 본토)

  • KG이니시스 (PC)
  • 웰컴페이먼츠 (PC)
  • 엑심베이
"ZH_TW"

중국어 (대만)

  • 엑심베이
"JA_JP"

일본어

  • 엑심베이
"RU_RU"

러시아어

  • 엑심베이
"TH_TH"

타이어

  • 엑심베이
"VI_VN"

베트남어

  • 엑심베이
customData?: json

결제 정보에 포함할 고객사 커스텀 JSON 데이터

country?: Country

국가

ISO 3166-1 alpha-2 코드입니다.

productType?: ProductType

상품 유형

"PRODUCT_TYPE_REAL"

실물

"PRODUCT_TYPE_DIGITAL"

디지털

offerPeriod?: OfferPeriod

서비스 제공 기간

range와 interval 중 하나를 입력해주세요.

  • range: 제공 기간 범위
  • interval: 제공 기간 주기

예1) 2023년 1월 1일 00시 00분 00초(KST) ~

range: {
 from: '2023-01-01T00:00:00+09:00'
}

예2) ~ 2023년 1월 1일 00시 00분 00초(KST)

range: {
 to: '2023-01-01T00:00:00+09:00'
}

예3) 2023년 1월 1일 00시 00분 00초(KST) ~ 2023년 12월 31일 23시 59분 59초(KST)

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'

range?: OfferPeriodRange

기간 범위

OfferPeriodRangeFrom

시작 시점만 있는 기간 범위

from: string

시작 시점

OfferPeriodRangeTo

종료 지점만 있는 기간 범위

to: string

종료 지점

OfferPeriodRangeFromTo

시작 지점과 종료 지점이 모두 있는 기간 범위

from: string

시작 시점

to: string

종료 지점

interval?: string

제공 주기

제공 주기 (${number}d | ${number}m | ${number}y 형태로 입력할 수 있습니다.)

storeDetails?: StoreDetails

상점 정보

  • KSNET 카카오페이의 경우 필수 입력
  • 나이스페이먼츠의 경우 매출 전표에 표기 할 용도로 선택 입력
  • KG이니시스 일본결제의 경우 JPPG(gmoPayment) 결제의 상점정보로 사용되거나 편의점 결제 시 영수증 표시 정보로 사용됨.
ceoFullName?: string

대표자 이름

KSNETKSNET

KSNET에서 카카오페이 UI를 직접 열 때 필수입니다.

phoneNumber?: string

전화번호

나이스페이먼츠나이스페이먼츠

나이스페이먼츠에 전달됩니다. 매출전표에 판매사업자 전화번호로 기재됩니다.

KSNETKSNET

KSNET에서 카카오페이 UI를 직접 열 때 필수입니다.

address?: string

주소

KSNETKSNET

KSNET에서 카카오페이 UI를 직접 열 때 필수입니다.

zipcode?: string

우편번호

email?: string

이메일

businessName?: string

사업자명 (상호)

나이스페이먼츠나이스페이먼츠

나이스페이먼츠에 전달됩니다. 매출전표에 판매사업자 상호로 기재됩니다.

KG이니시스KG이니시스

KG이니시스 모바일 결제에서 가맹점 이름으로 전달됩니다.

웰컴페이먼츠웰컴페이먼츠

웰컴페이먼츠 모바일 결제에서 가맹점 이름으로 전달됩니다.

하이픈하이픈

하이픈에 상점 이름으로 전달됩니다. 지정하지 않으면 기본값으로 포트원 콘솔의 상점 이름이 사용됩니다.

businessRegistrationNumber?: string

사업자 등록 번호

나이스페이먼츠나이스페이먼츠

나이스페이먼츠에 전달됩니다. 매출전표에 판매사업자 사업자등록번호로 기재됩니다.

storeName?: string

상점명

storeNameShort?: string

상점명 약어

storeNameEn?: string

상점명 영문

storeNameKana?: string

상점명 후리카나 (일본어 읽는법 표기)

openingHours?: StoreDetailsOpeningHours

상점 영업시간 (HH:mm)

open?: string

영업 시작 시간

close?: string

영업 종료 시간

contactName?: string

상점 연락처 정보 이름

ex: 문의창구, 연락처, 지원창구

promotionId?: string

프로모션 아이디

포트원의 프로모션 기능 이용시 지정합니다.

popup?: Popup

팝업 관련 필드

UI가 팝업 창으로 열릴 때 적용되는 속성입니다.

center?: boolean

팝업 정중앙 표시 true로 설정하면 팝업이 브라우저 화면의 정중앙에 표시됩니다. 결제사 및 환경에 따라 적용되지 않을 수 있습니다.

iframe?: Iframe

결제창이 iframe 방식일 경우 결제창에 적용할 속성

dim?: boolean

false로 설정하면 결제창 배경이 투명해집니다.

bypass?: PaymentBypass

PG사 결제창 호출 시 PG사로 그대로 bypass할 값들의 모음

tosspayments?: TosspaymentsPaymentBypass

토스페이먼츠 bypass 파라미터

discountCode?: string

토스페이먼츠 <-> 고객사 계약에 따라 프로모션 적용이 가능한 코드

useInternationalCardOnly?: boolean

해외 카드로만 결제가 가능하도록 할 지 여부

nice_v2?: NiceV2PaymentBypass

(신)나이스페이먼츠 bypass 파라미터

LogoImage?: string

결제창 로고 이미지 URL

NPDisableScroll?: NiceV2DisableScroll

결제창 스크롤 미사용 여부 (PC Only, Y: 미사용 / N(default): 사용)

"Y"
"N"
SkinType?: NiceV2SkinType

결제창 스킨 색상 설정

"red", "green", "purple", "gray", "dark" 중 하나의 값으로 입력해주세요.

"red"
"green"
"purple"
"gray"
"dark"
UserCI?: string

문화 상품권 결제시 결제 고객 사용자 인증 CI 정보. 아이디/비밀번호 외 추가로 CI 인증이 필요한 경우 사용. 사용 전 영업 담당자와 사전 협의 필수

MallUserID?: string

상점 사용자 아이디. 문화 상품권 결제시 경우 필수 입력

DirectCouponYN?: NiceV2DirectCoupon

신용카드 쿠폰 자동 적용 여부 (Y: 사전 등록된 선 할인 쿠폰을 자동 적용 / N: 쿠폰 미적용(기본값))

할부 거래 요청 시 할인 적용 후 승인 금액이 할부 가능 금액 (50,000) 미만인 경우 인증 실패 처리

"Y"

사전 등록된 선 할인 쿠폰을 자동 적용

"N"

쿠폰 미적용(기본값)

DirectShowOpt?: NiceV2DirectShow

다이렉트 호출 결제 수단 (BANK: 계좌이체/CELLPHONE: 휴대폰 소액결제)

"BANK"

계좌이체

"CELLPHONE"

휴대폰 소액결제

CardShowOpt?: string

카드사 별 호출 방식

형식) 카드코드:노출유형|카드코드:노출유형

예시) 08:3|02:3 → 롯데카드와 국민카드 선택시 앱 카드 직접 호출 방식으로 렌더링

  • 노출 유형: 1(안심클릭), 2(간편결제), 3(앱 카드 직접 호출)
  • 카드 코드: 02(국민), 04(삼성), 06(신한), 07(현대), 08(롯데), 12(NH), 15(우리)만 가능
PaycoClientId?: string

페이코 계정 자동 로그인 기능 사용하기 위해 페이코에서 고객사에 발급한 ClientId

PaycoAccessToken?: string

페이코 계정 자동 로그인 기능 사용을 위한 접속 토큰

SamPayMallType?: NiceV2SamPayMallType

삼성페이 고객사 유형 (01: 삼성페이 內 쇼핑 / 99: 기타 (기본값))

"99"

기타 (기본값)

"01"

삼성페이 內 쇼핑

paypal_v2?: PaypalV2PaymentBypass

Paypal bypass 파라미터

purchase_units?: Array<PaypalV2PurchaseUnit>

create order API 호출에 필요한 파라미터

shipping?: PaypalV2PurchaseUnitShipping

구매 상품 정보

address?: PaypalV2PurchaseUnitShippingAddress

수령지 정보

address_line_1: string

수령지 주소. 미 입력 시 입력된 주소로 override되지 않음

address_line_2?: string
admin_area_1?: string
admin_area_2: string

필수 입력. 미 입력 시 create order 실패

postal_code?: string
country_code: Country

국가 코드

payer?: PaypalV2Payer
tax_info?: PaypalV2PayerTaxInfo

구매자 정보

tax_id: string

구매자 세금 정보 (브라질 구매자의 경우 필수 입력)

tax_id_type: string
address?: PaypalV2PayerAddress
address_line_1?: string

구매자 주소지 정보

address_line_2?: string
admin_area_1?: string
admin_area_2?: string
postal_code?: string

우편번호

country_code: Country

국가 코드

payment_source?: PaypalV2PaymentSource
paypal?: PaypalV2PaymentSourcePaypal
experience_context?: PaypalV2PaymentSourcePaypalExperienceContext
brand_name?: string
shipping_preference?: PaypalV2PaymentSourcePaypalExperienceContextShippingPreference
"GET_FROM_FILE"
"NO_SHIPPING"
"SET_PROVIDED_ADDRESS"
landing_page?: PaypalV2PaymentSourcePaypalExperienceContextLandingPage
"LOGIN"
"GUEST_CHECKOUT"
"NO_PREFERENCE"
payment_method_preference?: PaypalV2PaymentSourcePaypalExperienceContextPaymentMethodPreference
"UNRESTRICTED"
"IMMEDIATE_PAYMENT_REQUIRED"
additional_data?: Array<PaypalV2AdditionalData>

STC 파라미터

key: string
value: string
inicis_v2?: InicisV2Bypass

KG이니시스 bypass 파라미터

KG이니시스는 PC 결제 모듈과 모바일 결제 모듈이 분리되어 있기 때문에 bypass 파라미터 또한 PC용과 모바일용이 분리되어 있습니다.

logo_url?: string

PC용 파라미터

결제창에 삽입할 메인 로고 url

결제창 중앙 상단에 표시됩니다. 이미지 권장 사이즈는 89*18 입니다.

logo_2nd?: string

PC용 파라미터

결제창에 삽입할 서브 로고 url

결제창 우측 상단에 표시됩니다. 이미지 권장 사이즈는 64*13 입니다.

parentemail?: string

PC용 파라미터

보호자 이메일 주소

14세 미만 고객의 경우 필수 입력입니다. "@", "." 외의 특수문자는 입력 불가합니다.

Ini_SSGPAY_MDN?: string

PC용 파라미터

SSGPAY 결제요청 시 PUSH 전송 휴대폰번호

- 없이 숫자만 허용합니다.

acceptmethod?: Array<string>

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이니시스 통합 코드 페이지에서 "결제요청 시 카드코드" 섹션을 참고하시기 바랍니다.

  • mallpoint(카드코드:카드코드)

    몰포인트 (별도 계약시 이용 가능)

    string 부분에는 카드코드:카드코드 와 같은 형식으로 입력합니다. (ex. mallpoint(11:34)) 카드사 코드는 KG이니시스 통합 코드 페이지에서 "결제요청 시 카드코드" 섹션을 참고하시기 바랍니다.

P_CARD_OPTION?: string

모바일용 파라미터

신용카드 우선선택 옵션

설정한 카드코드에 해당하는 카드가 선택된 채로 Display 됩니다. selcode=카드코드 형식으로 입력합니다. (ex. selcode=14)

P_MNAME?: string

모바일용 파라미터

가맹점 이름

P_RESERVED?: Array<string>

모바일용 파라미터

추가 옵션

아래 string 중 원하는 옵션들을 골라 array 형태로 입력합니다.

  • below1000=Y

    (카드결제 & 간편결제 시) 1000원 미만 결제 허용 옵션

  • noeasypay=Y

    (카드결제 시) 간편결제 미노출 옵션

  • global_visa3d=Y

    해외카드 노출 옵션

  • apprun_check=Y

    (android의 경우) custom url scheme 대신 intent schema(intent://) 호출

kcp_v2?: KcpV2Bypass

NHN KCP bypass 파라미터

skin_indx?: string
site_logo?: string
shop_user_id: string
kcp_pay_title?: string
complex_pnt_yn?: KcpV2ComplexPnt

포인트 결제의 경우 신용카드 + 포인트 결제인데, N으로 설정 시 포인트로만 결제가 이루어짐

"Y"
"N"
pt_memcorp_cd?: string
disp_tax_yn?: KcpV2DispTax

가상계좌, 계좌이체 시 현금영수증 노출 여부

"Y"
"N"
"R"
"E"
site_name?: string

결제창에 노출될 고객사 상호명

deli_term?: string

에스크로 배송 예상 소요일

smartro_v2?: SmartroV2PaymentBypass

스마트로 V2 bypass 파라미터

GoodsCnt?: number

결제 상품 품목 개수

SkinColor?: SmartroV2SkinColor

UI 스타일 (기본값: "RED")

"RED", "GREEN", "BLUE", "PURPLE" 중 하나의 값으로 입력해주세요.

"RED"
"GREEN"
"BLUE"
"PURPLE"
OpenType?: SmartroV2OpenType

해외 카드만 결제를 허용할지 여부(기본값: "KR")

"KR", "EN" 중 하나의 값으로 입력해주세요.

"KR"
"EN"
ksnet?: KsnetPaymentBypass

KSNET bypass 파라미터

sndQpayType?: KsnetSndQpayType

간편 결제 표시 구분

"0"

간편 결제 미표시

"1"

간편 결제 표시

easyPayDirect?: boolean

KSNET 간편결제 다이렉트 여부

welcome?: WelcomePaymentBypass

웰컴페이먼츠 bypass 파라미터

logo_url?: string

메인 로고 URL (크기: 89x19)

logo_2nd?: string

서브 로고 URL (크기: 64x13)

acceptmethod?: Array<string>

다양한 결제 옵션을 설정하기 위한 파라미터 배열입니다.

가능한 값들은 다음과 같습니다:

  • SKIN(#색상코드): 결제 창의 배경 색상 설정 (기본값: #c1272c)
    • 예시: SKIN(#fc6b2d)
  • below1000: 1,000원 미만 결제 허용 여부
  • onlyeasypaycode(간편결제코드들): 카드 결제창에 렌더링될 간편 결제 리스트 지정
    • 예시: onlyeasypaycode(kakaopay:lpay:payco)
    • 간편결제코드:
      • 카카오페이: kakaopay
      • 엘페이: lpay
      • 페이코: payco
      • 토스페이: tosspay
  • SLIMQUOTA(코드-개월:개월^코드-개월:개월): 부분 무이자 할부 옵션
    • 형식: SLIMQUOTA(카드코드-할부개월:부분무이자개월^...)
  • paypopup: 안심 클릭을 팝업 형태로 렌더링 할지 여부
  • hppdefaultcorp(통신사코드): 휴대폰 소액결제 시 기본 선택 통신사 지정
    • 예시: hppdefaultcorp(KTF)
    • 통신사코드:
      • SKT: SK 텔레콤
      • KTF: KT
      • LGT: LG 유플러스
      • MVNO: 알뜰폰 전체
      • CJH: 알뜰폰 CJ 헬로 모바일
      • KCT: 알뜰폰 티플러스
      • SKL: 알뜰폰 SK 세븐 모바일
  • hppnofix(Y|N): 휴대폰 소액결제창에 자동 입력되는 buyer_tel 값을 수정할 수 있는지 여부
    • Y: 수정 불가능
    • N: 수정 가능 (기본값)
  • va_ckprice: 가상계좌 발급 시, 주민번호 채번할 때 금액 체크 기능
P_CARD_OPTION?: string
  1. 신용카드 우선 선택 옵션
  • 예시: selcode=14
  • 해당 카드 코드에 해당하는 카드가 선택된 채로 표시
  • 간편결제는 불가능 (타 카드 선택 가능)
  1. 선택적 표시 옵션
  • 예시 1: onlycard=visa3d
  • 예시 2: selcode=14:onlycard=visa3d
  • 선택적 표시 가능 결제 방식:
    • 안심결제: visa3d
    • ISP: isp
    • 간편결제: easypay
P_ONLY_EASYPAYCODE?: string

카드 결제창에 렌더링될 간편 결제 리스트를 지정합니다.

예시: 카카오페이, 엘페이, 페이코만 렌더링 → KAKAOPAY:LPAY:PAYCO

  • 카카오페이: KAKAOPAY
  • 엘페이: LPAY
  • 페이코: PAYCO
  • 토스페이: TOSSPAY
P_RESERVED?: Array<string>

결제창 동작을 제어하기 위한 파라미터들을 설정하는 배열입니다.

가능한 값들은 다음과 같습니다:

  • below1000=Y: 1,000원 미만 결제 허용 여부
  • hpp_default_corp=통신사코드: 휴대폰 소액결제 시 기본 선택 통신사 지정
    • 예시: hpp_default_corp=KTF
    • 통신사코드:
      • SKT: SK 텔레콤
      • KTF: KT
      • LGT: LG 유플러스
      • MVNO: 알뜰폰 전체
      • CJH: 알뜰폰 CJ 헬로 모바일
      • KCT: 알뜰폰 티플러스
      • SKL: 알뜰폰 SK 세븐 모바일
  • hpp_nofix=Y|N: 휴대폰 소액결제창에서 자동 입력된 buyer_tel 수정 가능 여부
    • Y: 수정 불가능
    • N: 수정 가능 (기본값)
kpn?: KpnBypass

KPN bypass 파라미터

CardSelect?: Array<KpnCardSelect>
  • 해외카드 (VISA + MASTER + JCB) : GLOBAL
  • 11Pay (SKPay) : 11PAY
  • 구인증 : LEGACY_AUTH
  • 키인 : KEY_IN
"GLOBAL"

해외카드

"11PAY"

11Pay

"LEGACY_AUTH"

구인증

"KEY_IN"

키인

naverpay?: NaverpayPaymentBypass

네이버페이 bypass 파라미터

useCfmYmdt?: string

이용 완료일(YYYYMMDD)

productItems: Array<NaverpayProductItem>
categoryType: string

결제 상품 유형

categoryId: string

결제 상품 분류

uid: string

결제 상품 식별값

name: string

상품명

payReferrer?: NaverpayProductItemPayReferrer

결제 상품 유입경로

startDate?: string

시작일(YYYYMMDD)

endDate?: string

종료일(YYYYMMDD)

sellerId?: string

하위 판매자 식별키

count: number

결제 상품 개수

subMerchantInfo?: NaverpaySubMerchantInfo

하부 가맹점 정보. PG 업종 가맹점인 경우에만 필수 값

subMerchantName: string

하부 가맹점 명

subMerchantId: string

하부 가맹점 ID

subMerchantBusinessNo: string

하부 가맹점 사업자 번호(숫자 10자리)

subMerchantPayId: string

하부 가맹점 결제 키

subMerchantTelephoneNo: string

하부 가맹점 대표 전화번호

subMerchantCustomerServiceUrl: string

하부 가맹점 고객 서비스 URL

deliveryFee?: number

배송비

kakaopay?: KakaopayPaymentBypass

카카오페이 bypass 파라미터

custom_message?: string

카카오페이 결제창에 띄워줄 사용자 정의 문구

tosspay_v2?: TosspayV2PaymentBypass

토스페이 bypass 파라미터

expiredTime?: string

결제 만료 기한 (yyyy-MM-dd HH:mm:ss)

cashReceiptTradeOption?: TosspayV2CashReceiptTradeOption

현금영수증 발급타입

  • CULTURE: 문화비
  • GENERAL: 일반 (기본값)
  • PUBLIC_TP: 교통비
"CULTURE"

문화비

"GENERAL"

일반 (기본값)

"PUBLIC_TP"

교통비

toss_brandpay?: TossBrandpayPaymentBypass

토스 브랜드페이 bypass 파라미터

brandpayOptions?: TossBrandpayBrandpayOptions

loadBrandpay 호출시 전달하는 세번째 파라미터

ui?: TossBrandpayBrandpayOptionsUi
highlightColor?: string

UI의 메인 색상. (기본값: #3182f6)

buttonStyle?: TossBrandpayBrandpayOptionsUiButtonStyle

버튼 스타일

  • default(기본값): 모서리가 둥글고 주변에 여백을 가진 버튼
  • full: 하단 영역이 전부 채워지는 형태의 버튼
"default"

모서리가 둥글고 주변에 여백을 가진 버튼(기본값)

"full"

하단 영역이 전부 채워지는 형태의 버튼

labels?: TossBrandpayBrandpayOptionsUiLabels
oneTouchPay?: string

UI에 표시되는 원터치 결제를 대신해 사용할 텍스트. (기본값: "원터치 결제")

navigationBar?: TossBrandpayBrandpayOptionsUiNavigationBar
visible?: boolean

내비게이션 바 사용 여부. (기본값: true)

paddingTop?: number

내비게이션 바 위쪽에 설정할 여백 값. 값의 단위는 px

widgetOptions?: TossBrandpayWidgetOptions

브랜드페이 위젯 render() 함수 호출시 전달하는 두번째 파라미터

methodType?: TossBrandpayWidgetOptionsMethodType

위젯에 보여줄 결제 수단. 예) 카드 전달시 등록한 결제 수단 중 카드만 노출 됨

"카드"
"계좌"
methodId?: string

위젯에서 기본 결제 수단으로 선택할 결제 수단의 ID

ui?: TossBrandpayWidgetOptionsUi
promotionSection?: TossBrandpayWidgetOptionsUiPromotionSection
summary?: TossBrandpayWidgetOptionsUiPromotionSectionSummary
visible?: boolean

혜택 배지 영역을 보여줄지 여부. 혜택 배지 영역에서는 즉시 할인 대상 카드 정보 등을 간략히 보여 줌. 기본값은 true

description?: TossBrandpayWidgetOptionsUiPromotionSectionDescription
visible?: boolean

결제 혜택 영역을 보여줄지 여부. 기본값은 true

defaultOpen?: boolean

결제 혜택의 상세 설명을 보여줄지 여부. 각 카드사의 결제 혜택을 자세히 설명 함. 기본값은 false

discountCode?: string

카드사 할인코드

methodId?: string

등록되어 있는 결제수단 중 하나를 지정해서 바로 결제하고 싶을 때 사용

hyphen?: HyphenBypass

하이픈 bypass 파라미터

designCd?: string
eximbay_v2?: EximbayV2Bypass

엑심베이 V2 bypass 파라미터

payment?: EximbayV2Payment

결제 정보

payment_method?: string

결제수단 단독 노출

multi_payment_method?: Array<string>

결제수단 노출 목록

merchant?: EximbayV2Merchant

상점 정보

shop?: string

상점명

partner_code?: string

파트너 코드

tax?: EximbayV2Tax

세금 정보

receipt_status?: EximbayV2TaxReceiptStatus

현금영수증 발급 여부

"Y"
"N"
surcharge?: Array<EximbayV2Surcharge>

최대 3개의 추가 비용 목록

name?: string

항목명

quantity?: string

수량

unit_price?: string

단가 (음수 가능)

ship_to?: EximbayV2ShipTo

배송지 정보

city?: string

배송지 도시

country?: string

배송지 국가 (ISO 3166 두 자리 국가 코드)

first_name?: string

수신인의 성을 제외한 이름

last_name?: string

수신인의 성

phone_number?: string

수신인 전화번호

postal_code?: string

배송지 우편번호

state?: string

배송지가 미국 혹은 캐나다인 경우, 배송지 주 정보

street1?: string

배송지 상세 주소

bill_to?: EximbayV2BillTo

청구지 정보

city?: string

청구지 도시

country?: string

청구지 국가 (ISO 3166 두 자리 국가 코드)

first_name?: string

청구 카드 명의자의 성을 제외한 이름

last_name?: string

청구 카드 명의자의 성

phone_number?: string

청구 카드 명의자의 전화번호

postal_code?: string

청구지 우편번호

state?: string

청구지가 미국 혹은 캐나다인 경우, 청구지 주 정보

street1?: string

청구지 상세 주소

settings?: EximbayV2Settings

설정 정보

call_from_app?: EximbayV2SettingsCallFromApp

인앱 웹뷰 여부

"Y"
"N"
issuer_country?: string

해외 결제 가맹점에서 국내 결제를 사용할 경우 KR

virtualaccount_expiry_date?: string

입금 만료 일자 (yyyyMMddHH)

inicis_jp?: InicisJpBypass

이니시스 일본 bypass 파라미터

paymentUI?: InicisJpPaymentUI

결제창 UI 설정

colorTheme?: string

결제창 색상

가능한 값:

  • red1
  • red2
  • red3
  • red4
  • orange
  • yellow
  • black
  • purple
  • green
  • blue1
  • blue2
  • blue3
  • blue4
  • blue5
  • blue6
logoUrl?: string

가맹점 로고 이미지 URL

69 * 20 픽셀 크기의 이미지 URL

payletter_global?: PayletterGlobalBypass

페이레터 해외결제 bypass 파라미터

pginfo?: string

결제수단 지정용 파라미터

  • 해외카드 인증 : PLCreditCard
  • 해외카드 비인증(3DS) : PLCreditCardMpi
  • 유니온페이 : PLUnionPay_HC
  • 위챗페이 PC결제: WeChatPayQRCodePayment
  • 위챗페이 모바일결제 : WeChatPayH5Payment
  • 알리페이 : ICBAlipay
servicename?: string

고객사 서비스명, WeChatPay, Alipay 이용 시 필수 입력

card?: PaymentRequestUnionCard

카드 결제 설정

cardCompany?: CardCompany

카드사 다이렉트 호출 시 필요한 카드사 식별 값

availableCards?: Array<CardCompany>

일부 카드사만 노출 설정

일부 카드사만을 선택 가능하게 하고 싶은 경우 사용하는 옵션입니다.

useFreeInterestFromMall?: boolean

상점분담 무이자 활성화 여부

installment?: Installment

할부 설정

신용카드 결제 시 할부 관련 설정을 제어합니다.

사용 예시

3개월 고정 할부

installment: {
  monthOption: {
    fixedMonth: 3
  }
}

2~6개월 할부 선택

installment: {
  monthOption: {
    availableMonthList: [2, 3, 4, 5, 6]
  }
}

무이자 할부 설정 (삼성카드 2,3개월)

installment: {
  freeInstallmentPlans: [{
    cardCompany: 'CARD_COMPANY_SAMSUNG',
    months: [2, 3]
  }]
}

주의사항

  • 일반적으로 5만원 이상부터 할부가 가능합니다
  • 1개월 할부는 일시불과 동일하게 처리됩니다
  • 카드 다이렉트 호출 시 고정 할부만 가능한 PG사가 있습니다
  • 무이자 할부는 가맹점이 수수료를 부담하는 방식입니다
freeInstallmentPlans?: Array<FreeInstallmentPlan>

무이자 할부 설정

나이스페이먼츠나이스페이먼츠

나이스페이먼츠에서 무이자 할부를 지원합니다.

KG이니시스KG이니시스

KG이니시스에서 무이자 할부를 지원합니다.

NHN KCPNHN KCP

NHN KCP에서 무이자 할부를 지원합니다.

KSNETKSNET

KSNET에서 무이자 할부를 지원합니다.

웰컴페이먼츠웰컴페이먼츠

웰컴페이먼츠에서 무이자 할부를 지원합니다.

cardCompany: CardCompany

무이자 할부를 제공하는 카드사

months: Array<number>

무이자 할부를 제공하는 개월 수

monthOption?: InstallmentMonthOption

할부 개월 수 설정

나이스페이먼츠나이스페이먼츠

나이스페이먼츠에서 고정 할부 및 할부 선택을 지원합니다.

KG이니시스KG이니시스

KG이니시스에서 고정 할부 및 할부 선택을 지원합니다.

NHN KCPNHN KCP

NHN KCP에서 고정 할부 및 할부 선택을 지원합니다.

스마트로스마트로

스마트로에서 고정 할부만 지원합니다.

KSNETKSNET

KSNET에서 고정 할부 및 할부 선택을 지원합니다.

웰컴페이먼츠웰컴페이먼츠

웰컴페이먼츠에서 고정 할부 및 할부 선택을 지원합니다.

한국결제네트웍스한국결제네트웍스

KPN에서 고정 할부만 지원합니다.

토스브랜드페이토스브랜드페이

토스 브랜드페이에서 고정 할부만 지원합니다. availableMonthList에 2개 이상의 값이 있으면 오류가 발생합니다.

fixedMonth?: number

구매자가 선택할 수 없도록 고정된 할부 개월수

구매자가 할부 개월 수를 선택할 수 있도록 하려면 availableMonthList를 사용해주세요.

availableMonthList?: Array<number>

구매자가 선택할 수 있는 할부 개월수 리스트

구매자가 할부 개월 수를 선택할 수 없도록 하려면 fixedMonth를 사용해주세요.

useCardPoint?: boolean

카드 포인트 사용 설정

useAppCardOnly?: boolean

앱 카드만 허용할지 여부

useInstallment?: boolean

할부 사용 가능 여부

virtualAccount?: PaymentRequestUnionVirtualAccount

가상계좌 결제 설정

cashReceiptType?: CashReceiptType

현금영수증 유형

토스페이먼츠, KG이니시스, 스마트로, 웰컴페이먼츠, 한국결제네트웍스에서 지원합니다. 동작은 PG에 따라 다릅니다.

KG이니시스KG이니시스
웰컴페이먼츠웰컴페이먼츠

KG이니시스, 웰컴페이먼츠에서는 ANONYMOUS인 경우 현금영수증 설정이 표시되지 않습니다. 이외의 값은 무시됩니다.

스마트로스마트로

스마트로에서는 UI를 건너뛸 때 필수입니다. 이외에는 무시됩니다.

한국결제네트웍스한국결제네트웍스

한국결제네트웍스에서는 ANONYMOUS인 경우 현금영수증 설정이 표시되지 않고, ANONYMOUS 이외의 값일 경우 UI에서 현금영수증 정보 입력이 강제됩니다. 지정하지 않으면 현금영수증 정보 입력은 선택입니다.

PERSONAL과 CORPORATE의 차이는 없습니다.

"CASH_RECEIPT_TYPE_PERSONAL"

소득공제(개인)

"CASH_RECEIPT_TYPE_CORPORATE"

지출증빙(사업자)

"CASH_RECEIPT_TYPE_ANONYMOUS"

미발행(PG 설정에 따라 무기명으로 자진 발급될 수 있음)

customerIdentifier?: string

현금영수증 구매자 번호

카드일련번호, 주민등록번호, 사업자등록번호, 휴대전화번호 중 하나입니다. 스마트로에서 PG UI를 건너뛸 때 사용합니다.

스마트로스마트로

스마트로에서는 UI를 건너뛰고 cashReceiptType이 ANONYMOUS가 아닐 때 필수입니다.

bankCode?: Bank

은행

가상계좌를 발급할 은행입니다. KCP와 스마트로에서 지원합니다.

NHN KCPNHN KCP

NHN KCP에서는 availableBanks에 은행 하나만 지정한 것처럼 동작합니다. availableBanks가 우선합니다.

스마트로스마트로

스마트로에서는 설정하면 UI가 열리지 않고 바로 가상계좌가 발급됩니다. 에스크로 결제에서는 사용할 수 없습니다.

accountExpiry?: PaymentRequestUnionVirtualAccountAccountExpiry

가상계좌 입금 만료 기한

토스페이먼츠, KG이니시스, NHN KCP에서 지원합니다.

validHours와 dueDate 중 하나만 지정합니다.

NHN KCPNHN KCP

KCP에서는 초 단위로 전달됩니다.

KG이니시스KG이니시스

KG이니시스에서는 분 단위로 전달됩니다.

validHours: number

유효 시간

예) 3을 전달하면 지금으로부터 3시간 후가 만료 기한으로 지정 됨

dueDate: string

만료 시각

  • YYYYMMDD
  • YYYYMMDDHHmmss
  • YYYY-MM-DD
  • YYYY-MM-DD HH:mm:ss
availableBanks?: Array<Bank>

선택 가능 은행 목록

가상계좌 발급 UI에서 선택할 수 있는 은행 목록을 지정합니다. KCP에서만 지원합니다.

transfer?: PaymentRequestUnionTransfer

계좌이체 결제 설정

cashReceiptType?: CashReceiptType

현금영수증 유형

토스페이먼츠, NICE페이먼츠, KG이니시스, 스마트로, KSNET, 웰컴페이먼츠, 한국결제네트웍스에서 지원합니다. 동작은 PG에 따라 다릅니다.

나이스페이먼츠나이스페이먼츠

NICE페이먼츠에서는 PG UI를 건너뛸 때 필수입니다. 이외에는 무시됩니다.

KG이니시스KG이니시스
KSNETKSNET
웰컴페이먼츠웰컴페이먼츠

KG이니시스, KSNET, 웰컴페이먼츠에서는 ANONYMOUS인 경우 현금영수증 설정이 표시되지 않습니다. 이외의 값은 무시됩니다.

스마트로스마트로

스마트로에서는 PG UI를 건너뛸 때 필수입니다. 설정할 경우 자동으로 PG UI를 건너뜁니다.

한국결제네트웍스한국결제네트웍스

한국결제네트웍스에서는 ANONYMOUS인 경우 현금영수증 설정이 표시되지 않고, ANONYMOUS 이외의 값일 경우 UI에서 현금영수증 정보 입력이 강제됩니다. 지정하지 않으면 현금영수증 정보 입력은 선택입니다.

PERSONAL과 CORPORATE의 차이는 없습니다.

"CASH_RECEIPT_TYPE_PERSONAL"

소득공제(개인)

"CASH_RECEIPT_TYPE_CORPORATE"

지출증빙(사업자)

"CASH_RECEIPT_TYPE_ANONYMOUS"

미발행(PG 설정에 따라 무기명으로 자진 발급될 수 있음)

customerIdentifier?: string

현금영수증 구매자 번호

카드일련번호, 주민등록번호, 사업자등록번호, 휴대전화번호 중 하나입니다. NICE페이먼츠와 스마트로에서 PG UI를 건너뛸 때 사용합니다.

나이스페이먼츠나이스페이먼츠

NICE페이먼츠에서는 PG UI를 건너뛰고 cashReceiptType이 ANONYMOUS가 아닐 때 필수입니다. 이외에는 무시됩니다.

스마트로스마트로

스마트로에서는 PG UI를 건너뛰고 cashReceiptType이 ANONYMOUS가 아닐 때 필수입니다. 설정할 경우 자동으로 PG UI를 건너뜁니다.

mobile?: PaymentRequestUnionMobile

휴대전화 결제 설정

carrier?: Carrier

휴대폰 소액결제 통신사 바로 호출을 위한 통신사 구분 값

"CARRIER_SKT"

SK텔레콤

"CARRIER_KT"

KT

"CARRIER_LGU"

LG U+

"CARRIER_HELLO"

헬로모바일

"CARRIER_KCT"

티플러스

"CARRIER_SK7"

SK 7mobile

avaliableCarriers?: Array<Carrier>

일부 통신사만 노출 설정

일부 통신사만을 선택 가능하게 하고 싶은 경우 사용하는 옵션입니다.

"CARRIER_SKT"

SK텔레콤

"CARRIER_KT"

KT

"CARRIER_LGU"

LG U+

"CARRIER_HELLO"

헬로모바일

"CARRIER_KCT"

티플러스

"CARRIER_SK7"

SK 7mobile

giftCertificate?: PaymentRequestUnionGiftCertificate

상품권 결제 설정

giftCertificateType?: GiftCertificateType

상품권 종류

"GIFT_CERTIFICATE_TYPE_BOOKNLIFE"

도서문화상품권 | KG이니시스

"GIFT_CERTIFICATE_TYPE_SMART_MUNSANG"

스마트문상, (구)게임문화상품권

"GIFT_CERTIFICATE_TYPE_CULTURELAND"

컬쳐랜드 문화상품권

"GIFT_CERTIFICATE_TYPE_CULTURE_GIFT"

문화상품권

easyPay?: PaymentRequestUnionEasyPay
easyPayProvider?: EasyPayProvider

간편결제 UI 직접 호출

PG 제휴 간편결제의 UI를 직접 호출하기 위해, 간편결제 서비스를 지정합니다.

useFreeInterestFromMall?: boolean

상점분담 무이자 활성화 여부

availableCards?: Array<CardCompany>

일부 카드사만 노출 설정

일부 카드사만을 선택 가능하게 하고 싶은 경우 사용하는 옵션입니다.

installment?: Installment

할부 설정

신용카드 결제 시 할부 관련 설정을 제어합니다.

사용 예시

3개월 고정 할부

installment: {
  monthOption: {
    fixedMonth: 3
  }
}

2~6개월 할부 선택

installment: {
  monthOption: {
    availableMonthList: [2, 3, 4, 5, 6]
  }
}

무이자 할부 설정 (삼성카드 2,3개월)

installment: {
  freeInstallmentPlans: [{
    cardCompany: 'CARD_COMPANY_SAMSUNG',
    months: [2, 3]
  }]
}

주의사항

  • 일반적으로 5만원 이상부터 할부가 가능합니다
  • 1개월 할부는 일시불과 동일하게 처리됩니다
  • 카드 다이렉트 호출 시 고정 할부만 가능한 PG사가 있습니다
  • 무이자 할부는 가맹점이 수수료를 부담하는 방식입니다
freeInstallmentPlans?: Array<FreeInstallmentPlan>

무이자 할부 설정

나이스페이먼츠나이스페이먼츠

나이스페이먼츠에서 무이자 할부를 지원합니다.

KG이니시스KG이니시스

KG이니시스에서 무이자 할부를 지원합니다.

NHN KCPNHN KCP

NHN KCP에서 무이자 할부를 지원합니다.

KSNETKSNET

KSNET에서 무이자 할부를 지원합니다.

웰컴페이먼츠웰컴페이먼츠

웰컴페이먼츠에서 무이자 할부를 지원합니다.

cardCompany: CardCompany

무이자 할부를 제공하는 카드사

months: Array<number>

무이자 할부를 제공하는 개월 수

monthOption?: InstallmentMonthOption

할부 개월 수 설정

나이스페이먼츠나이스페이먼츠

나이스페이먼츠에서 고정 할부 및 할부 선택을 지원합니다.

KG이니시스KG이니시스

KG이니시스에서 고정 할부 및 할부 선택을 지원합니다.

NHN KCPNHN KCP

NHN KCP에서 고정 할부 및 할부 선택을 지원합니다.

스마트로스마트로

스마트로에서 고정 할부만 지원합니다.

KSNETKSNET

KSNET에서 고정 할부 및 할부 선택을 지원합니다.

웰컴페이먼츠웰컴페이먼츠

웰컴페이먼츠에서 고정 할부 및 할부 선택을 지원합니다.

한국결제네트웍스한국결제네트웍스

KPN에서 고정 할부만 지원합니다.

토스브랜드페이토스브랜드페이

토스 브랜드페이에서 고정 할부만 지원합니다. availableMonthList에 2개 이상의 값이 있으면 오류가 발생합니다.

fixedMonth?: number

구매자가 선택할 수 없도록 고정된 할부 개월수

구매자가 할부 개월 수를 선택할 수 있도록 하려면 availableMonthList를 사용해주세요.

availableMonthList?: Array<number>

구매자가 선택할 수 있는 할부 개월수 리스트

구매자가 할부 개월 수를 선택할 수 없도록 하려면 fixedMonth를 사용해주세요.

cashReceiptType?: CashReceiptType

현금영수증 유형

나이스페이먼츠, 토스페이먼츠 브랜드페이에서 사용합니다.

나이스페이먼츠나이스페이먼츠

나이스페이먼츠에서는 네이버페이 포인트·머니, SSGPAY 계좌이체 UI를 직접 호출할 때 필수입니다.

"CASH_RECEIPT_TYPE_PERSONAL"

소득공제(개인)

"CASH_RECEIPT_TYPE_CORPORATE"

지출증빙(사업자)

"CASH_RECEIPT_TYPE_ANONYMOUS"

미발행(PG 설정에 따라 무기명으로 자진 발급될 수 있음)

customerIdentifier?: string

현금영수증 구매자 번호

카드일련번호, 주민등록번호, 사업자등록번호, 휴대전화번호 중 하나입니다.

cashReceiptType이 있고 ANONYMOUS가 아닐 때 필수입니다.

useCardPoint?: boolean

카드사 포인트 사용 여부

토스페이먼츠 브랜드페이에서 사용합니다. true로 설정하면 카드사 포인트 사용이 켜진 상태로 UI가 표시됩니다. 이외의 경우 구매자가 카드사 포인트 사용 여부를 선택할 수 있습니다. 토스페이먼츠와의 추가 게약이 필요합니다.

availablePayMethods?: Array<EasyPayPaymentMethod>

표시할 간편결제 수단 목록

나이스페이먼츠, NHN KCP, KSNET에서 일부 간편결제의 UI를 직접 호출할 때 사용합니다.

PG 제휴를 통해 간편결제를 이용할 때에는 복합결제가 불가능한 경우가 많습니다. 즉, 전액 카드 결제나 전액 포인트 결제 등만 가능합니다. 보통 UI 안에서 결제 수단을 선택하게 되나, 일부 PG에서는 UI를 호출할 때 수단 중 하나를 지정할 수 있는 기능을 제공하기도 합니다. 이때 availablePayMethods가 사용됩니다.

단, 나이스페이먼츠를 통해 네이버페이 UI를 직접 호출할 때에는 필수임에 유의합니다.

나이스페이먼츠나이스페이먼츠

나이스페이먼츠에서는 네이버페이, 토스페이 SSGPAY UI를 직접 호출할 때에 사용합니다.

네이버페이 UI를 직접 호출할 때에는 필수입니다.

  • CARD: 네이버페이 카드 결제 UI를 엽니다.
  • CHARGE 또는 MONEY: 네이버페이 포인트·머니 결제 UI를 엽니다.

토스페이 UI를 직접 호출할 때에는 선택입니다. 기본값은 둘 모두 지정한 것과 같습니다.

  • CARD: 토스페이 카드 결제 UI를 엽니다.
  • CHARGE 또는 MONEY: 토스페이 포인트 결제 UI를 엽니다.
  • 둘 모두 지정: 카드 또는 포인트 결제 중 하나를 선택하는 UI를 엽니다.

SSGPAY UI를 직접 호출하실 때에는 파라미터 관련 문의 바랍니다.

NHN KCPNHN KCP

NHN KCP에서는 네이버페이 UI를 직접 호출할 때에 사용합니다. 기본값은 둘 모두 지정한 것과 같습니다.

  • CARD: 네이버페이 카드 결제 UI를 엽니다.
  • CHARGE 또는 MONEY: 네이버페이 포인트·머니 결제 UI를 엽니다.
  • 둘 모두 지정: 카드 또는 포인트·머니 결제 중 하나를 선택하는 UI를 엽니다.
KSNETKSNET

KSNET에서는 카카오페이 UI를 직접 호출할 때에 사용합니다. 기본값은 둘 모두 지정한 것과 같습니다.

  • CARD: 카카오페이 카드 결제 UI를 엽니다.
  • CHARGE 또는 MONEY: 카카오페이 포인트 결제 UI를 엽니다.
  • 둘 모두 지정: 카드 또는 포인트 결제 중 하나를 선택하는 UI를 엽니다.
"CARD"
"TRANSFER"
"CHARGE"
"MONEY"
useInstallment?: boolean

할부 사용 가능 여부

false로 지정하면 신용카드 할부 사용을 금지합니다. 토스페이(직계약)에서 지원합니다.

paypal?: {}
alipay?: {}
convenienceStore?: PaymentRequestUnionConvenienceStore
paymentDeadline?: PaymentRequestUnionConvenienceStorePaymentDeadline

편의점결제 지불기한

validHours: number

유효 시간 (단위: 시간)

dueDate: string

만료일시

RFC 3339 형식입니다.