# 온보딩 API - 별도 계약 필요

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

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

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

## ⌨ 하위상점의 전자결제 신청 정보를 가져오기 (호스팅사 > 포트원)

## 하위상점의 전자결제 신청 정보를 가져오기 (호스팅사 > 포트원)

<mark style="color:blue;">`GET`</mark> `https://api.portone.io/v2/stores/{store-id}/applications`

하위상점 등록 API를 통해서 호스팅사의 사업자 정보를 포트원에 전달하면 전자결제 신청을 위해 하위상점의 전자결제 신청 정보, 계약 진행 상태 정보를 가져옵니다.

#### Path Parameters

| Name                                       | Type   | Description |
| ------------------------------------------ | ------ | ----------- |
| store-id<mark style="color:red;">\*</mark> | string | store의 id   |

#### Headers

| Name                                            | Type   | Description |
| ----------------------------------------------- | ------ | ----------- |
| Authorization<mark style="color:red;">\*</mark> | string | jwt 토큰 헤더   |

{% tabs %}
{% tab title="200 조회 성공" %}
{% tabs %}
{% tab title="Response" %}
**`applications`** <mark style="color:red;">**\***</mark> <mark style="color:red;">**Array\[ApplicationPublic]**</mark>

전자결제 신청내역

<details>

<summary>ApplicationPublic</summary>

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

전자결제 신청 id

***

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

전자결제 신청한 store id

***

**`pg_company`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**PgCompany**</mark>

PG사

`"UNIDENTIFIED"`, `"NICE"`, `"KCP"`, `"KICC"`, `"DANAL"`, `"SETTLE"`, `"JTNET"`, `"INICIS"`, `"SMARTRO"`, `"BLUEWALNUT"`, `"TOSSPAYMENTS"`, `"DAOU"`, `"KSNET"`, `"MOBILIANS"`, `"ALIPAY"`, `"EXIMBAY"`, `"PAYPAL"`, `"PAYMENTWALL"`, `"NAVERPAY"`, `"NAVERCO"`, `"KAKAOPAY"`, `"TOSSPAY"`, `"CHAI"`, `"PAYCO"`, `"SMILEPAY"`

***

**`methods`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**Array\[MethodAndType]**</mark>

해당 PG사로 신청한 결제수단 및 방식

`"CARD_GENERAL"`, `"CARD_SUBSCRIBE"`, `"CARD_KEYIN"`, `"TRANS_GENERAL"`, `"VBANK_GENERAL"`, `"PHONE_GENERAL"`, `"PHONE_SUBSCRIBE"`, `"GIFT_CARD_GENERAL"`, `"ABROAD_GENERAL"`, `"MY_ACCOUNT_GENERAL"`, `"NAVERPAY_GENERAL"`, `"NAVERCO_GENERAL"`, `"KAKAOPAY_GENERAL"`, `"TOSSPAY_GENERAL"`, `"PAYCO_GENERAL"`, `"SMILEPAY_GENERAL"`, `"CERTIFICATION_PHONE"`, `"CERTIFICATION_UNIFIED"`

***

**`status`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**ApplicationStatusClass**</mark>

신청 상태 대분류

`"RECEPTION_SCHEDULED"`, `"TRANSFER"`, `"RECEPTION_PENDING"`, `"RECEPTION_COMPLETED"`, `"APPLICATION_CANCELED"`, `"MERCHANT_REVIEWING"`, `"CONTRACT_PROCESSING"`, `"CONTRACT_COMPLETED"`, `"CONTRACT_CANCELED"`, `"CONTRACT_PENDING"`, `"CONTRACT_REJECTED"`, `"SERVICE_CLOSED"`, `"SERVICE_OPEN"`

***

**`pg_specific_info`** <mark style="color:red;">**\***</mark> <mark style="color:red;">**PgSpecificInfo**</mark>

PG사별 특수값

***

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

실패 사유

***

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

결제 연동에 필요한 Credential

***

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

생성 시각

***

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

수정 시각

***

</details>

