# 빌링키 관련 API

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

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

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

## ⌨ 빌링키 다건 조회

## 빌링키 다건 조회

<mark style="color:blue;">`GET`</mark> `https://api.portone.io/v2/billing-keys`

#### Query Parameters

| Name                                           | Type   | Description                                                |
| ---------------------------------------------- | ------ | ---------------------------------------------------------- |
| billing\_key<mark style="color:red;">\*</mark> | array  | 빌링키                                                        |
| store\_id                                      | string | 하위 상점 ID - 값을 넣지 않으면 Merchant 유저의 기본값으로 설정된 상점의 id가 입력됩니다. |

{% tabs %}
{% tab title="200 200 응답" %}
{% tabs %}
{% tab title="Response" %}
**`billing_keys`** <mark style="color:red;">**\***</mark> <mark style="color:red;">**Array\[BillingKey]**</mark>

빌링키 정보

<details>

<summary>BillingKey</summary>

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

빌링키

***

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

가맹점 ID

***

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

하위 상점 ID

***

**`channel`** <mark style="color:red;">**\***</mark> <mark style="color:red;">**Channel**</mark>

결제 채널 정보

***

**`origin`** <mark style="color:red;">**Origin**</mark>

결제를 요청한 근원에 대한 정보

***

**`customer`** <mark style="color:red;">**\***</mark> <mark style="color:red;">**Customer**</mark>

구매자 정보

***

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

발급 일시 (`status`가 `ISSUED`인 경우 제공)

***

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

커스텀 데이터

***

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

가맹점이 채번 하는 빌링키 발급 건 고유 ID

***

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

빌링키 발급 건 이름

***

**`payment_method_detail`** <mark style="color:red;">**\***</mark> <mark style="color:red;">**BillingKeyPaymentMethod**</mark>

빌링키 결제수단 상세정보

***

</details>

***

{% endtab %}

{% tab title="BillingKeyPaymentMethod" %}
**`card`** <mark style="color:red;">**object**</mark>

카드 정보

<details>

<summary>card</summary>

**`detail`** <mark style="color:red;">**CardDetail**</mark>

카드 정보

***

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

마스킹된 카드 번호

***

</details>

***

**`mobile`** <mark style="color:red;">**Mobile**</mark>

모바일결제 정보

<details>

<summary>Mobile</summary>

**`carrier`** <mark style="color:green;">**Carrier**</mark>

통신사

`"SKT"`, `"KT"`, `"LGU"`, `"HELLO"`, `"KCT"`, `"SK7"`

***

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

휴대전화번호

***

</details>

***

**`easy_pay`** <mark style="color:red;">**object**</mark>

간편결제 정보

<details>

<summary>easy_pay</summary>

**`provider`** <mark style="color:green;">**EasyPayProvider**</mark>

간편결제 PG사

`"PAYCO"`, `"SAMSUNGPAY"`, `"SSGPAY"`, `"KAKAOPAY"`, `"NAVERPAY"`, `"CHAI"`, `"LPAY"`, `"KPAY"`, `"TOSSPAY"`, `"LGPAY"`, `"PINPAY"`, `"APPLEPAY"`

***

</details>

***

{% endtab %}

{% tab title="CardDetail" %}
**`publisher`** <mark style="color:green;">**string**</mark>

발행사 코드

***

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

발급사 코드

***

**`brand`** <mark style="color:green;">**CardBrand**</mark>

카드 브랜드

`"LOCAL"`, `"MASTER"`, `"UNIONPAY"`, `"VISA"`, `"JCB"`, `"AMEX"`, `"DINERS"`

***

**`card_type`** <mark style="color:green;">**CardType**</mark>

카드 종류

`"CREDIT"`, `"DEBIT"`, `"GIFT"`

***

**`card_owner_type`** <mark style="color:green;">**CardOwnerType**</mark>

카드 소유주 유형

`"PERSONAL"`, `"CORPORATE"`

***

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

카드 빈넘버

***

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

카드전표인자명

***

{% endtab %}

{% tab title="Channel" %}
**`id`** <mark style="color:green;">**string**</mark>

채널 ID

***

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

채널 이름

***

**`type`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**ChannelType**</mark>

채널 유형

`"LIVE"`, `"TEST"`

***

**`pg_provider`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**PgProvider**</mark>

결제대행사(PG사)

`"HTML5_INICIS"`, `"PAYPAL"`, `"PAYPAL_V2"`, `"INICIS"`, `"DANAL"`, `"NICE"`, `"DANAL_TPAY"`, `"JTNET"`, `"UPLUS"`, `"NAVERPAY"`, `"KAKAO"`, `"SETTLE"`, `"KCP"`, `"MOBILIANS"`, `"KAKAOPAY"`, `"NAVERCO"`, `"SYRUP"`, `"KICC"`, `"EXIMBAY"`, `"SMILEPAY"`, `"PAYCO"`, `"KCP_BILLING"`, `"ALIPAY"`, `"PAYPLE"`, `"CHAI"`, `"BLUEWALNUT"`, `"SMARTRO"`, `"SMARTRO_V2"`, `"PAYMENTWALL"`, `"TOSSPAYMENTS"`, `"KCP_QUICK"`, `"DAOU"`, `"GALAXIA"`, `"TOSSPAY"`, `"KCP_DIRECT"`, `"SETTLE_ACC"`, `"SETTLE_FIRM"`, `"INICIS_UNIFIED"`, `"KSNET"`, `"PINPAY"`

***

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

PG사에 등록된 가맹점 ID

***

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Customer" %}
**`id`** <mark style="color:green;">**string**</mark>

구매자 ID

***

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

구매자 이름

***

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

구매자 생년

***

**`gender`** <mark style="color:green;">**Gender**</mark>

`"MALE"`, `"FEMALE"`, `"OTHER"`

***

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

구매자 이메일

***

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

구매자 전화번호

***

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

구매자 주소 (한 줄)

***

**`separated_address`** <mark style="color:red;">**SeparatedAddress**</mark>

구매자 주소 (단위별)

<details>

<summary>SeparatedAddress</summary>

**`country`** <mark style="color:green;">**Country**</mark>

국가

