feat: parameter details

portone-io · Feb 10, 2025 · b36e3b0 · b36e3b0
1 parent 25f3971
commit b36e3b0
Showing 1 changed file with 135 additions and 44 deletions.
diff --git a/src/routes/(root)/opi/ko/quick-guide/payment/index.mdx b/src/routes/(root)/opi/ko/quick-guide/payment/index.mdx
@@ -113,6 +113,12 @@ import { Condition, InteractiveDoc, Section } from "./_preview";
           </Hint>
         </Condition>
 
+        <Condition when={({ pg: { name } }) => name === 'inicis'}>
+          <Hint style="warning">
+            KG이니시스의 경우 ASCII 문자만 허용되며, 40자 이하로 입력합니다. 
+          </Hint>
+        </Condition>
+
       - orderName: string
 
         **주문명**
@@ -135,6 +141,12 @@ import { Condition, InteractiveDoc, Section } from "./_preview";
           </Hint>
         </Condition>
 
+        <Condition when={({ pg: { name } }) => name === 'inicis'}>
+          <Hint style="warning">
+            KG이니시스의 경우 최대 40바이트까지 입력할 수 있으며, 40바이트 초과시 37바이트에서 잘리고 "..."가 추가됩니다.
+          </Hint>
+        </Condition>
+
       - totalAmount: number
 
         **결제 금액**
@@ -178,12 +190,6 @@ import { Condition, InteractiveDoc, Section } from "./_preview";
           </Hint>
         </Condition>
 
-        <Condition when={({ pg: { name } }) => name === 'inicis'}>
-          <Hint style="warning">
-            KG이니시스는 `KRW`와 `USD`만을 지원합니다. `USD`의 경우 카드 결제만 지원합니다.
-          </Hint>
-        </Condition>
-
         <Condition when={({ pg: { name } }) => name === 'ksnet'}>
           <Hint style="warning">
             KSNET은 `KRW`와 `USD`만을 지원합니다.
@@ -196,6 +202,18 @@ import { Condition, InteractiveDoc, Section } from "./_preview";
           </Hint>
         </Condition>
 
+        <Condition when={({ pg: { name, payMethods } }) => name === 'inicis' && payMethods === 'card'}>
+          <Hint style="warning">
+            KG이니시스 카드 결제는 `KRW`와 `USD`만을 지원합니다.
+          </Hint>
+        </Condition>
+
+        <Condition when={({ pg: { name, payMethods } }) => name === 'inicis' && payMethods !== 'card'}>
+          <Hint style="warning">
+            카드 결제를 제외한 KG이니시스는 `KRW`만을 지원합니다.
+          </Hint>
+        </Condition>
+
       - payMethod: string
 
         **결제 수단**
@@ -243,33 +261,33 @@ import { Condition, InteractiveDoc, Section } from "./_preview";
               - 휴대폰 소액결제: `MOBILE`
               - 간편결제: `EASY_PAY`
             </Condition>
-          </Details.Content>
 
-          <Condition when={({ pg: { name }}) => name === 'inicis'}>
-            - 카드: `CARD`
-            - 실시간 계좌이체: `TRANSFER`
-            - 가상계좌: `VIRTUAL_ACCOUNT`
-            - 휴대폰 소액결제: `MOBILE`
-            - 간편결제: `EASY_PAY`
-            - 상품권: `GIFT_CERTIFICATE`
-          </Condition>
+            <Condition when={({ pg: { name }}) => name === 'inicis'}>
+              - 카드: `CARD`
+              - 실시간 계좌이체: `TRANSFER`
+              - 가상계좌: `VIRTUAL_ACCOUNT`
+              - 휴대폰 소액결제: `MOBILE`
+              - 간편결제: `EASY_PAY`
+              - 상품권: `GIFT_CERTIFICATE`
+            </Condition>
 
-          <Condition when={({ pg: { name }}) => name === 'ksnet'}>
-            - 카드: `CARD`
-            - 실시간 계좌이체: `TRANSFER`
-            - 가상계좌: `VIRTUAL_ACCOUNT`
-            - 휴대폰 소액결제: `MOBILE`
-            - 간편결제: `EASY_PAY`
-          </Condition>
+            <Condition when={({ pg: { name }}) => name === 'ksnet'}>
+              - 카드: `CARD`
+              - 실시간 계좌이체: `TRANSFER`
+              - 가상계좌: `VIRTUAL_ACCOUNT`
+              - 휴대폰 소액결제: `MOBILE`
+              - 간편결제: `EASY_PAY`
+            </Condition>
 
