Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V2 Core용 토스페이 문서 추가 #492

Merged
merged 9 commits into from
Jun 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/content/docs/ko/_nav.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,7 @@
- /ko/v2-payment/pg/kcp-v2
- /ko/v2-payment/pg/kakaopay
- /ko/v2-payment/pg/naverpay
- /ko/v2-payment/pg/tosspay-v2
- /ko/v2-payment/pg/paypal-v2
- /ko/v2-payment/pg/danal-identity-verification
- /ko/v2-payment/onboarding
Expand Down
18 changes: 10 additions & 8 deletions src/content/docs/ko/ready/readme.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -501,22 +501,24 @@ import IntegrationTosspayments from './_components/integration-guide/tosspayment
포트원 콘솔에서 채널 추가 시 계약 완료 후 카카오페이로부터 전달받은 \[CID]를 입력한 후 `저장`을 클릭합니다.
</Details>

<VersionGate default="v1">
<Details id="channel-config-tosspay">
<p slot="summary">토스페이</p>
<Details id="channel-config-tosspay">
<p slot="summary">토스페이</p>

<VersionGate default="v1">
<Hint style="info">
**채널 연동 시 필요한 입력 정보 확인 방법은 모듈에 상관없이 동일합니다.**
</Hint>
</VersionGate>