`"AF"`, `"AX"`, `"AL"`, `"DZ"`, `"AS"`, `"AD"`, `"AO"`, `"AI"`, `"AQ"`, `"AG"`, `"AR"`, `"AM"`, `"AW"`, `"AU"`, `"AT"`, `"AZ"`, `"BH"`, `"BS"`, `"BD"`, `"BB"`, `"BY"`, `"BE"`, `"BZ"`, `"BJ"`, `"BM"`, `"BT"`, `"BO"`, `"BQ"`, `"BA"`, `"BW"`, `"BV"`, `"BR"`, `"IO"`, `"BN"`, `"BG"`, `"BF"`, `"BI"`, `"KH"`, `"CM"`, `"CA"`, `"CV"`, `"KY"`, `"CF"`, `"TD"`, `"CL"`, `"CN"`, `"CX"`, `"CC"`, `"CO"`, `"KM"`, `"CG"`, `"CD"`, `"CK"`, `"CR"`, `"CI"`, `"HR"`, `"CU"`, `"CW"`, `"CY"`, `"CZ"`, `"DK"`, `"DJ"`, `"DM"`, `"DO"`, `"EC"`, `"EG"`, `"SV"`, `"GQ"`, `"ER"`, `"EE"`, `"ET"`, `"FK"`, `"FO"`, `"FJ"`, `"FI"`, `"FR"`, `"GF"`, `"PF"`, `"TF"`, `"GA"`, `"GM"`, `"GE"`, `"DE"`, `"GH"`, `"GI"`, `"GR"`, `"GL"`, `"GD"`, `"GP"`, `"GU"`, `"GT"`, `"GG"`, `"GN"`, `"GW"`, `"GY"`, `"HT"`, `"HM"`, `"VA"`, `"HN"`, `"HK"`, `"HU"`, `"IS"`, `"IN"`, `"ID"`, `"IR"`, `"IQ"`, `"IE"`, `"IM"`, `"IL"`, `"IT"`, `"JM"`, `"JP"`, `"JE"`, `"JO"`, `"KZ"`, `"KE"`, `"KI"`, `"KP"`, `"KR"`, `"KW"`, `"KG"`, `"LA"`, `"LV"`, `"LB"`, `"LS"`, `"LR"`, `"LY"`, `"LI"`, `"LT"`, `"LU"`, `"MO"`, `"MK"`, `"MG"`, `"MW"`, `"MY"`, `"MV"`, `"ML"`, `"MT"`, `"MH"`, `"MQ"`, `"MR"`, `"MU"`, `"YT"`, `"MX"`, `"FM"`, `"MD"`, `"MC"`, `"MN"`, `"ME"`, `"MS"`, `"MA"`, `"MZ"`, `"MM"`, `"NA"`, `"NR"`, `"NP"`, `"NL"`, `"NC"`, `"NZ"`, `"NI"`, `"NE"`, `"NG"`, `"NU"`, `"NF"`, `"MP"`, `"NO"`, `"OM"`, `"PK"`, `"PW"`, `"PS"`, `"PA"`, `"PG"`, `"PY"`, `"PE"`, `"PH"`, `"PN"`, `"PL"`, `"PT"`, `"PR"`, `"QA"`, `"RE"`, `"RO"`, `"RU"`, `"RW"`, `"BL"`, `"SH"`, `"KN"`, `"LC"`, `"MF"`, `"PM"`, `"VC"`, `"WS"`, `"SM"`, `"ST"`, `"SA"`, `"SN"`, `"RS"`, `"SC"`, `"SL"`, `"SG"`, `"SX"`, `"SK"`, `"SI"`, `"SB"`, `"SO"`, `"ZA"`, `"GS"`, `"SS"`, `"ES"`, `"LK"`, `"SD"`, `"SR"`, `"SJ"`, `"SZ"`, `"SE"`, `"CH"`, `"SY"`, `"TW"`, `"TJ"`, `"TZ"`, `"TH"`, `"TL"`, `"TG"`, `"TK"`, `"TO"`, `"TT"`, `"TN"`, `"TR"`, `"TM"`, `"TC"`, `"TV"`, `"UG"`, `"UA"`, `"AE"`, `"GB"`, `"US"`, `"UM"`, `"UY"`, `"UZ"`, `"VU"`, `"VE"`, `"VN"`, `"VG"`, `"VI"`, `"WF"`, `"EH"`, `"YE"`, `"ZM"`, `"ZW"`

***

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

시/도/구

***

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

도시

***

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

일반 주소

***

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

상세 주소

***

</details>

***

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

구매자 우편번호

***

{% endtab %}

{% tab title="Origin" %}
**`platform_type`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

결제를 요청한 단말의 플랫폼 분류

`"PC"`, `"MOBILE"`, `"API"`

***

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

결제근원의 환경 정보 (Http 의 User-Agent header value)

***

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

결제근원의 페이지 url

***

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

결제근원의 IP 주소

***

{% endtab %}
{% endtabs %}
{% endtab %}

{% tab title="401 인증 실패" %}
{% tabs %}
{% tab title="Response" %}
**`code`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

`"UNAUTHORIZED"`

***

**`params`** <mark style="color:red;">**object**</mark>

에러 세부사항

***

{% endtab %}
{% endtabs %}
{% endtab %}

{% tab title="500 내부 서버 오류" %}
{% tabs %}
{% tab title="Response" %}
**`code`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

`"PORTONE_ERROR"`

***

**`params`** <mark style="color:red;">**object**</mark>

에러 세부사항

***

{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}

## ⌨ 빌링키 발급

## 빌링키 발급

<mark style="color:green;">`POST`</mark> `https://api.portone.io/v2/billing-keys`

#### Request Body

| Name                                                      | Type                               | Description                                                                                                                               |
| --------------------------------------------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| store\_id                                                 | string                             | 하위 상점 ID                                                                                                                                  |
| customer                                                  | CustomerForm                       | 고객 정보                                                                                                                                     |
| custom\_data                                              | string                             |                                                                                                                                           |
| channel\_name<mark style="color:red;">\*</mark>           | string                             | 결제 채널 이름                                                                                                                                  |
| payment\_method\_option<mark style="color:red;">\*</mark> | InstantBillingKeyPaymentMethodForm | <p>가능한 결제 수단: 카드, 휴대폰 소액 결제 선택한 결제 수단에 따라</p><p><code>card</code></p><p>와</p><p><code>mobile\_phone</code></p><p>중 하나에만 값이 들어있어야 합니다.</p> |

{% tabs %}
{% tab title="200 빌링키 발급 성공" %}
{% tabs %}
{% tab title="Response" %}
**`billing_key`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

***

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

***

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

***

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

***

{% endtab %}
{% endtabs %}
{% endtab %}

