@portone/mcp-server 0.13.0

package/assets/docs/opi/ko/integration/pg/v1/kcp-v2-identity-verification.md

@@ -0,0 +1,188 @@
+---
+title: NHN KCP(신모듈) 본인인증 연동하기
+description: NHN KCP(신모듈) 본인인증 연동 방법을 안내합니다.
+targetVersions:
+  - v1
+versionVariants:
+  v2: /opi/ko/integration/pg/v2/kcp-v2-identity-verification
+---
+
+## NHN KCP(신모듈) 본인인증 채널 설정하기
+
+- [결제대행사 채널 설정하기](https://developers.portone.io/opi/ko/integration/ready/readme#3-결제대행사-채널-설정하기) 페이지의 내용을 참고하여 채널 설정을 진행합니다.
+
+## API 방식으로 본인인증하기
+
+- [본인인증 관련 API](https://developers.portone.io/api/rest-v1/certification?v=v1)페이지의 내용을 참고하여 연동을 진행합니다.
+
+### 본인인증 요청 API
+
+```ts title="server-side"
+const response = await fetch(
+  `https://api.iamport.kr/certifications/otp/request`,
+  {
+    method: "POST",
+    headers: {
+      Authorization: `Bearer ${ACCESS_TOKEN}`,
+      "Content-Type": "application/json",
+    },
+    body: JSON.stringify({
+      merchant_uid: "merchant_1234567890",
+      name: "홍길동",
+      phone: "01012345678",
+      birth: "900101",
+      gender_digit: "1",
+      carrier: "SKT",
+      is_mvno: false,
+      verification_method: "SMS",
+      ip: "127.0.0.1",
+      bypass: {
+        kcpV2: {
+          media_type: "MC01", // PC
+          web_siteid: "SITE_123456",
+          cp_sms_msg: "인증번호는 [000000] 입니다.",
+          cp_callback: "01012345678",
+        },
+      },
+    }),
+  },
+);
+
+const data = await response.json();
+```
+
+<div class="tabs-container">
+
+<div class="tabs-content" data-title="필수 파라미터">
+
+- channelKey: string
+
+  **본인인증 요청하고자 하는 PG사의 채널키**
+
+  pg 파라미터는 deprecated 되었기 때문에, 반드시 channelKey 파라미터에 본인인증을 요청하고자 하는 PG사 채널의 채널키를 입력해주세요.
+
+- name: string
+
+  **본인인증 대상자 성명**
+
+- phone: string
+
+  **본인인증 대상자 전화번호**
+
+- birth: string
+
+  **본인인증 대상자 생년월일(YYMMDD)**
+
+- gender\_digit: string
+
+  **주민등록번호 뒷부분 첫차리**
+
+  외국인 고객은 다음 기준에 따라 입력해주세요:
+
+  - 남성: \~1999년생은 5, 2000년 이후 출생자는 7
+  - 여성: \~1999년생은 6, 2000년 이후 출생자는 8
+
+- carrier: string
+
+  **통신사 코드**
+
+  - SKT
+  - KT
+  - LGT
+
+- is\_mvno: boolean
+
+  **알뜰폰 사용 여부**
+
+  알뜰폰 사용자의 경우, carrier 파라미터에 SKT, KT, LGT 중 하나를 지정 후
+  is\_mvno 파라미터를 true로 지정합니다.
+
+- verification\_method: string
+
+  **본인인증 방식**
+
+  - SMS
+  - APP
+
+- bypass.kcpV2.media\_type: string
+
+  **미디어 타입**
+
+  - PC : MC01
+  - MOBILE : MC02
+
+</div>
+
+<div class="tabs-content" data-title="선택 파라미터">
+
+- merchant\_uid: string
+
+  **고객사 주문번호**
+
+  본인인증을 식별하기 위한 고객사의 주문 고유 번호로 매번 고유하게 채번되어야 합니다.
+
+- bypass.kcpV2.web\_siteid: string
+
+  **KCP 사이트 식별코드**
+
+  DI 생성 시 사용할 사이트 ID입니다. 미입력 시 KCP에서 발급한 사이트 ID로 설정됩니다.
+
+- bypass.kcpV2.cp\_sms\_msg: string
+
+  **CP 지정 SMS 메세지**
+
+  인증번호 난수가 채워질 \[000000] 부분만 제외 (6자리)하고 표시할 문자 발송 내용으로 요청 바랍니다.
+  “\[000000]” 문자열은 반드시 포함되어야 합니다.
+
+  ex) “cp\_sms\_msg” : “\[TEST SHOP]이용자번호는\[000000]입니다.”
+
+- bypass.kcpV2.cp\_callback: string
+
+  **CP 지정 callback 번호**
+
+  인증번호 SMS의 발신자
+
+</div>
+
+</div>
+
+### 본인인증 확인 API
+
+```ts title="sever-side"
+const response = await fetch(
+  `https://api.iamport.kr/certifications/otp/confirm/{imp_uid}`,
+  {
+    method: "POST",
+    headers: {
+      Authorization: `Bearer ${ACCESS_TOKEN}`,
+      "Content-Type": "application/json",
+    },
+    body: JSON.stringify({
+      imp_uid: "imp_uid",
+      otp: "123456",
+    }),
+  },
+);
+```
+
+<div class="tabs-container">
+
+<div class="tabs-content" data-title="필수 파라미터">
+
+- imp\_uid: string
+
+  **포트원 인증 고유번호**
+
+</div>
+
+<div class="tabs-content" data-title="선택 파라미터">
+
+- otp: string
+
+  **SMS로 전송된 인증번호**
+
+  APP 방식 본인인증에서는 전달하지 않습니다.
+
+</div>
+
+</div>

package/assets/docs/opi/ko/integration/pg/v1/kg.md

@@ -0,0 +1,177 @@
+---
+title: KG모빌리언스
+description: KG모빌리언스 결제 연동 방법을 안내합니다.
+targetVersions:
+  - v1
+---
+
+## 1. KG모빌리언스 채널 설정하기
+
+[결제대행사 채널 설정하기](https://developers.portone.io/opi/ko/integration/ready/readme#3-결제대행사-채널-설정하기) 페이지의 내용을 참고하여 채널 설정을 진행합니다.
+
+(관련 이미지 첨부)
+
+## 2. 결제 요청하기
+
+[JavaScript SDK](https://developers.portone.io/sdk/ko/v1-sdk/javascript-sdk/readme) `IMP.request_pay(param, callback)`을 호출하여
+KG 모빌리언스 결제창을 호출할 수 있습니다.
+**결제 결과**는 PC의 경우 `IMP.request_pay(param, callback)` 호출 후
+**callback** 으로 수신되고
+모바일의 경우 **m\_redirect\_url**로 리디렉션됩니다.
+
+```ts title="Javascript SDK"
+IMP.request_pay(
+  {
+    channelKey: "{콘솔 내 연동 정보의 채널키}",
+    pay_method: "phone",
+    merchant_uid: "order_no_0001", //상점에서 생성한 고유 주문번호
+    name: "주문명:결제테스트",
+    amount: 1004,
+    buyer_email: "test@portone.io",
+    buyer_name: "구매자이름",
+    buyer_tel: "010-1234-5678", //필수
+    buyer_addr: "서울특별시 강남구 삼성동",
+    buyer_postcode: "123-456",
+    m_redirect_url: "{모바일에서 결제 완료 후 리디렉션 될 URL}",
+  },
+  function (rsp) {
+    // callback 로직
+    //* ...중략... *//
+  },
+);
+```
+
+## 주요 파라미터 설명
+
+- channelKey: string
+
+  **채널키**
+
+  결제를 진행할 채널을 지정합니다.
+
+  포트원 콘솔 내 \[결제 연동] - \[연동 정보] - \[채널 관리] 에서 확인 가능합니다.
+
+  (최신 JavaScript SDK 버전부터 사용 가능합니다.)
+
+- pg(deprecated)?: string
+
+  **PG사 구분코드**
+
+  `mobilians` 로 지정하면 됩니다.
+
+  <div class="hint" data-style="warning">
+
+  `pg` 파라미터는 지원 중단 예정입니다.
+
+  JS SDK를 가장 최신 버전으로 업그레이드 후 `channelKey` 파라미터로 채널 설정(PG사 구분)을 대체해주세요.
+
+  </div>
+
+- pay\_method: string
+
+**결제수단 구분 코드**}
+
+- card (신용카드)
+
+  - phone (휴대폰 소액 결제)
+
+- merchant\_uid: string
+
+  **주문번호**
+
+  매번 고유하게 채번되어야 합니다.
+
+- amount: number
+
+  **결제금액**
+
+  **string** 이 아닌점에 유의하세요
+
+인증결제창 호출 파라미터에서 **customer\_uid** 값을 추가하면 비 인증 결제창을 호출할 수 있습니다. 비
+인증 결제창에서 빌링키를 발급받은 후 해당 빌링키로 결제를 요청합니다.
+
+```ts title="Javascript SDK"
+IMP.request_pay(
+  {
+    channelKey: "{콘솔 내 연동 정보의 채널키}",
+    pay_method: "phone",
+    merchant_uid: "order_monthly_0001", // 상점에서 관리하는 주문 번호
+    name: "최초인증결제",
+    amount: 1004, // 결제창에 표시될 금액. 실제 승인이 이뤄지지는 않습니다.
+    customer_uid: "your-customer-unique-id", // 필수 입력.
+    buyer_email: "test@portone.io",
+    buyer_name: "포트원",
+    buyer_tel: "02-1234-1234",
+    m_redirect_url: "{모바일에서 결제 완료 후 리디렉션 될 URL}",
+  },
+  function (rsp) {
+    if (rsp.success) {
+      alert("빌링키 발급 성공");
+    } else {
+      alert("빌링키 발급 실패");
+    }
+  },
+);
+```
+
+<div class="hint" data-style="info">
+
+- 비 인증 결제를 위해서는 **KG모빌리언스와 계약이 완료된 MID 정보를** 관리자콘솔에 설정하셔야 비 인증 결제창을 활성화시킬 수 있습니다.
+- **KG모빌리언스 휴대폰 결제는** 빌링키 발급시 **실 결제가 발생됩니다.**
+- 최초 승인일자 기준 매월 **동일한 일자에 동일 금액**이 재결제되어야 합니다.
+
+</div>
+
+### 주요 파라미터 설명
+
+- channelKey: string
+
+  **채널키**
+
+  결제를 진행할 채널을 지정합니다.
+
+  포트원 콘솔 내 \[결제 연동] - \[연동 정보] - \[채널 관리] 에서 확인 가능합니다.
+
+  (최신 JavaScript SDK 버전부터 사용 가능합니다.)
+
+- pg(deprecated)?: string
+
+  **PG사 구분코드**
+
+  **`mobilians.<KG모빌리언스와 계약이 완료된 MID>`** 로 지정하면 됩니다.
+
+  <div class="hint" data-style="warning">
+
+  `pg` 파라미터는 지원 중단 예정입니다.
+
+  JS SDK를 가장 최신 버전으로 업그레이드 후 `channelKey` 파라미터로 채널 설정(PG사 구분)을 대체해주세요.
+
+  </div>
+
+- customer\_uid: string
+
+  **카드 빌링키**
+
+  비 인증 결제창에서 고객이 입력한 카드정보와 1:1로 매칭될 빌링키를 지정합니다.
+
+- amount: number
+
+  **결제금액**
+
+  결제창에 표시될 금액으로 실제 승인이 발생됩니다.
+
+  (실 결제를 발생시키기 위해서는 **`customer_uid`** 로 **REST API 를 이용하여 결제를 요청**해주셔야 합니다.)
+
+### 빌링키(`customer_uid`)로 결제 요청하기
+
+빌링키 발급이 성공하면 실 빌링키는 `customer_uid` 와 1:1 매칭되어 **포트원 서버에 저장**됩니다.
+`customer_uid`를 고객사 내부서버에 저장하시고 [**비 인증 결제요청 REST API**](https://developers.portone.io/api/rest-v1/nonAuthPayment?v=v1#post%20%2Fsubscribe%2Fpayments%2Fagain) 를 호출하시면
+결제를 발생시킬 수 있습니다.
+
+```sh title="server-side"
+curl -H "Content-Type: application/json" \
+     -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":1004}' \
+     https://api.iamport.kr/subscribe/payments/again
+```
+
+**포트원을 통해 KG 모빌리언스를 사용할 때에는 API 방식 비 인증 결제를 사용할 수 없습니다.**

package/assets/docs/opi/ko/integration/pg/v1/kicc.md

@@ -0,0 +1,308 @@
+---
+title: 이지페이(KICC)
+description: 이지페이(KICC) 결제창 연동 방법을 안내합니다.
+targetVersions:
+  - v1
+---
+
+## 1. 이지페이(KICC) 채널 설정하기
+
+[결제대행사 채널 설정하기](https://developers.portone.io/opi/ko/integration/ready/readme#3-결제대행사-채널-설정하기) 페이지의 내용을 참고하여 채널 설정을 진행합니다.
+
+(관련 이미지 첨부)
+
+## 2. 결제 요청하기
+
+<div class="tabs-container">
+
+<div class="tabs-content" data-title="인증결제">
+
+[JavaScript SDK](https://developers.portone.io/sdk/ko/v1-sdk/javascript-sdk-old/readme) `IMP.request_pay(param, callback)`을 호출하여 KICC 결제창을 호출할 수 있습니다.
+**결제결과**는 PC의 경우 `IMP.request_pay(param, callback)` 호출 후 **callback**으로 수신되고
+모바일의 경우 **m\_redirect\_url**로 리디렉션됩니다.
+
+```ts title="Javascript SDK"
+IMP.request_pay(
+  {
+    channelKey: "{콘솔 내 연동 정보의 채널키}",
+    pay_method: "card",
+    merchant_uid: "order_no_0001", // 상점에서 생성한 고유 주문번호
+    name: "주문명:결제테스트",
+    amount: 1004,
+    buyer_email: "test@portone.io",
+    buyer_name: "구매자이름",
+    buyer_tel: "010-1234-5678", // 필수
+    buyer_addr: "서울특별시 강남구 삼성동",
+    buyer_postcode: "123-456",
+    m_redirect_url: "{모바일에서 결제 완료 후 리디렉션 될 URL}",
+  },
+  function (rsp) {
+    // callback 로직
+    //* ...중략... *//
+  },
+);
+```
+
+### 주요 파라미터 설명
+
+- channelKey: string
+
+  **채널키**
+
+  결제를 진행할 채널을 지정합니다.
+
+  포트원 콘솔 내 \[결제 연동] - \[연동 정보] - \[채널 관리] 에서 확인 가능합니다.
+
+  (최신 JavaScript SDK 버전부터 사용 가능합니다.)
+
+- pg(deprecated)?: string
+
+  **PG사 구분코드**
+
+  `kicc` 로 지정하면 됩니다.
+
+  <div class="hint" data-style="warning">
+
+  `pg` 파라미터는 지원 중단 예정입니다.
+
+  JS SDK를 가장 최신 버전으로 업그레이드 후 `channelKey` 파라미터로 채널 설정(PG사 구분)을 대체해주세요.
+
+  </div>
+
+- pay\_method: string
+
+  **결제수단 구분코드**
+
+  - card(신용카드)
+  - trans(실시간 계좌이체)
+  - vbank(가상계좌)
+  - phone(휴대폰소액결제)
+
+- merchant\_uid: string
+
+  **주문번호**
+
+  고객사에서 매번 고유하게 채번되어야 합니다.
+
+- buyer\_tel: string
+
+  **`주문자 연락처`**
+
+- amount: number
+
+  **결제금액**
+
+  **string** 이 아닌점에 유의하세요
+
+- escrow?: boolean
+
+  **에스크로 설정여부**
+
+  계좌이체, 가상계좌만 지원됩니다.
+
+</div>
+
+<div class="tabs-content" data-title="비인증 결제(결제창)">
+
+인증결제창 호출 파라미터에서 **`customer_uid`** 값을 추가하면 비 인증 결제창을 호출할 수 있습니다.
+비 인증 결제창에서 빌링키를 발급받은 후 해당 빌링키로 결제를 요청합니다.
+
+```ts title="Javascript SDK"
+IMP.request_pay(
+  {
+    channelKey: "{콘솔 내 연동 정보의 채널키}",
+    pay_method: "card", // 'card'만 지원됩니다.
+    merchant_uid: "order_monthly_0001", // 상점에서 관리하는 주문 번호
+    name: "최초인증결제",
+    amount: 1004, // 결제창에 표시될 금액. 실제 승인이 이뤄지지는 않습니다.
+    customer_uid: "your-customer-unique-id", // 필수 입력.
+    buyer_email: "test@portone.io",
+    buyer_name: "포트원",
+    buyer_tel: "02-1234-1234",
+    m_redirect_url: "{모바일에서 결제 완료 후 리디렉션 될 URL}",
+  },
+  function (rsp) {
+    if (rsp.success) {
+      alert("빌링키 발급 성공");
+    } else {
+      alert("빌링키 발급 실패");
+    }
+  },
+);
+```
+
+<div class="hint" data-style="info">
+
+- 비 인증 결제를 위해서는 **KICC와 협의가 완료된 MID 정보** 관리자콘솔에 설정하셔야 비인증 결제창을 활성화 시킬수 있습니다.
+- KICC는 빌링키 발급시 **실 결제가 발생되지 않습니다**.(금액을 지정해도 결제가 발생되지 않음)
+
+</div>
+
+### 주요 파라미터 설명
+
+- channelKey: string
+
+  **채널키**
+
+  결제를 진행할 채널을 지정합니다.
+
+  포트원 콘솔 내 \[결제 연동] - \[연동 정보] - \[채널 관리] 에서 확인 가능합니다.
+
+  (최신 JavaScript SDK 버전부터 사용 가능합니다.)
+
+- pg(deprecated)?: string
+
+  **PG사 구분코드**
+
+  **`kicc.<KICC와 협의가 완료된 MID>`** 로 지정하면 됩니다.
+
+  <div class="hint" data-style="warning">
+
+  `pg` 파라미터는 지원 중단 예정입니다.
+
+  JS SDK를 가장 최신 버전으로 업그레이드 후 `channelKey` 파라미터로 채널 설정(PG사 구분)을 대체해주세요.
+
+  </div>
+
+- customer\_uid: string
+
+  **카드 빌링키**
+
+  비 인증 결제창에서 고객이 입력한 카드정보와 1:1로 매칭될 빌링키를 지정합니다.
+
+- amount: number
+
+  **결제금액**
+
+  결제창에 표시될 금액으로 실제 승인은 이루어지지 않습니다.
+
+  (실 결제를 발생시키기 위해서는 **`customer_uid`** 로 **REST API 를 이용하여 결제요청**을 해 주셔야 합니다.)
+
+### 빌링키(`customer_uid`)로 결제 요청하기
+
+빌링키 발급이 성공하면 실 빌링키는 `customer_uid` 와 1:1 매칭되어 **포트원 서버에 저장**됩니다. `customer_uid`를 고객사 내부서버에 저장하시고 [**비 인증 결제요청 REST API**](https://developers.portone.io/api/rest-v1/nonAuthPayment?v=v1#post%20%2Fsubscribe%2Fpayments%2Fagain) 를 호출하시면 결제를 발생시킬 수 있습니다.
+
+```sh title="server-side"
+curl -H "Content-Type: application/json" \
+     -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":1004}' \
+     https://api.iamport.kr/subscribe/payments/again
+```
+
+**포트원을 통한 KICC API 방식 비 인증 결제는 지원되지 않습니다.**
+
+</div>
+
+</div>
+
+## 3. 부가기능
+
+<div class="tabs-container">
+
+<div class="tabs-content" data-title="에스크로 설정">
+
+KICC는 **현금성 결제수단** (실시간 계좌이체, 가상계좌)에 한하여 에스크로 결제수단을 지원합니다.
+
+> 에스크로 설정을 위해서는 아래 파라미터를 기본적으로 설정한 후 추가적인 파라미터를
+>
+> 입력해야 합니다.
+>
+> - **`escrow: true`**
+
+**추가 파라미터 안내**
+
+에스크로 결제 시 다음 파라미터를 반드시 설정해야 합니다.
+
+- `buyer_name` : 구매자 이름
+
+- `buyer_email` : 구매자 이메일
+
+- `buyer_tel` : 구매자 전화번호
+
+- `kiccProducts` : 상품별 부분배송을 위한 상품 관련 정보 (4개의 필수 속성으로 구성된 객체배열). 해당 `amount` 값은 결제 금액(`param.amount`) 값과 관계가 없으며 비교검증되지 않습니다.
+  - `orderNumber` : 상품주문번호
+  - `name` : 상품명
+  - `quantity` : 수량
+  - `amount` : 상품 가격
+
+```json
+{
+  "escrow": true, // 에스크로 결제인 경우 필요
+  "kiccProducts": [
+    {
+      "orderNumber": "xxxx",
+      "name": "상품A",
+      "quantity": 3,
+      "amount": 1000
+    },
+    {
+      "orderNumber": "yyyy",
+      "name": "상품B",
+      "quantity": 2,
+      "amount": 3000
+    }
+  ]
+}
+```
+
+</div>
+
+<div class="tabs-content" data-title="카드사 모듈 바로 호출">
+
+```json
+{
+  "card": {
+    "direct": {
+      "code": "367",
+      "quota": 3
+    }
+  }
+}
+```
+
+**파라미터 설명**
+
+- **`code`** : 카드사 금융결제원 표준 코드. [**링크**](https://developers.portone.io/opi/ko/support/code-info/card-code) 참조 (**string**)
+- **`quota`** : 할부 개월 수. 일시불일 시 0 으로 지정. (**number**)
+
+<div class="hint" data-style="danger">
+
+**주의사항**
+
+- 일부 PG사의 경우, 모든 상점아이디에 대하여 카드사 결제창 direct 노출 기능을 지원하지 않습니다. 반드시 포트원을 통해 현재 사용중인 상점아이디가 카드사 결제창 direct 호출이 가능하도록 설정이 되어있는지 PG사에 확인이 필요합니다.
+
+</div>
+
+</div>
+
+<div class="tabs-content" data-title="특정 카드사 노출">
+
+```json
+{
+  "card": {
+    "detail": [
+      { "card_code": "*", "enabled": false }, //모든 카드사 비활성화
+      { "card_code": "366", "enabled": true } //특정 카드만 활성화
+    ]
+  }
+}
+```
+
+**파라미터 설명**
+
+- detail?: object\[]
+
+  **카드사 렌더링 정보**
+
+  - card\_code?: string
+
+    **카드사 코드**
+
+    [카드사 코드](https://developers.portone.io/opi/ko/support/code-info/card-code)를 참고하세요.
+
+  - enabled?: boolean
+
+    **렌더링 여부**
+
+</div>
+
+</div>