개발자센터

requestIssueBillingKey 요청 형식

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

requestIssueBillingKey 요청 데이터 정의

request: IssueBillingKeyRequest
displayAmount?: number

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

currency?: Currency

결제 통화 코드

storeId: string

스토어 아이디

  • 포트원 계정에 생성된 상점을 식별하는 고유한 값으로 관리자 콘솔에서 확인할 수 있습니다.
channelKey?: string

채널 키

콘솔에서 채널 연동 시 생성된 채널 키입니다.

billingKeyMethod: BillingKeyMethod

빌링키 발급 수단

issueName?: string

빌링키 발급 주문 명

issueId?: string

빌링키 발급 주문 고유 번호

customer?: Customer
customerId?: string

구매자 고유 ID

fullName?: string

구매자 전체 이름

fullName과 firstName / lastName이 모두 입력된 경우 fullName으로 기록됩니다.

firstName?: string

구매자 이름

firstName을 입력하는 경우 lastName도 필수로 입력해야 합니다. fullName이 없고, firstName과 lastName이 존재하는 경우 {firstName} {lastName}으로 저장됩니다.

lastName?: string

구매자 성

lastName을 입력하는 경우 firstName도 필수로 입력해야 합니다.

phoneNumber?: string

구매자 연락처

email?: string

구매자 이메일 주소

유효한 이메일 주소를 입력해주세요.

address?: Address

주소 정보

country?: Country

국가

addressLine1: string

일반주소

addressLine2: string

상세주소

city?: string

도시

province?: string

주, 도, 시

zipcode?: string

구매자 우편번호

gender?: Gender

구매자 성별

birthYear?: string

구매자 출생년도

ex. "1990" 같은 형식으로 입력해주세요.

birthMonth?: string

구매자 출생월

ex. "12", "07" 같은 형식으로 입력해주세요.

birthDay?: string

구매자 출생일

ex. "25", "08" 같은 형식으로 입력해주세요.

windowType?: WindowTypes

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

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

리디렉션 방식에서 프로세스 완료 후 이동될 고객사 URL

  • 결제/본인인증 창이 새로운 창으로 리다이렉트 되어 프로세스가 진행되는 방식인 경우 필수 설정 항목 입니다.
  • 대부분의 모바일 환경에서 창 호출시 필수 항목입니다.
  • 리다이렉트 환경에서 해당 필드 누락시 에러가 발생합니다.
locale?: Locale

결제창 언어 (지원되지 않은 일부 PG사 존재)

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?: { from } | { to } | { from, to }

기간 범위

{ from }
from: string

시작 시점

{ to }
to: string

종료 지점

{ from, to }
from: string

시작 시점

to: string

종료 지점

interval?: string

제공 주기

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

appScheme?: string

앱 URL Scheme

noticeUrls?: Array<string>

웹훅 URL

productType?: ProductType

상품 유형

bypass?: IssueBillingKeyBypass
kakaopay?: KakaopayPaymentBypass

카카오페이 bypass 파라미터

custom_message?: string

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

smartro_v2?: SmartroV2IssueBillingKeyBypass
SkinColor?: "RED"|"GREEN"|"BLUE"|...

UI 스타일(기본: RED)

IsPwdPass?: "Y"|"N"

결제 비밀번호 등록 Skip 여부

naverpay?: NaverpayIssueBillingKeyBypass
subMerchantName?: string

하부 가맹점 명

subMerchantId?: string

하부 가맹점 ID

welcome?: WelcomeIssueBillingKeyBypass
logo_url?: string

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

logo_2nd?: string

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

tosspay_v2?: TosspayV2IssueBillingKeyBypass
encryptedUserCi?: string

암호화된 사용자 CI

inicis_v2?: InicisV2IssueBillingKeyBypass
carduse?: "percard"|"cocard"

개인/법인카드 선택 옵션

kcp_v2?: KcpV2IssueBillingKeyBypass
batch_soc_choice?: "S"|"C"

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

popup?: Popup

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

center?: boolean

true로 설정하면 결제창이 브라우저 화면의 정중앙에 표시됩니다.

card: { cardCompany }

billingKeyMethod가 CARD인 경우에만 허용됩니다.

mobile: { carrier, avaliableCarriers }

billingKeyMethod가 MOBILE인 경우에만 허용됩니다.

easyPay: { availableCards }

billingKeyMethod가 EASY_PAY인 경우에만 허용됩니다.

paypal: {}

billingKeyMethod가 PAYPAL인 경우에만 허용됩니다.