{% tab title="400 잘못된 요청" %}
{% tabs %}
{% tab title="Response" %}
**`code`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

`INVALID_REQUEST`: 파라미터를 포함한 요청을 처리하는 데에 실패했습니다. 올바른 형식의 파라미터를 전송했는지 확인해주세요.\\

`"INVALID_REQUEST"`

***

**`params`** <mark style="color:red;">**object**</mark>

에러 상세 정보를 담은 파라미터 모음

***

{% endtab %}
{% endtabs %}
{% endtab %}

{% tab title="401 인증 실패" %}
{% tabs %}
{% tab title="Response" %}
**`code`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

`UNAUTHORIZED`: 권한이 없습니다. 올바른 API Key를 헤더에 제공했는지 확인해주세요.\\

`"UNAUTHORIZED"`

***

**`params`** <mark style="color:red;">**object**</mark>

에러 상세 정보를 담은 파라미터 모음

***

{% endtab %}
{% endtabs %}
{% endtab %}

{% tab title="403 권한 없음" %}
{% tabs %}
{% tab title="Response" %}
**`code`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

`PERMISSION_DENIED`: 해당 요청을 수행하기 위한 권한이 없습니다.\\

`"PERMISSION_DENIED"`

***

**`params`** <mark style="color:red;">**object**</mark>

에러 상세 정보를 담은 파라미터 모음

***

{% endtab %}
{% endtabs %}
{% endtab %}

{% tab title="404 하위 상점이나 결제 채널을 찾을 수 없습니다." %}
{% tabs %}
{% tab title="Response" %}
**`code`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

`STORE_NOT_FOUND`: 하위 상점을 찾을 수 없습니다.\
`CHANNEL_NOT_FOUND`: 결제 채널을 찾을 수 없습니다.\\

`"STORE_NOT_FOUND"`, `"CHANNEL_NOT_FOUND"`

***

**`params`** <mark style="color:red;">**object**</mark>

에러 상세 정보를 담은 파라미터 모음

***

{% endtab %}
{% endtabs %}
{% endtab %}

{% tab title="500 내부 서버 에러" %}
{% tabs %}
{% tab title="Response" %}
**`code`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

`"PORTONE_ERROR"`, `"PG_PROVIDER_ERROR"`

***

**`params`** <mark style="color:red;">**object**</mark>

에러 상세 정보를 담은 파라미터 모음

***

