From ff6f0c9073aaa625f370ec248ea7b1f7f35e4e65 Mon Sep 17 00:00:00 2001 From: XiNiHa Date: Mon, 20 May 2024 02:38:02 +0900 Subject: [PATCH] =?UTF-8?q?=EC=9D=B8=EC=A6=9D=EA=B2=B0=EC=A0=9C=20?= =?UTF-8?q?=EC=8A=A4=EB=A7=88=ED=8A=B8=20=EB=9D=BC=EC=9A=B0=ED=8C=85=20?= =?UTF-8?q?=EB=AC=B8=EC=84=9C=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/content/docs/ko/smartrouting/authpay.mdx | 141 +++++++++++++++++++ 1 file changed, 141 insertions(+) create mode 100644 src/content/docs/ko/smartrouting/authpay.mdx diff --git a/src/content/docs/ko/smartrouting/authpay.mdx b/src/content/docs/ko/smartrouting/authpay.mdx new file mode 100644 index 000000000..f5fe242ed --- /dev/null +++ b/src/content/docs/ko/smartrouting/authpay.mdx @@ -0,0 +1,141 @@ +--- +title: 인증결제 스마트 라우팅 연동하기 +description: 인증결제 사용 시에 스마트 라우팅을 연동하는 방법을 설명합니다. +targetVersions: ["v2"] +--- + +import ParamTree from "~/components/gitbook/ParamTree.astro"; + +인증결제 스마트 라우팅은 먼저 스마트 라우팅을 위해 사용할 채널 그룹을 생성하고, +해당 그룹의 ID를 전용 파라미터인 `channelGroupId`를 통해 지정해 주기만 하면 +다른 부분은 기본적인 인증결제 사용법과 동일하게 사용할 수 있습니다. +인증결제와 관련된 자세한 내용은 [인증결제 연동하기](/docs/ko/authpay/guide) 문서를 참고하시기 바랍니다. + +## 스마트 라우팅 결제창 호출하기 + +```tsx title="스마트 라우팅 결제창 호출하기" +PortOne.requestPayment({ + storeId: "store-4ff4af41-85e3-4559-8eb8-0d08a2c6ceec", + + // 단일 채널에 대한 Channel Key 대신 + // 사용할 모든 채널을 포함하는 Channel Group의 ID를 설정합니다. + channelGroupId: "channel-group-live-f042e8e2-92f1-4f68-ad61-cec6ede41529", + + // 기타 인증결제 파라미터 설정 + paymentId: `payment-${crypto.randomUUID()}`, + orderName: "나이키 와플 트레이너 2 SD", + totalAmount: 1000, + currency: "CURRENCY_KRW", + payMethod: "CARD", + + // 스마트 라우팅 사용 시 필수 파라미터들 추가 설정 + productType: "DIGITAL", + customer: { + fullName: "홍길동", + phoneNumber: "010-1234-5678", + email: "test@test.com", + }, +}); +``` + +### 주요 파라미터 + +- **`channelGroupId`** **\*** **string** + + 결제창을 호출하기 위해 사용할 채널 그룹의 ID입니다. + + - 관리자 콘솔의 \[결제 연동] → \[스마트 라우팅] 메뉴에서 확인할 수 있습니다. + + - 채널 그룹 ID를 지정하여 결제창을 호출하면, 채널 그룹 내의 채널 중 하나가 + 매 결제창 호출 시마다 무작위로 지정되어 결제창이 호출됩니다. + + - 무작위 채널 지정은 채널 그룹에 설정된 비율 설정을 반영하여 이루어집니다. + +### 기타 파라미터 + +각 파라미터에 대한 상세한 설명은 [JavaScript SDK 레퍼런스 → 결제요청 파라미터](/docs/ko/v2-payment/v2-sdk/payment-request) +문서를 참고하시기 바랍니다. + + + - **`productType`** **\*** **string** + + 스마트 라우팅 사용 시 필수 입력해야 합니다. + + - **`customer`** **\*** **object** + + 구매자 정보를 지정하는 파라미터입니다. + + + - **`fullName`** **\*** **string** + + 스마트 라우팅 사용 시 해당 파라미터 혹은 `firstName`과 `lastName` 파라미터를 필수 입력해야 합니다. + + - **`phoneNumber`** **\*** **string** + + 스마트 라우팅 사용 시 필수 입력해야 합니다. + + - **`email`** **\*** **string** + + 스마트 라우팅 사용 시 필수 입력해야 합니다. + + + - **`easyPay`** **object** + + 간편결제 사용 시 필요한 파라미터입니다. + + + - **`easyPayProvider`** **\*** **string** + + 스마트 라우팅으로 간편결제 사용 시 필수 입력해야 합니다. + + + - **`virtualAccount`** **object** + + 가상계좌 결제 사용 시 필요한 파라미터입니다. + + + - **`accountExpiry`** **\*** **object** + + 스마트 라우팅으로 가상계좌 결제 사용 시 필수 입력해야 합니다. + + `dueDate` 혹은 `validHours` 파라미터를 사용하여 원하는 방식으로 기한을 지정할 수 있습니다. + + + - **`giftCertificate`** **object** + + 상품권 결제 사용 시 필요한 파라미터입니다. + + + - **`giftCertificateType`** **\*** **string** + + 스마트 라우팅으로 상품권 결제 사용 시 필수 입력해야 합니다. + + + - **`bypass`** **object** + + PG사별 고유 옵션 지정을 위한 파라미터입니다. + + + - **`nice_v2`** **object** + + `nice_v2` 채널 사용 시 적용되는 파라미터입니다. + + + - **`MallUserID`** **\*** **string** + + 스마트 라우팅에 사용할 채널 그룹 내에 `nice_v2` 채널이 포함된 경우 필수 입력해야 합니다. + + + + + - **`kcp_v2`** **object** + + `kcp_v2` 채널 사용 시 적용되는 파라미터입니다. + + + - **`shop_user_id`** **\*** **string** + + 스마트 라우팅에 사용할 채널 그룹 내에 `kcp_v2` 채널이 포함된 경우 필수 입력해야 합니다. + + +