@portone/mcp-server 0.13.0

package/assets/docs/opi/ko/extra/plugins/wordpress/woocommerce/payment.md

@@ -0,0 +1,62 @@
+---
+title: 일반결제 연동하기
+description: 우커머스 플러그인을 통해 일반결제를 연동합니다.
+targetVersions:
+  - v1
+---
+
+이 문서는 우커머스 플러그인을 사용하여 일반결제 기능을 연동하는 방법을 설명합니다.
+
+## STEP1: 포트원SDK 버전 설정하기
+
+워드프레스 관리자 페이지의 우커머스 > 설정 > 포트원 페이지로 이동합니다. 인증결제를 위해 SDK버젼 설정이 필요합니다.
+
+(관련 이미지 첨부)
+
+## STEP2: 결제 수단 활성화하기
+
+워드프레스 관리자 페이지의 우커머스 > 설정 > 결제 페이지로 이동합니다. 사용하고자 하는 포트원 결제 수단을 활성화하고 관리 버튼을 통해 설정 페이지로 이동합니다.
+
+(관련 이미지 첨부)
+
+## STEP3: 고객사 정보 입력하기
+
+포트원 관리자 콘솔 > 결제연동 > 내 식별정보에서 확인한 고객사 정보를 입력합니다. 변경 사항 저장 버튼을 눌러 설정 내용을 저장합니다.
+
+(관련 이미지 첨부)
+
+## STEP4: PG사 및 상점아이디 설정하기
+
+연동하실 PG사와 PG사의 상점아이디를 입력해주세요.
+
+(관련 이미지 첨부)
+
+## STEP5: 결제 수단별 설정하기
+
+결제 수단별 옵션들을 다음과 같이 설정할 수 있습니다.
+
+### 신용카드, 카카오페이, PAYCO, Eximbay, Paymentwall
+
+- 추가 옵션이 없습니다.
+
+### 휴대폰 소액결제
+
+- 디지털 상품: 실물이 아닌 디지털 상품은 활성화해야 합니다.
+
+### 실시간 계좌이체
+
+- 실시간 계좌이체 에스크로: 활성화하여 우커머스의 실시간 계좌이체 결제 수단을 에스크로 방식으로 변경할 수 있습니다.
+
+### 가상계좌
+
+- 가상계좌 에스크로: 활성화하여 우커머스의 가상계좌 결제 수단을 에스크로 방식으로 변경할 수 있습니다.
+- 가상계좌 입금통지 설정: 가상계좌 입금통지를 받기 위해 반드시 설정해야 합니다. (필수)
+- 사업자등록번호: 다날 - 신용카드/계좌이체/가상계좌를 PG사로 사용할때 반드시 입력해야 합니다.
+
+<div class="hint" data-style="info">
+
+가상계좌 입금통지 설정
+
+가상계좌를 사용하는 경우에는 가상계좌 입금통지 설정을 반드시 설정해야 합니다.
+
+</div>

package/assets/docs/opi/ko/extra/plugins/wordpress/woocommerce/readme.md

