개발자센터

requestIssueBillingKey 요청 형식

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

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

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

requestIssueBillingKey 요청 데이터 정의

request: IssueBillingKeyRequest
displayAmount?: number

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

currency?: Currency

displayAmount 의 화폐

"CURRENCY_KRW"

South Korean won

"CURRENCY_USD"

United States dollar

"CURRENCY_EUR"

Euro

"CURRENCY_JPY"

Japanese yen

"CURRENCY_CNY"

Chinese yuan

"CURRENCY_VND"

Vietnamese dong

"CURRENCY_THB"

Thai baht

"CURRENCY_SGD"

Singapore dollar

"CURRENCY_AUD"

Australian dollar

"CURRENCY_HKD"

Hong Kong dollar

"CURRENCY_AED"

United Arab Emirates dirham

"CURRENCY_AFN"

Afghan afghani

"CURRENCY_ALL"

Albanian lek

"CURRENCY_AMD"

Armenian dram

"CURRENCY_ANG"

Netherlands Antillean guilder

"CURRENCY_AOA"

Angolan kwanza

"CURRENCY_ARS"

Argentine peso

"CURRENCY_AWG"

Aruban florin

"CURRENCY_AZN"

Azerbaijani manat

"CURRENCY_BAM"

Bosnia and Herzegovina convertible mark

"CURRENCY_BBD"

Barbadian dollar

"CURRENCY_BDT"

Bangladeshi taka

"CURRENCY_BGN"

Bulgarian lev

"CURRENCY_BMD"

Bermudian dollar

"CURRENCY_BND"

Brunei dollar

"CURRENCY_BOB"

Boliviano

"CURRENCY_BOV"

Bolivian Mvdol

"CURRENCY_BRL"

Brazilian real

"CURRENCY_BSD"

Bahamian dollar

"CURRENCY_BWP"

Botswana pula

"CURRENCY_BYN"

Belarusian ruble

"CURRENCY_BZD"

Belize dollar

"CURRENCY_CAD"

Canadian dollar

"CURRENCY_CDF"

Congolese franc

"CURRENCY_CHE"

WIR euro

"CURRENCY_CHF"

Swiss franc

"CURRENCY_CHW"

WIR franc

"CURRENCY_CLF"

Chilean unit of account (UF)

"CURRENCY_CLP"

Chilean peso

"CURRENCY_COP"

Colombian peso

"CURRENCY_COU"

Unidad de Valor Real

"CURRENCY_CRC"

Costa Rican colon

"CURRENCY_CUC"

Cuban convertible peso

"CURRENCY_CUP"

Cuban peso

"CURRENCY_CVE"

Cape Verdean escudo

"CURRENCY_CZK"

Czech koruna

"CURRENCY_DJF"

Djiboutian franc

"CURRENCY_DKK"

Danish krone

"CURRENCY_DOP"

Dominican peso

"CURRENCY_DZD"

Algerian dinar

"CURRENCY_EGP"

Egyptian pound

"CURRENCY_ERN"

Eritrean nakfa

"CURRENCY_ETB"

Ethiopian birr

"CURRENCY_FJD"

Fiji dollar

"CURRENCY_FKP"

Falkland Islands pound

"CURRENCY_GBP"

Pound sterling

"CURRENCY_GEL"

Georgian lari

"CURRENCY_GHS"

Ghanaian cedi

"CURRENCY_GIP"

Gibraltar pound

"CURRENCY_GMD"

Gambian dalasi

"CURRENCY_GNF"

Guinean franc

"CURRENCY_GTQ"

Guatemalan quetzal

"CURRENCY_GYD"

Guyanese dollar

"CURRENCY_HNL"

Honduran lempira

"CURRENCY_HRK"

Croatian kuna

"CURRENCY_HTG"

Haitian gourde

"CURRENCY_HUF"

Hungarian forint

"CURRENCY_IDR"

Indonesian rupiah

"CURRENCY_ILS"

Israeli new shekel

"CURRENCY_INR"

Indian rupee

"CURRENCY_IQD"

Iraqi dinar

"CURRENCY_IRR"

Iranian rial

"CURRENCY_ISK"

Icelandic króna

"CURRENCY_JMD"

Jamaican dollar

"CURRENCY_JOD"

Jordanian dinar

"CURRENCY_KES"

Kenyan shilling

"CURRENCY_KGS"

Kyrgyzstani som

"CURRENCY_KHR"

Cambodian riel

"CURRENCY_KMF"

Comoro franc

"CURRENCY_KPW"

North Korean won

"CURRENCY_KWD"

Kuwaiti dinar

"CURRENCY_KYD"

Cayman Islands dollar

"CURRENCY_KZT"

Kazakhstani tenge

"CURRENCY_LAK"

Lao kip

"CURRENCY_LBP"

Lebanese pound

"CURRENCY_LKR"

Sri Lankan rupee

"CURRENCY_LRD"

Liberian dollar

"CURRENCY_LSL"

Lesotho loti

"CURRENCY_LYD"

Libyan dinar

"CURRENCY_MAD"

Moroccan dirham

"CURRENCY_MDL"

Moldovan leu

"CURRENCY_MGA"

Malagasy ariary

"CURRENCY_MKD"

Macedonian denar

"CURRENCY_MMK"

Myanmar kyat

"CURRENCY_MNT"

Mongolian tögrög

"CURRENCY_MOP"

Macanese pataca

"CURRENCY_MRU"

Mauritanian ouguiya

"CURRENCY_MUR"

Mauritian rupee

"CURRENCY_MVR"

Maldivian rufiyaa

"CURRENCY_MWK"

Malawian kwacha

"CURRENCY_MXN"

Mexican peso

