# 빌링키 발급 요청 파라미터

{% hint style="warning" %}
**Deprecated**

이 문서는 더 이상 관리되지 않습니다.

[PortOne 개발자센터](https://developers.portone.io/)를 이용해주세요.
{% endhint %}

## 빌링키 발급 요청 파라미터 정의

### **`storeId`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

> **상점 ID**
>
> * 포트원에서 채번하는 상점 ID입니다.
> * 관리자콘솔의 결제 연동 페이지에서 확인하실 수 있습니다.

### **`channelName`** <mark style="color:green;">**string**</mark>

> **채널 이름**
>
> 콘솔에서 설정한 채널 이름입니다.
>
> `pgProvider` 파라미터가 없는 경우에 필수로 존재해야 합니다. 두 파라미터가 모두 존재하는 경우 `channelName`을 적용하니 둘 중 하나만 제공해주세요.

### **`pgProvider`** <mark style="color:green;">**string**</mark>

> **PG사 구분코드**
>
> `channelName` 파라미터가 없는 경우에 필수로 존재해야 합니다.
>
> 가능한 PG사 코드는 아래를 참고해주세요.
>
> <details>
>
> <summary>PG사 코드</summary>
>
> * `HTML5_INICIS`
> * `INICIS`
> * `NICE`
> * `KCP`
> * `KCP_BILLING`
> * `KCP_QUICK`
> * `DANAL`
> * `DANAL_TPAY`
> * `UPLUS`
> * `TOSSPAYMENTS`
> * `MOBILIANS`
> * `NAVERCO`
> * `KICC`
> * `SMARTRO`
> * `JTNET`
> * `DAOU`
> * `BLUEWALNUT`
> * `PAYPAL`
> * `ALIPAY`
> * `EXIMBAY`
> * `PAYMENTWALL`
> * `SETTLE`
> * `SETTLE_ACC`
> * `SETTLE_FIRM`
> * `GALAXIA`
> * `NAVERPAY`
> * `KAKAOPAY`
> * `SMILEPAY`
> * `TOSSPAY`
> * `CHAI`
> * `PAYCO`
> * `PAYPLE`
> * `INICIS_UNIFIED`
> * `SYRUP`
> * `KCP_DIRECT`
> * `KAKAO`
> * `KSNET`
>
> </details>

### **`isTestChannel`** <mark style="color:orange;background-color:yellow;">**boolean**</mark>

> **테스트 채널 정보로 결제할지 여부**
>
> 미입력 시 기본값은 `false`입니다.
>
> 선택하신 채널이 테스트 채널이 아닌 경우 에러가 발생합니다.

### **`billingKeyMethod`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

> **빌링키 발급수단 구분코드**
>
> PG사별 지원되는 발급수단이 모두 상이합니다.
>
> **각 PG사별 결제 연동 가이드**를 참고하세요
>
> <details>
>
> <summary>발급수단 구분코드 확인하기</summary>
>
> * `CARD` (카드)
> * `MOBILE` (휴대폰 소액결제)
>
> </details>

### **`customer`** <mark style="color:red;">**\***</mark> <mark style="color:blue;">**object**</mark>

> **고객 정보**
>
> > **`customerId`** <mark style="color:green;">**string**</mark>
> >
> > **구매자 고유 ID**
>
> > **`fullName`** <mark style="color:green;">**string**</mark>
> >
> > **구매자 전체 이름** `fullName`과 `firstName` / `lastName`이 모두 입력된 경우 `fullName`으로 기록됩니다.
>
> > **`firstName`** <mark style="color:green;">**string**</mark>
> >
> > **구매자 이름** `firstName`을 입력하는 경우 `lastName`도 필수로 입력해야 합니다. `fullName`이 없고, `firstName`과 `lastName`이 존재하는 경우 `{firstName} {lastName}`으로 저장됩니다.
>
> > **`lastName`** <mark style="color:green;">**string**</mark>
> >
> > **구매자 성** `lastName`을 입력하는 경우 `firstName`도 필수로 입력해야 합니다.
>
> > **`phoneNumber`** <mark style="color:green;">**string**</mark>
> >
> > **구매자 연락처**
>
> > **`email`** <mark style="color:green;">**string**</mark>
> >
> > **구매자 이메일 주소** 유효한 이메일 주소를 입력해주세요.
>
> > **`address`** <mark style="color:green;">**string**</mark>
> >
> > **구매자 주소**
>
> > **`zipcode`** <mark style="color:green;">**string**</mark>
> >
> > **구매자 우편번호**
>
> > **`gender`** <mark style="color:green;">**string**</mark>
> >
> > **구매자 성별** `MALE`, `FEMALE`, `OTHER` 중 하나를 입력해주세요.
>
> > **`birthYear`** <mark style="color:green;">**string**</mark>
> >
> > **구매자 출생년도** ex. `"1990"` 같은 형식으로 입력해주세요.

### **`windowType`** <mark style="color:blue;">**object**</mark>

> **결제 환경 별 제공되는 결제창 유형**
>
> * PG사에 따라 가능한 결제창이 다릅니다.
>
> * 전달되지 않았을 때 결정되는 기본 결제창이 다릅니다.
>
> * 미입력 시, 해당 PG사의 기본 결제창 방식을 따릅니다.
>
> > **`pc`** <mark style="color:green;">**string**</mark>
> >
> > **PC에서의 결제창 유형** `IFRAME`, `REDIRECTION`, `POPUP` 중 하나를 입력해주세요.
>
> > **`mobile`** <mark style="color:green;">**string**</mark>
> >
> > **모바일에서의 결제창 유형** `IFRAME`, `REDIRECTION`, `POPUP` 중 하나를 입력해주세요.

### **`redirectUrl`** <mark style="color:green;">**string**</mark>

> **리디렉션 방식에서 결제 프로세스 완료 후 이동될 가맹점 URL**
>
> * 결제창이 새로운 창으로 리다이렉트 되어 결제가 진행되는 결제 방식인 경우 필수 설정 항목 입니다.
> * 대부분의 모바일 결제환경에서 결제창 호출시 필수 항목입니다.
> * 리다이렉트 환경에서 해당 필드 누락시 에러가 발생합니다.

### **`appScheme`** <mark style="color:green;">**string**</mark>

> **모바일 결제 후 가맹점 앱으로 복귀를 위한 URL scheme**
>
> * WebView 환경 결제시 필수설정 항목 입니다.
> * ISP/앱카드 앱에서 결제정보인증 후 기존 앱으로 복귀할 때 사용합니다.

### **`locale`** <mark style="color:green;">**string**</mark>

> **결제창 언어** (지원되지 않은 일부 PG사 존재)
>
> <details>
>
> <summary>상세코드 확인하기</summary>
>
> * KO\_KR (한국어)
> * EN\_US (영어)
>
> </details>

### **`customData`** <mark style="color:blue;">**object**</mark>

> **결제 정보와 함께 관리하고 싶은 가맹점 커스텀 JSON 데이터**

### **`card`** <mark style="color:blue;">**object**</mark>

> `billingKeyMethod`가 `CARD`인 경우에만 허용됩니다.
>
> **카드 정보**
>
> * 카드 결제 시, 카드 결제에 대한 세부 정보
>
> > **`cardCompany`** <mark style="color:green;">**string**</mark>
> >
> > **카드사 다이렉트 호출 시 필요한 카드사 식별 값**
> >
> > <details>
> >
> > <summary>카드사 식별 값</summary>
> >
> > * KOREA\_DEVELOPMENT\_BANK(KDB산업은행 카드)
> > * KFCC(새마을금고 카드)
> > * SHINHYUP(신협 카드)
> > * EPOST(우체국 카드)
> > * SAVINGS\_BANK\_KOREA(저축은행 카드)
> > * KAKAO\_BANK(카카오뱅크 카드)
> > * WOORI\_CARD(우리카드)
> > * BC\_CARD(BC카드)
> > * GWANGJU\_CARD(광주카드)
> > * SAMSUNG\_CARD(삼성카드)
> > * SHINHAN\_CARD(신한카드)
> > * HYUNDAI\_CARD(현대카드)
> > * LOTTE\_CARD(롯데카드)
> > * SUHYUP\_CARD(수협카드)
> > * CITI\_CARD(씨티카드)
> > * NH\_CARD(NH 농협카드)
> > * JEONBUK\_CARD(전북카드)
> > * JEJU\_CARD(제주카드)
> > * HANA\_CARD(하나카드)
> > * KOOKMIN\_CARD(국민카드)
> > * K\_BANK(K뱅크 카드)
> > * TOSS\_BANK(토스뱅크 카드)
> >
> > </details>

### **`mobile`** <mark style="color:blue;">**object**</mark>

> `billingKeyMethod`가 `MOBILE`인 경우에만 허용됩니다.
>
> **휴대폰 소액결제 정보**
>
> * 휴대폰 소액결제 시 세부 정보
>
> > **`carrier`** <mark style="color:green;">**string**</mark>
> >
> > **휴대폰 소액결제 시 필요한 통신사 식별 값**
> >
> > <details>
> >
> > <summary>통신사 식별 값</summary>
> >
> > * CARRIER\_SKT (SKT)
> > * CARRIER\_KT (KT)
> > * CARRIER\_LGU (LGU)
> > * CARRIER\_HELLO (HELLO)
> > * CARRIER\_KCT (KCT)
> > * CARRIER\_SK7 (SK7)
> >
> > </details>