@@ -0,0 +1,30 @@
+---
+title: 우커머스 플러그인
+description: 포트원 우커머스 플러그인 사용방법을 안내합니다.
+targetVersions:
+  - v1
+---
+
+이 문서는 포트원 우커머스용 결제플러그인을 사용하여 쉽고 빠르게 결제를 연동하는 방법을 설명합니다.
+
+## 플러그인 설치 및 활성화하기
+
+포트원 우커머스용 플러그인을 워드프레스 사이트에 설치합니다. 해당 플러그인을 사용하기 위해서
+[우커머스 플러그인](https://ko.wordpress.org/plugins/woocommerce/)이 설치되어 있어야 합니다.
+
+먼저 워드프레스 관리자 페이지에서 **플러그인** 메뉴를 클릭합니다. 페이지의 상단 플러그인 검색창에 포트원을 검색하여 결과 목록에 있는 **포트원
+우커머스 결제**를 선택합니다.
+
+(관련 이미지 첨부)
+
+플러그인을 설치하고 플러그인을 활성화 합니다.
+
+(관련 이미지 첨부)
+
+## 결제 연동하기
+
+일반결제 또는 정기결제 기능을 워드프레스 우커머스 플러그인을 사용하여 연동할 수 있습니다.
+
+[일반결제 연동하기](https://developers.portone.io/opi/ko/extra/plugins/wordpress/woocommerce/payment)
+
+[정기결제 연동하기](https://developers.portone.io/opi/ko/extra/plugins/wordpress/woocommerce/subscription)

package/assets/docs/opi/ko/extra/plugins/wordpress/woocommerce/subscription.md

@@ -0,0 +1,60 @@
+---
+title: 정기결제 연동하기
+description: 우커머스 플러그인을 통해 정기결제를 연동합니다.
+targetVersions:
+  - v1
+---
+
+이 문서는 우커머스 플러그인을 사용하여 정기결제 기능을 연동하는 방법을 설명합니다.
+
+<div class="hint" data-style="info">
+
+Woocommerce Subscriptions 플러그인
+
+플러그인의 정기결제 기능을 사용하기 위해서는 우커머스에서 제공하는 [WooCommerce Subscriptions](https://woocommerce.com/products/woocommerce-subscriptions/) 플러그인(유료, $199)이 반드시 설치되어 있어야 합니다.
+
+</div>
+
+## STEP1: WooCommerce Subscriptions 다운로드 및 설치
+
+**WooCommerce Subscriptions** 플러그인을 구매하여 다운로드 받습니다. 다운로드 받은 파일내에 담겨있는
+`woocommerce-subscriptions.zip` 파일을 업로드하고 **지금 설치하기** 버튼을 눌러 플러그인을
+설치합니다.
+
+![](/gitbook-assets/ko/woosub-1.png)
+
+설치가 완료되면, **플러그인을 활성화** 버튼을 눌러 플러그인을 활성화합니다.
+
+![](/gitbook-assets/ko/woosub-2.png)
+
+## STEP2: 결제 수단 선택하기
+
+워드프레스 관리자 페이지의 **우커머스 > 설정 > 결제 페이지**로 이동하여, 사용하고자 하는 포트원 정기결제 수단을 선택합니다.
+
+다음 PG사의 경우, 정기결제 수단을 다음과 같이 선택합니다.
+
+- **나이스페이먼츠**: 포트원(KEY-IN결제/정기결제)
+- **KG이니시스 / 다날(신용카드, 휴대폰소액결제)**: 포트원(정기결제-결제창방식)
+
+결제 수단을 포트원(정기결제-결제창방식)으로 선택한 화면입니다.
+
+(관련 이미지 첨부)
+
+## STEP3: 고객사 정보 입력하기
+
+결제 페이지 하단에 [포트원 관리자 콘솔](https://admin.portone.io)에서 확인한 고객사 정보를 입력합니다. 변경 사항 저장 버튼을 눌러 설정 내용을 저장합니다.
+
+(관련 이미지 첨부)
+
+## STEP4: 상품 생성하기
+
+워드프레스 관리자 페이지의 **우커머스 > 상품 > 추가하기** 페이지로 이동합니다. 하단의 **상품
+데이터** 항목을 Simple subscription으로 설정하고, 정기결제에 필요한 옵션들을 설정합니다.
+매월 9,900원(Subscription price: 9900, every, month)을 과금하고 가입비(Sign-up fee)를 100,000원으로
+설정하는 예제입니다.
+
+![](/gitbook-assets/ko/woosub-5.png)
+
+상품을 공개하면, 다음과 같이 정기결제 상품이 추가됩니다.
+
+![](/gitbook-assets/ko/woosub-6.png)

package/assets/docs/opi/ko/extra/plugins/wordpress/woocommerce/vbank.md

@@ -0,0 +1,64 @@
+---
+title: 가상계좌 입금통보 URL 설정하기
+description: 우커머스 플러그인에서 가상계좌 입금통지 URL을 설정합니다.
+targetVersions:
+  - v1
+---
+
+이 문서는 가상계좌를 결제수단으로 사용하기 위해서 필요한 입금통지 URL을 설정하는 방법을 설명합니다.
+결제 금액이 가상계좌에 입금되었을 때, 해당 정보를 워드프레스 사이트에 통지하기 위해서 다음과 같이
+설정합니다.
+
+## STEP1: 가상계좌 입금통지 URL 복사하기
+
+먼저 워드프레스 관리자 페이지의 우커머스 > 설정 > 결제 페이지로 이동합니다. 페이지 상단에서 아임포트(가상계좌)를 선택하고 가상계좌 입금통지설정란의 URL을 복사합니다.
+
+![](/gitbook-assets/ko/vbank-1.png)
+
+## STEP2: 결제알림(Webhook) URL 입력하기
+
+[포트원 관리자 콘솔](http://admin.portone.io) 내 \[결제 연동] - \[연동 관리] - \[결제알림(Webhook) 관리]
+탭을 선택합니다. \[결제모듈 V1] 선택 후 설정 모드를 \[실연동]으로 선택한 후 Endpoint URL란에
+전 단계에서 복사한 값을 입력하고, 하단의 저장 버튼을 눌러 설정을 저장합니다.
+
+(관련 이미지 첨부)
+
+## STEP3: 입금통지 테스트하기
+
+입금통지를 설정한 후, 가상계좌 거래가 원활하게 이루어지는지 테스트할 수 있습니다.
+
+### 1. NHN KCP 선택하기
+
+포트원 콘솔 내 \[결제 연동] - \[연동 관리] - \[채널 관리] 탭을 선택합니다.
+\[+ 채널 추가]를 클릭한 후 연동 모드를 \[테스트]로 선택합니다. 결제대행사에서 NHN KCP를 선택한 후
+\[결제창 일반/수기결제 및 API 수기/정기결제]를 선택한 후 \[다음]을 클릭합니다.
+\[PG상점아이디 (사이트코드)]를 클릭하여 \*\*KCP 결제창 일반결제 (AO09C)\*\*를 클릭한 후 \[저장]을 클릭합니다.
+(해당 테스팅 기능은 KCP에서만 제공합니다.)
+
+(관련 이미지 첨부)
+
+### 2. 구매 시도하기
+
+그 다음, 가상계좌 결제수단으로 상품 구매를 시도하여 결제 프로세스를 완료합니다.
+
+![](/gitbook-assets/ko/vbank-4.png)
+
+우커머스 주문내역을 조회하면 해당 주문이 가상계좌 입금대기중 상태라는 것을 확인할 수 있습니다.
+
+![](/gitbook-assets/ko/vbank-5.png)
+
+### 3. 입금내역 통지하기
+
+[포트원 관리자 콘솔](http://admin.portone.io) 내 \[결제] - \[상세 내역 조회] 페이지에서 \[필터]를
+클릭한 후 \[결제모드]에서 \[테스트 결제]를 체크합니다.
+
+(관련 이미지 첨부)
+
+테스트 결제 내역을 조회하여 가상계좌로 결제를 시도한 주문건을 확인합니다.
+결제 건을 클릭한 후 상세 모달에서 \[테스트 입금 웹훅통지] 버튼을 눌러 워드프레스에 입금내역 통지를 테스트 합니다.
+
+(관련 이미지 첨부)
+
+우커머스 주문내역을 조회하면 해당 주문건이 완료 상태로 변경된 것을 확인할 수 있습니다.
+
+![](/gitbook-assets/ko/vbank-7.png)

package/assets/docs/opi/ko/extra/promotion/console-guide.md

@@ -0,0 +1,148 @@
+---
+title: 프로모션 생성하기
+description: 프로모션 기간, 예산, 할인 조건 등 설정 방법을 안내합니다.
+targetVersions:
+  - v1
+  - v2
+---
+
+## 프로모션 생성하기
+
+프로모션 결제를 사용하기 위해서는 포트원 관리자콘솔 내 \[프로모션]에서 프로모션 설정이 필요합니다.
+프로모션은 상점별로 생성하여 사용할 수 있으며, 하위상점을 사용하시는 고객사의 경우 프로모션을 각각 생성하여 사용하시길 권장드립니다.
+
+1. 포트원 콘솔 내에서 \[프로모션]을 클릭하세요.
+2. \[+ 프로모션 추가]를 클릭하세요.
+
+(이미지 첨부: 콘솔 내 프로모션 화면 예시 1)
+
+3. **프로모션 추가** 화면에서 다음 정보를 입력하세요.
+
+(이미지 첨부: 콘솔 내 프로모션 화면 예시 2)
+
+- \[프로모션 이름] : 생성된 프로모션을 고객사에서 구분할 수 있는 이름을 입력하시길 권장드립니다.
+
+- \[프로모션 일정] : 프로모션 시작일과 종료일을 선택하세요. 시작일이 미래인 경우 생성 후 **예정** 상태이며,
+  설정된 시작일이 경과되면 **진행중** 상태로 변경되며 프로모션 할인이 적용됩니다.
+
+- \[카드사] : 프로모션 할인을 제공할 카드사를 선택하세요. 카드사는 한 프로모션 당 한 곳만 설정할 수 있습니다.
+
+- \[프로모션 예산] : 프로모션을 진행할 전체 예산으로 할인 금액으로 사용할 예산을 입력하세요.
+  예산이 100% 소진된 이후 결제 건에 대해서는 프로모션이 적용되지 않습니다.
+
+- \[프로모션 예산 미복구] : 프로모션 할인이 적용된 거래 건이 부분취소 혹은 전체취소 되었을 때,
+  적용되었던 프로모션 금액을 예산에 다시 포함시킬지 여부를 설정할 수 있습니다.
+  기본적으로 취소된 프로모션 금액이 예산에 복구되며, 프로모션 예산 미복구를 활성화하는 경우 복구되지 않습니다.
+  프로모션 예산 미복구를 활성화하는 경우, 환불 예상 비율 혹은 환불 예상 금액을 입력하여 여유 예산을 설정할 수 있습니다.
+
+- \[할인방식] : 할인율 또는 할인금액을 선택할 수 있으며, 입력된 수치에 따라 정률 또는 정액으로 할인 금액이 적용됩니다.
+  할인율 방식을 선택한 경우, \[최대 할인 금액]을 설정할 수 있으며 최대 할인 금액 설정시 프로모션 할인 금액이
+  최대 할인 금액을 초과할 수 없습니다. 최대 할인 금액을 설정하지 않는 경우 주문 금액에 정률로 계산되어 프로모션 할인이 적용됩니다.
+
+- \[할인 조건 설정] : 할인 조건을 최대 5개까지 설정할 수 있습니다. 최소 결제 금액을 기준으로 구간별
+  할인금액 / 할인율을 설정할 수 있습니다.
+
+  - \[최소 결제 금액] : 최소 결제 금액 설정시 주문 금액이 최소 결제 금액 이상인 경우에만 프로모션 할인이 적용됩니다.
+    만약 최소 결제 금액을 0으로 입력하는 경우 해당 카드로 결제되는 모든 건에 프로모션 할인이 적용됩니다.
+
+  - \[할인율] : 입력된 할인율만큼 주문 금액을 기준으로 정률로 계산되어 할인이 적용됩니다.
+
+  - \[할인금액] : 입력된 할인 금액만큼 할인이 적용됩니다.
+
+  - 예를 들어, `10000원 이상 결제 시 10% 할인, 50000원 이상 결제 시 20% 할인` 과 같은 정책을 생성하고 싶다면
+    조건 1을 **최소 결제 금액 10000원, 할인율 10%**, 조건 2를 **최소 결제 금액 50000원, 할인율 20%** 와 같이 설정하시기 바랍니다.
+
+<div class="hint" data-style="info">
+
+1. 할인 조건의 경우 생성 후 수정이 불가능하므로 변경을 원하시면 삭제 후 다시 추가해야 합니다.
+
+2. 추가 할인 조건의 경우 앞서 생성된 조건의 할인비율보다 크게 설정해야합니다.
+   할인 금액 방식으로 입력하는 경우에도 (할인 금액 / 최소 결제 금액) \* 100으로 할인율을 계산하며,
+   만약 할인율이 낮아지는 경우 금액 입력이 불가능 합니다.
+
+</div>
+
+4. \[저장]을 클릭하세요.
+
+## 프로모션 수정하기
+
+1. 생성된 프로모션 우측에 \[...]을 클릭하세요.
+2. \[수정]을 클릭하세요.
+
+(이미지 첨부: 콘솔 내 프로모션 화면 예시 3)
+
+3. **프로모션 수정** 화면에서 원하는 정보를 수정하세요.
+
+(이미지 첨부: 콘솔 내 프로모션 화면 예시 4)
+
+- **예정** 상태인 경우, 프로모션 아이디를 제외한 모든 정보를 수정할 수 있습니다.
+- **일시중지**, **진행중**, **예산소진** 상태인 경우 프로모션 이름 및 프로모션 일정만 수정할 수 있습니다.
+- **종료** 상태인 경우 모든 정보를 수정할 수 없습니다.
+
+## 프로모션 상태 안내
+
+생성된 프로모션은 총 5개의 상태로 구분할 수 있으며, 상태에 따라 프로모션 아이디를 지정하여 결제 요청했더라도
+프로모션 할인 금액이 적용되지 않을 수 있습니다.
+
+### 예정
+
+프로모션 생성 후 프로모션 시작일이 경과되지 않은 경우 **예정**상태로 표시됩니다.
+예정 상태인 경우 프로모션 아이디를 제외한 모든 정보를 수정할 수 있습니다.
+
+예정 상태인 프로모션을 일시중지하는 경우 프로모션 시작일이 경과되어도 프로모션이 진행중 상태로 변경되지 않으며,
+프로모션 아이디를 지정하여 결제를 요청하더라도 프로모션 할인이 적용되지 않습니다.
+
+예정 상태인 프로모션을 종료하는 경우 종료 상태로 변경되며 상태 변경이 불가능합니다.
+
+### 진행중
+
+프로모션 생성 후 프로모션 시작일이 경과된 경우 **진행중**상태로 표시됩니다.
+진행중 상태인 경우 프로모션 이름 및 프로모션 일정만 수정할 수 있습니다.
+
+진행중 상태인 경우 결제 요청 시 프로모션 아이디를 지정하면 프로모션 할인이 적용됩니다.
+
+진행중 상태인 프로모션을 일시중지하는 경우 직후 결제 요청 건부터 프로모션 아이디를 지정했더라도 프로모션 할인이 적용되지 않습니다.
+다만, 일시중지 직전 결제 요청되었으나 결제 승인이 완료되지 않은 건의 경우 프로모션 할인 금액이 적용될 수 있습니다.
+
+진행중 상태인 프로모션을 종료하는 경우 종료 상태로 변경되며 상태 변경이 불가능합니다.
+
+### 일시중지
+
+사용자가 직접 생성된 프로모션을 일시중지할 수 있으며 예정, 진행중, 예산소진 상태인 경우 일시중지가 가능합니다.
+
+예정이거나 진행중 혹은 예산소진 상태에서 일시중지 상태로 변경된 경우 프로모션 이름 및
+프로모션 일정 중 종료일만 변경할 수 있으며, 시작일은 변경이 불가능합니다.
+
+일시중지하는 경우 프로모션 시작일이 경과되거나 예산이 남아있어도 프로모션 할인은 적용되지 않습니다.
+재시작하여 프로모션이 원 상태로 변경되며, 다시 사용이 가능합니다.
+
+### 예산소진
+
+프로모션 할인금액이 설정된 예산만큼 모두 소진된 경우 **예산소진**상태로 표시됩니다.
+예산소진 상태인 경우 프로모션 아이디를 지정하여 결제 요청하더라도 프로모션 할인이 적용되지 않습니다.
+
+만약 프로모션 할인이 적용된 거래건이 취소되는 경우 해당 거래 건에 적용되었던 할인 금액만큼 예산에 귀속되며,
+이후 거래 요청 시 할인 금액이 적용됩니다.
+
+### 종료
+
+프로모션 종료일이 경과되거나 사용자가 종료한 경우 **종료**상태로 표시됩니다.
+종료된 프로모션은 재시작할 수 없습니다.
+
+프르모션이 종료되는 경우 즉시 프로모션 할인이 적용되지 않습니다. 다만, 종료 직전 결제 요청한 경우 프로모션 종료 이후
+결제 승인이 완료되면 프로모션 할인금액이 적용됩니다.
+
+## 프로모션 엑셀 다운로드
+
+엑셀 다운로드 클릭 시 **프로모션 내역**, **거래 내역** 두 가지 유형으로 데이터를 다운로드 받을 수 있습니다.
+
+- 프로모션 내역 : 조회 기간 내 전체 프로모션 내역에 대해 다운로드할 수 있습니다.
+
+- 프로모션 아이디, 프로모션 이름, 상태, 카드사, 예산, 소진금액, 할인조건, 최대 할인 금액, 프로모션 생성날짜,
+  프로모션 수정 날짜, 프로모션 시작 날짜, 프로모션 종료 예정 날짜, 프로모션 실제 종료 날짜가 포함됩니다.
+
+- 거래 내역 : 조회 기간 내 전체 프로모션이 적용된 건별 거래 내역에 대해 다운로드 할 수 있습니다.
+
+- 고객사 주문번호, 포트원 거래번호, 프로모션 아이디, PG사 승인번호, 카드사 승인번호 등 거래 데이터가 포함됩니다.
+
+- 만약 특정 프로모션이 적용된 거래 내역 확인을 원하시는 경우 해당 프로모션의 `...` 버튼 클릭 후 `거래내역 다운로드`를 클릭하세요.