***

{% endtab %}

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

mid

***

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

api key

***

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

client key

***

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

mert key

***

{% endtab %}

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

배송 및 서비스 기간

***

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

개발 방식

`"SELF_DEVELOPMENT"`, `"WORDPRESS"`

***

**`supporting_countries`** <mark style="color:green;">**Array\[string]**</mark>

결제 제공 국가 (ISO 3166-1 alpha-2)

***

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

페이코 ID

***

**`bank_name`** <mark style="color:green;">**BankName**</mark>

은행

`"BANK_OF_KOREA"`, `"KDB"`, `"IBK"`, `"KB"`, `"HANA"`, `"SH"`, `"KOREA_EXIMBANK"`, `"NH"`, `"WOORI"`, `"SHINHAN"`, `"SC"`, `"CITY"`, `"DGB"`, `"BOOSAN_BANK"`, `"KJ_BANK"`, `"JEJU_BANK"`, `"JB_BANK"`, `"KN_BANK"`, `"MG"`, `"CU"`, `"SB"`, `"BOA"`, `"MORGAN_STANLEY"`, `"HSBC"`, `"DEUTSCHE_BANK"`, `"JP_MORGAN"`, `"BNP_PARISBAS"`, `"ICBC"`, `"BANK_OF_CHINA"`, `"SJ"`, `"CHINA_CONSTRUCTION_BANK"`, `"POST_BANK"`, `"K_BANK"`, `"KAKAO_BANK"`, `"TOSS_BANK"`

***

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

계좌번호

***

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

예금주명

***

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

홈페이지 명 (서비스 명)

***

**`nicepay_terms_agreed`** <mark style="color:orange;">**Array\[boolean]**</mark>

약관들 동의 여부

***

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

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

에러 코드

***

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

에러 세부사항

<details>

<summary>params</summary>

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

에러 메시지

***

</details>

***

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

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

에러 코드

***

**`params`** <mark style="color:red;">**\***</mark> <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>

에러 코드

***

**`params`** <mark style="color:red;">**\***</mark> <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>

에러 코드

***

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

에러 세부사항

<details>

<summary>params</summary>

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

에러 메시지

***

</details>

***

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

## ⌨ 온보딩 API 를 통해 전자결제 신청하기 (호스팅사 > 포트원 > 결제대행사)

## 온보딩 API 를 통해 전자결제 신청하기 (호스팅사 > 포트원 > 결제대행사)

<mark style="color:green;">`POST`</mark> `https://api.portone.io/v2/stores/{store-id}/applications`

호스팅사 고객의 사업자 정보를 기반으로 생성된 스토어 식별코드로 전자 결제를 신청합니다.

#### Path Parameters

| Name                                       | Type   | Description |
| ------------------------------------------ | ------ | ----------- |
| store-id<mark style="color:red;">\*</mark> | string | store의 id   |

#### Headers

| Name                                            | Type   | Description |
| ----------------------------------------------- | ------ | ----------- |
| Authorization<mark style="color:red;">\*</mark> | string | jwt 토큰 헤더   |

#### Request Body

| Name                                                 | Type                           | Description             |
| ---------------------------------------------------- | ------------------------------ | ----------------------- |
| applications<mark style="color:red;">\*</mark>       | Array\[ApplicationByPgCompany] | pg사 기준으로 묶은 application |
| pg\_specific\_info<mark style="color:red;">\*</mark> | PgSpecificInfo                 | PG사별 특수값                |

{% tabs %}
{% tab title="200 전자결제 신청 성공" %}
{% tabs %}
{% tab title="Response" %}
**`applications`** <mark style="color:red;">**\***</mark> <mark style="color:red;">**Array\[ApplicationPublic]**</mark>

전자결제 신청내역

<details>

<summary>ApplicationPublic</summary>

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

전자결제 신청 id

***

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

전자결제 신청한 store id

***

**`pg_company`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**PgCompany**</mark>

PG사

