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

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

@@ -52,7 +52,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",
@@ -124,7 +124,7 @@ IMP.request_pay(
   - 카카오페이 (kakaopay)
   - 네이버페이 (naverpay)
   - 엘페이 (lpay)
-  - 삼성페이(samsung)
+  - 삼성페이(samsungpay)
   - SSGpay (ssgpay)
   - 애플페이 (applepay)
   - 페이코 (payco)
@@ -136,6 +136,10 @@ IMP.request_pay(
 
   매번 고유하게 채번되어야 합니다.
 
+- name: string
+
+  **주문명**
+
 - amount: number
 
   **결제금액**
@@ -150,10 +154,52 @@ IMP.request_pay(
 
   **구매자 email 주소**
 
+- buyer\_tel?: string
+
+  **구매자 연락처**
+
+- buyer\_addr?: string
+
+  **구매자 주소**
+
+- buyer\_postcode?: string
+
+  **구매자 우편번호**
+
+- escrow?: boolean
+
+  **에스크로 결제 여부**
+
+- tax\_free?: number
+
+  **면세금액**
+
 - currency?: string
 
   **통화구분코드**
 
+- m\_redirect\_url?: string
+
+  **모바일 결제 후 리디렉션 될 URL**
+
+  모바일 환경에서 필수 입력합니다.
+
+- app\_scheme?: string
+
+  **모바일 앱 URL scheme** (모바일 전용)
+
+- notice\_url?: string | string\[]
+
+  **웹훅 수신 URL**
+
+- confirm\_url?: string
+
+  **Confirm process URL**
+
+- custom\_data?: object
+
+  **가맹점 커스텀 데이터**
+
 - appCard?: boolean
 
   카드 결제시, 카드 결제창에 앱카드만 선택 가능하도록 할지 여부 (기본값: **false**)
@@ -172,20 +218,32 @@ IMP.request_pay(
 
   - isCulturalExpense?: boolean
 
-    문화비 지출여부
-
-  - useInternationalCardOnly?: boolean
+    **문화비 지출 여부** (bypass 루트 레벨, 계좌이체/가상계좌 전용)
 
-    해외카드(Visa, MasterCard, UnionPay) 결제 여부입니다. 값이 `true`면 해외카드 결제가 가능한 영문 결제창이 열립니다.
+    `pay_method`가 `trans` 또는 `vbank`일 때만 토스페이먼츠에 전달됩니다.
 
   - cashReceiptType?: string
 
-    현금성 결제(계좌이체, 가상계좌)창에서 선택할 수 있는 현금영수증 발급 유형 (기본값: 결제창에서 선택 가능)
+    **현금영수증 발급 유형** (bypass 루트 레벨, 계좌이체/가상계좌 전용)
+
+    `pay_method`가 `trans` 또는 `vbank`일 때만 토스페이먼츠에 전달됩니다. 미지정 시 결제창에서 선택 가능합니다.
 
     - anonymous (미발행, 자진발급)
     - personal (소득공제)
     - corporate (지출증빙)
 
+  - tosspayments?: object
+
+    **토스페이먼츠 전용 파라미터** (카드 결제 전용)
+
+    - useInternationalCardOnly?: boolean
+
+      해외카드(Visa, MasterCard, UnionPay) 결제 여부입니다. 값이 `true`면 해외카드 결제가 가능한 영문 결제창이 열립니다.
+
+    - discountCode?: string
+
+      **카드사 할인코드**
+
 ```json
 {
   "pay_method": "trans",
@@ -196,6 +254,18 @@ IMP.request_pay(
 }
 ```
 
+```json
+{
+  "pay_method": "card",
+  "bypass": {
+    "tosspayments": {
+      "useInternationalCardOnly": true,
+      "discountCode": "카드사 할인코드"
+    }
+  }
+}
+```
+
 </details>
 
 </div>
@@ -264,12 +334,52 @@ IMP.request_pay(
 
   비 인증 결제창에서 고객이 입력한 카드정보와 1:1로 매칭될 빌링키를 지정합니다.
 
+- name: string
+
+  **주문명**
+
 - amount: number
 
   **결제금액**
 
   결제창에 표시될 금액으로 실제 승인은 이루어지지 않습니다.(실 결제를 발생시키기 위해서는 **customer\_uid** 로 **REST API 를 이용하여 결제요청**을 해주셔야 합니다.)
 
+- buyer\_name?: string
+
+  **구매자 이름**
+
+- buyer\_email?: string
+
+  **구매자 이메일**
+
+- buyer\_tel?: string
+
+  **구매자 연락처**
+
+- buyer\_addr?: string
+
+  **구매자 주소**
+
+- buyer\_postcode?: string
+
+  **구매자 우편번호**
+
+- m\_redirect\_url?: string
+
+  **모바일 결제 후 리디렉션 될 URL**
+
+- app\_scheme?: string
+
+  **모바일 앱 URL scheme** (모바일 전용)
+
+- notice\_url?: string | string\[]
+
+  **웹훅 수신 URL**
+
+- custom\_data?: object
+
+  **가맹점 커스텀 데이터**
+
 - customer\_id?: string
 
   **`구매자 식별자`**

package/assets/docs/opi/ko/integration/pg/v1/nhn-kcp/kcp-quickpay.md

@@ -125,7 +125,6 @@ IMP.request_pay(
     channelKey: "{콘솔 내 연동 정보의 채널키}",
     merchant_uid: "order_no_0001",
     name: "PIN 변경",
-    customer_uid: "use_your_unique_id", //`bypass.kcpQuick.memberId`와 동일하게 입력
     bypass: {
       kcpQuick: {
         actionType: "PinChange",
@@ -154,7 +153,6 @@ IMP.request_pay(
     pay_method: "card",
     merchant_uid: "order_no_0001",
     name: "PIN 초기화",
-    customer_uid: "use_your_unique_id", // `bypass.kcpQuick.memberId`와 동일하게 입력
     bypass: {
       kcpQuick: {
         actionType: "PinReset",
@@ -183,7 +181,6 @@ IMP.request_pay(
     pay_method: "card",
     merchant_uid: "order_no_0001",
     name: "PIN 확인",
-    customer_uid: "use_your_unique_id", // `bypass.kcpQuick.memberId`와 동일하게 입력
     bypass: {
       kcpQuick: {
         actionType: "PinCheck",
@@ -215,7 +212,6 @@ IMP.request_pay(
     channelKey: "{콘솔 내 연동 정보의 채널키}",
     merchant_uid: "order_no_0001",
     name: "전화번호 변경",
-    customer_uid: "use_your_unique_id", // `bypass.kcpQuick.memberId`와 동일하게 입력
     bypass: {
       kcpQuick: {
         actionType: "PhoneChange",
@@ -285,7 +281,6 @@ IMP.request_pay(
     channelKey: "{콘솔 내 연동 정보의 채널키}",
     merchant_uid: "order_no_0001",
     name: "간편결제 서비스 해지",
-    customer_uid: "use_your_unique_id", //`bypass.kcpQuick.memberId`와 동일하게 입력
     bypass: {
       kcpQuick: {
         actionType: "Terminate",
@@ -358,7 +353,7 @@ IMP.request_pay(
     name: "선불머니 환급계좌 등록 및 변경",
     bypass: {
       kcpQuick: {
-        actionType: "RefundAccount",
+        actionType: "PrepaidRefundAccount",
         encryptedCI: "encrypted_ci",
         memberID: "use_your_unique_id",
       },
@@ -504,10 +499,13 @@ IMP.request_pay(
       - PinCheck : PIN 확인
       - PhoneChange : 전화번호 변경
       - Terminate : 간편결제 서비스 해지
+      - RegisterFido : 생체인증 등록
       - SignUp : 간편결제+선불머니 서비스 유저 등록 (사전 협의 필요)
       - Leave : 간편결제+선불머니 서비스 해지 (사전 협의 필요)
       - PrepaidRefundAccount: 선불머니 환급계좌 등록 및 변경 (사전 협의 필요)
       - PrepaidRefund: 선불머니 환급 요청 (사전 협의 필요)
+      - PrepaidLimitRaise: 선불머니 보유한도 상향 요청 (사전 협의 필요)
+      - PrepaidKYC: 선불머니 고객 확인 재이행 (사전 협의 필요)
 
     - encryptedCI: string
 
@@ -536,6 +534,7 @@ IMP.request_pay(
 
       **디바이스 식별값**
 
+      고객 단말기별 고유한 아이디를 전달해주시면 됩니다.
       미 입력시 고객이 사용한 브라우저 정보(User-Agent)가 입력됩니다.
 
     - noAuth?: boolean
@@ -566,16 +565,6 @@ IMP.request_pay(
 
 <details>
 
-<summary>`customer_uid` 파라미터 안내</summary>
-
-결제수단 등록/삭제, 결제 요청시에는 결제수단을 식별하는 `customer_uid`를 입력한 후 사용해야 합니다.
-이 외의 PIN 변경/확인/초기화, 사용자 등록, 해지 요청시에는 `customer_uid`에 결제수단 등록시 입력한 `memberID`를 입력해야 합니다.
-위의 경우에 `customer_uid` 파라미터에 발급시 입력했던 `customer_uid`를 입력하는 경우 에러가 리턴됩니다.
-
-</details>
-
-<details>
-
 <summary>`encryptedCI` 파라미터 안내</summary>
 
 본인인증 후 전달받은 CI 값을 아래 방법으로 암호화하여 입력해야합니다.
@@ -676,35 +665,38 @@ PIN 초기화 이후 [빌링키 삭제 API](https://developers.portone.io/api/re
 - `Leave`: 간편결제+선불머니 서비스 해지 (선불머니 환급 완료 후 진행 가능)
 - `PrepaidRefundAccount`: 선불머니 환급계좌 등록 및 변경
 - `PrepaidRefund`: 선불머니 환급 요청
+- `PrepaidLimitRaise`: 선불머니 보유한도 상향 요청
 
 </details>
 
 <details>
 
-<summary>무인증 결제 안내</summary>
-
-결제 수단 등록, PIN 체크시 `noAuth:true` 파라미터를 추가하여 요청한 경우 무인증 등록이 가능합니다.
-등록 이후 결제 요청하는 경우 무인증 결제를 이용할 수 있습니다. 무인증 결제시 PIN 입력 과정이 생략되며,
-바로 결제가 진행됩니다.
+<summary>선불머니 기능 이용 시 선불머니 거래사전 등록 API 선행 필요</summary>
 
-만약 무인증 등록과정 없이 무인증 결제가 요청되는 경우 PIN 입력 화면이 표시되고, 올바른 PIN 입력시 무인증 등록 및 결제가 진행됩니다.
+선불머니 관련 기능을 이용하기 위해서는
+[**선불머니 거래사전 등록 API**](https://developers.portone.io/api/rest-v1/pg.kcpquick?v=v1#post%20%2Fkcpquick%2Fprepare%2F%7Bmerchant_uid%7D)가 반드시 선행되어야 합니다.
 
-</details>
+**대상 기능 목록:**
 
-<details>
-
-<summary>선불머니 결제의 경우 부분취소 불가</summary>
+- `SignUp`: 간편결제+선불머니 서비스 유저 등록
+- `Leave`: 간편결제+선불머니 서비스 해지
+- `PrepaidRefundAccount`: 선불머니 환급계좌 등록 및 변경
+- `PrepaidRefund`: 선불머니 환급 요청
+- `PrepaidLimitRaise`: 선불머니 보유한도 상향 요청
+- `PrepaidKYC`: 선불머니 고객 확인 재이행
 
-선불머니 결제는 KCP 정책상 부분취소를 지원하지 않으며 전체취소만 가능합니다.
+거래사전 등록 API를 호출하지 않은 상태에서 선불머니 기능을 요청하는 경우 에러가 발생할 수 있으니 유의하시기 바랍니다.
 
-**대안 방법:**
+</details>
 
-- 부분 환불이 필요한 경우: 전체 취소 후 차액만큼 재결제 진행
+<details>
 
-<div class="hint" data-style="info">
+<summary>무인증 결제 안내</summary>
 
-KCP에서 선불머니 부분취소 기능 지원 예정이나, 현재로서는 위의 대안 방법을 활용하시기 바랍니다.
+결제 수단 등록, PIN 체크시 `noAuth:true` 파라미터를 추가하여 요청한 경우 무인증 등록이 가능합니다.
+등록 이후 결제 요청하는 경우 무인증 결제를 이용할 수 있습니다. 무인증 결제시 PIN 입력 과정이 생략되며,
+바로 결제가 진행됩니다.
 
-</div>
+만약 무인증 등록과정 없이 무인증 결제가 요청되는 경우 PIN 입력 화면이 표시되고, 올바른 PIN 입력시 무인증 등록 및 결제가 진행됩니다.
 
 </details>

package/assets/docs/opi/ko/integration/pg/v1/nhn-kcp/readme.md

@@ -39,6 +39,7 @@ targetVersions:
     - 카카오페이 : `kakaopay`
     - 네이버페이 : `naverpay`
     - 애플페이 : `applepay`
+    - 토스페이 : `tosspay`
 
   - 베네피아 포인트 : `point`
 
@@ -143,12 +144,15 @@ IMP.request_pay(
   - `cultureland` (컬쳐랜드 문화상품권)
   - `smartculture` (스마트문상)
   - `booknlife` (도서문화상품권)
+  - `happymoney` (해피머니 문화상품권)
   - `payco` (페이코)
   - `lpay` (L페이)
   - `kakaopay` (카카오페이)
   - `naverpay` (네이버페이)
   - `samsung` (삼성페이)
+  - `ssgpay` (SSG페이)
   - `applepay` (애플페이)
+  - `tosspay` (토스페이)
   - `point` (베네피아 포인트)
 
 - merchant\_uid: string
@@ -157,10 +161,81 @@ IMP.request_pay(
 
   고객사에서 채번하는 주문 고유 번호로 매번 고유하게 채번되어야 합니다.
 
+- name: string
+
+  **주문명**
+
 - amount: integer
 
   **결제금액**
 
+- buyer\_name?: string
+
+  **구매자 이름**
+
+- buyer\_email?: string
+
+  **구매자 이메일**
+
+- buyer\_tel?: string
+
+  **구매자 연락처**
+
+- buyer\_addr?: string
+
+  **구매자 주소**
+
+- buyer\_postcode?: string
+
+  **구매자 우편번호**
+
+- escrow?: boolean
+
+  **에스크로 결제 여부**
+
+- tax\_free?: number
+
+  **면세금액**
+
+- vbank\_due?: string
+
+  **가상계좌 입금마감일시**
+
+  `YYYYMMDD` 또는 `YYYYMMDDHHmmss` 형식으로 지정합니다. 시간 미지정 시 23:59:59로 설정됩니다.
+
+- m\_redirect\_url?: string
+
+  **모바일 결제 후 리디렉션 될 URL**
+
+- app\_scheme?: string
+
+  **모바일 앱 URL scheme** (모바일 전용)
+
+  모바일 앱에서 결제 시 ISP/앱카드 등에서 결제 완료 후 가맹점 앱으로 돌아올 때 사용됩니다.
+
+- notice\_url?: string | string\[]
+
+  **웹훅 수신 URL**
+
+  포트원 관리자 콘솔에 설정한 웹훅 URL 대신 사용할 URL을 지정합니다.
+
+- confirm\_url?: string
+
+  **Confirm process URL**
+
+- custom\_data?: object
+
+  **가맹점 커스텀 데이터**
+
+  결제 정보와 함께 저장할 커스텀 데이터입니다. 결제 조회 시 반환됩니다.
+
+- language?: string
+
+  **결제창 언어**
+
+  - `ko`: 한국어 (기본값)
+  - `en`: 영어
+
 <br />
 
 #### 기타 파라미터
@@ -176,8 +251,10 @@ IMP.request_pay(
     예시
 
     - `[]`: 일시불만 결제 가능
-    - `2,3,4,5,6`: 일시불을 포함한 2, 3, 4, 5, 6개월까지 할부개월 선택 가능
-    - `3`: 일시불을 포함한 2,3개월까지 할부개월 선택 가능
+    - `[2,3,4,5,6]`: 일시불을 포함한 2, 3, 4, 5, 6개월까지 할부개월 선택 가능
+    - `[3]`: 일시불을 포함한 2, 3개월까지 할부개월 선택 가능
+
+    배열 내 최댓값을 기준으로 일시불부터 해당 개월수까지 할부가 활성화됩니다.
 
   예시코드
 
@@ -188,7 +265,7 @@ IMP.request_pay(
   ```json
   {
     "display": {
-      "card_quota": [6] // 할부개월 6개월까지만 활성화
+      "card_quota": [2, 3, 4, 5, 6] // 할부개월 6개월까지만 활성화
     }
   }
   ```
@@ -299,6 +376,76 @@ IMP.request_pay(
 
   </div>
 
+- company?: string
+
+  **상호명**
+
+  결제창 및 카드사 모듈에 표시되는 상호명입니다. 카드사 다이렉트 호출 시 설정하지 않으면 `iamport`로 표기됩니다.
+
+- auth\_mode?: string
+
+  **인증 방식**
+
+  키인결제(일회성 결제) 이용 시 설정합니다.
+
+  - `key-in`: 키인결제 모드로 결제창을 호출합니다.
+
+- bypass?: object
+
+  **KCP 전용 파라미터**
+
+  KCP 결제창에 직접 전달되는 파라미터입니다. PC와 모바일에서 지원되는 항목이 다릅니다.
+
+  - shop\_user\_id?: string
+
+    **고객사 회원 ID**
+
+    상품권 결제 및 휴대폰 소액결제 시 필수 입력해야 합니다. (PC, 모바일)
+
+  - coupon\_apply\_yn?: string
+
+    **할인쿠폰 영역 활성/비활성화**
+
+    KCP와 협의 후 사용 가능합니다. (PC, 모바일)
+
+    - `Y`: 활성
+    - `N`: 비활성
+
+  - skin\_indx?: string
+
+    **결제창 스킨 유형** (PC 전용)
+
+    1\~11 사이의 숫자로 지정 가능합니다.
+
+  - site\_logo?: string
+
+    **결제창 로고 URL** (PC 전용)
+
+  - complex\_pnt\_yn?: string
+
+    **포인트 복합결제 시 신용카드 결제 여부** (PC 전용)
+
+    포인트 결제 시 일부 금액을 신용카드로 결제할 수 있는지 여부를 설정합니다.
+
+    - `Y`: 포인트 + 신용카드 복합결제 허용
+    - `N`: 전액 포인트결제
+
+  - pt\_memcorp\_cd?: string
+
+    **베네피아 회원 코드** (PC, 모바일)
+
+    베네피아 포인트 결제 시 필수 입력해야 합니다.
+
+  - app\_flag?: string
+
+    **KB국민카드 다이렉트 호출 시 앱카드 사용 여부** (PC, 모바일)
+
+    `card.direct`로 KB국민카드 다이렉트 호출 시 결제 방식을 지정합니다.
+
+    - `Y`: 앱카드(KB Pay) 사용
+    - `N`: ISP 결제 사용
+    - `S`: 앱카드(KB Pay)와 ISP 선택지 제공 (모바일 전용)
+
 #### 유의사항
 
 <details>
@@ -527,6 +674,20 @@ IMP.request_pay(
 
   결제창에 표시되는 금액입니다.
 
+- bypass?: object
+
+  **KCP 빌링키 발급 전용 파라미터**
+
+  - site\_logo?: string
+
+    **결제창 로고 URL** (PC 전용)
+
+  - batch\_birth\_day\_yn?: string
+
+    **생년월일 입력 박스 항상 표시 여부** (PC 전용)
+
+    - `Y`: 초기 화면에서 생년월일 입력 박스가 항상 표시됩니다.
+
 #### 유의사항
 
 <details>

package/assets/docs/opi/ko/integration/pg/v1/nice-v2/billing-api-caution.md

@@ -28,11 +28,11 @@ targetVersions:
 
 **간편결제 (카카오페이, 네이버페이) 빌링키로 결제 시에는 할부결제가 불가능하기 때문에 `card_quota` 파라미터 없이 요청해야 합니다.**
 
-|파라미터                     |데이터 타입           |의미                                                                                               |
-|-----------------------------|----------------------|---------------------------------------------------------------------------------------------------|
-|vat\_amount                  |double                |총 결제 금액 중 부가세 금액. 부가세 직접 입력 방식을 위해 사용. 단, 나이스정보통신와 사전 협의 필요|
-|intereset\_free\_by\_merchant|boolean(기본값: false)|상점 부담 무이자 할부 적용 여부. 단, 나이스정보통신와 사전 협의 필요                               |
-|use\_card\_point             |boolean(기본값: false)|카드사 포인트 사용 여부. 단, 나이스정보통신와 사전 협의 필요                                       |
+|파라미터                    |데이터 타입           |의미                                                                                               |
+|----------------------------|----------------------|---------------------------------------------------------------------------------------------------|
+|vat\_amount                 |double                |총 결제 금액 중 부가세 금액. 부가세 직접 입력 방식을 위해 사용. 단, 나이스정보통신와 사전 협의 필요|
+|interest\_free\_by\_merchant|boolean(기본값: false)|상점 부담 무이자 할부 적용 여부. 단, 나이스정보통신와 사전 협의 필요                               |
+|use\_card\_point            |boolean(기본값: false)|카드사 포인트 사용 여부. 단, 나이스정보통신와 사전 협의 필요                                       |
 
 ## 가상계좌
 
@@ -109,7 +109,7 @@ POST /receipts/{imp_uid}
   // ...중략
   "type": "personal", // 현금영수증 발급 유형: 소득공제
   "identifier": "01012345678", // 현금영수증 발행 식별 정보: 휴대폰 번호
-  "wdentifier_type": "phone" // 현금영수증 발행 식별 정보 유형: 휴대폰 번호
+  "identifier_type": "phone" // 현금영수증 발행 식별 정보 유형: 휴대폰 번호
 }
 ```