{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Address" %}
**`address_line_1`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

주소1

***

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

주소2

***

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

도시

***

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

주, 도, 시

***

**`country`** <mark style="color:green;">**Country**</mark>

국가

`"AF"`, `"AX"`, `"AL"`, `"DZ"`, `"AS"`, `"AD"`, `"AO"`, `"AI"`, `"AQ"`, `"AG"`, `"AR"`, `"AM"`, `"AW"`, `"AU"`, `"AT"`, `"AZ"`, `"BH"`, `"BS"`, `"BD"`, `"BB"`, `"BY"`, `"BE"`, `"BZ"`, `"BJ"`, `"BM"`, `"BT"`, `"BO"`, `"BQ"`, `"BA"`, `"BW"`, `"BV"`, `"BR"`, `"IO"`, `"BN"`, `"BG"`, `"BF"`, `"BI"`, `"KH"`, `"CM"`, `"CA"`, `"CV"`, `"KY"`, `"CF"`, `"TD"`, `"CL"`, `"CN"`, `"CX"`, `"CC"`, `"CO"`, `"KM"`, `"CG"`, `"CD"`, `"CK"`, `"CR"`, `"CI"`, `"HR"`, `"CU"`, `"CW"`, `"CY"`, `"CZ"`, `"DK"`, `"DJ"`, `"DM"`, `"DO"`, `"EC"`, `"EG"`, `"SV"`, `"GQ"`, `"ER"`, `"EE"`, `"ET"`, `"FK"`, `"FO"`, `"FJ"`, `"FI"`, `"FR"`, `"GF"`, `"PF"`, `"TF"`, `"GA"`, `"GM"`, `"GE"`, `"DE"`, `"GH"`, `"GI"`, `"GR"`, `"GL"`, `"GD"`, `"GP"`, `"GU"`, `"GT"`, `"GG"`, `"GN"`, `"GW"`, `"GY"`, `"HT"`, `"HM"`, `"VA"`, `"HN"`, `"HK"`, `"HU"`, `"IS"`, `"IN"`, `"ID"`, `"IR"`, `"IQ"`, `"IE"`, `"IM"`, `"IL"`, `"IT"`, `"JM"`, `"JP"`, `"JE"`, `"JO"`, `"KZ"`, `"KE"`, `"KI"`, `"KP"`, `"KR"`, `"KW"`, `"KG"`, `"LA"`, `"LV"`, `"LB"`, `"LS"`, `"LR"`, `"LY"`, `"LI"`, `"LT"`, `"LU"`, `"MO"`, `"MK"`, `"MG"`, `"MW"`, `"MY"`, `"MV"`, `"ML"`, `"MT"`, `"MH"`, `"MQ"`, `"MR"`, `"MU"`, `"YT"`, `"MX"`, `"FM"`, `"MD"`, `"MC"`, `"MN"`, `"ME"`, `"MS"`, `"MA"`, `"MZ"`, `"MM"`, `"NA"`, `"NR"`, `"NP"`, `"NL"`, `"NC"`, `"NZ"`, `"NI"`, `"NE"`, `"NG"`, `"NU"`, `"NF"`, `"MP"`, `"NO"`, `"OM"`, `"PK"`, `"PW"`, `"PS"`, `"PA"`, `"PG"`, `"PY"`, `"PE"`, `"PH"`, `"PN"`, `"PL"`, `"PT"`, `"PR"`, `"QA"`, `"RE"`, `"RO"`, `"RU"`, `"RW"`, `"BL"`, `"SH"`, `"KN"`, `"LC"`, `"MF"`, `"PM"`, `"VC"`, `"WS"`, `"SM"`, `"ST"`, `"SA"`, `"SN"`, `"RS"`, `"SC"`, `"SL"`, `"SG"`, `"SX"`, `"SK"`, `"SI"`, `"SB"`, `"SO"`, `"ZA"`, `"GS"`, `"SS"`, `"ES"`, `"LK"`, `"SD"`, `"SR"`, `"SJ"`, `"SZ"`, `"SE"`, `"CH"`, `"SY"`, `"TW"`, `"TJ"`, `"TZ"`, `"TH"`, `"TL"`, `"TG"`, `"TK"`, `"TO"`, `"TT"`, `"TN"`, `"TR"`, `"TM"`, `"TC"`, `"TV"`, `"UG"`, `"UA"`, `"AE"`, `"GB"`, `"US"`, `"UM"`, `"UY"`, `"UZ"`, `"VU"`, `"VE"`, `"VN"`, `"VG"`, `"VI"`, `"WF"`, `"EH"`, `"YE"`, `"ZM"`, `"ZW"`

***

{% endtab %}

{% tab title="CardCredential" %}
**`card_number`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

***

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

***

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

***

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

***

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

***

{% endtab %}

{% tab title="Carrier" %}
휴대폰 통신사

`"SKT"`, `"KT"`, `"LGU"`, `"HELLO"`, `"KCT"`, `"SK7"`
{% endtab %}

{% tab title="Country" %}
국가

`"AF"`, `"AX"`, `"AL"`, `"DZ"`, `"AS"`, `"AD"`, `"AO"`, `"AI"`, `"AQ"`, `"AG"`, `"AR"`, `"AM"`, `"AW"`, `"AU"`, `"AT"`, `"AZ"`, `"BH"`, `"BS"`, `"BD"`, `"BB"`, `"BY"`, `"BE"`, `"BZ"`, `"BJ"`, `"BM"`, `"BT"`, `"BO"`, `"BQ"`, `"BA"`, `"BW"`, `"BV"`, `"BR"`, `"IO"`, `"BN"`, `"BG"`, `"BF"`, `"BI"`, `"KH"`, `"CM"`, `"CA"`, `"CV"`, `"KY"`, `"CF"`, `"TD"`, `"CL"`, `"CN"`, `"CX"`, `"CC"`, `"CO"`, `"KM"`, `"CG"`, `"CD"`, `"CK"`, `"CR"`, `"CI"`, `"HR"`, `"CU"`, `"CW"`, `"CY"`, `"CZ"`, `"DK"`, `"DJ"`, `"DM"`, `"DO"`, `"EC"`, `"EG"`, `"SV"`, `"GQ"`, `"ER"`, `"EE"`, `"ET"`, `"FK"`, `"FO"`, `"FJ"`, `"FI"`, `"FR"`, `"GF"`, `"PF"`, `"TF"`, `"GA"`, `"GM"`, `"GE"`, `"DE"`, `"GH"`, `"GI"`, `"GR"`, `"GL"`, `"GD"`, `"GP"`, `"GU"`, `"GT"`, `"GG"`, `"GN"`, `"GW"`, `"GY"`, `"HT"`, `"HM"`, `"VA"`, `"HN"`, `"HK"`, `"HU"`, `"IS"`, `"IN"`, `"ID"`, `"IR"`, `"IQ"`, `"IE"`, `"IM"`, `"IL"`, `"IT"`, `"JM"`, `"JP"`, `"JE"`, `"JO"`, `"KZ"`, `"KE"`, `"KI"`, `"KP"`, `"KR"`, `"KW"`, `"KG"`, `"LA"`, `"LV"`, `"LB"`, `"LS"`, `"LR"`, `"LY"`, `"LI"`, `"LT"`, `"LU"`, `"MO"`, `"MK"`, `"MG"`, `"MW"`, `"MY"`, `"MV"`, `"ML"`, `"MT"`, `"MH"`, `"MQ"`, `"MR"`, `"MU"`, `"YT"`, `"MX"`, `"FM"`, `"MD"`, `"MC"`, `"MN"`, `"ME"`, `"MS"`, `"MA"`, `"MZ"`, `"MM"`, `"NA"`, `"NR"`, `"NP"`, `"NL"`, `"NC"`, `"NZ"`, `"NI"`, `"NE"`, `"NG"`, `"NU"`, `"NF"`, `"MP"`, `"NO"`, `"OM"`, `"PK"`, `"PW"`, `"PS"`, `"PA"`, `"PG"`, `"PY"`, `"PE"`, `"PH"`, `"PN"`, `"PL"`, `"PT"`, `"PR"`, `"QA"`, `"RE"`, `"RO"`, `"RU"`, `"RW"`, `"BL"`, `"SH"`, `"KN"`, `"LC"`, `"MF"`, `"PM"`, `"VC"`, `"WS"`, `"SM"`, `"ST"`, `"SA"`, `"SN"`, `"RS"`, `"SC"`, `"SL"`, `"SG"`, `"SX"`, `"SK"`, `"SI"`, `"SB"`, `"SO"`, `"ZA"`, `"GS"`, `"SS"`, `"ES"`, `"LK"`, `"SD"`, `"SR"`, `"SJ"`, `"SZ"`, `"SE"`, `"CH"`, `"SY"`, `"TW"`, `"TJ"`, `"TZ"`, `"TH"`, `"TL"`, `"TG"`, `"TK"`, `"TO"`, `"TT"`, `"TN"`, `"TR"`, `"TM"`, `"TC"`, `"TV"`, `"UG"`, `"UA"`, `"AE"`, `"GB"`, `"US"`, `"UM"`, `"UY"`, `"UZ"`, `"VU"`, `"VE"`, `"VN"`, `"VG"`, `"VI"`, `"WF"`, `"EH"`, `"YE"`, `"ZM"`, `"ZW"`
{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="CustomerForm" %}
**`customer_id`** <mark style="color:green;">**string**</mark>

가맹점의 고객 고유 ID - 값을 넣지 않으면 PortOne에서 자체 채번합니다.

***

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

휴대폰 번호

***

**`customer_name`** <mark style="color:red;">**CustomerName**</mark>

고객 이름 정보. full\_name만 채워져 있거나, first\_name & last\_name이 채워져 있어야 함

<details>

<summary>CustomerName</summary>

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

***

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

***

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

***

</details>

***

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

고객 이메일

***

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

우편번호

***

**`address`** <mark style="color:red;">**Address**</mark>

주소 형식

<details>

<summary>Address</summary>

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

주소1

***

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

주소2

***

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

도시

***

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

주, 도, 시

***

**`country`** <mark style="color:green;">**Country**</mark>

국가

`"AF"`, `"AX"`, `"AL"`, `"DZ"`, `"AS"`, `"AD"`, `"AO"`, `"AI"`, `"AQ"`, `"AG"`, `"AR"`, `"AM"`, `"AW"`, `"AU"`, `"AT"`, `"AZ"`, `"BH"`, `"BS"`, `"BD"`, `"BB"`, `"BY"`, `"BE"`, `"BZ"`, `"BJ"`, `"BM"`, `"BT"`, `"BO"`, `"BQ"`, `"BA"`, `"BW"`, `"BV"`, `"BR"`, `"IO"`, `"BN"`, `"BG"`, `"BF"`, `"BI"`, `"KH"`, `"CM"`, `"CA"`, `"CV"`, `"KY"`, `"CF"`, `"TD"`, `"CL"`, `"CN"`, `"CX"`, `"CC"`, `"CO"`, `"KM"`, `"CG"`, `"CD"`, `"CK"`, `"CR"`, `"CI"`, `"HR"`, `"CU"`, `"CW"`, `"CY"`, `"CZ"`, `"DK"`, `"DJ"`, `"DM"`, `"DO"`, `"EC"`, `"EG"`, `"SV"`, `"GQ"`, `"ER"`, `"EE"`, `"ET"`, `"FK"`, `"FO"`, `"FJ"`, `"FI"`, `"FR"`, `"GF"`, `"PF"`, `"TF"`, `"GA"`, `"GM"`, `"GE"`, `"DE"`, `"GH"`, `"GI"`, `"GR"`, `"GL"`, `"GD"`, `"GP"`, `"GU"`, `"GT"`, `"GG"`, `"GN"`, `"GW"`, `"GY"`, `"HT"`, `"HM"`, `"VA"`, `"HN"`, `"HK"`, `"HU"`, `"IS"`, `"IN"`, `"ID"`, `"IR"`, `"IQ"`, `"IE"`, `"IM"`, `"IL"`, `"IT"`, `"JM"`, `"JP"`, `"JE"`, `"JO"`, `"KZ"`, `"KE"`, `"KI"`, `"KP"`, `"KR"`, `"KW"`, `"KG"`, `"LA"`, `"LV"`, `"LB"`, `"LS"`, `"LR"`, `"LY"`, `"LI"`, `"LT"`, `"LU"`, `"MO"`, `"MK"`, `"MG"`, `"MW"`, `"MY"`, `"MV"`, `"ML"`, `"MT"`, `"MH"`, `"MQ"`, `"MR"`, `"MU"`, `"YT"`, `"MX"`, `"FM"`, `"MD"`, `"MC"`, `"MN"`, `"ME"`, `"MS"`, `"MA"`, `"MZ"`, `"MM"`, `"NA"`, `"NR"`, `"NP"`, `"NL"`, `"NC"`, `"NZ"`, `"NI"`, `"NE"`, `"NG"`, `"NU"`, `"NF"`, `"MP"`, `"NO"`, `"OM"`, `"PK"`, `"PW"`, `"PS"`, `"PA"`, `"PG"`, `"PY"`, `"PE"`, `"PH"`, `"PN"`, `"PL"`, `"PT"`, `"PR"`, `"QA"`, `"RE"`, `"RO"`, `"RU"`, `"RW"`, `"BL"`, `"SH"`, `"KN"`, `"LC"`, `"MF"`, `"PM"`, `"VC"`, `"WS"`, `"SM"`, `"ST"`, `"SA"`, `"SN"`, `"RS"`, `"SC"`, `"SL"`, `"SG"`, `"SX"`, `"SK"`, `"SI"`, `"SB"`, `"SO"`, `"ZA"`, `"GS"`, `"SS"`, `"ES"`, `"LK"`, `"SD"`, `"SR"`, `"SJ"`, `"SZ"`, `"SE"`, `"CH"`, `"SY"`, `"TW"`, `"TJ"`, `"TZ"`, `"TH"`, `"TL"`, `"TG"`, `"TK"`, `"TO"`, `"TT"`, `"TN"`, `"TR"`, `"TM"`, `"TC"`, `"TV"`, `"UG"`, `"UA"`, `"AE"`, `"GB"`, `"US"`, `"UM"`, `"UY"`, `"UZ"`, `"VU"`, `"VE"`, `"VN"`, `"VG"`, `"VI"`, `"WF"`, `"EH"`, `"YE"`, `"ZM"`, `"ZW"`

***

</details>

***

**`gender`** <mark style="color:green;">**Gender**</mark>

성별

`"MALE"`, `"FEMALE"`, `"OTHER"`

***

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

출생연도

***

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

출생월

***

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

출생일

***

**`country`** <mark style="color:green;">**Country**</mark>

국가

`"AF"`, `"AX"`, `"AL"`, `"DZ"`, `"AS"`, `"AD"`, `"AO"`, `"AI"`, `"AQ"`, `"AG"`, `"AR"`, `"AM"`, `"AW"`, `"AU"`, `"AT"`, `"AZ"`, `"BH"`, `"BS"`, `"BD"`, `"BB"`, `"BY"`, `"BE"`, `"BZ"`, `"BJ"`, `"BM"`, `"BT"`, `"BO"`, `"BQ"`, `"BA"`, `"BW"`, `"BV"`, `"BR"`, `"IO"`, `"BN"`, `"BG"`, `"BF"`, `"BI"`, `"KH"`, `"CM"`, `"CA"`, `"CV"`, `"KY"`, `"CF"`, `"TD"`, `"CL"`, `"CN"`, `"CX"`, `"CC"`, `"CO"`, `"KM"`, `"CG"`, `"CD"`, `"CK"`, `"CR"`, `"CI"`, `"HR"`, `"CU"`, `"CW"`, `"CY"`, `"CZ"`, `"DK"`, `"DJ"`, `"DM"`, `"DO"`, `"EC"`, `"EG"`, `"SV"`, `"GQ"`, `"ER"`, `"EE"`, `"ET"`, `"FK"`, `"FO"`, `"FJ"`, `"FI"`, `"FR"`, `"GF"`, `"PF"`, `"TF"`, `"GA"`, `"GM"`, `"GE"`, `"DE"`, `"GH"`, `"GI"`, `"GR"`, `"GL"`, `"GD"`, `"GP"`, `"GU"`, `"GT"`, `"GG"`, `"GN"`, `"GW"`, `"GY"`, `"HT"`, `"HM"`, `"VA"`, `"HN"`, `"HK"`, `"HU"`, `"IS"`, `"IN"`, `"ID"`, `"IR"`, `"IQ"`, `"IE"`, `"IM"`, `"IL"`, `"IT"`, `"JM"`, `"JP"`, `"JE"`, `"JO"`, `"KZ"`, `"KE"`, `"KI"`, `"KP"`, `"KR"`, `"KW"`, `"KG"`, `"LA"`, `"LV"`, `"LB"`, `"LS"`, `"LR"`, `"LY"`, `"LI"`, `"LT"`, `"LU"`, `"MO"`, `"MK"`, `"MG"`, `"MW"`, `"MY"`, `"MV"`, `"ML"`, `"MT"`, `"MH"`, `"MQ"`, `"MR"`, `"MU"`, `"YT"`, `"MX"`, `"FM"`, `"MD"`, `"MC"`, `"MN"`, `"ME"`, `"MS"`, `"MA"`, `"MZ"`, `"MM"`, `"NA"`, `"NR"`, `"NP"`, `"NL"`, `"NC"`, `"NZ"`, `"NI"`, `"NE"`, `"NG"`, `"NU"`, `"NF"`, `"MP"`, `"NO"`, `"OM"`, `"PK"`, `"PW"`, `"PS"`, `"PA"`, `"PG"`, `"PY"`, `"PE"`, `"PH"`, `"PN"`, `"PL"`, `"PT"`, `"PR"`, `"QA"`, `"RE"`, `"RO"`, `"RU"`, `"RW"`, `"BL"`, `"SH"`, `"KN"`, `"LC"`, `"MF"`, `"PM"`, `"VC"`, `"WS"`, `"SM"`, `"ST"`, `"SA"`, `"SN"`, `"RS"`, `"SC"`, `"SL"`, `"SG"`, `"SX"`, `"SK"`, `"SI"`, `"SB"`, `"SO"`, `"ZA"`, `"GS"`, `"SS"`, `"ES"`, `"LK"`, `"SD"`, `"SR"`, `"SJ"`, `"SZ"`, `"SE"`, `"CH"`, `"SY"`, `"TW"`, `"TJ"`, `"TZ"`, `"TH"`, `"TL"`, `"TG"`, `"TK"`, `"TO"`, `"TT"`, `"TN"`, `"TR"`, `"TM"`, `"TC"`, `"TV"`, `"UG"`, `"UA"`, `"AE"`, `"GB"`, `"US"`, `"UM"`, `"UY"`, `"UZ"`, `"VU"`, `"VE"`, `"VN"`, `"VG"`, `"VI"`, `"WF"`, `"EH"`, `"YE"`, `"ZM"`, `"ZW"`

***

{% endtab %}

{% tab title="CustomerName" %}
**`full_name`** <mark style="color:green;">**string**</mark>

***

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

***

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

***

{% endtab %}

{% tab title="Gender" %}
성별

`"MALE"`, `"FEMALE"`, `"OTHER"`
{% endtab %}

{% tab title="InstantBillingKeyCardForm" %}
**`card_credential`** <mark style="color:red;">**\***</mark> <mark style="color:red;">**CardCredential**</mark>

카드를 이용한 결제 및 빌링키 발급에 필요한 인증 관련 정보

<details>

<summary>CardCredential</summary>

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

***

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

***

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

***

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

***

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

***

</details>

***

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

***

**`vbv`** <mark style="color:red;">**VBV**</mark>

3DS 인증 결과를 담는 객체 (Verified by Visa)

<details>

<summary>VBV</summary>

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

***

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

***

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

***

</details>

***

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="InstantBillingKeyPaymentMethodForm" %}
**`card`** <mark style="color:red;">**InstantBillingKeyCardForm**</mark>