`"UNIDENTIFIED"`, `"NICE"`, `"KCP"`, `"KICC"`, `"DANAL"`, `"SETTLE"`, `"JTNET"`, `"INICIS"`, `"SMARTRO"`, `"BLUEWALNUT"`, `"TOSSPAYMENTS"`, `"DAOU"`, `"KSNET"`, `"MOBILIANS"`, `"ALIPAY"`, `"EXIMBAY"`, `"PAYPAL"`, `"PAYMENTWALL"`, `"NAVERPAY"`, `"NAVERCO"`, `"KAKAOPAY"`, `"TOSSPAY"`, `"CHAI"`, `"PAYCO"`, `"SMILEPAY"`

***

**`methods`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**Array\[MethodAndType]**</mark>

해당 PG사로 신청한 결제수단 및 방식

`"CARD_GENERAL"`, `"CARD_SUBSCRIBE"`, `"CARD_KEYIN"`, `"TRANS_GENERAL"`, `"VBANK_GENERAL"`, `"PHONE_GENERAL"`, `"PHONE_SUBSCRIBE"`, `"GIFT_CARD_GENERAL"`, `"ABROAD_GENERAL"`, `"MY_ACCOUNT_GENERAL"`, `"NAVERPAY_GENERAL"`, `"NAVERCO_GENERAL"`, `"KAKAOPAY_GENERAL"`, `"TOSSPAY_GENERAL"`, `"PAYCO_GENERAL"`, `"SMILEPAY_GENERAL"`, `"CERTIFICATION_PHONE"`, `"CERTIFICATION_UNIFIED"`

***

**`status`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**ApplicationStatusClass**</mark>

신청 상태 대분류

`"RECEPTION_SCHEDULED"`, `"TRANSFER"`, `"RECEPTION_PENDING"`, `"RECEPTION_COMPLETED"`, `"APPLICATION_CANCELED"`, `"MERCHANT_REVIEWING"`, `"CONTRACT_PROCESSING"`, `"CONTRACT_COMPLETED"`, `"CONTRACT_CANCELED"`, `"CONTRACT_PENDING"`, `"CONTRACT_REJECTED"`, `"SERVICE_CLOSED"`, `"SERVICE_OPEN"`

***

**`pg_specific_info`** <mark style="color:red;">**\***</mark> <mark style="color:red;">**PgSpecificInfo**</mark>

PG사별 특수값

***

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

실패 사유

***

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

결제 연동에 필요한 Credential

***

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

생성 시각

***

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

수정 시각

***

</details>

***

{% endtab %}

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

mid

***

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

api key

***

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

client key

***

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

mert key

***

{% endtab %}

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

배송 및 서비스 기간

***

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

개발 방식

`"SELF_DEVELOPMENT"`, `"WORDPRESS"`

***

**`supporting_countries`** <mark style="color:green;">**Array\[string]**</mark>

결제 제공 국가 (ISO 3166-1 alpha-2)

***

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

페이코 ID

***

**`bank_name`** <mark style="color:green;">**BankName**</mark>

은행

`"BANK_OF_KOREA"`, `"KDB"`, `"IBK"`, `"KB"`, `"HANA"`, `"SH"`, `"KOREA_EXIMBANK"`, `"NH"`, `"WOORI"`, `"SHINHAN"`, `"SC"`, `"CITY"`, `"DGB"`, `"BOOSAN_BANK"`, `"KJ_BANK"`, `"JEJU_BANK"`, `"JB_BANK"`, `"KN_BANK"`, `"MG"`, `"CU"`, `"SB"`, `"BOA"`, `"MORGAN_STANLEY"`, `"HSBC"`, `"DEUTSCHE_BANK"`, `"JP_MORGAN"`, `"BNP_PARISBAS"`, `"ICBC"`, `"BANK_OF_CHINA"`, `"SJ"`, `"CHINA_CONSTRUCTION_BANK"`, `"POST_BANK"`, `"K_BANK"`, `"KAKAO_BANK"`, `"TOSS_BANK"`

***

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

계좌번호

***

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