-          <Condition when={({ pg: { name }}) => name === 'kcp'}>
-            - 카드: `CARD`
-            - 실시간 계좌이체: `TRANSFER`
-            - 가상계좌: `VIRTUAL_ACCOUNT`
-            - 휴대폰 소액결제: `MOBILE`
-            - 간편결제: `EASY_PAY`
-            - 상품권: `GIFT_CERTIFICATE`
-          </Condition>
+            <Condition when={({ pg: { name }}) => name === 'kcp'}>
+              - 카드: `CARD`
+              - 실시간 계좌이체: `TRANSFER`
+              - 가상계좌: `VIRTUAL_ACCOUNT`
+              - 휴대폰 소액결제: `MOBILE`
+              - 간편결제: `EASY_PAY`
+              - 상품권: `GIFT_CERTIFICATE`
+            </Condition>
+          </Details.Content>
         </Details>
 
       <Condition when={({ pg: { payMethods }}) => payMethods === "card"}>
@@ -306,6 +324,12 @@ import { Condition, InteractiveDoc, Section } from "./_preview";
                 </Hint>
               </Condition>
 
+              <Condition when={({ pg: { name } }) => name === 'inicis'}>
+                <Hint style="warning">
+                  KG이니시스의 경우 카드사 단독 노출 시 별도 계약이 필요합니다.
+                </Hint>
+              </Condition>
+
               <Details>
                 <Details.Summary>지원 카드사 코드 목록</Details.Summary>
 
@@ -368,7 +392,7 @@ import { Condition, InteractiveDoc, Section } from "./_preview";
 
               지정한 일부 카드사만을 목록에 노출할 수 있습니다. 상단의 카드사 식별 값 항목을 참고해주세요.
 
-            <Condition when={({ pg: { name }}) => name !== 'kcp'}>
+            <Condition when={({ pg: { name }}) => !['kcp', 'inicis'].includes(name)}>
               - useFreeInterestFromMall?: boolean
 
                 **상점 분담 무이자 활성화 여부**
@@ -380,7 +404,7 @@ import { Condition, InteractiveDoc, Section } from "./_preview";
                 </Condition>
             </Condition>
 
-            <Condition when={({ pg: { name }}) => name !== 'kcp'}>
+            <Condition when={({ pg: { name }}) => !['kcp', 'inicis'].includes(name)}>
               - useInstallment?: boolean
 
                 **할부 사용 여부**
@@ -403,6 +427,12 @@ import { Condition, InteractiveDoc, Section } from "./_preview";
 
                   고객사가 부담하는 무이자 할부 설정입니다.
 
+                  <Condition when={({ pg: { name } }) => name === 'inicis'}>
+                    <Hint style="warning">
+                      KG이니시스의 경우 상점 부담 무이자 할부 이용 시 별도 계약이 필요합니다.
+                    </Hint>
+                  </Condition>
+
                   <Parameter.Details>
                     - cardCompany: string
 
@@ -432,7 +462,7 @@ import { Condition, InteractiveDoc, Section } from "./_preview";
 
                       구매자가 할부 개월 수를 선택할 수 있도록 하려면 `availableMonthList`를 사용해주세요.
 
-                    <Condition when={({ pg: { name }}) => name !== 'kcp'}>
+                    <Condition when={({ pg: { name }}) => !['kcp', 'inicis'].includes(name)}>
                       - availableMonthList: number\[]
 
                         **구매자가 선택할 수 있는 할부 개월 수 목록**
@@ -456,17 +486,25 @@ import { Condition, InteractiveDoc, Section } from "./_preview";
                     나이스페이먼츠의 경우 카드사 포인트 사용 시 별도 계약이 필요합니다.
                   </Hint>
                 </Condition>
+
+                <Condition when={({ pg: { name } }) => name === 'inicis'}>
+                  <Hint style="warning">
+                    KG이니시스의 경우 카드사 포인트 사용 시 별도 계약이 필요합니다.
+                  </Hint>
+                </Condition>
             </Condition>
 
-            - useAppCardOnly?: boolean
+            <Condition when={({ pg: { name } }) => name !== 'inicis'}>
+              - useAppCardOnly?: boolean
 
-              **앱 카드만 허용할지 여부**
+                **앱 카드만 허용할지 여부**
 
-              <Condition when={({ pg: { name } }) => name === 'toss'}>
-                <Hint style="warning">
-                  토스페이먼츠의 경우 씨티카드는 적용이 불가능합니다.
-                </Hint>
-              </Condition>
+                <Condition when={({ pg: { name } }) => name === 'toss'}>
+                  <Hint style="warning">
+                    토스페이먼츠의 경우 씨티카드는 적용이 불가능합니다.
+                  </Hint>
+                </Condition>
+            </Condition>
           </Parameter.Details>
       </Condition>
 