빌링키 발급 시에 필요한 카드 관련 정보

<details>

<summary>InstantBillingKeyCardForm</summary>

**`card_credential`** <mark style="color:red;">**\***</mark> <mark style="color:red;">**CardCredential**</mark>

카드를 이용한 결제 및 빌링키 발급에 필요한 인증 관련 정보

***

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

***

**`vbv`** <mark style="color:red;">**VBV**</mark>

3DS 인증 결과를 담는 객체 (Verified by Visa)

***

</details>

***

**`mobile_phone`** <mark style="color:red;">**MobileForm**</mark>

휴대폰을 이용한 소액결제와 정기결제를 위한 빌링키 발급 시에 사용하는 휴대폰 관련 정보

<details>

<summary>MobileForm</summary>

**`carrier`** <mark style="color:green;">**Carrier**</mark>

휴대폰 통신사

`"SKT"`, `"KT"`, `"LGU"`, `"HELLO"`, `"KCT"`, `"SK7"`

***

</details>

***

{% endtab %}

{% tab title="MobileForm" %}
**`carrier`** <mark style="color:green;">**Carrier**</mark>

휴대폰 통신사

`"SKT"`, `"KT"`, `"LGU"`, `"HELLO"`, `"KCT"`, `"SK7"`

***

{% endtab %}

