requestIssueBillingKey 요청 형식

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

아래의 경우에는 정책상 빌링키 발급과 초회 결제가 함께 일어나야 하므로 requestIssueBillingKeyAndPay 함수를 이용해 주세요.

KG이니시스 휴대폰 결제
웰컴페이먼츠 휴대폰 결제

`requestIssueBillingKey` 요청 데이터 정의

request: IssueBillingKeyRequest

displayAmount?: number

빌링키 발급 창에 디스플레이 용으로 띄우는 금액

currency?: Currency

displayAmount 의 화폐

storeId: string

상점 아이디

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

channelKey?: string

채널 키

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

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

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

billingKeyMethod: BillingKeyMethod

빌링키 발급 수단

"CARD"

카드

"MOBILE"

휴대전화

"EASY_PAY"

간편결제

"PAYPAL"

페이팔(RT)

issueName?: string

빌링키 발급 주문 명

issueId?: string

빌링키 발급 주문 고유 번호

customer?: Customer

customerId?: string

구매자 ID

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

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

스마트로

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

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

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

KG이니시스

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

fullName?: string

구매자 전체 이름

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

나이스페이먼츠

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

KG이니시스

웰컴페이먼츠

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

NHN KCP

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

스마트로

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

KSNET

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

한국결제네트웍스

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

하이픈

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

firstName?: string

구매자 성이 아닌 이름

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

lastName?: string

구매자 성

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

phoneNumber?: string

구매자 휴대전화 번호

숫자만 입력합니다.

나이스페이먼츠

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

KG이니시스

웰컴페이먼츠

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

NHN KCP

NHN KCP에 전달됩니다.

스마트로

스마트로에 전달됩니다.

email?: string

구매자 이메일 주소

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

나이스페이먼츠

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

KG이니시스

웰컴페이먼츠

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

NHN 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

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

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 데이터

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 형태로 입력할 수 있습니다.)

appScheme?: string

앱 URL Scheme

noticeUrls?: Array<string>

웹훅 URL

productType?: ProductType

상품 유형

"PRODUCT_TYPE_REAL"

실물

"PRODUCT_TYPE_DIGITAL"

디지털

bypass?: IssueBillingKeyBypass

inicis_v2?: InicisV2IssueBillingKeyBypass

KG이니시스 bypass 파라미터

carduse?: InicisV2CardUse

개인/법인카드 선택 옵션

"percard"

개인카드만 선택 가능

"cocard"

법인 카드만 선택 가능

kcp_v2?: KcpV2IssueBillingKeyBypass

KCP bypass 파라미터

batch_soc_choice?: KcpV2BatchSocChoice

결제창에서 주민번호/사업자 번호 고정여부 설정

"S"

주민번호만 표시

"C"

사업자번호만 표시

smartro_v2?: SmartroV2IssueBillingKeyBypass

스마트로 bypass 파라미터

SkinColor?: SmartroV2SkinColor

UI 스타일(기본: RED)

"RED"

"GREEN"

"BLUE"

"PURPLE"

IsPwdPass?: SmartroV2IsPwdPass

결제 비밀번호 등록 Skip 여부

"Y"

비밀번호 설정 미사용

"N"

비밀번호 설정 사용

welcome?: WelcomeIssueBillingKeyBypass

웰컴페이먼츠 bypass 파라미터

logo_url?: string

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

logo_2nd?: string

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

naverpay?: NaverpayIssueBillingKeyBypass

네이버페이 bypass 파라미터

subMerchantName?: string

하부 가맹점 명

subMerchantId?: string

하부 가맹점 ID

kakaopay?: KakaopayPaymentBypass

카카오페이 bypass 파라미터

custom_message?: string

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

tosspay_v2?: TosspayV2IssueBillingKeyBypass

토스페이 bypass 파라미터

encryptedUserCi?: string

암호화된 사용자 CI

popup?: Popup

팝업 관련 필드

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

center?: boolean

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

iframe?: Iframe

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

dim?: boolean

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

card?: IssueBillingKeyRequestUnionCard

cardCompany?: CardCompany

카드 결제시 사용되는 카드사 코드

mobile?: IssueBillingKeyRequestUnionMobile

carrier?: Carrier

통신사 코드

"CARRIER_SKT"

SK텔레콤

"CARRIER_KT"

"CARRIER_LGU"

LG U+

"CARRIER_HELLO"

헬로모바일

"CARRIER_KCT"

티플러스

"CARRIER_SK7"

SK 7mobile

avaliableCarriers?: Array<Carrier>

통신사 코드

"CARRIER_SKT"

SK텔레콤

"CARRIER_KT"

"CARRIER_LGU"

LG U+

"CARRIER_HELLO"

헬로모바일

"CARRIER_KCT"

티플러스

"CARRIER_SK7"

SK 7mobile

easyPay?: IssueBillingKeyRequestUnionEasyPay

availableCards?: Array<CardCompany>

카드 결제시 사용되는 카드사 코드

easyPayProvider?: EasyPayProvider

PG 제휴로 간편결제를 이용할 때, 간편결제 UI를 직접 호출할 수 있는 간편결제

availablePayMethods?: Array<EasyPayPaymentMethod>

노출을 허용할 결제 수단의 종류

"CARD"

"TRANSFER"

"CHARGE"

"MONEY"

paypal?: {}

requestIssueBillingKey 요청 형식

requestIssueBillingKey 요청 데이터 정의

`requestIssueBillingKey` 요청 데이터 정의