@@ -762,6 +800,12 @@ import { Condition, InteractiveDoc, Section } from "./_preview";
 
               **간편결제 수단**
 
+              <Condition when={({ pg: { name } }) => name === 'inicis'}>
+                <Hint style="warning">
+                  KG이니시스의 경우 간편결제 수단 설정 시 별도 계약이 필요합니다.
+                </Hint>
+              </Condition>
+
               <Details>
                 <Details.Summary>지원 간편결제 코드</Details.Summary>
 
@@ -776,6 +820,17 @@ import { Condition, InteractiveDoc, Section } from "./_preview";
                     - `LPAY` (L페이)
                     - `TOSSPAY` (토스페이)
                   </Condition>
+
+                  <Condition when={({ pg: { name }}) => name === 'inicis'}>
+                    - `KAKAOPAY` (카카오페이)
+                    - `NAVERPAY` (네이버페이)
+                    - `SAMSUNGPAY` (삼성페이)
+                    - `SSGPAY` (SSG페이)
+                    - `APPLEPAY` (애플페이)
+                    - `LPAY` (L페이)
+                    - `TOSSPAY` (토스페이)
+                    - `PAYCO` (페이코)
+                  </Condition>
                 </Details.Content>
               </Details>
 
@@ -987,6 +1042,12 @@ import { Condition, InteractiveDoc, Section } from "./_preview";
           </Hint>
         </Condition>
 
+        <Condition when={({ pg: { name } }) => name === 'inicis'}>
+          <Hint style="warning">
+            KG이니시스의 경우 면세 금액을 직접 지정하기 위해서는 별도 계약이 필요합니다.
+          </Hint>
+        </Condition>
+
       - vatAmount?: number
 
         **부가세**
@@ -1003,6 +1064,12 @@ import { Condition, InteractiveDoc, Section } from "./_preview";
           </Hint>
         </Condition>
 
+        <Condition when={({ pg: { name } }) => name === 'inicis'}>
+          <Hint style="warning">
+            KG이니시스의 경우 부가세 금액을 직접 지정하기 위해서는 별도 계약이 필요합니다.
+          </Hint>
+        </Condition>
+
       - customer?: object
 
         **구매자 정보**
@@ -1015,7 +1082,7 @@ import { Condition, InteractiveDoc, Section } from "./_preview";
 
         <Condition when={({ pg: { name }}) => name === 'inicis'}>
           <Hint style="warning">
-            KG이니시스 결제 시 구매자 이름, 연락처, 이메일을 필수로 입력해야 합니다.
+            KG이니시스 결제 시 PC 환경에서는 구매자 이름, 연락처, 이메일을 필수로 입력해야 합니다.
           </Hint>
         </Condition>
 
@@ -1058,6 +1125,12 @@ import { Condition, InteractiveDoc, Section } from "./_preview";
 
             **구매자 이메일 주소**
 
+            <Condition when={({ pg: { name } }) => name === 'inicis'}>
+              <Hint style="warning">
+                KG이니시스의 경우 특수문자는 `@`와 `.`만 허용됩니다.
+              </Hint>
+            </Condition>
+
           - address?: object
 
             **구매자 주소**
@@ -1482,13 +1555,31 @@ import { Condition, InteractiveDoc, Section } from "./_preview";
           </Hint>
         </Condition>
 
-        <Condition when={({ pg: { name }}) => ['kcp'].includes(name)}>
+        <Condition when={({ pg: { name } }) => name === 'inicis'}>
+          <Hint style="warning">
+            KG이니시스의 경우 에스크로 사용 시 별도 계약이 필요합니다.
+          </Hint>
+        </Condition>
+
+        <Condition when={({ pg: { name }}) => ['kcp', 'inicis'].includes(name)}>
           #### locale?: string
 
           **결제창 언어**
+
+          <Condition when={({ pg: { name } }) => name === 'kcp'}>
+            - 한국어: `KO_KR`
+            - 영어: `EN_US`
+          </Condition>
+
+          <Condition when={({ pg: { name } }) => name === 'inicis'}>
+            - 한국어: `KO_KR`
+            - 영어: `EN_US`
+            - 중국어(간체): `ZH_CN`
 
-          - 한국어: `KO_KR`
-          - 영어: `EN_US`
+            <Hint style="warning">
+              KG이니시스의 경우 중국어(간체)는 PC 결제 시에만 지원됩니다.
+            </Hint>
+          </Condition>
         </Condition>
 
       - country?: string