@portone/mcp-server 0.15.0-alpha.5 → 0.16.0

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

@@ -0,0 +1,275 @@
+---
+title: 이지페이(KICC) 해외결제
+description: 이지페이(KICC) 해외결제 결제 연동 방법을 안내합니다.
+targetVersions:
+  - v1
+---
+
+## 채널 설정하기
+
+- [결제대행사 채널 설정하기](https://developers.portone.io/opi/ko/integration/ready/readme#3-결제대행사-채널-설정하기)의 내용을 참고하여 PG 설정을 진행합니다.
+
+## 가능한 결제 수단
+
+- **결제창 일반 결제**
+
+  KICC 해외결제를 통해 위챗페이와 알리페이 플러스를 이용할 수 있습니다.
+  이용하고자 하는 결제사 별 파라미터는 아래를 참고해주세요.
+
+## SDK 결제 요청하기
+
+결제 요청 시에는 `request_pay` 함수를 호출해야 합니다.
+`channelKey` 파라미터에 결제 채널 연동 후 생성된 채널 키값을 지정하여 KICC 채널 사용을 명시해주세요.
+
+KICC 기준으로 작성한 예시 코드는 아래와 같습니다.
+
+<div class="tabs-container">
+
+<div class="tabs-content" data-title="위챗페이">
+
+```javascript
+IMP.request_pay(
+  {
+    channelKey: "{콘솔 내 연동 정보의 채널키}",
+    pay_method: "wechat",
+    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
+
+**채널키**
+
+결제를 진행할 채널을 지정합니다.
+
+포트원 콘솔 내 \[결제 연동] - \[연동 정보] - \[채널 관리] 에서 확인 가능합니다.
+
+- pay\_method: string
+
+  **결제수단 구분코드**
+
+  - wechat (위챗페이)
+  - alipay\_plus (알리페이 플러스)
+
+- merchant\_uid: string
+
+  **주문번호**
+
+  고객사에서 매번 고유하게 채번되어야 합니다.
+
+- buyer\_name: string
+
+  **주문자 이름**
+
+- buyer\_email: string
+
+  **주문자 이메일**
+
+- buyer\_tel: string
+
+  **주문자 연락처**
+
+- amount: number
+
+  **결제금액**
+
+- currency: string
+
+  **결제 통화 코드**
+
+  [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 통화 코드
+
+  - `KRW`: 한국 원
+  - `USD`: 미국 달러
+
+  미입력하거나 올바르지 않은 값을 입력한 경우 원화(KRW)결제로 동작합니다.
+
+- language: string
+
+  **결제창 언어**
+
+  - `ko`: 한국어
+  - `en`: 영어
+  - `zh`: 중국어 (중국본토)
+
+</div>
+
+<div class="tabs-content" data-title="알리페이 플러스">
+
+```javascript
+IMP.request_pay(
+  {
+    channelKey: "{콘솔 내 연동 정보의 채널키}",
+    pay_method: "alipay_plus",
+    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}",
+    order_description: "주문 상세 내용",
+    alipay_plus: {
+      wallet: "alipay",
+    },
+  },
+  function (rsp) {
+    // callback 로직
+    //* ...중략... *//
+  },
+);
+```
+
+**주요 파라미터 설명**
+
+- channelKey: string
+
+  **채널키**
+
+  결제를 진행할 채널을 지정합니다.
+
+  포트원 콘솔 내 \[결제 연동] - \[연동 정보] - \[채널 관리] 에서 확인 가능합니다.
+
+- pay\_method: string
+
+  **결제수단 구분코드**
+
+  - wechat (위챗페이)
+  - alipay\_plus (알리페이 플러스)
+
+- merchant\_uid: string
+
+  **주문번호**
+
+  고객사에서 매번 고유하게 채번되어야 합니다.
+
+- buyer\_name: string
+
+  **주문자 이름**
+
+- buyer\_email: string
+
+  **주문자 이메일**
+
+- buyer\_tel: string
+
+  **주문자 연락처**
+
+- order\_description: string
+
+  **주문 상세 정보**
+
+  주문 상세 정보로 고객사에서 자유롭게 입력합니다.
+
+  알리페이 플러스 결제시 필수입니다.
+
+  KICC와 알리페이 플러스에서는 영문만 사용하는 것을 권장합니다.
+
+- amount: number
+
+  **결제금액**
+
+- currency: string
+
+  **결제 통화 코드**
+
+  [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 통화 코드
+
+  - `KRW`: 한국 원
+  - `USD`: 미국 달러
+
+  미입력하거나 올바르지 않은 값을 입력한 경우 원화(KRW)결제로 동작합니다.
+
+- language: string
+
+  **결제창 언어**
+
+  - `ko`: 한국어
+  - `en`: 영어
+  - `zh`: 중국어 (중국본토)
+
+- alipay\_plus: object
+
+  **알리페이 플러스 정보**
+
+  - wallet?: string
+
+    **알리페이 플러스를 통해 이용할 간편결제**
+
+    미입력 시 이용 가능한 간편결제 수단이 모두 노출되는 알리페이 플러스 통합 월렛 화면이 표기됩니다.
+
+    - `alipay`: Alipay (알리페이)
+    - `true_money`: TrueMoney (트루머니)
+    - `alipay_hk`: AlipayHK (알리페이 홍콩)
+    - `touch_n_go`: Touch 'n Go (터치앤고)
+    - `gcash`: GCash (지캐시)
+    - `dana`: DANA (다나)
+    - `rabbit_line_pay`: Rabbit LINE Pay (래빗 라인페이)
+    - `bpi`: BPI - Bank of the Philippine Islands (필리핀 제도 은행)
+    - `boost`: Boost (부스트)
+    - `bill_ease`: BillEase (빌이즈)
+    - `tinaba`: Tinaba (티나바)
+    - `mpay`: MPay (엠페이)
+    - `kredivo`: Kredivo (크레디보)
+
+</div>
+
+</div>
+
+## 유의 사항
+
+<div class="tabs-container">
+
+<div class="tabs-content" data-title="위챗페이">
+
+### 결제 승인
+
+위챗페이의 경우 위챗 앱을 이용해 QR코드를 스캔하여 결제를 진행하는 방식으로 결제창이 닫힌 이후에도 구매자가 QR코드를 이미
+스캔해둔 상태라면 언제든지 결제 승인이 발생할 수 있습니다.
+
+따라서 PC에서 callback / Mobile에서 redirect 된 이후 결제내역 조회를 통해 확인된 상태값을 100% 신뢰하지 않도록
+해야하며 웹훅 연동은 필수로 진행해야합니다.
+
+### 결제 취소
+
+위챗페이의 경우 결제 취소가 비동기로 처리됩니다. 결제 취소 요청에 대한 응답으로 주문 상태를 변경하지 않고
+웹훅을 통해 결제 취소 결과를 반영하도록 처리가 필요합니다.
+
+### 도메인 등록
+
+위챗페이는 KICC를 통해 결제창이 오픈될 고객사 결제 페이지 도메인에 대한 등록 요청이 필요합니다.
+
+등록되어있지 않은 도메인에 대해서는 모바일 결제 시도 시 오류 페이지로 연결되므로 유의 바랍니다.
+
+</div>
+
+<div class="tabs-content" data-title="알리페이 플러스">
+
+### 결제 승인
+
+알리페이 플러스의 경우 일부 결제 수단은 앱으로 QR코드를 스캔하여 결제를 진행하는 방식으로 결제창이 닫힌 이후에도 구매자가 QR코드를 이미
+스캔해둔 상태라면 언제든지 결제 승인이 발생할 수 있습니다.
+
+따라서 PC에서 callback / Mobile에서 redirect 된 이후 결제내역 조회를 통해 확인된 상태값을 100% 신뢰하지 않도록
+해야하며 웹훅 연동은 필수로 진행해야합니다.
+
+</div>
+
+</div>

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

@@ -1,6 +1,6 @@
 ---
-title: 이지페이(KICC)
-description: 이지페이(KICC) 결제창 연동 방법을 안내합니다.
+title: 이지페이(KICC) (구모듈)
+description: 이지페이(KICC) (구모듈) 결제창 연동 방법을 안내합니다.
 targetVersions:
   - v1
 ---
@@ -84,9 +84,9 @@ IMP.request_pay(
 
   고객사에서 매번 고유하게 채번되어야 합니다.
 
-- buyer\_tel: string
+- name: string
 
-  **`주문자 연락처`**
+  **주문명**
 
 - amount: number
 
@@ -94,12 +94,93 @@ IMP.request_pay(
 
   **string** 이 아닌점에 유의하세요
 
+- buyer\_name?: string
+
+  **구매자 이름**
+
+- buyer\_email?: string
+
+  **구매자 이메일**
+
+- buyer\_tel: string
+
+  **주문자 연락처**
+
+- buyer\_addr?: string
+
+  **구매자 주소**
+
+- buyer\_postcode?: string
+
+  **구매자 우편번호**
+
 - escrow?: boolean
 
   **에스크로 설정여부**
 
   계좌이체, 가상계좌만 지원됩니다.
 
+- tax\_free?: number
+
+  **면세금액**
+
+- digital?: boolean
+
+  **디지털 컨텐츠 여부**
+
+  - `true`: 컨텐츠
+  - `false`: 실물 상품
+
+- vbank\_due?: string
+
+  **가상계좌 입금마감일시**
+
+- company?: string
+
+  **상호명**
+
+  카드사 다이렉트 호출 시 설정하지 않으면 `iamport`로 표기됩니다.
+
+- auth\_mode?: string
+
+  **인증 방식**
+
+  - `key-in`: 키인결제 모드
+
+- m\_redirect\_url?: string
+
+  **모바일 결제 후 리디렉션 될 URL**
+
+- app\_scheme?: string
+
+  **모바일 앱 URL scheme** (모바일 전용)
+
+- notice\_url?: string | string\[]
+
+  **웹훅 수신 URL**
+
+- confirm\_url?: string
+
+  **Confirm process URL**
+
+- custom\_data?: object
+
+  **가맹점 커스텀 데이터**
+
+- customer\_id?: string
+
+  **구매자 고유 ID**
+
+- bypass?: object
+
+  **KICC 전용 파라미터**
+
+  - kicc?: object
+
+    - disp\_cash\_yn?: string
+
+      **현금영수증 표시 여부**
+
 </div>
 
 <div class="tabs-content" data-title="비인증 결제(결제창)">
@@ -170,6 +251,14 @@ IMP.request_pay(
 
   비 인증 결제창에서 고객이 입력한 카드정보와 1:1로 매칭될 빌링키를 지정합니다.
 
+- merchant\_uid: string
+
+  **주문번호**
+
+- name: string
+
+  **주문명**
+
 - amount: number
 
   **결제금액**
@@ -178,6 +267,30 @@ IMP.request_pay(
 
   (실 결제를 발생시키기 위해서는 **`customer_uid`** 로 **REST API 를 이용하여 결제요청**을 해 주셔야 합니다.)
 
+- buyer\_name?: string
+
+  **구매자 이름**
+
+- buyer\_email?: string
+
+  **구매자 이메일**
+
+- buyer\_tel?: string
+
+  **구매자 연락처**
+
+- m\_redirect\_url?: string
+
+  **모바일 결제 후 리디렉션 될 URL**
+
+- notice\_url?: string | string\[]
+
+  **웹훅 수신 URL**
+
+- custom\_data?: object
+
+  **가맹점 커스텀 데이터**
+
 ### 빌링키(`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) 를 호출하시면 결제를 발생시킬 수 있습니다.