1. [토스페이 가맹점 관리자](https://merchant.pay.toss.im/) 접속 후 로그인을 합니다.
2. \[가맹점 정보]→\[API Key정보]를 클릭합니다.
1. [토스페이 가맹점 관리자](https://merchant.pay.toss.im/) 접속 후 로그인을 합니다.
2. \[가맹점 정보]→\[API Key정보]를 클릭합니다.

<Figure src={image21} caption="토스페이 가맹점 관리자 내 API Key 조회 화면" />
<Figure src={image21} caption="토스페이 가맹점 관리자 내 API Key 조회 화면" />

3. 포트원 콘솔에서 채널 추가 시 \[상점아이디(MID)], \[API Key]를 입력한 후 `저장`을 클릭합니다.
</Details>
3. 포트원 콘솔에서 채널 추가 시 \[상점아이디(MID)], \[API Key]를 입력한 후 `저장`을 클릭합니다.
</Details>

<VersionGate default="v1">
<Details id="channel-config-payco">
<p slot="summary">페이코</p>

Expand Down
42 changes: 19 additions & 23 deletions src/content/docs/ko/v2-payment/pg/inicis-v2.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: KG이니시스
description: KG이니시스 연동 가이드를 확인합니다.
title: 이니시스
description: 이니시스 결제 연동 방법을 안내합니다.
targetVersions: ["v2"]
versionVariants:
v1: /ko/pg/payment-gateway/inicis
Expand All @@ -14,9 +14,7 @@ import ParamTree from "~/components/gitbook/ParamTree.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
import Tabs from "~/components/gitbook/tabs/Tabs.astro";

## 이니시스 PG 설정하기

### 채널 설정하기
## 채널 설정하기

- [결제대행사 채널 설정하기](../../ready/readme#3-결제대행사-채널-설정하기)의 내용을 참고하여 PG 설정을 진행합니다.

Expand Down Expand Up @@ -345,7 +343,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro";
</ParamTree>
</ParamTree>

### SDK 결제 - 유의사항
### 유의사항

#### 공통

Expand Down Expand Up @@ -644,7 +642,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro";
</ParamTree>
</ParamTree>

### SDK 빌링키 발급 - 유의사항
### 유의사항

<Details>
<p slot="summary">PC와 모바일에서 파라미터 필수 여부가 상이합니다.</p>
Expand Down Expand Up @@ -1099,23 +1097,21 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro";
<Tab title="API 예약/반복 결제">
```ts
const response = await axios({
url: `https://api.portone.io/payments/${PAYMENT_ID_HERE}/schedule`,
url: `https://api.portone.io/payments/${PAYMENT_ID_HERE}/billing-key`,
method: "post",
headers: { Authorization: `PortOne ${PORTONE_API_SECRET}` },
data: {
payment: {
billingKey: "billing-key-1", // 빌링키 발급 API를 통해 발급받은 빌링키
orderName: "월간 이용권 정기결제",
customer: {
id: "customer-1234", // 고객사에서 관리하는 고객 고유번호
phoneNumber: `010-1234-5678`,
email: `[email protected]`,
},
amount: {
total: 10000,
},
currency: "KRW",
billingKey: "billing-key-1", // 빌링키 발급 API를 통해 발급받은 빌링키
orderName: "월간 이용권 정기결제",
customer: {
id: "customer-1234", // 고객사에서 관리하는 고객 고유번호
phoneNumber: `010-1234-5678`,
email: `[email protected]`,
},
amount: {
total: 10000,
},
currency: "KRW",
productCount: 1,
},
});
Expand Down Expand Up @@ -1343,7 +1339,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro";
</ParamTree>
</ParamTree>

### API 유의사항
### 유의사항

#### 공통

Expand Down Expand Up @@ -1375,15 +1371,15 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro";
- `products`
</Details>

### API 영수증 내 하위 상점 거래 등록
## API 영수증 내 하위 상점 거래 등록

오픈마켓 고객사의 경우 해당 API를 호출하여 결제 내역 매출 전표에 하위 상점 거래를 등록할 수 있습니다.

자세한 파라미터 구성은
[REST API Docs](/api/rest-v2/payment#post%20%2Fpayments%2F%7BpaymentId%7D%2Fregister-store-receipt)
를 참고해주시기 바랍니다.

#### 주요 파라미터
### 주요 파라미터

<ParamTree>
- `paymentId` <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>
Expand Down
62 changes: 29 additions & 33 deletions src/content/docs/ko/v2-payment/pg/kpn.mdx
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
---
title: 한국결제네트웍스(KPN)
description: 한국결제네트웍스(KPN) 연동 가이드를 확인합니다.
description: 한국결제네트웍스(KPN) 결제 연동 방법을 안내합니다.
targetVersions: ["v2"]
---

import Details from "~/components/gitbook/Details.astro";
import ParamTree from "~/components/gitbook/ParamTree.astro";

## KPN PG 설정하기

### 채널 설정하기
## 채널 설정하기

- [결제대행사 채널 설정하기](../../ready/readme#3-결제대행사-채널-설정하기)의 내용을 참고하여 PG 설정을 진행합니다.

#### 사전 계약 안내
## 사전 계약 안내

아래 기능을 사용하시려면 한국결제네트웍스(KPN)에 사전 신청 후 계약이 완료되어야 합니다.
그렇지 않은 상태에서 해당 기능 이용시 결제 승인에 실패하거나,
Expand All @@ -29,7 +27,7 @@ import ParamTree from "~/components/gitbook/ParamTree.astro";
- 간편결제 다이렉트 호출
- 결제 취소 시 계좌 환불 서비스 설정

### 가능한 결제 수단
## 가능한 결제 수단

- **결제창 일반 결제**

Expand Down Expand Up @@ -65,7 +63,7 @@ import ParamTree from "~/components/gitbook/ParamTree.astro";

자세한 파라미터 구성은 [REST API Docs](/api/rest-v2/billingKey#post%20%2Fbilling-keys)를 참고해주시기 바랍니다.

### SDK 결제 요청하기
## SDK 결제 요청하기

결제 요청 시에는 `requestPayment` 함수를 호출해야 합니다.
`channelKey` 파라미터에 결제 채널 연동 후 생성된 채널 키를 지정하여 한국결제네트웍스(KPN) 채널 사용을 명시해주세요.
Expand All @@ -87,7 +85,7 @@ function requestPayment() {
}
```

#### **주요 파라미터**
### 주요 파라미터

<ParamTree>
- `storeId` <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>
Expand Down Expand Up @@ -161,7 +159,7 @@ function requestPayment() {
</ParamTree>
</ParamTree>

### SDK 결제 - 유의사항
### 유의사항

#### 공통

Expand Down Expand Up @@ -327,7 +325,7 @@ function requestPayment() {
- `availableCarriers`: 결제창에 노출될 통신사 리스트 지정 옵션
</Details>

### SDK 빌링키 발급 요청하기
## SDK 빌링키 발급 요청하기

빌링키 발급 요청 시에는 `requestIssueBillingKey` 함수를 호출해야 합니다.
`channelKey` 파라미터에 결제 채널 연동 후 생성된 채널 키를 지정하여 한국결제네트웍스(KPN) 채널 사용을 명시해주세요.
Expand All @@ -351,7 +349,7 @@ function requestIssueBillingKey() {
}
```

#### **주요 파라미터**
### 주요 파라미터

<ParamTree>
- `storeId` <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>
Expand Down Expand Up @@ -402,14 +400,14 @@ function requestIssueBillingKey() {
</ParamTree>
</ParamTree>

### SDK 빌링키 발급 - 유의사항
### 유의사항

<Details>
<p slot="summary">offerPeriod 파라미터는 range형식만 가능합니다.</p>

SDK를 통한 빌링키 발급 요청 시 offerPeriod 파라미터를 사용하여 결제창 내에 제공 기간을 표시할 수 있습니다.
해당 파라미터는 range형태로만 입력 가능합니다.

구체적인 형식은 SDK 가이드를 참고해주세요.
</Details>

Expand All @@ -430,7 +428,7 @@ function requestIssueBillingKey() {
`card.cardCompany` 필드에 값을 입력한 후 빌링키 발급을 요청한 경우에도 빌링키 발급 동작에 아무런 영향을 미치지 않습니다.
</Details>

### API 수기(키인) 결제 요청하기
## API 수기(키인) 결제 요청하기

수기(키인)로 결제하기 위해서는 `POST /payments/${PAYMENT_ID_HERE}/instant` API를 통해 결제를 요청해야 합니다.

Expand Down Expand Up @@ -471,7 +469,7 @@ const issueResponse = await axios({
});
```

#### **주요 파라미터**
### 주요 파라미터

<ParamTree>
- `paymentId` <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>
Expand Down Expand Up @@ -659,7 +657,7 @@ const issueResponse = await axios({
</ParamTree>
</ParamTree>

### API 빌링키 발급 요청하기
## API 빌링키 발급 요청하기

빌링키를 발급하기 위해서는 `POST /billing-keys` API를 이용하여 빌링키 발급을 요청해야 합니다.

Expand Down Expand Up @@ -694,7 +692,7 @@ const issueResponse = await axios({
});
```

#### **주요 파라미터**
### 주요 파라미터

<ParamTree>
- `channelKey` <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>
Expand Down Expand Up @@ -776,37 +774,35 @@ const issueResponse = await axios({
</ParamTree>
</ParamTree>

### API 빌링키 단건 결제 요청하기
## API 빌링키 단건 결제 요청하기

발급된 빌링키로 단건 결제를 진행하려면 `POST /payments/${PAYMENT_ID_HERE}/billing-key` API를 이용하여 결제를 요청하실 수 있습니다.

한국결제네트웍스(KPN) 기준으로 작성한 예시 코드는 아래와 같습니다.

```typescript title="API 빌링키 단건 결제"
const response = await axios({
url: `https://api.portone.io/payments/${PAYMENT_ID_HERE}/schedule`,
url: `https://api.portone.io/payments/${PAYMENT_ID_HERE}/billing-key`,
method: "post",
headers: { Authorization: `PortOne ${PORTONE_API_SECRET}` },
data: {
payment: {
billingKey: "billing-key-1", // 빌링키 발급 API를 통해 발급받은 빌링키
orderName: "월간 이용권 정기결제",
customer: {
id: "customer-1234", // 고객사에서 관리하는 고객 고유번호
phoneNumber: `010-1234-5678`,
email: `[email protected]`,
},
amount: {
total: 10000,
taxFree: 3000,
},
currency: "KRW",
billingKey: "billing-key-1", // 빌링키 발급 API를 통해 발급받은 빌링키
orderName: "월간 이용권 정기결제",
customer: {
id: "customer-1234", // 고객사에서 관리하는 고객 고유번호
phoneNumber: `010-1234-5678`,
email: `[email protected]`,
},
amount: {
total: 10000,
},
currency: "KRW",
productCount: 1,
},
});
```

#### **주요 파라미터**
### 주요 파라미터

<ParamTree>
- `paymentId` <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/ko/v2-payment/pg/ksnet.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: KSNET
description: KSNET 연동 방법을 안내합니다.
description: KSNET 결제 연동 방법을 안내합니다.
targetVersions: ["v2"]
versionVariants:
v1: /ko/pg/payment-gateway/ksnet/readme
Expand All @@ -10,7 +10,7 @@ import Details from "~/components/gitbook/Details.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
import Tabs from "~/components/gitbook/tabs/Tabs.astro";

## KSNET 채널 설정하기
## 채널 설정하기

- [결제대행사 채널 설정하기](../../ready/readme#3-결제대행사-채널-설정하기) 페이지의 내용을 참고하여 채널 설정을 진행합니다.

Expand Down
10 changes: 5 additions & 5 deletions src/content/docs/ko/v2-payment/pg/naverpay.mdx
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
---
title: 네이버페이 (결제형)
description: 네이버페이 연동 방법을 안내합니다.
description: 네이버페이 간편결제 연동 방법을 안내합니다.
targetVersions: ["v2"]
versionVariants:
v1: /ko/pg/simple/naver
---

import Details from "~/components/gitbook/Details.astro";

## 1. 네이버페이 (결제형) 채널 설정하기
## 네이버페이 (결제형) 채널 설정하기

- [결제대행사 채널 설정하기](../../ready/readme#3-결제대행사-채널-설정하기) 페이지의 내용을 참고하여 채널 설정을 진행합니다.

## 2. 가능한 결제 수단
## 가능한 결제 수단

- 간편 결제
- `payMethod`(결제) 혹은 `billingKeyMethod`(빌링키 발급) 파라미터를 `EASY_PAY` 로 설정해야 합니다.
- 결제창 내에서 카드, 계좌이체, 네이버페이 머니 충전식 결제 중 선택이 가능합니다.

## 3. SDK - 유의할 파라미터
## SDK - 유의할 파라미터

### 결제/빌링키 발급 공통

Expand Down Expand Up @@ -160,7 +160,7 @@ import Details from "~/components/gitbook/Details.astro";
- 네이버페이의 경우, 빌링키 발급창에 띄워줄 금액 정보를 파라미터로 설정할 수 있습니다. (optional)
- 해당 파라미터를 입력할 경우 `displayAmount` 필드도 함께 입력해야 합니다.

## 4. 이외 연동 주의사항
## 이외 연동 주의사항

- **에러 메시지 비 가공**
- 결제창 호출(`requestPayment` 함수)후 결제창 하단의 “취소" 버튼 클릭 등으로 결제 프로세스가
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/ko/v2-payment/pg/nice-v2.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 나이스페이먼츠
description: 나이스페이먼츠 연동 방법을 안내합니다.
description: 나이스페이먼츠 결제 연동 방법을 안내합니다.
targetVersions: ["v2"]
versionVariants:
v1: /ko/pg/payment-gateway/nice-v2/readme
Expand All @@ -13,7 +13,7 @@ import Details from "~/components/gitbook/Details.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
import Tabs from "~/components/gitbook/tabs/Tabs.astro";

## 나이스페이먼츠 채널 설정하기
## 채널 설정하기

- [결제대행사 채널 설정하기](../../ready/readme#3-결제대행사-채널-설정하기) 페이지의 내용을 참고하여 채널 설정을 진행합니다.
V2 결제 모듈을 사용하시려면 나이스페이먼츠(신모듈)로 연동하셔야 합니다.
Expand Down
Loading