@portone/mcp-server 0.14.0 → 0.15.0-alpha.0

package/assets/docs/schema/browser-sdk.yml

@@ -1,6 +1,38 @@
 # yaml-language-server: $schema=https://raw.githubusercontent.com/portone-io/client-sdk-generator/refs/heads/main/schema.json
 
-pgProviders: {}
+flags:
+  nice:
+    description: 나이스페이먼츠
+  smartro:
+    description: 스마트로
+  toss:
+    description: 토스페이먼츠
+  kpn:
+    description: 한국결제네트웍스
+  inicis:
+    description: KG이니시스
+  ksnet:
+    description: KSNET
+  kcp:
+    description: NHN KCP
+  kakao:
+    description: 카카오페이
+  naver:
+    description: 네이버페이
+  tosspay:
+    description: 토스페이
+  hyphen:
+    description: 하이픈
+  eximbay:
+    description: 엑심베이
+  toss_brandpay:
+    description: 토스브랜드페이
+  welcome:
+    description: 웰컴페이먼츠
+  inicis_jp:
+    description: KG이니시스(일본)
+  payletter_global:
+    description: 페이레터해외결제
 resources:
   entity:
     Address:
@@ -1281,10 +1313,18 @@ resources:
     EasyPayPaymentMethod:
       type: enum
       variants:
-        CARD: {}
-        TRANSFER: {}
-        CHARGE: {}
-        MONEY: {}
+        CARD:
+          description: |
+            카드
+        CHARGE:
+          description: |
+            포인트(충전, 적립) 결제
+        TRANSFER:
+          description: |
+            계좌결제
+        MONEY:
+          description: |
+            포인트 및 계좌결제가 모두 가능한 경우
       description: |
         간편결제 결제수단
     EasyPayProvider:
@@ -1552,7 +1592,7 @@ resources:
           items:
             type: resourceRef
             $ref: "#/resources/entity/FreeInstallmentPlan"
-          pgSpecific:
+          flagOptions:
             tosspayments:
               visible: true
             nice:
@@ -1607,7 +1647,7 @@ resources:
             <PgSection pgName={(name) => ['toss_brandpay'].includes(name)}>
             토스 브랜드페이에서 고정 할부만 지원합니다. `availableMonthList`에 2개 이상의 값이 있으면 오류가 발생합니다.
             </PgSection>
-          pgSpecific:
+          flagOptions:
             tosspayments:
               visible: true
             nice:
@@ -1802,7 +1842,9 @@ resources:
           description: |
             **상품 코드**
 
-            - 토스페이먼츠의 경우 필수로 입력해주세요.
+            <PgSection pgName={(name) => name === 'tosspayments'}>
+            토스페이먼츠의 경우 필수입니다.
+            </PgSection>
         amount:
           type: integer
           description: |
@@ -1824,7 +1866,12 @@ resources:
         link:
           type: string
           optional: true
-          description: "**상품 판매 URL**"
+          description: |
+            **상품 판매 URL**
+
+            <PgSection pgName={(name) => name === 'eximbay'}>
+            엑심베이에서 products 파라미터를 사용하는 경우 필수로 입력해야 합니다.
+            </PgSection>
     ProductType:
       type: enum
       variants:
@@ -2084,11 +2131,24 @@ resources:
         웰컴페이먼츠에서는 최대 40바이트까지 입력할 수 있으며, 40바이트 초과시 37바이트에서 잘리고 "..."가 추가됩니다.
         </PgSection>
 
+        <PgSection pgName={(name) => name === 'ksnet'}>
+        KSNET에서는 EUC-KR 기준 최대 50바이트까지 입력할 수 있습니다.
+        </PgSection>
+
         <PgSection pgName={(name) => name === 'naver'}>
-        네이버페이에서는 `bypass.naverpay.productItems`의 개수에 따라 주문명 뒤에 `외 X개`가 붙으므로,
+        네이버페이에서는 최대 128자까지 입력할 수 있습니다.
+        `bypass.naverpay.productItems`의 개수에 따라 주문명 뒤에 `외 X개`가 붙으므로,
         주문명을 `bypass.naverpay.productItems[0].name`과 똑같이 입력하는 것이 권장됩니다.
         </PgSection>
 