{% tab title="VBV" %}
**`cavv`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

***

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

***

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

***

{% endtab %}
{% endtabs %}

## ⌨ 빌링키 단건 조회

## 빌링키 단건 조회

<mark style="color:blue;">`GET`</mark> `https://api.portone.io/v2/billing-keys/{billing_key}`

#### Path Parameters

| Name                                           | Type   | Description |
| ---------------------------------------------- | ------ | ----------- |
| billing\_key<mark style="color:red;">\*</mark> | string | 빌링키         |

#### Query Parameters

| Name      | Type   | Description                                                |
| --------- | ------ | ---------------------------------------------------------- |
| store\_id | string | 하위 상점 ID - 값을 넣지 않으면 Merchant 유저의 기본값으로 설정된 상점의 id가 입력됩니다. |

{% tabs %}
{% tab title="200 200 응답" %}
{% tabs %}
{% tab title="Response" %}
**`billing_key`** <mark style="color:red;">**\***</mark> <mark style="color:red;">**BillingKey**</mark>

빌링키 정보

<details>

<summary>BillingKey</summary>

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

빌링키

***

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

가맹점 ID

***

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

하위 상점 ID

***

**`channel`** <mark style="color:red;">**\***</mark> <mark style="color:red;">**channel\_Channel**</mark>

결제 채널 정보

***

**`origin`** <mark style="color:red;">**Origin**</mark>

결제를 요청한 근원에 대한 정보

***

**`customer`** <mark style="color:red;">**\***</mark> <mark style="color:red;">**Customer**</mark>

구매자 정보

***

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

발급 일시 (`status`가 `ISSUED`인 경우 제공)