예금주명

***

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

홈페이지 명 (서비스 명)

***

**`nicepay_terms_agreed`** <mark style="color:orange;">**Array\[boolean]**</mark>

약관들 동의 여부

***

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

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

에러 코드

***

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

에러 세부사항

<details>

<summary>params</summary>

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

에러 메시지

***

</details>

***

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

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

에러 코드

***

**`params`** <mark style="color:red;">**\***</mark> <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>

에러 코드

***

**`params`** <mark style="color:red;">**\***</mark> <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>

에러 코드

***

**`params`** <mark style="color:red;">**\***</mark> <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>

에러 코드

***

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

에러 세부사항

<details>

<summary>params</summary>

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

에러 메시지

***

</details>

***

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

{% tabs %}
{% tab title="ApplicationByPgCompany" %}
**`pg_company`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**PublicPgCompany**</mark>

PG사

`"UNIDENTIFIED"`, `"TOSSPAYMENTS"`

***

**`methods`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**Array\[PublicMethodAndType]**</mark>

결제 수단 및 방식\
`CARD_GENERAL`: 카드 일반결제\
`CARD_SUBSCRIBE`: 카드 정기결제\
`TRANS_GENERAL`: 계좌이체 일반결제\
`VBANK_GENERAL`: 가상계좌 일반결제\
`PHONE_GENERAL`: 휴대폰 일반결제\
`GIFT_CARD_GENERAL`: 상품권 일반결제\\

`"CARD_GENERAL"`, `"CARD_SUBSCRIBE"`, `"TRANS_GENERAL"`, `"VBANK_GENERAL"`, `"PHONE_GENERAL"`, `"GIFT_CARD_GENERAL"`

***

{% endtab %}

{% tab title="BankName" %}
은행

`"BANK_OF_KOREA"`, `"KDB"`, `"IBK"`, `"KB"`, `"HANA"`, `"SH"`, `"KOREA_EXIMBANK"`, `"NH"`, `"WOORI"`, `"SHINHAN"`, `"SC"`, `"CITY"`, `"DGB"`, `"BOOSAN_BANK"`, `"KJ_BANK"`, `"JEJU_BANK"`, `"JB_BANK"`, `"KN_BANK"`, `"MG"`, `"CU"`, `"SB"`, `"BOA"`, `"MORGAN_STANLEY"`, `"HSBC"`, `"DEUTSCHE_BANK"`, `"JP_MORGAN"`, `"BNP_PARISBAS"`, `"ICBC"`, `"BANK_OF_CHINA"`, `"SJ"`, `"CHINA_CONSTRUCTION_BANK"`, `"POST_BANK"`, `"K_BANK"`, `"KAKAO_BANK"`, `"TOSS_BANK"`
{% endtab %}

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

배송 및 서비스 기간

***

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

개발 방식

`"SELF_DEVELOPMENT"`, `"WORDPRESS"`

***

**`supporting_countries`** <mark style="color:green;">**Array\[string]**</mark>

결제 제공 국가 (ISO 3166-1 alpha-2)

***

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

페이코 ID

***

**`bank_name`** <mark style="color:green;">**BankName**</mark>

은행

`"BANK_OF_KOREA"`, `"KDB"`, `"IBK"`, `"KB"`, `"HANA"`, `"SH"`, `"KOREA_EXIMBANK"`, `"NH"`, `"WOORI"`, `"SHINHAN"`, `"SC"`, `"CITY"`, `"DGB"`, `"BOOSAN_BANK"`, `"KJ_BANK"`, `"JEJU_BANK"`, `"JB_BANK"`, `"KN_BANK"`, `"MG"`, `"CU"`, `"SB"`, `"BOA"`, `"MORGAN_STANLEY"`, `"HSBC"`, `"DEUTSCHE_BANK"`, `"JP_MORGAN"`, `"BNP_PARISBAS"`, `"ICBC"`, `"BANK_OF_CHINA"`, `"SJ"`, `"CHINA_CONSTRUCTION_BANK"`, `"POST_BANK"`, `"K_BANK"`, `"KAKAO_BANK"`, `"TOSS_BANK"`

