diff --git a/src/content/docs/ko/ready/readme.mdx b/src/content/docs/ko/ready/readme.mdx index 0ad506593..3b21b9e96 100644 --- a/src/content/docs/ko/ready/readme.mdx +++ b/src/content/docs/ko/ready/readme.mdx @@ -499,13 +499,14 @@ import IntegrationTosspayments from './_components/integration-guide/tosspayment 포트원 콘솔에서 채널 추가 시 계약 완료 후 카카오페이로부터 전달받은 \[CID]를 입력한 후 `저장`을 클릭합니다. -

토스페이

- - **채널 연동 시 필요한 입력 정보 확인 방법은 모듈에 상관없이 동일합니다.** - + + + **채널 연동 시 필요한 입력 정보 확인 방법은 모듈에 상관없이 동일합니다.** + + 1. [토스페이 가맹점 관리자](https://merchant.pay.toss.im/) 접속 후 로그인을 합니다. 2. \[가맹점 정보]→\[API Key정보]를 클릭합니다. @@ -513,6 +514,7 @@ import IntegrationTosspayments from './_components/integration-guide/tosspayment
3. 포트원 콘솔에서 채널 추가 시 \[상점아이디(MID)], \[API Key]를 입력한 후 `저장`을 클릭합니다. +
@@ -520,7 +522,7 @@ import IntegrationTosspayments from './_components/integration-guide/tosspayment 포트원 콘솔에서 채널 추가 시 계약 완료 후 페이코로부터 전달받은 \[가맹점코드(CPID)], \[ProductID], \[SellerKey]를 입력한 후 `저장`을 클릭합니다.
- + #### 해외 결제대행사 diff --git a/src/content/docs/ko/v2-payment/pg/inicis-v2.mdx b/src/content/docs/ko/v2-payment/pg/inicis-v2.mdx index 368759ab2..9a1e5d744 100644 --- a/src/content/docs/ko/v2-payment/pg/inicis-v2.mdx +++ b/src/content/docs/ko/v2-payment/pg/inicis-v2.mdx @@ -1,6 +1,6 @@ --- title: 이니시스 -description: 이니시스 연동 가이드를 확인합니다. +description: 이니시스 결제 연동 방법을 안내합니다. targetVersions: ["v2"] versionVariants: v1: /ko/pg/payment-gateway/inicis @@ -14,13 +14,11 @@ 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 설정을 진행합니다. -#### 사전 계약 안내 +## 사전 계약 안내 아래 기능을 사용하시려면 이니시스에 사전 신청 후 계약이 완료되어야 합니다. 그렇지 않은 상태에서 해당 기능 이용시 결제 승인에 실패하거나, @@ -38,7 +36,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro"; - 카드사/간편결제 다이렉트 호출 - 휴대폰 결제 익월 환불 -### 가능한 결제 수단 +## 가능한 결제 수단 - **결제창 일반 결제** @@ -75,7 +73,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro"; 자세한 파라미터 구성은 [REST API Docs](/api/rest-v2/billingKey#post%20%2Fbilling-keys)를 참고해주시기 바랍니다. -### SDK 결제 요청하기 +## SDK 결제 요청하기 결제 요청 시에는 `requestPayment` 함수를 호출해야 합니다. `channelKey`파라미터에 결제 채널 연동 후 생성된 채널 키값을 지정하여 이니시스 채널 사용을 명시해주세요. @@ -106,7 +104,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro"; -#### **주요 파라미터** +### 주요 파라미터 - `storeId` **\*** **string** @@ -345,7 +343,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro"; -### SDK 결제 - 유의사항 +### 유의사항 #### 공통 @@ -516,7 +514,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro"; - `carrier`: 휴대폰 소액결제 통신사 바로 호출을 위한 통신사 구분 값 -### SDK 빌링키 발급 요청하기 +## SDK 빌링키 발급 요청하기 빌링키 발급 요청 시에는 `requestIssueBillingKey` 함수를 호출해야 합니다. `channelKey` 파라미터에 결제 채널 연동 후 생성된 채널 키값을 지정하여 이니시스 채널 사용을 명시해주세요. @@ -545,7 +543,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro"; -#### **주요 파라미터** +### 주요 파라미터
@@ -644,7 +642,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro"; -### SDK 빌링키 발급 - 유의사항 +### 유의사항

PC와 모바일에서 파라미터 필수 여부가 상이합니다.

@@ -703,7 +701,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro"; `card.cardCompany` 필드에 값을 채워도 빌링키 발급 동작에 아무런 영향을 미치지 않습니다.
-### API 수기(키인)결제 요청하기 +## API 수기(키인)결제 요청하기 수기(키인)로 결제하기 위해서는 `POST /payments/${PAYMENT_ID_HERE}/instant`를 이용하여 결제 요청을 해야합니다. @@ -749,7 +747,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro"; -#### **주요 파라미터** +### 주요 파라미터 - `paymentId` **\*** **string** @@ -964,7 +962,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro"; -### API 빌링키 발급 요청하기 +## API 빌링키 발급 요청하기 빌링키를 발급하기 위해서는 `POST /billing-keys`를 이용하여 빌링키 발급 요청을 해야합니다. @@ -999,7 +997,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro"; -#### **주요 파라미터** +### 주요 파라미터 - `channelKey` **\*** **string** @@ -1089,7 +1087,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro"; -### API 빌링키 단건 결제 요청하기 +## API 빌링키 단건 결제 요청하기 발급된 빌링키로 단건 결제를 하기 위해 `POST /payments/${PAYMENT_ID_HERE}/billing-key`를 이용하여 결제를 요청합니다. @@ -1121,7 +1119,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro"; -#### **주요 파라미터** +### 주요 파라미터 - `paymentId` **\*** **string** @@ -1212,7 +1210,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro"; **상품 개수** -### API 빌링키 예약/반복 결제 요청하기 +## API 빌링키 예약/반복 결제 요청하기 예약 결제를 하기 위해서는 `POST /payments/${PAYMENT_ID_HERE}/schedule` 를 이용하여 결제를 예약합니다. @@ -1244,7 +1242,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro"; -#### **주요 파라미터** +### 주요 파라미터 - `paymentId` **\*** **string** @@ -1341,7 +1339,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro"; -### API 유의사항 +### 유의사항 #### 공통 @@ -1373,7 +1371,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro"; - `products` -### API 영수증 내 하위 상점 거래 등록 +## API 영수증 내 하위 상점 거래 등록 오픈마켓 고객사의 경우 해당 API를 호출하여 결제 내역 매출 전표에 하위 상점 거래를 등록할 수 있습니다. @@ -1381,7 +1379,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro"; [REST API Docs](/api/rest-v2/payment#post%20%2Fpayments%2F%7BpaymentId%7D%2Fregister-store-receipt) 를 참고해주시기 바랍니다. -#### **주요 파라미터** +### 주요 파라미터 - `paymentId` **\*** **string** diff --git a/src/content/docs/ko/v2-payment/pg/kpn.mdx b/src/content/docs/ko/v2-payment/pg/kpn.mdx index 8c43fec26..3394c4022 100644 --- a/src/content/docs/ko/v2-payment/pg/kpn.mdx +++ b/src/content/docs/ko/v2-payment/pg/kpn.mdx @@ -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)에 사전 신청 후 계약이 완료되어야 합니다. 그렇지 않은 상태에서 해당 기능 이용시 결제 승인에 실패하거나, @@ -29,7 +27,7 @@ import ParamTree from "~/components/gitbook/ParamTree.astro"; - 간편결제 다이렉트 호출 - 결제 취소 시 계좌 환불 서비스 설정 -### 가능한 결제 수단 +## 가능한 결제 수단 - **결제창 일반 결제** @@ -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) 채널 사용을 명시해주세요. @@ -87,7 +85,7 @@ function requestPayment() { } ``` -#### **주요 파라미터** +### 주요 파라미터 - `storeId` **\*** **string** @@ -161,7 +159,7 @@ function requestPayment() { -### SDK 결제 - 유의사항 +### 유의사항 #### 공통 @@ -327,7 +325,7 @@ function requestPayment() { - `availableCarriers`: 결제창에 노출될 통신사 리스트 지정 옵션 -### SDK 빌링키 발급 요청하기 +## SDK 빌링키 발급 요청하기 빌링키 발급 요청 시에는 `requestIssueBillingKey` 함수를 호출해야 합니다. `channelKey` 파라미터에 결제 채널 연동 후 생성된 채널 키를 지정하여 한국결제네트웍스(KPN) 채널 사용을 명시해주세요. @@ -351,7 +349,7 @@ function requestIssueBillingKey() { } ``` -#### **주요 파라미터** +### 주요 파라미터 - `storeId` **\*** **string** @@ -402,14 +400,14 @@ function requestIssueBillingKey() { -### SDK 빌링키 발급 - 유의사항 +### 유의사항

offerPeriod 파라미터는 range형식만 가능합니다.

SDK를 통한 빌링키 발급 요청 시 offerPeriod 파라미터를 사용하여 결제창 내에 제공 기간을 표시할 수 있습니다. 해당 파라미터는 range형태로만 입력 가능합니다. - + 구체적인 형식은 SDK 가이드를 참고해주세요.
@@ -430,7 +428,7 @@ function requestIssueBillingKey() { `card.cardCompany` 필드에 값을 입력한 후 빌링키 발급을 요청한 경우에도 빌링키 발급 동작에 아무런 영향을 미치지 않습니다. -### API 수기(키인) 결제 요청하기 +## API 수기(키인) 결제 요청하기 수기(키인)로 결제하기 위해서는 `POST /payments/${PAYMENT_ID_HERE}/instant` API를 통해 결제를 요청해야 합니다. @@ -471,7 +469,7 @@ const issueResponse = await axios({ }); ``` -#### **주요 파라미터** +### 주요 파라미터 - `paymentId` **\*** **string** @@ -659,7 +657,7 @@ const issueResponse = await axios({ -### API 빌링키 발급 요청하기 +## API 빌링키 발급 요청하기 빌링키를 발급하기 위해서는 `POST /billing-keys` API를 이용하여 빌링키 발급을 요청해야 합니다. @@ -694,7 +692,7 @@ const issueResponse = await axios({ }); ``` -#### **주요 파라미터** +### 주요 파라미터 - `channelKey` **\*** **string** @@ -776,7 +774,7 @@ const issueResponse = await axios({ -### API 빌링키 단건 결제 요청하기 +## API 빌링키 단건 결제 요청하기 발급된 빌링키로 단건 결제를 진행하려면 `POST /payments/${PAYMENT_ID_HERE}/billing-key` API를 이용하여 결제를 요청하실 수 있습니다. @@ -804,7 +802,7 @@ const response = await axios({ }); ``` -#### **주요 파라미터** +### 주요 파라미터 - `paymentId` **\*** **string** diff --git a/src/content/docs/ko/v2-payment/pg/ksnet.mdx b/src/content/docs/ko/v2-payment/pg/ksnet.mdx index d8321406a..21ea2c311 100644 --- a/src/content/docs/ko/v2-payment/pg/ksnet.mdx +++ b/src/content/docs/ko/v2-payment/pg/ksnet.mdx @@ -1,6 +1,6 @@ --- title: KSNET -description: KSNET 연동 방법을 안내합니다. +description: KSNET 결제 연동 방법을 안내합니다. targetVersions: ["v2"] versionVariants: v1: /ko/pg/payment-gateway/ksnet/readme @@ -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-결제대행사-채널-설정하기) 페이지의 내용을 참고하여 채널 설정을 진행합니다. diff --git a/src/content/docs/ko/v2-payment/pg/naverpay.mdx b/src/content/docs/ko/v2-payment/pg/naverpay.mdx index a49ff7e5e..b7a4b1fa9 100644 --- a/src/content/docs/ko/v2-payment/pg/naverpay.mdx +++ b/src/content/docs/ko/v2-payment/pg/naverpay.mdx @@ -1,6 +1,6 @@ --- title: 네이버페이 (결제형) -description: 네이버페이 연동 방법을 안내합니다. +description: 네이버페이 간편결제 연동 방법을 안내합니다. targetVersions: ["v2"] versionVariants: v1: /ko/pg/simple/naver @@ -8,17 +8,17 @@ versionVariants: import Details from "~/components/gitbook/Details.astro"; -## 1. 네이버페이 (결제형) 채널 설정하기 +## 네이버페이 (결제형) 채널 설정하기 - [결제대행사 채널 설정하기](../../ready/readme#3-결제대행사-채널-설정하기) 페이지의 내용을 참고하여 채널 설정을 진행합니다. -## 2. 가능한 결제 수단 +## 가능한 결제 수단 - 간편 결제 - `payMethod`(결제) 혹은 `billingKeyMethod`(빌링키 발급) 파라미터를 `EASY_PAY` 로 설정해야 합니다. - 결제창 내에서 카드, 계좌이체, 네이버페이 머니 충전식 결제 중 선택이 가능합니다. -## 3. SDK - 유의할 파라미터 +## SDK - 유의할 파라미터 ### 결제/빌링키 발급 공통 @@ -160,7 +160,7 @@ import Details from "~/components/gitbook/Details.astro"; - 네이버페이의 경우, 빌링키 발급창에 띄워줄 금액 정보를 파라미터로 설정할 수 있습니다. (optional) - 해당 파라미터를 입력할 경우 `displayAmount` 필드도 함께 입력해야 합니다. -## 4. 이외 연동 주의사항 +## 이외 연동 주의사항 - **에러 메시지 비 가공** - 결제창 호출(`requestPayment` 함수)후 결제창 하단의 “취소" 버튼 클릭 등으로 결제 프로세스가 diff --git a/src/content/docs/ko/v2-payment/pg/nice-v2.mdx b/src/content/docs/ko/v2-payment/pg/nice-v2.mdx index 7123bd166..28af2a78a 100644 --- a/src/content/docs/ko/v2-payment/pg/nice-v2.mdx +++ b/src/content/docs/ko/v2-payment/pg/nice-v2.mdx @@ -1,6 +1,6 @@ --- title: 나이스페이먼츠 -description: 나이스페이먼츠 연동 방법을 안내합니다. +description: 나이스페이먼츠 결제 연동 방법을 안내합니다. targetVersions: ["v2"] versionVariants: v1: /ko/pg/payment-gateway/nice-v2/readme @@ -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 결제 모듈을 사용하시려면 나이스페이먼츠(신모듈)로 연동하셔야 합니다. diff --git a/src/content/docs/ko/v2-payment/pg/paypal-v2.mdx b/src/content/docs/ko/v2-payment/pg/paypal-v2.mdx index 342af0393..cd1f5afcd 100644 --- a/src/content/docs/ko/v2-payment/pg/paypal-v2.mdx +++ b/src/content/docs/ko/v2-payment/pg/paypal-v2.mdx @@ -1,6 +1,6 @@ --- title: 페이팔 -description: 페이팔 연동 방법을 안내합니다. +description: 페이팔 결제 연동 방법을 안내합니다. targetVersions: ["v2"] versionVariants: v1: /ko/pg/payment-gateway/spb @@ -26,7 +26,7 @@ import image9 from "./_assets/paypal/screenshot7.png"; import image10 from "./_assets/paypal/screenshot8.png"; import image11 from "./_assets/paypal/screenshot9.png"; -## 페이팔 채널 설정하기 +## 채널 설정하기 [결제대행사 채널 설정하기](../../ready/readme#3-결제대행사-채널-설정하기) 페이지의 내용을 참고하여 채널을 설정해야 합니다. 포트원 V2 결제 모듈을 사용하시려면 페이팔(SPB/RT)로 연동해야 합니다. diff --git a/src/content/docs/ko/v2-payment/pg/smartro-v2.mdx b/src/content/docs/ko/v2-payment/pg/smartro-v2.mdx index 3cd6b8d7a..eaa3d4af9 100644 --- a/src/content/docs/ko/v2-payment/pg/smartro-v2.mdx +++ b/src/content/docs/ko/v2-payment/pg/smartro-v2.mdx @@ -1,6 +1,6 @@ --- title: 스마트로 -description: 스마트로 결제창 연동 방법을 안내합니다. +description: 스마트로 결제 연동 방법을 안내합니다. targetVersions: ["v2"] versionVariants: v1: /ko/pg/payment-gateway/smartro-v2/readme @@ -11,12 +11,12 @@ import ParamTree from "~/components/gitbook/ParamTree.astro"; import Tab from "~/components/gitbook/tabs/Tab.astro"; import Tabs from "~/components/gitbook/tabs/Tabs.astro"; -## 스마트로 채널 설정하기 +## 채널 설정하기 - [결제대행사 채널 설정하기](../../ready/readme#3-결제대행사-채널-설정하기) 페이지의 내용을 참고하여 채널 설정을 진행합니다. V2 결제 모듈을 사용하시려면 스마트로(신모듈)로 연동하셔야 합니다. -### 가능한 결제 수단 +## 가능한 결제 수단 - **결제창 일반결제** @@ -40,7 +40,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro"; `method` 파라미터를 `card`로 설정해야 합니다. -### 공통 유의사항 +## 공통 유의사항

주문 번호(`paymentId`)에 특수문자를 사용할 수 없습니다.

@@ -62,7 +62,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro"; 스마트로의 경우 `KRW`와 `USD`만 지원하며 이 외의 값을 입력하는 경우 에러를 리턴하며 결제가 진행되지 않습니다.
-### SDK 결제 요청하기 +## SDK 결제 요청하기 결제 요청 시에는 `requestPayment` 함수를 호출해야 합니다. `channelKey`파라미터에 결제 채널 연동 후 생성된 채널 키값을 지정하여 스마트로 채널 사용을 명시해주세요. @@ -91,7 +91,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro"; -#### 주요 파라미터 +### 주요 파라미터 - `storeId` **\*** **string** @@ -207,7 +207,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro"; } ``` -### SDK 빌링키 발급 요청하기 +## SDK 빌링키 발급 요청하기 빌링키 발급 요청 시에는 `requestBillingKeyIssue` 함수를 호출해야 합니다. `channelKey`파라미터에 결제 채널 연동 후 생성된 채널 키값을 지정하여 스마트로 채널 사용을 명시해주세요. @@ -229,7 +229,7 @@ import Tabs from "~/components/gitbook/tabs/Tabs.astro"; -#### 주요 파라미터 +### 주요 파라미터 - `storeId` **\*** **string** diff --git a/src/content/docs/ko/v2-payment/pg/tosspay-v2.mdx b/src/content/docs/ko/v2-payment/pg/tosspay-v2.mdx index 23c33367f..47e9268c0 100644 --- a/src/content/docs/ko/v2-payment/pg/tosspay-v2.mdx +++ b/src/content/docs/ko/v2-payment/pg/tosspay-v2.mdx @@ -1,19 +1,17 @@ --- title: 토스페이 -description: 토스페이 간편결제 결제창 연동가이드를 확인 합니다. +description: 토스페이 간편결제 연동 방법을 안내합니다. targetVersions: ["v2"] --- import Details from "~/components/gitbook/Details.astro"; import ParamTree from "~/components/gitbook/ParamTree.astro"; -## 토스페이(신모듈) PG 설정하기 - -### 채널 설정하기 +## 채널 설정하기 - [결제대행사 채널 설정하기](../../ready/readme#3-결제대행사-채널-설정하기)의 내용을 참고하여 PG 설정을 진행합니다. -#### 사전 계약 안내 +## 사전 계약 안내 아래 기능을 사용하시려면 토스페이에 사전 신청 후 계약이 완료되어야 합니다. 그렇지 않은 상태에서 해당 기능 이용시 결제 승인에 실패하거나, @@ -21,7 +19,7 @@ import ParamTree from "~/components/gitbook/ParamTree.astro"; - API를 통한 정기결제 -### 가능한 결제 수단 +## 가능한 결제 수단 - **결제창 일반 결제** @@ -35,7 +33,7 @@ import ParamTree from "~/components/gitbook/ParamTree.astro"; - 간편결제 : `EASY_PAY` -### SDK 결제 요청하기 +## SDK 결제 요청하기 결제 요청 시에는 `requestPayment` 함수를 호출해야 합니다. `channelKey` 파라미터에 결제 채널 연동 후 생성된 채널 키를 지정하여 토스페이 채널 사용을 명시해주세요. @@ -57,7 +55,7 @@ function requestPayment() { } ``` -#### **주요 파라미터** +### 주요 파라미터 - `storeId` **\*** **string** @@ -70,7 +68,7 @@ function requestPayment() { **채널 키** - 포트원 콘솔 내 \[결제연동] > \[채널관리] 화면에서 채널 추가 시 생성되는 값입니다. 결제 호출 시 채널을 지정할 때 사용됩니다. + 포트원 콘솔 내 \[연동 관리] > \[연동 정보] > \[채널 관리] 화면에서 채널 추가 시 생성되는 값입니다. 결제 호출 시 채널을 지정할 때 사용됩니다. - `paymentId` **\*** **string** @@ -109,7 +107,7 @@ function requestPayment() { **PG사 결제창 호출 시 PG사로 그대로 bypass할 파라미터들의 모음** - - `tosspay` **object** + - `tosspay_v2` **object** **토스페이에서 제공하는 파라미터** @@ -118,7 +116,7 @@ function requestPayment() { **결제 만료 기한** - `yyyy-MM-dd HH:mm:ss` 의 형식입니다. + `yyyy-MM-dd HH:mm:ss` 의 형식으로 입력해야 합니다. 입력하지 않을 경우, 기본값인 15분으로 설정됩니다. 최대 60분까지 설정할 수 있습니다. @@ -137,7 +135,7 @@ function requestPayment() { -### SDK 결제 - 유의사항 +### 유의사항 #### 공통 @@ -152,10 +150,10 @@ function requestPayment() { 토스페이의 경우, 현금영수증 발급에 대한 정보를 따로 입력받지 않고, 앱에 저장된 식별정보로 현금영수증을 발급합니다. - 이 떄문에 현금영수증 타입을 personal, corporate로 지정하더라도 실제로는 다른 타입의 현금영수증이 발급될 수 있습니다. + 이 때문에 현금영수증 타입을 personal, corporate로 지정하더라도 실제로는 다른 타입의 현금영수증이 발급될 수 있습니다. -### SDK 빌링키 발급 요청하기 +## SDK 빌링키 발급 요청하기 빌링키 발급 요청 시에는 `requestIssueBillingKey` 함수를 호출해야 합니다. `channelKey` 파라미터에 결제 채널 연동 후 생성된 채널 키를 지정하여 토스페이 채널 사용을 명시해주세요. @@ -179,7 +177,7 @@ function requestIssueBillingKey() { } ``` -#### **주요 파라미터** +### 주요 파라미터 - `storeId` **\*** **string** @@ -192,7 +190,7 @@ function requestIssueBillingKey() { **채널 키** - 포트원 콘솔 내 \[결제연동] > \[채널관리] 화면에서 채널 추가 시 생성되는 값입니다. 결제 호출 시 채널을 지정할 때 사용됩니다. + 포트원 콘솔 내 \[연동 관리] > \[연동 정보] > \[채널 관리] 화면에서 채널 추가 시 생성되는 값입니다. 결제 호출 시 채널을 지정할 때 사용됩니다. - `billingKeyMethod` **\*** **string** @@ -218,10 +216,10 @@ function requestIssueBillingKey() { 모바일 환경의 경우, 필수 입력입니다. -### SDK 빌링키 발급 - 유의사항 +### 유의사항
-

빌링키 발급 웹훅 연동 필요

+

빌링키 발급 웹훅 연동 안내

토스페이 빌링키 발급시 빌링키 발급 웹훅을 반드시 연동하는 것이 좋습니다. @@ -231,7 +229,7 @@ function requestIssueBillingKey() {
-

빌링키 업데이트 웹훅 연동 필요

+

빌링키 업데이트 웹훅 연동 안내

빌링키가 발급된후에 토스페이앱에서 엔드유저가 직접 빌링키에 연결된 결제수단을 변경할 수 있습니다. @@ -240,7 +238,7 @@ function requestIssueBillingKey() { 만약 빌링키에 연결된 결제수단을 서비스 내부적으로 사용하고 있다면, 빌링키 업데이트 웹훅을 연동하시거나 정보를 표시하기 전 포트원의 빌링키 정보 조회 API를 호출하여 데이터를 최신화하기를 권장합니다.
-### API 빌링키 단건 결제 요청하기 +## API 빌링키 단건 결제 요청하기 발급된 빌링키로 단건 결제를 진행하려면 `POST /payments/${PAYMENT_ID_HERE}/billing-key` API를 이용하여 결제를 요청하실 수 있습니다. @@ -261,7 +259,7 @@ const response = await axios({ }, amount: { total: 50000, - taxFree: 3000, + taxFree: 3000, }, currency: "KRW", useFreeInterestFromMerchant: true, // 고객사 분담 무이자 설정 @@ -272,7 +270,7 @@ const response = await axios({ }); ``` -#### **주요 파라미터** +### 주요 파라미터 - `paymentId` **\*** **string** @@ -351,7 +349,7 @@ const response = await axios({ **상품 개수** -### API 빌링키 예약/반복 결제 요청하기 +## API 빌링키 예약/반복 결제 요청하기 예약 결제를 진행하려면 `POST /payments/${PAYMENT_ID_HERE}/schedule` API를 이용하여 결제를 예약하실 수 있습니다. @@ -380,7 +378,7 @@ const response = await axios({ }); ``` -#### **주요 파라미터** +### 주요 파라미터 - `paymentId` **\*** **string** diff --git a/src/content/docs/ko/v2-payment/pg/tosspayments.mdx b/src/content/docs/ko/v2-payment/pg/tosspayments.mdx index 8dec0e9d8..dea284842 100644 --- a/src/content/docs/ko/v2-payment/pg/tosspayments.mdx +++ b/src/content/docs/ko/v2-payment/pg/tosspayments.mdx @@ -1,6 +1,6 @@ --- title: 토스페이먼츠 -description: 토스페이먼츠 결제창 연동 방법을 안내합니다. +description: 토스페이먼츠 결제 연동 방법을 안내합니다. targetVersions: ["v2"] versionVariants: v1: /ko/pg/payment-gateway/newtoss/readme @@ -17,7 +17,7 @@ import image3 from "./_assets/tosspayments/tosspayments_3.png"; import image4 from "./_assets/tosspayments/tosspayments_4.png"; import image5 from "./_assets/tosspayments/tosspayments_5.png"; -## 토스페이먼츠 채널 설정하기 +## 채널 설정하기 - [**토스페이먼츠 설정**](../../ready/2-pg/payment-gateway/tosspayments) 페이지의 내용을 참고하여 채널 설정을 진행합니다. - V2 결제 모듈을 사용하시려면 토스페이먼츠(신모듈)로 연동하셔야 합니다.