***

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

커스텀 데이터

***

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

가맹점이 채번 하는 빌링키 발급 건 고유 ID

***

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

빌링키 발급 건 이름

***

**`payment_method_detail`** <mark style="color:red;">**\***</mark> <mark style="color:red;">**BillingKeyPaymentMethod**</mark>

빌링키 결제수단 상세정보

***

</details>

***

{% endtab %}

{% tab title="BillingKeyPaymentMethod" %}
**`card`** <mark style="color:red;">**object**</mark>

카드 정보

<details>

<summary>card</summary>

**`detail`** <mark style="color:red;">**CardDetail**</mark>

카드 정보

***

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

마스킹된 카드 번호

***

</details>

***

**`mobile`** <mark style="color:red;">**Mobile**</mark>

모바일결제 정보

<details>

<summary>Mobile</summary>

**`carrier`** <mark style="color:green;">**Carrier**</mark>

통신사

`"SKT"`, `"KT"`, `"LGU"`, `"HELLO"`, `"KCT"`, `"SK7"`

***

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

휴대전화번호

***

</details>

***

**`easy_pay`** <mark style="color:red;">**object**</mark>

간편결제 정보

<details>

<summary>easy_pay</summary>

**`provider`** <mark style="color:green;">**EasyPayProvider**</mark>

간편결제 PG사

`"PAYCO"`, `"SAMSUNGPAY"`, `"SSGPAY"`, `"KAKAOPAY"`, `"NAVERPAY"`, `"CHAI"`, `"LPAY"`, `"KPAY"`, `"TOSSPAY"`, `"LGPAY"`, `"PINPAY"`, `"APPLEPAY"`

***

</details>

***

{% endtab %}

{% tab title="CardDetail" %}
**`publisher`** <mark style="color:green;">**string**</mark>

발행사 코드

***

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

발급사 코드

***

**`brand`** <mark style="color:green;">**CardBrand**</mark>

카드 브랜드

`"LOCAL"`, `"MASTER"`, `"UNIONPAY"`, `"VISA"`, `"JCB"`, `"AMEX"`, `"DINERS"`

***

**`card_type`** <mark style="color:green;">**CardType**</mark>

카드 종류

`"CREDIT"`, `"DEBIT"`, `"GIFT"`

***

**`card_owner_type`** <mark style="color:green;">**CardOwnerType**</mark>

카드 소유주 유형

`"PERSONAL"`, `"CORPORATE"`

***

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

카드 빈넘버

***

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

카드전표인자명

***

{% endtab %}

{% tab title="channel\_Channel" %}
**`id`** <mark style="color:green;">**string**</mark>

채널 ID

***

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

채널 이름

***

**`type`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**channel\_ChannelType**</mark>

채널 유형

`"LIVE"`, `"TEST"`

***

**`pg_provider`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**pg\_provider\_PgProvider-2**</mark>

결제대행사(PG사)

`"HTML5_INICIS"`, `"PAYPAL"`, `"PAYPAL_V2"`, `"INICIS"`, `"DANAL"`, `"NICE"`, `"DANAL_TPAY"`, `"JTNET"`, `"UPLUS"`, `"NAVERPAY"`, `"KAKAO"`, `"SETTLE"`, `"KCP"`, `"MOBILIANS"`, `"KAKAOPAY"`, `"NAVERCO"`, `"SYRUP"`, `"KICC"`, `"EXIMBAY"`, `"SMILEPAY"`, `"PAYCO"`, `"KCP_BILLING"`, `"ALIPAY"`, `"PAYPLE"`, `"CHAI"`, `"BLUEWALNUT"`, `"SMARTRO"`, `"SMARTRO_V2"`, `"PAYMENTWALL"`, `"TOSSPAYMENTS"`, `"KCP_QUICK"`, `"DAOU"`, `"GALAXIA"`, `"TOSSPAY"`, `"KCP_DIRECT"`, `"SETTLE_ACC"`, `"SETTLE_FIRM"`, `"INICIS_UNIFIED"`, `"KSNET"`, `"PINPAY"`

***

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

PG사에 등록된 가맹점 ID

***

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Customer" %}
**`id`** <mark style="color:green;">**string**</mark>

구매자 ID

***

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

구매자 이름

***

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

구매자 생년

***

**`gender`** <mark style="color:green;">**Gender**</mark>

`"MALE"`, `"FEMALE"`, `"OTHER"`

***

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

구매자 이메일

***

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

구매자 전화번호

***

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

구매자 주소 (한 줄)

***

**`separated_address`** <mark style="color:red;">**SeparatedAddress**</mark>

구매자 주소 (단위별)

<details>

<summary>SeparatedAddress</summary>

**`country`** <mark style="color:green;">**Country**</mark>

국가 코드