"CURRENCY_MXV"

Mexican Unidad de Inversion

"CURRENCY_MZN"

Mozambican metical

"CURRENCY_NAD"

Namibian dollar

"CURRENCY_NGN"

Nigerian naira

"CURRENCY_NIO"

Nicaraguan córdoba

"CURRENCY_NOK"

Norwegian krone

"CURRENCY_NPR"

Nepalese rupee

"CURRENCY_NZD"

New Zealand dollar

"CURRENCY_OMR"

Omani rial

"CURRENCY_PAB"

Panamanian balboa

"CURRENCY_PEN"

Peruvian sol

"CURRENCY_PGK"

Papua New Guinean kina

"CURRENCY_PHP"

Philippine peso

"CURRENCY_PKR"

Pakistani rupee

"CURRENCY_PLN"

Polish złoty

"CURRENCY_PYG"

Paraguayan guaraní

"CURRENCY_QAR"

Qatari riyal

"CURRENCY_RON"

Romanian leu

"CURRENCY_RSD"

Serbian dinar

"CURRENCY_RUB"

Russian ruble

"CURRENCY_RWF"

Rwandan franc

"CURRENCY_SAR"

Saudi riyal

"CURRENCY_SBD"

Solomon Islands dollar

"CURRENCY_SCR"

Seychelles rupee

"CURRENCY_SDG"

Sudanese pound

"CURRENCY_SEK"

Swedish krona

"CURRENCY_SHP"

Saint Helena pound

"CURRENCY_SLE"

Sierra Leonean leone (new leone)

"CURRENCY_SLL"

Sierra Leonean leone (old leone)

"CURRENCY_SOS"

Somali shilling

"CURRENCY_SRD"

Surinamese dollar

"CURRENCY_SSP"

South Sudanese pound

"CURRENCY_STN"

São Tomé and Príncipe dobra

"CURRENCY_SVC"

Salvadoran colón

"CURRENCY_SYP"

Syrian pound

"CURRENCY_SZL"

Swazi lilangeni

"CURRENCY_TJS"

Tajikistani somoni

"CURRENCY_TMT"

Turkmenistan manat

"CURRENCY_TND"

Tunisian dinar

"CURRENCY_TOP"

Tongan paʻanga

"CURRENCY_TRY"

Turkish lira

"CURRENCY_TTD"

Trinidad and Tobago dollar

"CURRENCY_TWD"

New Taiwan dollar

"CURRENCY_TZS"

Tanzanian shilling

"CURRENCY_UAH"

Ukrainian hryvnia

"CURRENCY_UGX"

Ugandan shilling

"CURRENCY_USN"

United States dollar (next day)

"CURRENCY_UYI"

Uruguay Peso en Unidades Indexadas

"CURRENCY_UYU"

Uruguayan peso

"CURRENCY_UYW"

Unidad previsional

"CURRENCY_UZS"

Uzbekistan som

"CURRENCY_VED"

Venezuelan bolívar digital

"CURRENCY_VES"

Venezuelan bolívar soberano

"CURRENCY_VUV"

Vanuatu vatu

"CURRENCY_WST"

Samoan tala

"CURRENCY_XAF"

CFA franc BEAC

"CURRENCY_XAG"

Silver (one troy ounce)

"CURRENCY_XAU"

Gold (one troy ounce)

"CURRENCY_XBA"

European Composite Unit

"CURRENCY_XBB"

European Monetary Unit

"CURRENCY_XBC"

European Unit of Account 9

"CURRENCY_XBD"

European Unit of Account 17

"CURRENCY_XCD"

East Caribbean dollar

"CURRENCY_XDR"

Special drawing rights

"CURRENCY_XOF"

CFA franc BCEAO

"CURRENCY_XPD"

Palladium (one troy ounce)

"CURRENCY_XPF"

CFP franc

"CURRENCY_XPT"

Platinum (one troy ounce)

"CURRENCY_XSU"

SUCRE

"CURRENCY_XTS"

Code reserved for testing

"CURRENCY_XUA"

ADB Unit of Account

"CURRENCY_XXX"

No currency

"CURRENCY_YER"

Yemeni rial

"CURRENCY_ZAR"

South African rand

"CURRENCY_ZMW"

Zambian kwacha

"CURRENCY_ZWL"

Zimbabwean dollar

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

구매자 성별

"GENDER_MALE"

남성

"GENDER_FEMALE"

여성

"GENDER_OTHER"

기타

birthYear?: string

구매자 출생년도

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

birthMonth?: string

구매자 출생월

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

birthDay?: string

구매자 출생일

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

firstNameKana?: string

구매자 이름 후리가나

일본어 읽는 법 표기

lastNameKana?: string

구매자 성 후리가나

일본어 읽는 법 표기

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

결제창 언어 (지원되지 않은 일부 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?: 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

상품 유형

bypass?: IssueBillingKeyBypass
kakaopay?: KakaopayPaymentBypass

카카오페이 bypass 파라미터

custom_message?: string

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

smartro_v2?: SmartroV2IssueBillingKeyBypass
SkinColor?: SmartroV2SkinColor

UI 스타일(기본: RED)

IsPwdPass?: SmartroV2IsPwdPass

결제 비밀번호 등록 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?: InicisV2CardUse

개인/법인카드 선택 옵션

kcp_v2?: KcpV2IssueBillingKeyBypass
batch_soc_choice?: KcpV2BatchSocChoice

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

popup?: Popup

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

center?: boolean

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

card: IssueBillingKeyRequestUnionCard

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

mobile: IssueBillingKeyRequestUnionMobile

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

easyPay: IssueBillingKeyRequestUnionEasyPay

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

paypal: {}

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