# 채널 관련 API

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

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

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

## ⌨ 채널 불러오기

## 채널 불러오기

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

#### Query Parameters

| Name      | Type   | Description                                                            |
| --------- | ------ | ---------------------------------------------------------------------- |
| store\_id | string | 하위상점 ID (Merchant 유저가 store\_id를 명시하지 않으면, Merchant 유저의 대표 상점 id가 입력됨) |

{% tabs %}
{% tab title="200 채널 불러오기 성공" %}
{% tabs %}
{% tab title="Response" %}
**`channels`** <mark style="color:red;">**Array\[Channel]**</mark>

V2 결제를 지원하는 채널

<details>

<summary>Channel</summary>

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

결제 채널 ID

***

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

결제 채널 이름

***

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

V2 결제가 가능한 PG사

기본값: `"PG_PROVIDER_UNSPECIFIED"`

`"PG_PROVIDER_UNSPECIFIED"`, `"PG_PROVIDER_TOSSPAYMENTS"`, `"PG_PROVIDER_KSNET"`, `"PG_PROVIDER_KAKAOPAY"`, `"PG_PROVIDER_SMARTRO_V2"`, `"PG_PROVIDER_NAVERPAY"`

***

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

기본값: `"CHANNEL_TYPE_UNSPECIFIED"`

`"CHANNEL_TYPE_UNSPECIFIED"`, `"CHANNEL_TYPE_LIVE"`, `"CHANNEL_TYPE_MERCHANT_TEST"`, `"CHANNEL_TYPE_SHARED_TEST"`

***

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

PG 상점 ID

***

**`is_for_payment`** <mark style="color:red;">**\***</mark> <mark style="color:orange;">**boolean**</mark>

결제용 채널 여부

***

**`is_for_identification_certification`** <mark style="color:orange;">**boolean**</mark>

본인인증용 채널 여부

***

**`toss_payments_credential`** <mark style="color:red;">**TossPaymentsCredential**</mark>

***

**`ksnet_credential`** <mark style="color:red;">**KsnetCredential**</mark>

***

**`smartro_v2_credential`** <mark style="color:red;">**SmartroV2Credential**</mark>

***

**`naverpay_credential`** <mark style="color:red;">**NaverpayCredential**</mark>

***

</details>

***

{% endtab %}

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

***

{% endtab %}

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

***

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

***

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

***

{% endtab %}

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

***

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

***

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

***

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

***

{% endtab %}
{% endtabs %}

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

***

**`client_key`** <mark style="color:green;">**string**</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>

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

<details>

<summary>params</summary>

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

***

</details>

***

{% 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>

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

<details>

<summary>params</summary>

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

***

</details>

***

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

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

`CHANNEL_NOT_FOUND`: 채널을 찾을 수 없습니다.\\

`"CHANNEL_NOT_FOUND"`

***

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

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

<details>

<summary>params</summary>

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

***

</details>

***

{% 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>

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

<details>

<summary>params</summary>

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

***

</details>

***

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