`"AF"`, `"AX"`, `"AL"`, `"DZ"`, `"AS"`, `"AD"`, `"AO"`, `"AI"`, `"AQ"`, `"AG"`, `"AR"`, `"AM"`, `"AW"`, `"AU"`, `"AT"`, `"AZ"`, `"BH"`, `"BS"`, `"BD"`, `"BB"`, `"BY"`, `"BE"`, `"BZ"`, `"BJ"`, `"BM"`, `"BT"`, `"BO"`, `"BQ"`, `"BA"`, `"BW"`, `"BV"`, `"BR"`, `"IO"`, `"BN"`, `"BG"`, `"BF"`, `"BI"`, `"KH"`, `"CM"`, `"CA"`, `"CV"`, `"KY"`, `"CF"`, `"TD"`, `"CL"`, `"CN"`, `"CX"`, `"CC"`, `"CO"`, `"KM"`, `"CG"`, `"CD"`, `"CK"`, `"CR"`, `"CI"`, `"HR"`, `"CU"`, `"CW"`, `"CY"`, `"CZ"`, `"DK"`, `"DJ"`, `"DM"`, `"DO"`, `"EC"`, `"EG"`, `"SV"`, `"GQ"`, `"ER"`, `"EE"`, `"ET"`, `"FK"`, `"FO"`, `"FJ"`, `"FI"`, `"FR"`, `"GF"`, `"PF"`, `"TF"`, `"GA"`, `"GM"`, `"GE"`, `"DE"`, `"GH"`, `"GI"`, `"GR"`, `"GL"`, `"GD"`, `"GP"`, `"GU"`, `"GT"`, `"GG"`, `"GN"`, `"GW"`, `"GY"`, `"HT"`, `"HM"`, `"VA"`, `"HN"`, `"HK"`, `"HU"`, `"IS"`, `"IN"`, `"ID"`, `"IR"`, `"IQ"`, `"IE"`, `"IM"`, `"IL"`, `"IT"`, `"JM"`, `"JP"`, `"JE"`, `"JO"`, `"KZ"`, `"KE"`, `"KI"`, `"KP"`, `"KR"`, `"KW"`, `"KG"`, `"LA"`, `"LV"`, `"LB"`, `"LS"`, `"LR"`, `"LY"`, `"LI"`, `"LT"`, `"LU"`, `"MO"`, `"MK"`, `"MG"`, `"MW"`, `"MY"`, `"MV"`, `"ML"`, `"MT"`, `"MH"`, `"MQ"`, `"MR"`, `"MU"`, `"YT"`, `"MX"`, `"FM"`, `"MD"`, `"MC"`, `"MN"`, `"ME"`, `"MS"`, `"MA"`, `"MZ"`, `"MM"`, `"NA"`, `"NR"`, `"NP"`, `"NL"`, `"NC"`, `"NZ"`, `"NI"`, `"NE"`, `"NG"`, `"NU"`, `"NF"`, `"MP"`, `"NO"`, `"OM"`, `"PK"`, `"PW"`, `"PS"`, `"PA"`, `"PG"`, `"PY"`, `"PE"`, `"PH"`, `"PN"`, `"PL"`, `"PT"`, `"PR"`, `"QA"`, `"RE"`, `"RO"`, `"RU"`, `"RW"`, `"BL"`, `"SH"`, `"KN"`, `"LC"`, `"MF"`, `"PM"`, `"VC"`, `"WS"`, `"SM"`, `"ST"`, `"SA"`, `"SN"`, `"RS"`, `"SC"`, `"SL"`, `"SG"`, `"SX"`, `"SK"`, `"SI"`, `"SB"`, `"SO"`, `"ZA"`, `"GS"`, `"SS"`, `"ES"`, `"LK"`, `"SD"`, `"SR"`, `"SJ"`, `"SZ"`, `"SE"`, `"CH"`, `"SY"`, `"TW"`, `"TJ"`, `"TZ"`, `"TH"`, `"TL"`, `"TG"`, `"TK"`, `"TO"`, `"TT"`, `"TN"`, `"TR"`, `"TM"`, `"TC"`, `"TV"`, `"UG"`, `"UA"`, `"AE"`, `"GB"`, `"US"`, `"UM"`, `"UY"`, `"UZ"`, `"VU"`, `"VE"`, `"VN"`, `"VG"`, `"VI"`, `"WF"`, `"EH"`, `"YE"`, `"ZM"`, `"ZW"`

***

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

시/도/구

***

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

도시

***

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

일반 주소

***

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

상세 주소

***

</details>

***

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

구매자 우편번호

***

{% endtab %}

{% tab title="Origin" %}
**`platform_type`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

결제를 요청한 단말의 플랫폼 분류

`"PC"`, `"MOBILE"`, `"API"`

***

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

결제근원의 환경 정보 (Http 의 User-Agent header value)

***

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

결제근원의 페이지 url

***

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

결제근원의 IP 주소

***

{% endtab %}
{% endtabs %}
{% endtab %}

{% tab title="401 인증 실패" %}
{% tabs %}
{% tab title="Response" %}
**`code`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

`"UNAUTHORIZED"`

***

**`params`** <mark style="color:red;">**object**</mark>

에러 세부사항

***

{% endtab %}
{% endtabs %}
{% endtab %}

{% tab title="404 리소스를 찾을 수 없음" %}
{% tabs %}
{% tab title="Response" %}
**`code`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

`"BILLING_KEY_NOT_FOUND"`

***

**`params`** <mark style="color:red;">**object**</mark>

에러 세부사항

***

{% endtab %}
{% endtabs %}
{% endtab %}

{% tab title="500 내부 서버 오류" %}
{% tabs %}
{% tab title="Response" %}
**`code`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

`"PORTONE_ERROR"`

***

**`params`** <mark style="color:red;">**object**</mark>

에러 세부사항

***

{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}

## ⌨ 빌링키 삭제

## 빌링키 삭제

<mark style="color:red;">`DELETE`</mark> `https://api.portone.io/v2/billing-keys/{billing_key}`

#### Path Parameters

| Name                                           | Type   | Description |
| ---------------------------------------------- | ------ | ----------- |
| billing\_key<mark style="color:red;">\*</mark> | string | 빌링키         |

#### Query Parameters

| Name      | Type   | Description                                                |
| --------- | ------ | ---------------------------------------------------------- |
| store\_id | string | 하위 상점 ID - 값을 넣지 않으면 Merchant 유저의 기본값으로 설정된 상점의 id가 입력됩니다. |

{% tabs %}
{% tab title="200 200 응답" %}
{% tabs %}
{% tab title="Response" %}
**`deleted_at`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

빌링키 삭제 시각

***

{% endtab %}
{% endtabs %}
{% endtab %}

{% tab title="400 금지된 요청" %}
{% tabs %}
{% tab title="Response" %}
**`code`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

`"INVALID_REQUEST"`, `"BILLING_KEY_NOT_ISSUED"`, `"BILLING_KEY_ALREADY_DELETED"`, `"BOOKED_SCHEDULE_EXISTENCE"`

***

**`params`** <mark style="color:red;">**object**</mark>

에러 세부사항

***

{% endtab %}
{% endtabs %}
{% endtab %}

{% tab title="401 인증 실패" %}
{% tabs %}
{% tab title="Response" %}
**`code`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

`"UNAUTHORIZED"`

***

**`params`** <mark style="color:red;">**object**</mark>

에러 세부사항

***

{% endtab %}
{% endtabs %}
{% endtab %}

{% tab title="404 리소스를 찾을 수 없음" %}
{% tabs %}
{% tab title="Response" %}
**`code`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

`"BILLING_KEY_NOT_FOUND"`

***

**`params`** <mark style="color:red;">**object**</mark>

에러 세부사항

***

{% endtab %}
{% endtabs %}
{% endtab %}

{% tab title="500 내부 서버 오류" %}
{% tabs %}
{% tab title="Response" %}
**`code`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

`"PORTONE_ERROR"`, `"PG_PROVIDER_ERROR"`

***

**`params`** <mark style="color:red;">**object**</mark>

에러 세부사항

***

{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}