package/assets/docs/opi/ko/integration/pg/v1/ksnet/readme.md

@@ -60,7 +60,7 @@ IMP.request_pay(
     name: "나이키 와플 트레이너 2 SD",
     pay_method: "card",
     escrow: false,
-    amount: "109000",
+    amount: 109000,
     tax_free: 3000,
     buyer_name: "홍길동",
     buyer_email: "buyer@example.com",
@@ -160,10 +160,22 @@ IMP.request_pay(
 
   **구매자명**
 
+- buyer\_email?: string
+
+  **구매자 이메일**
+
 - buyer\_tel?: string
 
   **구매자 전화번호**
 
+- buyer\_addr?: string
+
+  **구매자 주소**
+
+- buyer\_postcode?: string
+
+  **구매자 우편번호**
+
 - currency: string
 
   **결제 통화**
@@ -245,7 +257,7 @@ IMP.request_pay(
 
       **통신사 구분**
 
-      통신사에 따라 LG는 `lgt`, KT는 `kgf`, SKT는 `skt`로 입력해야 하며, 통신사 구분이 어려우신 경우
+      통신사에 따라 LG는 `lgt`, KT는 `ktf`, SKT는 `skt`로 입력해야 하며, 통신사 구분이 어려우신 경우
       임의의 값을 입력하여 요청해도 무방합니다.
 
     - url?: string
@@ -254,6 +266,14 @@ IMP.request_pay(
 
       - 결제를 요청하는 사이트의 url을 입력하여야 합니다.
 
+    - sndKakaopayType?: string
+
+      **카카오페이 결제시 허용할 결제수단**
+
+      - `CARD`: 카드 결제만 허용
+      - `MONEY`: 카카오머니 결제만 허용
+      - 미입력시 모든 결제수단 허용
+
 </div>
 
 <div class="tabs-content" data-title="비인증 결제창 요청">

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

@@ -120,6 +120,46 @@ IMP.request_pay(
 
   **string** 이 아닌점에 유의하세요
 
+- buyer\_name?: string
+
+  **구매자 이름**
+
+- buyer\_email?: string
+
+  **구매자 이메일**
+
+- buyer\_tel?: string
+
+  **구매자 연락처**
+
+- buyer\_addr?: string
+
+  **구매자 주소**
+
+- buyer\_postcode?: string
+
+  **구매자 우편번호**
+
+- tax\_free?: number
+
+  **면세금액**
+
+- notice\_url?: string | string\[]
+
+  **웹훅 수신 URL**
+
+- confirm\_url?: string
+
+  **Confirm process URL**
+
+- custom\_data?: object
+
+  **가맹점 커스텀 데이터**
+
+- customer\_id?: string
+
+  **구매자 고유 ID**
+
 - naverUseCfm?: string
 
   **이용 완료일** (`yyyyMMdd` 형식의 문자열로 **결제 당일 또는 미래의 일자**여야 함)
@@ -297,6 +337,26 @@ IMP.request_pay(
 
   정기/반복 결제 등록과정에서는 결제승인이 이뤄지지 않습니다.
 
+- buyer\_name?: string
+
+  **구매자 이름**
+
+- buyer\_email?: string
+
+  **구매자 이메일**
+
+- buyer\_tel?: string
+
+  **구매자 연락처**
+
+- notice\_url?: string | string\[]
+
+  **웹훅 수신 URL**
+
+- custom\_data?: object
+
+  **가맹점 커스텀 데이터**
+
 - naverProductCode: string
 
   **고객사의 상품코드**