+        <PgSection pgName={(name) => name === 'kakao'}>
+        카카오페이에서는 최대 100자까지 입력할 수 있습니다.
+        </PgSection>
+
+        <PgSection pgName={(name) => name === 'tosspay'}>
+        토스페이에서는 최대 255자까지 입력할 수 있습니다. 공백으로만 설정할 수 없고, `\`와 `,`를 포함할 수 없습니다.
+        </PgSection>
+
         <PgSection pgName={(name) => name === 'hyphen'}>
         하이픈에서는 최대 1000바이트까지 입력할 수 있습니다.
         </PgSection>
@@ -2409,49 +2469,49 @@ resources:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/issueBillingKey/InicisV2"
-            pgSpecific:
+            flagOptions:
               inicis:
                 visible: true
           kcp_v2:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/issueBillingKey/KcpV2"
-            pgSpecific:
+            flagOptions:
               kcp:
                 visible: true
           smartro_v2:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/issueBillingKey/SmartroV2"
-            pgSpecific:
+            flagOptions:
               smartro:
                 visible: true
           welcome:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/issueBillingKey/Welcome"
-            pgSpecific:
+            flagOptions:
               welcome:
                 visible: true
           naverpay:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/issueBillingKey/Naverpay"
-            pgSpecific:
+            flagOptions:
               naver:
                 visible: true
           kakaopay:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/payment/Kakaopay"
-            pgSpecific:
+            flagOptions:
               kakao:
                 visible: true
           tosspay_v2:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/issueBillingKey/TosspayV2"
-            pgSpecific:
+            flagOptions:
               tosspay:
                 visible: true
       issueBillingKeyAndPay:
@@ -2515,6 +2575,10 @@ resources:
           description: |
             **엑심베이 bypass 파라미터**
           properties:
+            payment:
+              type: resourceRef
+              $ref: "#/resources/entity/bypass/issueBillingKeyAndPay/EximbayV2Payment"
+              optional: true
             merchant:
               type: resourceRef
               $ref: "#/resources/entity/bypass/issueBillingKeyAndPay/EximbayV2Merchant"
@@ -2535,6 +2599,23 @@ resources:
               type: resourceRef
               $ref: "#/resources/entity/bypass/issueBillingKeyAndPay/EximbayV2BillTo"
               optional: true
+        EximbayV2Payment:
+          type: object
+          description: |
+            결제 정보
+          properties:
+            payment_method:
+              type: string
+              description: |
+                결제수단 단독 노출
+              optional: true
+            multi_payment_method:
+              type: array
+              items:
+                type: string
+              description: |
+                결제수단 노출 목록
+              optional: true
         EximbayV2Merchant:
           type: object
           properties:
@@ -2661,21 +2742,21 @@ resources:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/issueBillingKeyAndPay/Welcome"
-            pgSpecific:
+            flagOptions:
               welcome:
                 visible: true
           payletter_global:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/issueBillingKeyAndPay/PayletterGlobal"
-            pgSpecific:
+            flagOptions:
               payletter_global:
                 visible: true
           eximbay_v2:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/issueBillingKeyAndPay/EximbayV2"
-            pgSpecific:
+            flagOptions:
               eximbay_v2:
                 visible: true
       loadIssueBillingKeyUI:
@@ -4445,119 +4526,119 @@ resources:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/payment/Tosspayments"
-            pgSpecific:
+            flagOptions:
               toss:
                 visible: true
           nice_v2:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/payment/NiceV2"
-            pgSpecific:
+            flagOptions:
               nice:
                 visible: true
           paypal_v2:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/payment/PaypalV2"
-            pgSpecific:
+            flagOptions:
               paypal:
                 visible: true
           inicis_v2:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/payment/InicisV2"
-            pgSpecific:
+            flagOptions:
               inicis:
                 visible: true
           kcp_v2:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/payment/KcpV2"
-            pgSpecific:
+            flagOptions:
               kcp:
                 visible: true
           smartro_v2:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/payment/SmartroV2"
-            pgSpecific:
+            flagOptions:
               smartro:
                 visible: true
           ksnet:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/payment/Ksnet"
-            pgSpecific:
+            flagOptions:
               ksnet:
                 visible: true
           welcome:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/payment/Welcome"
-            pgSpecific:
+            flagOptions:
               welcome:
                 visible: true
           kpn:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/payment/Kpn"
-            pgSpecific:
+            flagOptions:
               kpn:
                 visible: true
           naverpay:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/payment/Naverpay"
-            pgSpecific:
+            flagOptions:
               naver:
                 visible: true
           kakaopay:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/payment/Kakaopay"
-            pgSpecific:
+            flagOptions:
               kakao:
                 visible: true
           tosspay_v2:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/payment/TosspayV2"
-            pgSpecific:
+            flagOptions:
               tosspay:
                 visible: true
           toss_brandpay:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/payment/TossBrandpay"
-            pgSpecific:
+            flagOptions:
               toss_brandpay:
                 visible: true
           hyphen:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/payment/Hyphen"
-            pgSpecific:
+            flagOptions:
               hyphen:
                 visible: true
           eximbay_v2:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/payment/EximbayV2"
-            pgSpecific:
+            flagOptions:
               eximbay:
                 visible: true
           inicis_jp:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/payment/InicisJp"
-            pgSpecific:
+            flagOptions:
               inicis_jp:
                 visible: true
           payletter_global:
             type: resourceRef
             optional: true
             $ref: "#/resources/entity/bypass/payment/PayletterGlobal"
-            pgSpecific:
+            flagOptions:
               payletter_global:
                 visible: true
     OfferPeriodRange:
@@ -5130,6 +5211,8 @@ resources:
           items:
             type: resourceRef
             $ref: "#/resources/entity/Product"
+          description: |
+            구매 상품 정보
         isCulturalExpense:
           optional: true
           type: boolean
@@ -5330,21 +5413,24 @@ resources:
           type: resourceRef
           $ref: "#/resources/entity/Iframe"
     IssueBillingKeyRequestUnion:
-      type: discriminatedUnion
-      types:
-        CARD:
+      type: object
+      properties:
+        card:
           type: resourceRef
           $ref: "#/resources/request/IssueBillingKeyRequestUnionCard"
-        MOBILE:
+          optional: true
+        mobile:
           type: resourceRef
           $ref: "#/resources/request/IssueBillingKeyRequestUnionMobile"
-        EASY_PAY:
+          optional: true
+        easyPay:
           type: resourceRef
           $ref: "#/resources/request/IssueBillingKeyRequestUnionEasyPay"
-        PAYPAL:
+          optional: true
+        paypal:
           type: resourceRef
           $ref: "#/resources/request/IssueBillingKeyRequestUnionPaypal"
-      discriminator: billingKeyMethod
+          optional: true
     IssueBillingKeyAndPayRequestBase:
       type: object
       properties:
@@ -5387,6 +5473,18 @@ resources:
           optional: true
           type: resourceRef
           $ref: "#/resources/entity/Customer"
+        products:
+          optional: true
+          type: array
+          items:
+            type: resourceRef
+            $ref: "#/resources/entity/Product"
+          description: |
+            **구매 상품 정보**
+
+            <PgSection pgName={(name) => name === 'eximbay'}>
+            해외카드 결제를 제외하고 필수 입력입니다. 해외카드의 경우에도 위험 거래 관리가 필요한 경우 요구될 수 있습니다.
+            </PgSection>
         windowType:
           optional: true
           type: resourceRef
@@ -5458,13 +5556,12 @@ resources:
           type: resourceRef
           $ref: "#/resources/entity/Iframe"
     IssueBillingKeyAndPayRequestUnion:
-      type: discriminatedUnion
-      discriminator: billingKeyAndPayMethod
-      optional: true
-      types:
-        MOBILE:
+      type: object
+      properties:
+        mobile:
           type: resourceRef
           $ref: "#/resources/request/IssueBillingKeyAndPayRequestUnionMobile"
+          optional: true
     PaymentRequestBase:
       type: object
       properties:
@@ -5564,6 +5661,12 @@ resources:
           items:
             type: resourceRef
             $ref: "#/resources/entity/Product"
+          description: |
+            **구매 상품 정보**
+
+            <PgSection pgName={(name) => name === 'eximbay'}>
+            해외카드 결제를 제외하고 필수 입력입니다. 해외카드의 경우에도 위험 거래 관리가 필요한 경우 요구될 수 있습니다.
+            </PgSection>
         isCulturalExpense:
           optional: true
           type: boolean
@@ -5616,37 +5719,44 @@ resources:
           type: resourceRef
           $ref: "#/resources/entity/bypass/PaymentBypass"
     PaymentRequestUnion:
-      type: discriminatedUnion
-      discriminator: payMethod
-      optional: true
-      types:
-        CARD:
+      type: object
+      properties:
+        card:
           type: resourceRef
           $ref: "#/resources/request/PaymentRequestUnionCard"
-        VIRTUAL_ACCOUNT:
+          optional: true
+        virtualAccount:
           type: resourceRef
           $ref: "#/resources/request/PaymentRequestUnionVirtualAccount"
-        TRANSFER:
+          optional: true
+        transfer:
           type: resourceRef
           $ref: "#/resources/request/PaymentRequestUnionTransfer"
-        MOBILE:
+          optional: true
+        mobile:
           type: resourceRef
           $ref: "#/resources/request/PaymentRequestUnionMobile"
-        GIFT_CERTIFICATE:
+          optional: true
+        giftCertificate:
           type: resourceRef
           $ref: "#/resources/request/PaymentRequestUnionGiftCertificate"
-        EASY_PAY:
+          optional: true
+        easyPay:
           type: resourceRef
           $ref: "#/resources/request/PaymentRequestUnionEasyPay"
-        PAYPAL:
+          optional: true
+        paypal:
           type: resourceRef
           $ref: "#/resources/request/PaymentRequestUnionPaypal"
-        ALIPAY:
+          optional: true
+        alipay:
           type: resourceRef
           $ref: "#/resources/request/PaymentRequestUnionAlipay"
-        CONVENIENCE_STORE:
+          optional: true
+        convenienceStore:
           type: resourceRef
           $ref: "#/resources/request/PaymentRequestUnionConvenienceStore"
+          optional: true
     IssueBillingKeyRequestUnionCard:
       type: object
       properties:
@@ -6114,7 +6224,12 @@ resources:
           description: |
             **빌링키**
 
-            빌링 결제를 일으킬 때 사용하는 빌링키입니다.
+            빌링 결제를 일으킬 때 사용하는 빌링키입니다. 수동 승인 사용시 'NEEDS_CONFIRMATION'으로 전달됩니다.
+        billingIssueToken:
+          type: string
+          optional: true
+          description: |
+            수동 승인 사용시 수동 승인 API 호출에 필요한 토큰입니다.
         code:
           type: string
           description: |
@@ -6159,6 +6274,13 @@ resources:
           type: string
           description: |
             **결제 ID**
+        paymentToken:
+          type: string
+          optional: true
+          description: |
+            **결제 토큰**
+
+            수동 승인 사용시 수동 승인 API 호출에 필요한 토큰입니다.
         code:
           type: string
           description: |
@@ -6189,24 +6311,29 @@ resources:
           value: ISSUE_BILLING_KEY_AND_PAY
           description: |
             `ISSUE_BILLING_KEY_AND_PAY`
-        txId:
+        billingKey:
           type: string
           description: |
-            **결제 시도 ID**
+            **빌링키**
 
-            초회결제에 해당하는, 요청마다 고유하게 생성되는 결제 시도 ID입니다.
+            빌링결제를 일으킬 때 사용하는 빌링키입니다. 수동 승인 사용시 'NEEDS_CONFIRMATION'으로 전달됩니다.
+        billingIssueToken:
+          type: string
+          optional: true
+          description: |
+            수동 승인 사용시 수동 승인 API 호출에 필요한 토큰입니다.
         paymentId:
           type: string
           description: |
             **결제 ID**
 
             초회결제의 결제 ID입니다.
-        billingKey:
+        txId:
           type: string
           description: |
-            **빌링키**
+            **결제 시도 ID**
 
-            빌링결제를 일으킬 때 사용하는 빌링키입니다.
+            초회결제에 해당하는, 요청마다 고유하게 생성되는 결제 시도 ID입니다. 수동 승인 사용시 'NEEDS_CONFIRMATION'으로 전달됩니다.
         code:
           type: string
           optional: true