***

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

계좌번호

***

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

예금주명

***

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

홈페이지 명 (서비스 명)

***

**`nicepay_terms_agreed`** <mark style="color:orange;">**Array\[boolean]**</mark>

약관들 동의 여부

***

{% endtab %}

{% tab title="PublicMethodAndType" %}
결제 수단 및 방식\
`CARD_GENERAL`: 카드 일반결제\
`CARD_SUBSCRIBE`: 카드 정기결제\
`TRANS_GENERAL`: 계좌이체 일반결제\
`VBANK_GENERAL`: 가상계좌 일반결제\
`PHONE_GENERAL`: 휴대폰 일반결제\
`GIFT_CARD_GENERAL`: 상품권 일반결제\\

`"CARD_GENERAL"`, `"CARD_SUBSCRIBE"`, `"TRANS_GENERAL"`, `"VBANK_GENERAL"`, `"PHONE_GENERAL"`, `"GIFT_CARD_GENERAL"`
{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="PublicPgCompany" %}
PG사

`"UNIDENTIFIED"`, `"TOSSPAYMENTS"`
{% endtab %}
{% endtabs %}

## ⌨ 가입 신청 URL 호출 & 상태값 조회하기

## 가입 신청 URL 호출 & 상태값 조회하기

<mark style="color:blue;">`GET`</mark> `https://api.portone.io/v2/stores/{store-id}/applications/tosspayments-status-and-url`

**1. 가입 신청 URL 호출 (호스팅사 > 포트원 > 결제대행사) - 토스페이먼츠 전용**

**2. 상태값 조회하기 (결제대행사 > 포트원 > 호스팅사)**

#### Path Parameters

| Name                                       | Type   | Description |
| ------------------------------------------ | ------ | ----------- |
| store-id<mark style="color:red;">\*</mark> | string | store의 id   |

#### Headers

| Name                                            | Type   | Description |
| ----------------------------------------------- | ------ | ----------- |
| Authorization<mark style="color:red;">\*</mark> | string | jwt 토큰 헤더   |

{% tabs %}
{% tab title="200 조회 성공" %}
{% tabs %}
{% tab title="Response" %}
**`urls`** <mark style="color:red;">**Array\[TosspaymentsApplicationUrl]**</mark>

<details>

<summary>TosspaymentsApplicationUrl</summary>

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

전자결제 신청 id

***

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

`GENERAL`: 일반결제\
`SUBSCRIBE`: 정기결제\
`EASY`: 간편결제\\

`"GENERAL"`, `"SUBSCRIBE"`, `"EASY"`

***

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

토스페이먼츠 온보딩페이지 url status가 `READY`, `IN_DRAFT`인 경우만 값이 담겨짐

***

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

토스페이먼츠 계약 상태 (토스페이먼츠에서 내려주는 상태값)\
`READY`: 신청서 작성 전\
`IN_DRAFT`: 신청서 작성 중\
`WAIT_FOR_REVIEW`: 신청서 제출 완료\
`IN_REVIEW`: 심사 중\
`DONE`: 계약 완료\
`CANCELED`: 계약 취소\
`TERMINATED`: 계약 해지\\

`"READY"`, `"IN_DRAFT"`, `"WAIT_FOR_REVIEW"`, `"IN_REVIEW"`, `"DONE"`, `"CANCELED"`, `"TERMINATED"`

***

</details>

***

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

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

에러 코드

***

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

에러 세부사항

<details>

<summary>params</summary>

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

에러 메시지

***

</details>

***

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

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

에러 코드

***

**`params`** <mark style="color:red;">**\***</mark> <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>

에러 코드

***

**`params`** <mark style="color:red;">**\***</mark> <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>

에러 코드

***

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

에러 세부사항

<details>

<summary>params</summary>

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

에러 메시지

***

</details>

***

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://portone.gitbook.io/docs/api-v2/applications.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.