@portone/mcp-server 0.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE-APACHE +201 -0
- package/LICENSE-MIT +21 -0
- package/README.md +165 -0
- package/assets/docs/README.md +27 -0
- package/assets/docs/api/backward-compatibility.md +40 -0
- package/assets/docs/blog/posts/2024-02/v2-oom.md +341 -0
- package/assets/docs/blog/posts/2024-02/v2-webhook.md +314 -0
- package/assets/docs/blog/posts/2024-02/v2-zio.md +529 -0
- package/assets/docs/blog/posts/2024-03/tgs.md +238 -0
- package/assets/docs/blog/posts/2024-04/gcp-datastream.md +307 -0
- package/assets/docs/blog/posts/2024-04/solid.md +558 -0
- package/assets/docs/blog/posts/2024-07/v2-event-sourcing-basic.md +231 -0
- package/assets/docs/help/admin-console/analytics/content32.md +270 -0
- package/assets/docs/help/admin-console/console-account/content31.md +94 -0
- package/assets/docs/help/admin-console/console_home/content34.md +82 -0
- package/assets/docs/help/admin-console/integration/content28.md +79 -0
- package/assets/docs/help/admin-console/payment-service/content29.md +260 -0
- package/assets/docs/help/admin-console/pg-settlement/content30.md +352 -0
- package/assets/docs/help/admin-console/platform-settlement/content33-1.md +201 -0
- package/assets/docs/help/api-sdk-2024-12-19.md +64 -0
- package/assets/docs/help/api-sdk-2025-01-15.md +84 -0
- package/assets/docs/help/applepay.md +46 -0
- package/assets/docs/help/content100000.md +46 -0
- package/assets/docs/help/content100002.md +52 -0
- package/assets/docs/help/content100004.md +29 -0
- package/assets/docs/help/content100014.md +50 -0
- package/assets/docs/help/content100015.md +20 -0
- package/assets/docs/help/content100016.md +28 -0
- package/assets/docs/help/content100020.md +28 -0
- package/assets/docs/help/content100022.md +40 -0
- package/assets/docs/help/content100023.md +21 -0
- package/assets/docs/help/content100024.md +25 -0
- package/assets/docs/help/content100025.md +40 -0
- package/assets/docs/help/content100026.md +20 -0
- package/assets/docs/help/content100027.md +24 -0
- package/assets/docs/help/content100029.md +29 -0
- package/assets/docs/help/content100030.md +82 -0
- package/assets/docs/help/content100033.md +44 -0
- package/assets/docs/help/content100035.md +34 -0
- package/assets/docs/help/content100036.md +14 -0
- package/assets/docs/help/content100037.md +16 -0
- package/assets/docs/help/content100038.md +32 -0
- package/assets/docs/help/content100039.md +28 -0
- package/assets/docs/help/content100040.md +31 -0
- package/assets/docs/help/content100041.md +37 -0
- package/assets/docs/help/content100044.md +15 -0
- package/assets/docs/help/content100045.md +21 -0
- package/assets/docs/help/content100046.md +34 -0
- package/assets/docs/help/content100047.md +32 -0
- package/assets/docs/help/content100048.md +25 -0
- package/assets/docs/help/content100049.md +20 -0
- package/assets/docs/help/content100052.md +147 -0
- package/assets/docs/help/content100053.md +40 -0
- package/assets/docs/help/content100054.md +18 -0
- package/assets/docs/help/content100055.md +37 -0
- package/assets/docs/help/content100056.md +15 -0
- package/assets/docs/help/content100057.md +28 -0
- package/assets/docs/help/content100058.md +36 -0
- package/assets/docs/help/content100059.md +23 -0
- package/assets/docs/help/content100060.md +43 -0
- package/assets/docs/help/content200001.md +21 -0
- package/assets/docs/help/content200002.md +38 -0
- package/assets/docs/help/content200005.md +30 -0
- package/assets/docs/help/content200012.md +91 -0
- package/assets/docs/help/content200013.md +52 -0
- package/assets/docs/help/content200015.md +41 -0
- package/assets/docs/help/content200016.md +30 -0
- package/assets/docs/help/content200017.md +39 -0
- package/assets/docs/help/content200018.md +105 -0
- package/assets/docs/help/content200019.md +59 -0
- package/assets/docs/help/content200020.md +42 -0
- package/assets/docs/help/content200023.md +54 -0
- package/assets/docs/help/content200024.md +49 -0
- package/assets/docs/help/content200025.md +68 -0
- package/assets/docs/help/content200027.md +34 -0
- package/assets/docs/help/content200028.md +70 -0
- package/assets/docs/help/content200029.md +71 -0
- package/assets/docs/help/content200030.md +67 -0
- package/assets/docs/help/content200032.md +39 -0
- package/assets/docs/help/content200033.md +21 -0
- package/assets/docs/help/content200034.md +34 -0
- package/assets/docs/help/content200037.md +38 -0
- package/assets/docs/help/content200038.md +50 -0
- package/assets/docs/help/content200039.md +45 -0
- package/assets/docs/help/content200040.md +15 -0
- package/assets/docs/help/content200043.md +23 -0
- package/assets/docs/help/content200044.md +33 -0
- package/assets/docs/help/content200045.md +25 -0
- package/assets/docs/help/content200046.md +104 -0
- package/assets/docs/help/content200048.md +34 -0
- package/assets/docs/help/content200049.md +54 -0
- package/assets/docs/help/content200050.md +43 -0
- package/assets/docs/help/content200051.md +81 -0
- package/assets/docs/help/content51.md +38 -0
- package/assets/docs/help/content61.md +165 -0
- package/assets/docs/help/core-service/channel-setting/danal.md +170 -0
- package/assets/docs/help/core-service/channel-setting/daou.md +118 -0
- package/assets/docs/help/core-service/channel-setting/eximbay.md +136 -0
- package/assets/docs/help/core-service/channel-setting/inicis.md +340 -0
- package/assets/docs/help/core-service/channel-setting/kakaopay.md +107 -0
- package/assets/docs/help/core-service/channel-setting/kcp_channel.md +235 -0
- package/assets/docs/help/core-service/channel-setting/kicc.md +114 -0
- package/assets/docs/help/core-service/channel-setting/kpn.md +93 -0
- package/assets/docs/help/core-service/channel-setting/ksnet.md +116 -0
- package/assets/docs/help/core-service/channel-setting/mobilians.md +107 -0
- package/assets/docs/help/core-service/channel-setting/naverpay.md +179 -0
- package/assets/docs/help/core-service/channel-setting/nice.md +210 -0
- package/assets/docs/help/core-service/channel-setting/payco.md +124 -0
- package/assets/docs/help/core-service/channel-setting/paymentwall.md +107 -0
- package/assets/docs/help/core-service/channel-setting/paypal.md +247 -0
- package/assets/docs/help/core-service/channel-setting/settle.md +123 -0
- package/assets/docs/help/core-service/channel-setting/smartro.md +164 -0
- package/assets/docs/help/core-service/channel-setting/smilepay.md +83 -0
- package/assets/docs/help/core-service/channel-setting/tosspay.md +168 -0
- package/assets/docs/help/core-service/channel-setting/tosspayments.md +232 -0
- package/assets/docs/help/core-service/channel-setting/welcome.md +110 -0
- package/assets/docs/help/core-service/how-to-use/additional-danal.md +71 -0
- package/assets/docs/help/core-service/how-to-use/additional-daou.md +65 -0
- package/assets/docs/help/core-service/how-to-use/additional-eximbay.md +54 -0
- package/assets/docs/help/core-service/how-to-use/additional-inicis.md +97 -0
- package/assets/docs/help/core-service/how-to-use/additional-kakaopay.md +56 -0
- package/assets/docs/help/core-service/how-to-use/additional-kcp.md +53 -0
- package/assets/docs/help/core-service/how-to-use/additional-kicc.md +67 -0
- package/assets/docs/help/core-service/how-to-use/additional-ksnet.md +68 -0
- package/assets/docs/help/core-service/how-to-use/additional-mobilians.md +71 -0
- package/assets/docs/help/core-service/how-to-use/additional-naverpay-order.md +69 -0
- package/assets/docs/help/core-service/how-to-use/additional-naverpay.md +72 -0
- package/assets/docs/help/core-service/how-to-use/additional-nice.md +112 -0
- package/assets/docs/help/core-service/how-to-use/additional-payco.md +68 -0
- package/assets/docs/help/core-service/how-to-use/additional-settle.md +70 -0
- package/assets/docs/help/core-service/how-to-use/additional-smartro.md +70 -0
- package/assets/docs/help/core-service/how-to-use/additional-tosspay.md +57 -0
- package/assets/docs/help/core-service/how-to-use/additional-tosspayments.md +47 -0
- package/assets/docs/help/core-service/how-to-use/additional-welcome.md +72 -0
- package/assets/docs/help/core-service/how-to-use/cancel-deadline-by-paymethod.md +68 -0
- package/assets/docs/help/core-service/how-to-use/cancel-guide-using-admin-console.md +49 -0
- package/assets/docs/help/core-service/how-to-use/cancel-reversal.md +114 -0
- package/assets/docs/help/core-service/how-to-use/cellphone-identity-verification.md +62 -0
- package/assets/docs/help/core-service/how-to-use/content200000.md +72 -0
- package/assets/docs/help/core-service/how-to-use/content200009.md +83 -0
- package/assets/docs/help/core-service/how-to-use/danal-contract.md +82 -0
- package/assets/docs/help/core-service/how-to-use/daou-contract.md +82 -0
- package/assets/docs/help/core-service/how-to-use/eximbay-contract.md +75 -0
- package/assets/docs/help/core-service/how-to-use/high-risk-industry.md +554 -0
- package/assets/docs/help/core-service/how-to-use/identity-verification-value.md +61 -0
- package/assets/docs/help/core-service/how-to-use/impossible-partial-cancel.md +53 -0
- package/assets/docs/help/core-service/how-to-use/information-pg.md +151 -0
- package/assets/docs/help/core-service/how-to-use/inicis-contract.md +95 -0
- package/assets/docs/help/core-service/how-to-use/inicis-vat.md +45 -0
- package/assets/docs/help/core-service/how-to-use/inicis-vbank-refund.md +45 -0
- package/assets/docs/help/core-service/how-to-use/kakao-contract.md +73 -0
- package/assets/docs/help/core-service/how-to-use/kakaopay-contract.md +41 -0
- package/assets/docs/help/core-service/how-to-use/kcp-contract.md +82 -0
- package/assets/docs/help/core-service/how-to-use/kcp-vat.md +39 -0
- package/assets/docs/help/core-service/how-to-use/kcp-vbank-refund.md +46 -0
- package/assets/docs/help/core-service/how-to-use/kicc-contract.md +81 -0
- package/assets/docs/help/core-service/how-to-use/ksnet-contract.md +78 -0
- package/assets/docs/help/core-service/how-to-use/mobilians-contract.md +81 -0
- package/assets/docs/help/core-service/how-to-use/naverpay-contract.md +86 -0
- package/assets/docs/help/core-service/how-to-use/naverpay-order-1.md +36 -0
- package/assets/docs/help/core-service/how-to-use/naverpay-order-contract.md +88 -0
- package/assets/docs/help/core-service/how-to-use/naverpay-order-diff.md +66 -0
- package/assets/docs/help/core-service/how-to-use/naverpay-order-review-items.md +66 -0
- package/assets/docs/help/core-service/how-to-use/naverpay-review-items.md +199 -0
- package/assets/docs/help/core-service/how-to-use/nice-contract.md +81 -0
- package/assets/docs/help/core-service/how-to-use/open-immediately.md +60 -0
- package/assets/docs/help/core-service/how-to-use/other-hosting-company.md +38 -0
- package/assets/docs/help/core-service/how-to-use/payco-contract.md +74 -0
- package/assets/docs/help/core-service/how-to-use/payment-settlement-method.md +30 -0
- package/assets/docs/help/core-service/how-to-use/paymentwall-contract.md +85 -0
- package/assets/docs/help/core-service/how-to-use/paypal-contract.md +66 -0
- package/assets/docs/help/core-service/how-to-use/point-service.md +293 -0
- package/assets/docs/help/core-service/how-to-use/refund-date.md +66 -0
- package/assets/docs/help/core-service/how-to-use/requirements.md +100 -0
- package/assets/docs/help/core-service/how-to-use/settle-contract.md +79 -0
- package/assets/docs/help/core-service/how-to-use/shopify-available-list.md +65 -0
- package/assets/docs/help/core-service/how-to-use/shopify-guide.md +62 -0
- package/assets/docs/help/core-service/how-to-use/small-business-commission-fee.md +55 -0
- package/assets/docs/help/core-service/how-to-use/smartro-contract.md +77 -0
- package/assets/docs/help/core-service/how-to-use/test-mode-cancel.md +63 -0
- package/assets/docs/help/core-service/how-to-use/tosspay-contract.md +82 -0
- package/assets/docs/help/core-service/how-to-use/tosspayments-contract.md +82 -0
- package/assets/docs/help/core-service/how-to-use/welcome-contract.md +81 -0
- package/assets/docs/help/core-service/how-to-use/withsoft-guide.md +69 -0
- package/assets/docs/help/core-service/how-to-use/wordpress-available-pg.md +49 -0
- package/assets/docs/help/core-service/how-to-use/wordpress-setting.md +50 -0
- package/assets/docs/help/core-service/payment-type/billing-key.md +72 -0
- package/assets/docs/help/core-service/payment-type/content200003.md +39 -0
- package/assets/docs/help/core-service/payment-type/content200007.md +176 -0
- package/assets/docs/help/core-service/payment-type/content200036.md +37 -0
- package/assets/docs/help/core-service/payment-type/content200042.md +150 -0
- package/assets/docs/help/core-service/payment-type/content200047.md +215 -0
- package/assets/docs/help/core-service/payment-type/content200052.md +142 -0
- package/assets/docs/help/core-service/payment-type/content200053.md +128 -0
- package/assets/docs/help/core-service/payment-type/crossborder.md +132 -0
- package/assets/docs/help/core-service/payment-type/eximbay-international.md +96 -0
- package/assets/docs/help/core-service/payment-type/hub-service-fee.md +79 -0
- package/assets/docs/help/core-service/payment-type/inicis-easypay-hub-fee.md +45 -0
- package/assets/docs/help/core-service/payment-type/inicis-international.md +65 -0
- package/assets/docs/help/core-service/payment-type/internationl-high-risk-industry.md +267 -0
- package/assets/docs/help/core-service/payment-type/internationl-pg.md +42 -0
- package/assets/docs/help/core-service/payment-type/kcp-easypay-hub-apply.md +49 -0
- package/assets/docs/help/core-service/payment-type/kcp-international.md +60 -0
- package/assets/docs/help/core-service/payment-type/nice-easypay-hub-fee.md +72 -0
- package/assets/docs/help/core-service/payment-type/nice-international.md +51 -0
- package/assets/docs/help/core-service/payment-type/paymentwall-international.md +84 -0
- package/assets/docs/help/core-service/payment-type/paypal-international.md +86 -0
- package/assets/docs/help/core-service/payment-type/paypal-payment-status.md +55 -0
- package/assets/docs/help/core-service/payment-type/schedule-logic-guide.md +49 -0
- package/assets/docs/help/core-service/payment-type/schedule-requirement.md +111 -0
- package/assets/docs/help/core-service/payment-type/schedule-validity-guide.md +68 -0
- package/assets/docs/help/core-service/payment-type/tosspayment-international.md +54 -0
- package/assets/docs/help/core-service/payment-type/tosspayments-easypay-hub-fee.md +42 -0
- package/assets/docs/help/core-service/payment-type/webhook-re-send.md +41 -0
- package/assets/docs/help/faq/console-faq/2-depth-auth.md +53 -0
- package/assets/docs/help/faq/console-faq/add-admin-account.md +42 -0
- package/assets/docs/help/faq/console-faq/change-console-url.md +51 -0
- package/assets/docs/help/faq/console-faq/impossible-login.md +30 -0
- package/assets/docs/help/faq/console-faq/payment-list.md +45 -0
- package/assets/docs/help/faq/console-faq/sub-store-mgnt.md +97 -0
- package/assets/docs/help/faq/general-inquiry/change-business-number.md +32 -0
- package/assets/docs/help/faq/general-inquiry/confirm-process.md +118 -0
- package/assets/docs/help/faq/general-inquiry/content200004.md +55 -0
- package/assets/docs/help/faq/general-inquiry/content200006.md +86 -0
- package/assets/docs/help/faq/general-inquiry/content200011.md +24 -0
- package/assets/docs/help/faq/general-inquiry/content200031.md +194 -0
- package/assets/docs/help/faq/general-inquiry/content200041.md +21 -0
- package/assets/docs/help/faq/general-inquiry/contract-checkpoint.md +49 -0
- package/assets/docs/help/faq/general-inquiry/main-user.md +56 -0
- package/assets/docs/help/faq/general-inquiry/platform-contract-method.md +67 -0
- package/assets/docs/help/faq/general-inquiry/platform-contract-pg.md +234 -0
- package/assets/docs/help/faq/general-inquiry/portone-advantages.md +71 -0
- package/assets/docs/help/faq/general-inquiry/real-channel-info.md +70 -0
- package/assets/docs/help/faq/general-inquiry/what-is-the-small-business-fee.md +41 -0
- package/assets/docs/help/faq/payment-faq/business-card-available.md +55 -0
- package/assets/docs/help/faq/payment-faq/business-info-change.md +96 -0
- package/assets/docs/help/faq/payment-faq/cancel-deadline.md +32 -0
- package/assets/docs/help/faq/payment-faq/cancel-guide.md +48 -0
- package/assets/docs/help/faq/payment-faq/cash-receipt-guide.md +64 -0
- package/assets/docs/help/faq/payment-faq/content200022.md +73 -0
- package/assets/docs/help/faq/payment-faq/pg-max-min-amount.md +158 -0
- package/assets/docs/help/faq/payment-faq/receipt-guide.md +38 -0
- package/assets/docs/help/faq/payment-faq/tosspayments-cash-receipt.md +32 -0
- package/assets/docs/help/faq/payment-faq/vbank-info.md +35 -0
- package/assets/docs/help/faq/payment-faq/vbank-service-detail.md +67 -0
- package/assets/docs/help/faq/payment-faq/vbank-test-guide.md +65 -0
- package/assets/docs/help/faq/platform-faq/platform_function_partnerbulkupload.md +190 -0
- package/assets/docs/help/faq/platform-faq/platform_infosec.md +56 -0
- package/assets/docs/help/faq/platform-faq/platform_nocode_guide.md +104 -0
- package/assets/docs/help/faq/platform-faq/platform_payout_guide.md +75 -0
- package/assets/docs/help/faq/platform-faq/platform_policymanagement_calculator.md +73 -0
- package/assets/docs/help/faq/platform-faq/platform_settlmentandpayout_guide.md +83 -0
- package/assets/docs/help/faq/platform-faq/platform_tax_setting_guide.md +108 -0
- package/assets/docs/help/faq/platform-faq/taxinvoice_guide.md +107 -0
- package/assets/docs/help/faq/platform-faq/taxinvoice_signupemail.md +67 -0
- package/assets/docs/help/holidays.md +29 -0
- package/assets/docs/help/notice-kakaopay-2025-06-30.md +47 -0
- package/assets/docs/help/platform-2024-11-07.md +73 -0
- package/assets/docs/help/platform-2024-11-25.md +91 -0
- package/assets/docs/help/platform-2024-12-10.md +71 -0
- package/assets/docs/help/platform-2025-03-04.md +54 -0
- package/assets/docs/help/platform-2025-04-03.md +105 -0
- package/assets/docs/help/platform-2025-04-08.md +120 -0
- package/assets/docs/help/platform-2025-05-14.md +70 -0
- package/assets/docs/help/platform-2025-1-16.md +65 -0
- package/assets/docs/help/platform-2025-2-10.md +75 -0
- package/assets/docs/help/platform-2025-2-13.md +43 -0
- package/assets/docs/help/portone-service/portone-service/content50.md +80 -0
- package/assets/docs/help/pricing/pg/domestic-and-oversea-fees.md +34 -0
- package/assets/docs/help/pricing/portone/portone-pricing.md +116 -0
- package/assets/docs/help/procedure/payment-integration/real-integration.md +43 -0
- package/assets/docs/help/procedure/payment-integration/test-integration.md +91 -0
- package/assets/docs/help/procedure/pg-application/content53.md +49 -0
- package/assets/docs/help/procedure/pg-application/content54.md +136 -0
- package/assets/docs/help/procedure/pg-application/content59.md +53 -0
- package/assets/docs/help/procedure/pg-application/start.md +154 -0
- package/assets/docs/help/procedure/recommendation/package.md +98 -0
- package/assets/docs/help/procedure/service-addition/add-service.md +98 -0
- package/assets/docs/help/recon_issue1.md +25 -0
- package/assets/docs/help/recon_issue2.md +29 -0
- package/assets/docs/help/service/identity-verification/identity-verification.md +65 -0
- package/assets/docs/help/service/integration-type/integration-type.md +49 -0
- package/assets/docs/help/service/payment-type/payment-type.md +100 -0
- package/assets/docs/help/service/paymethod/paymethod.md +100 -0
- package/assets/docs/help/service/pg/pg-service-list.md +339 -0
- package/assets/docs/help/service/version/portone-version.md +61 -0
- package/assets/docs/opi/ko/console/guide/account.md +111 -0
- package/assets/docs/opi/ko/console/guide/api-keys.md +34 -0
- package/assets/docs/opi/ko/console/guide/billing-payments.md +312 -0
- package/assets/docs/opi/ko/console/guide/channel-manage.md +303 -0
- package/assets/docs/opi/ko/console/guide/connect.md +84 -0
- package/assets/docs/opi/ko/console/guide/home.md +37 -0
- package/assets/docs/opi/ko/console/guide/integration.md +18 -0
- package/assets/docs/opi/ko/console/guide/list.md +183 -0
- package/assets/docs/opi/ko/console/guide/pay.md +14 -0
- package/assets/docs/opi/ko/console/guide/payments.md +298 -0
- package/assets/docs/opi/ko/console/guide/promotion.md +140 -0
- package/assets/docs/opi/ko/console/guide/readme.md +22 -0
- package/assets/docs/opi/ko/console/guide/reg.md +159 -0
- package/assets/docs/opi/ko/console/guide/smartrouting.md +74 -0
- package/assets/docs/opi/ko/console/pg.md +92 -0
- package/assets/docs/opi/ko/etc/recon.md +286 -0
- package/assets/docs/opi/ko/extra/confirm-process/readme-v1.md +98 -0
- package/assets/docs/opi/ko/extra/confirm-process/readme-v2.md +152 -0
- package/assets/docs/opi/ko/extra/identity-verification/readme-v2.md +261 -0
- package/assets/docs/opi/ko/extra/identity-verification/v1/all/0.md +35 -0
- package/assets/docs/opi/ko/extra/identity-verification/v1/all/1.md +44 -0
- package/assets/docs/opi/ko/extra/identity-verification/v1/all/2.md +75 -0
- package/assets/docs/opi/ko/extra/identity-verification/v1/all/3.md +134 -0
- package/assets/docs/opi/ko/extra/identity-verification/v1/all/readme.md +17 -0
- package/assets/docs/opi/ko/extra/identity-verification/v1/credit-auth/1.md +35 -0
- package/assets/docs/opi/ko/extra/identity-verification/v1/credit-auth/2.md +78 -0
- package/assets/docs/opi/ko/extra/identity-verification/v1/credit-auth/3.md +75 -0
- package/assets/docs/opi/ko/extra/identity-verification/v1/credit-auth/4.md +134 -0
- package/assets/docs/opi/ko/extra/identity-verification/v1/credit-auth/readme.md +17 -0
- package/assets/docs/opi/ko/extra/identity-verification/v1/phone/1.md +37 -0
- package/assets/docs/opi/ko/extra/identity-verification/v1/phone/2.md +86 -0
- package/assets/docs/opi/ko/extra/identity-verification/v1/phone/3.md +77 -0
- package/assets/docs/opi/ko/extra/identity-verification/v1/phone/4.md +149 -0
- package/assets/docs/opi/ko/extra/identity-verification/v1/phone/readme.md +19 -0
- package/assets/docs/opi/ko/extra/identity-verification/v1/readme.md +9 -0
- package/assets/docs/opi/ko/extra/link-pay/readme-v1.md +235 -0
- package/assets/docs/opi/ko/extra/plugins/readme-v1.md +7 -0
- package/assets/docs/opi/ko/extra/plugins/shopify/readme-v1.md +54 -0
- package/assets/docs/opi/ko/extra/plugins/shopify/shopify/shopify-1.md +16 -0
- package/assets/docs/opi/ko/extra/plugins/shopify/shopify/shopify-2.md +32 -0
- package/assets/docs/opi/ko/extra/plugins/shopify/shopify/shopify-3.md +16 -0
- package/assets/docs/opi/ko/extra/plugins/shopify/shopify/shopify-4.md +35 -0
- package/assets/docs/opi/ko/extra/plugins/shopify/shopify/shopify-5.md +27 -0
- package/assets/docs/opi/ko/extra/plugins/wordpress/button.md +166 -0
- package/assets/docs/opi/ko/extra/plugins/wordpress/edd.md +56 -0
- package/assets/docs/opi/ko/extra/plugins/wordpress/readme-v1.md +10 -0
- package/assets/docs/opi/ko/extra/plugins/wordpress/woocommerce/payment.md +62 -0
- package/assets/docs/opi/ko/extra/plugins/wordpress/woocommerce/readme.md +30 -0
- package/assets/docs/opi/ko/extra/plugins/wordpress/woocommerce/subscription.md +60 -0
- package/assets/docs/opi/ko/extra/plugins/wordpress/woocommerce/vbank.md +64 -0
- package/assets/docs/opi/ko/extra/promotion/console-guide.md +148 -0
- package/assets/docs/opi/ko/extra/promotion/integration.md +769 -0
- package/assets/docs/opi/ko/extra/promotion/intro.md +31 -0
- package/assets/docs/opi/ko/extra/promotion/refund.md +316 -0
- package/assets/docs/opi/ko/extra/smart-routing/console-guide.md +73 -0
- package/assets/docs/opi/ko/extra/smart-routing/integration.md +1324 -0
- package/assets/docs/opi/ko/extra/smart-routing/intro.md +155 -0
- package/assets/docs/opi/ko/integration/cancel/v1/basic.md +324 -0
- package/assets/docs/opi/ko/integration/cancel/v1/virtual-account.md +99 -0
- package/assets/docs/opi/ko/integration/cancel/v2/readme.md +378 -0
- package/assets/docs/opi/ko/integration/checklist/readme-v1.md +83 -0
- package/assets/docs/opi/ko/integration/pg/v1/blue.md +99 -0
- package/assets/docs/opi/ko/integration/pg/v1/danal.md +409 -0
- package/assets/docs/opi/ko/integration/pg/v1/daou/readme.md +305 -0
- package/assets/docs/opi/ko/integration/pg/v1/daou/undefined.md +214 -0
- package/assets/docs/opi/ko/integration/pg/v1/eximbay.md +242 -0
- package/assets/docs/opi/ko/integration/pg/v1/hyphen.md +196 -0
- package/assets/docs/opi/ko/integration/pg/v1/inicis.md +444 -0
- package/assets/docs/opi/ko/integration/pg/v1/kakaopay.md +207 -0
- package/assets/docs/opi/ko/integration/pg/v1/kcp-v2-identity-verification.md +188 -0
- package/assets/docs/opi/ko/integration/pg/v1/kg.md +177 -0
- package/assets/docs/opi/ko/integration/pg/v1/kicc.md +308 -0
- package/assets/docs/opi/ko/integration/pg/v1/ksnet/readme.md +533 -0
- package/assets/docs/opi/ko/integration/pg/v1/ksnet/warning.md +175 -0
- package/assets/docs/opi/ko/integration/pg/v1/naver.md +558 -0
- package/assets/docs/opi/ko/integration/pg/v1/newtoss/readme.md +503 -0
- package/assets/docs/opi/ko/integration/pg/v1/newtoss/warning.md +364 -0
- package/assets/docs/opi/ko/integration/pg/v1/nhn-kcp.md +1186 -0
- package/assets/docs/opi/ko/integration/pg/v1/nice-v2/billing-api-caution.md +150 -0
- package/assets/docs/opi/ko/integration/pg/v1/nice-v2/payment-caution.md +429 -0
- package/assets/docs/opi/ko/integration/pg/v1/nice-v2/readme.md +364 -0
- package/assets/docs/opi/ko/integration/pg/v1/nice.md +319 -0
- package/assets/docs/opi/ko/integration/pg/v1/payco.md +201 -0
- package/assets/docs/opi/ko/integration/pg/v1/paymentwall.md +283 -0
- package/assets/docs/opi/ko/integration/pg/v1/paypal.md +158 -0
- package/assets/docs/opi/ko/integration/pg/v1/readme.md +73 -0
- package/assets/docs/opi/ko/integration/pg/v1/rt/readme.md +501 -0
- package/assets/docs/opi/ko/integration/pg/v1/rt/warning.md +297 -0
- package/assets/docs/opi/ko/integration/pg/v1/settle/mybank.md +304 -0
- package/assets/docs/opi/ko/integration/pg/v1/settle/readme.md +185 -0
- package/assets/docs/opi/ko/integration/pg/v1/smartro-v2/api.md +197 -0
- package/assets/docs/opi/ko/integration/pg/v1/smartro-v2/caution.md +387 -0
- package/assets/docs/opi/ko/integration/pg/v1/smartro-v2/readme.md +293 -0
- package/assets/docs/opi/ko/integration/pg/v1/smartro.md +104 -0
- package/assets/docs/opi/ko/integration/pg/v1/smilepay.md +97 -0
- package/assets/docs/opi/ko/integration/pg/v1/spb/readme.md +441 -0
- package/assets/docs/opi/ko/integration/pg/v1/spb/stc.md +226 -0
- package/assets/docs/opi/ko/integration/pg/v1/spb/warning.md +729 -0
- package/assets/docs/opi/ko/integration/pg/v1/toss-brandpay/module.md +227 -0
- package/assets/docs/opi/ko/integration/pg/v1/toss-brandpay/readme.md +404 -0
- package/assets/docs/opi/ko/integration/pg/v1/toss-brandpay/warning.md +81 -0
- package/assets/docs/opi/ko/integration/pg/v1/toss-brandpay/widget.md +152 -0
- package/assets/docs/opi/ko/integration/pg/v1/toss.md +112 -0
- package/assets/docs/opi/ko/integration/pg/v1/tosspay-v2/caution.md +65 -0
- package/assets/docs/opi/ko/integration/pg/v1/tosspay-v2/readme.md +308 -0
- package/assets/docs/opi/ko/integration/pg/v1/tosspay.md +110 -0
- package/assets/docs/opi/ko/integration/pg/v1/welcome/api.md +229 -0
- package/assets/docs/opi/ko/integration/pg/v1/welcome/caution.md +517 -0
- package/assets/docs/opi/ko/integration/pg/v1/welcome/readme.md +795 -0
- package/assets/docs/opi/ko/integration/pg/v2/danal-identity-verification.md +121 -0
- package/assets/docs/opi/ko/integration/pg/v2/eximbay-v2.md +964 -0
- package/assets/docs/opi/ko/integration/pg/v2/hyphen.md +205 -0
- package/assets/docs/opi/ko/integration/pg/v2/inicis-jp.md +403 -0
- package/assets/docs/opi/ko/integration/pg/v2/inicis-unified-identity-verification.md +89 -0
- package/assets/docs/opi/ko/integration/pg/v2/inicis-v2.md +1598 -0
- package/assets/docs/opi/ko/integration/pg/v2/kakaopay.md +108 -0
- package/assets/docs/opi/ko/integration/pg/v2/kcp-v2-identity-verification.md +291 -0
- package/assets/docs/opi/ko/integration/pg/v2/kcp-v2.md +1273 -0
- package/assets/docs/opi/ko/integration/pg/v2/kpn.md +1133 -0
- package/assets/docs/opi/ko/integration/pg/v2/ksnet.md +526 -0
- package/assets/docs/opi/ko/integration/pg/v2/naverpay.md +186 -0
- package/assets/docs/opi/ko/integration/pg/v2/nice-v2.md +868 -0
- package/assets/docs/opi/ko/integration/pg/v2/payletter-global.md +62 -0
- package/assets/docs/opi/ko/integration/pg/v2/paypal-v2.md +1874 -0
- package/assets/docs/opi/ko/integration/pg/v2/readme.md +194 -0
- package/assets/docs/opi/ko/integration/pg/v2/smartro-v2.md +1043 -0
- package/assets/docs/opi/ko/integration/pg/v2/tosspay-v2.md +433 -0
- package/assets/docs/opi/ko/integration/pg/v2/tosspayments.md +551 -0
- package/assets/docs/opi/ko/integration/pg/v2/welcome.md +1441 -0
- package/assets/docs/opi/ko/integration/ready/readme.md +1069 -0
- package/assets/docs/opi/ko/integration/start/v1/auth.md +483 -0
- package/assets/docs/opi/ko/integration/start/v1/non-auth.md +420 -0
- package/assets/docs/opi/ko/integration/start/v1/readme.md +9 -0
- package/assets/docs/opi/ko/integration/start/v2/billing/issue.md +122 -0
- package/assets/docs/opi/ko/integration/start/v2/billing/payment.md +41 -0
- package/assets/docs/opi/ko/integration/start/v2/billing/readme.md +24 -0
- package/assets/docs/opi/ko/integration/start/v2/billing/schedule.md +54 -0
- package/assets/docs/opi/ko/integration/start/v2/checkout.md +258 -0
- package/assets/docs/opi/ko/integration/start/v2/keyin.md +54 -0
- package/assets/docs/opi/ko/integration/start/v2/readme.md +120 -0
- package/assets/docs/opi/ko/integration/using-ai-tools.md +140 -0
- package/assets/docs/opi/ko/integration/virtual-account/readme.md +268 -0
- package/assets/docs/opi/ko/integration/webhook/readme-v1.md +242 -0
- package/assets/docs/opi/ko/integration/webhook/readme-v2.md +599 -0
- package/assets/docs/opi/ko/quick-guide/payment.md +3305 -0
- package/assets/docs/opi/ko/readme.md +193 -0
- package/assets/docs/opi/ko/support/agency-and-tier.md +51 -0
- package/assets/docs/opi/ko/support/code-info/card-code.md +29 -0
- package/assets/docs/opi/ko/support/code-info/code.md +22 -0
- package/assets/docs/opi/ko/support/code-info/pg-1.md +161 -0
- package/assets/docs/opi/ko/support/code-info/pg-2.md +41 -0
- package/assets/docs/opi/ko/support/code-info/pg-3.md +36 -0
- package/assets/docs/opi/ko/support/code-info/pg.md +41 -0
- package/assets/docs/opi/ko/support/code-info/portone-code.md +15 -0
- package/assets/docs/opi/ko/support/code-info/readme.md +20 -0
- package/assets/docs/opi/ko/support/contact.md +23 -0
- package/assets/docs/opi/ko/support/faq/undefined.md +60 -0
- package/assets/docs/opi/ko/support/flow.md +24 -0
- package/assets/docs/opi/ko/support/redirect.md +26 -0
- package/assets/docs/opi/ko/support/tax.md +142 -0
- package/assets/docs/opi/ko/support/tls-support.md +497 -0
- package/assets/docs/platform/ko/guides/dictionary.md +20 -0
- package/assets/docs/platform/ko/guides/process.md +33 -0
- package/assets/docs/platform/ko/guides/webhook.md +171 -0
- package/assets/docs/platform/ko/readme.md +64 -0
- package/assets/docs/platform/ko/usages/client.md +17 -0
- package/assets/docs/platform/ko/usages/contract.md +126 -0
- package/assets/docs/platform/ko/usages/discount.md +89 -0
- package/assets/docs/platform/ko/usages/fee.md +97 -0
- package/assets/docs/platform/ko/usages/order.md +1666 -0
- package/assets/docs/platform/ko/usages/partner.md +115 -0
- package/assets/docs/platform/ko/using-ai-tools.md +140 -0
- package/assets/docs/release-notes/api-sdk/2023-04-24.md +10 -0
- package/assets/docs/release-notes/api-sdk/2023-05-08.md +22 -0
- package/assets/docs/release-notes/api-sdk/2023-05-12.md +24 -0
- package/assets/docs/release-notes/api-sdk/2023-05-22.md +46 -0
- package/assets/docs/release-notes/api-sdk/2023-05-25.md +15 -0
- package/assets/docs/release-notes/api-sdk/2023-06-19.md +20 -0
- package/assets/docs/release-notes/api-sdk/2023-07-03.md +26 -0
- package/assets/docs/release-notes/api-sdk/2023-07-10.md +35 -0
- package/assets/docs/release-notes/api-sdk/2023-07-17.md +31 -0
- package/assets/docs/release-notes/api-sdk/2023-07-31.md +14 -0
- package/assets/docs/release-notes/api-sdk/2023-08-31.md +29 -0
- package/assets/docs/release-notes/api-sdk/2023-12-15.md +12 -0
- package/assets/docs/release-notes/api-sdk/2024-01-08.md +36 -0
- package/assets/docs/release-notes/api-sdk/2024-01-11.md +18 -0
- package/assets/docs/release-notes/api-sdk/2024-01-25.md +35 -0
- package/assets/docs/release-notes/api-sdk/2024-01-30.md +19 -0
- package/assets/docs/release-notes/api-sdk/2024-02-23.md +26 -0
- package/assets/docs/release-notes/api-sdk/2024-03-08.md +12 -0
- package/assets/docs/release-notes/api-sdk/2024-03-15.md +30 -0
- package/assets/docs/release-notes/api-sdk/2024-03-25.md +23 -0
- package/assets/docs/release-notes/api-sdk/2024-04-01.md +37 -0
- package/assets/docs/release-notes/api-sdk/2024-04-05.md +10 -0
- package/assets/docs/release-notes/api-sdk/2024-04-12.md +32 -0
- package/assets/docs/release-notes/api-sdk/2024-05-08.md +34 -0
- package/assets/docs/release-notes/api-sdk/2024-05-14.md +17 -0
- package/assets/docs/release-notes/api-sdk/2024-06-03.md +48 -0
- package/assets/docs/release-notes/api-sdk/2024-06-17.md +37 -0
- package/assets/docs/release-notes/api-sdk/2024-06-19.md +39 -0
- package/assets/docs/release-notes/api-sdk/2024-06-20.md +13 -0
- package/assets/docs/release-notes/api-sdk/2024-07-04.md +15 -0
- package/assets/docs/release-notes/api-sdk/2024-07-11.md +47 -0
- package/assets/docs/release-notes/api-sdk/2024-09-05.md +36 -0
- package/assets/docs/release-notes/api-sdk/2024-09-27.md +27 -0
- package/assets/docs/release-notes/api-sdk/2024-12-19.md +52 -0
- package/assets/docs/release-notes/api-sdk/2025-01-15.md +76 -0
- package/assets/docs/release-notes/api-sdk/2025-05-19.md +49 -0
- package/assets/docs/release-notes/console/2023-04-24.md +41 -0
- package/assets/docs/release-notes/console/2023-05-08.md +6 -0
- package/assets/docs/release-notes/console/2023-05-22.md +15 -0
- package/assets/docs/release-notes/console/2023-07-05.md +29 -0
- package/assets/docs/release-notes/console/2023-07-07.md +25 -0
- package/assets/docs/release-notes/console/2023-07-17.md +16 -0
- package/assets/docs/release-notes/console/2023-08-23.md +17 -0
- package/assets/docs/release-notes/console/2023-09-12.md +16 -0
- package/assets/docs/release-notes/console/2023-12-27.md +24 -0
- package/assets/docs/release-notes/console/2024-09-05.md +23 -0
- package/assets/docs/release-notes/platform/2023-08-31.md +16 -0
- package/assets/docs/release-notes/platform/2023-11-08.md +37 -0
- package/assets/docs/release-notes/platform/2023-11-14.md +28 -0
- package/assets/docs/release-notes/platform/2023-12-15.md +11 -0
- package/assets/docs/release-notes/platform/2024-05-20.md +31 -0
- package/assets/docs/release-notes/platform/2024-05-29.md +159 -0
- package/assets/docs/release-notes/platform/2024-06-05.md +30 -0
- package/assets/docs/release-notes/platform/2024-07-05.md +49 -0
- package/assets/docs/release-notes/platform/2024-07-11.md +62 -0
- package/assets/docs/release-notes/platform/2024-07-30.md +44 -0
- package/assets/docs/release-notes/platform/2024-08-07.md +37 -0
- package/assets/docs/release-notes/platform/2024-08-22.md +111 -0
- package/assets/docs/release-notes/platform/2024-10-21.md +75 -0
- package/assets/docs/release-notes/platform/2024-11-07.md +65 -0
- package/assets/docs/release-notes/platform/2024-11-25.md +82 -0
- package/assets/docs/release-notes/platform/2024-12-10.md +61 -0
- package/assets/docs/release-notes/platform/2025-01-16.md +56 -0
- package/assets/docs/release-notes/platform/2025-02-10.md +67 -0
- package/assets/docs/release-notes/platform/2025-02-13.md +27 -0
- package/assets/docs/release-notes/platform/2025-03-04.md +49 -0
- package/assets/docs/release-notes/platform/2025-03-17.md +40 -0
- package/assets/docs/release-notes/platform/2025-04-03.md +96 -0
- package/assets/docs/release-notes/platform/2025-04-08.md +119 -0
- package/assets/docs/release-notes/platform/2025-05-14.md +77 -0
- package/assets/docs/release-notes/platform/2025-07-02.md +64 -0
- package/assets/docs/release-notes/platform/2025-07-07.md +55 -0
- package/assets/docs/schema/browser-sdk.yml +6349 -0
- package/assets/docs/schema/v1.openapi.json +11632 -0
- package/assets/docs/schema/v1.openapi.yml +11489 -0
- package/assets/docs/schema/v2.graphql +13849 -0
- package/assets/docs/schema/v2.openapi.json +47721 -0
- package/assets/docs/schema/v2.openapi.yml +34749 -0
- package/assets/docs/sdk/ko/readme.md +56 -0
- package/assets/docs/sdk/ko/v1-mobile-sdk/readme.md +31 -0
- package/assets/docs/sdk/ko/v1-sdk/javascript-sdk/cft-rt.md +32 -0
- package/assets/docs/sdk/ko/v1-sdk/javascript-sdk/cft.md +108 -0
- package/assets/docs/sdk/ko/v1-sdk/javascript-sdk/load-module-rt.md +10 -0
- package/assets/docs/sdk/ko/v1-sdk/javascript-sdk/load-module.md +55 -0
- package/assets/docs/sdk/ko/v1-sdk/javascript-sdk/payrq.md +502 -0
- package/assets/docs/sdk/ko/v1-sdk/javascript-sdk/payrt.md +300 -0
- package/assets/docs/sdk/ko/v1-sdk/javascript-sdk/readme.md +46 -0
- package/assets/docs/sdk/ko/v1-sdk/javascript-sdk-old/readme.md +33 -0
- package/assets/docs/sdk/ko/v2-mobile-sdk/android.md +268 -0
- package/assets/docs/sdk/ko/v2-mobile-sdk/react-native.md +239 -0
- package/assets/docs/sdk/ko/v2-mobile-sdk/readme.md +30 -0
- package/assets/docs/sdk/ko/v2-sdk/billing-key-and-pay-request.md +26 -0
- package/assets/docs/sdk/ko/v2-sdk/billing-key-and-pay-response.md +15 -0
- package/assets/docs/sdk/ko/v2-sdk/billing-key-request.md +24 -0
- package/assets/docs/sdk/ko/v2-sdk/billing-key-response.md +15 -0
- package/assets/docs/sdk/ko/v2-sdk/changelog.md +8 -0
- package/assets/docs/sdk/ko/v2-sdk/identity-verification-request.md +15 -0
- package/assets/docs/sdk/ko/v2-sdk/identity-verification-response.md +15 -0
- package/assets/docs/sdk/ko/v2-sdk/load-issue-billing-key-ui-request.md +15 -0
- package/assets/docs/sdk/ko/v2-sdk/load-issue-billing-key-ui-response.md +23 -0
- package/assets/docs/sdk/ko/v2-sdk/load-payment-ui-request.md +15 -0
- package/assets/docs/sdk/ko/v2-sdk/load-payment-ui-response.md +23 -0
- package/assets/docs/sdk/ko/v2-sdk/payment-request.md +15 -0
- package/assets/docs/sdk/ko/v2-sdk/payment-response.md +15 -0
- package/assets/docs/sdk/ko/v2-sdk/readme.md +73 -0
- package/assets/docs/sdk/ko/v2-sdk/update-load-issue-billing-key-ui-request.md +15 -0
- package/assets/docs/sdk/ko/v2-sdk/update-load-payment-ui-request.md +15 -0
- package/assets/docs/sdk/ko/v2-server-sdk/javascript.md +170 -0
- package/assets/docs/sdk/ko/v2-server-sdk/jvm.md +170 -0
- package/assets/docs/sdk/ko/v2-server-sdk/python.md +152 -0
- package/assets/docs/sdk/ko/v2-server-sdk/readme.md +259 -0
- package/assets/docs/v1-docs-full.md +36540 -0
- package/assets/docs/v2-docs-full.md +34980 -0
- package/assets/docs/website-links.md +331 -0
- package/assets/instructions.md +19 -0
- package/manifest.json +50 -0
- package/package.json +66 -0
- package/server/index.js +1764 -0
|
@@ -0,0 +1,227 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 모듈 로딩 연동
|
|
3
|
+
description: 토스페이먼츠 브랜드페이의 모듈 로딩에 연동 방법을 안내합니다.
|
|
4
|
+
targetVersions:
|
|
5
|
+
- v1
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## 모듈 로드 파라미터 정의
|
|
9
|
+
|
|
10
|
+
<div class="tabs-container">
|
|
11
|
+
|
|
12
|
+
<div class="tabs-content" data-title="모듈 로드 요청">
|
|
13
|
+
|
|
14
|
+
```ts title="Javascript SDK"
|
|
15
|
+
await IMP.loadModule(
|
|
16
|
+
"toss-brandpay",
|
|
17
|
+
{
|
|
18
|
+
userCode: "imp00000000", //// 관리자 콘솔 - 결제 연동 페이지에서 확인 가능합니다.
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
customerKey: "d005f081-830a-4b9c-b5e2-73e56fbe6ac3",
|
|
22
|
+
loadBrandpayOptions: {
|
|
23
|
+
ui: {
|
|
24
|
+
buttonStyle: "default",
|
|
25
|
+
highlightColor: "#3182f6",
|
|
26
|
+
navigationBar: {
|
|
27
|
+
visible: true,
|
|
28
|
+
paddingTop: 10,
|
|
29
|
+
},
|
|
30
|
+
labels: {
|
|
31
|
+
oneTouchPay: "원터치결제",
|
|
32
|
+
},
|
|
33
|
+
},
|
|
34
|
+
},
|
|
35
|
+
},
|
|
36
|
+
);
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
<details>
|
|
40
|
+
|
|
41
|
+
<summary>
|
|
42
|
+
|
|
43
|
+
<strong>주요 파라미터 설명</strong>
|
|
44
|
+
|
|
45
|
+
</summary>
|
|
46
|
+
|
|
47
|
+
- moduleType: string
|
|
48
|
+
|
|
49
|
+
**모듈 타입**
|
|
50
|
+
|
|
51
|
+
브랜드페이의 경우 `toss-brandpay` 를 사용합니다.
|
|
52
|
+
|
|
53
|
+
- userCode: string
|
|
54
|
+
|
|
55
|
+
**고객사 식별코드**
|
|
56
|
+
|
|
57
|
+
`IMP` 로 시작하는 포트원 고객사 식별코드입니다.
|
|
58
|
+
|
|
59
|
+
- tier\_code?: string
|
|
60
|
+
|
|
61
|
+
**하위상점(Tier)의 고유코드**
|
|
62
|
+
|
|
63
|
+
\[상점·계정 관리]-\[하위 상점 관리]에서 하위 상점을 생성한 경우에만 사용 가능합니다. 하위상점 고유코드는 알파벳 대문자 또는 숫자만 입력가능하며, 3자까지 입력 가능합니다.
|
|
64
|
+
|
|
65
|
+
- loadBrandpayOptions?: object
|
|
66
|
+
|
|
67
|
+
브랜드페이의 모듈 로딩에 필요한 추가 파라미터입니다.
|
|
68
|
+
`moduleType`을 `toss-brandpay`로 설정하는 경우 필요합니다.
|
|
69
|
+
|
|
70
|
+
- loadBrandpayOptions.customer\_id: string
|
|
71
|
+
|
|
72
|
+
**구매자 ID**
|
|
73
|
+
|
|
74
|
+
고객 ID입니다. 다른사용자에게 노출될 경우, 악의적 사용에 대한 문제가 있음으로 자동 증가하는 숫자는 허용되지 않습니다.
|
|
75
|
+
UUID 등 유추가 불가능한 무작위 값을 사용하시길 권장드립니다.
|
|
76
|
+
|
|
77
|
+
- loadBrandpayOptions.ui?: object
|
|
78
|
+
|
|
79
|
+
브랜드페이의 경우 결제창의 UI를 커스터마이징이 가능하며, 아래의 옵션들을 제공하고 있습니다.
|
|
80
|
+
포트원을 통한 연동 후 `IMP.request_pay` 호출 시 `bypass.toss_brandpay.ui` 객체 정보를 추가하여 UI 커스터마이징 기능을 사용할 수 있습니다.
|
|
81
|
+
|
|
82
|
+
- loadBrandpayOptions.ui.buttonStyle?: string
|
|
83
|
+
|
|
84
|
+
**버튼스타일 구분코드**
|
|
85
|
+
|
|
86
|
+
버튼 스타일입니다. 값을 넣지 않으면 기본값인 `default`로 설정됩니다.
|
|
87
|
+
`default`로 설정하면 모서리가 둥글고 주변에 여백을 가진 버튼을 사용할 수 있고, `full`로 설정하면 하단 영역이 전부 채워지는 형태의 버튼을 사용할 수 있습니다.
|
|
88
|
+
|
|
89
|
+
- loadBrandpayOptions.ui.highlightColor?: string
|
|
90
|
+
|
|
91
|
+
**UI 메인 색상**
|
|
92
|
+
|
|
93
|
+
UI의 메인 색상입니다. 값을 넣지 않으면 기본 색상인 `#3182f6`로 설정됩니다. [웹에서 사용할 수 있는 색상 코드 형식](http://developer.mozilla.org/ko/docs/Web/CSS/color_value)을 모두 사용할 수 있습니다.
|
|
94
|
+
|
|
95
|
+
- loadBrandpayOptions.ui.navigationBar.visible?: boolean
|
|
96
|
+
|
|
97
|
+
**내비게이션 바 사용 여부**
|
|
98
|
+
|
|
99
|
+
화면 뒤로 가기 기능을 제공하는 내비게이션 바 사용 여부입니다. 값을 넣지 않으면 기본값인 `true`로 설정됩니다. 내비게이션 바를 사용하지 않으려면 `false`로 설정해야 합니다.
|
|
100
|
+
|
|
101
|
+
- loadBrandpayOptions.ui.navigationBar.paddingTop?: number
|
|
102
|
+
|
|
103
|
+
**내비게이션 바 상단 여백**
|
|
104
|
+
|
|
105
|
+
내비게이션 바 위쪽에 설정할 여백 값입니다. 값의 단위는 `px`입니다.
|
|
106
|
+
|
|
107
|
+
- loadBrandpayOptions.ui.labels.oneTouchPay?: string
|
|
108
|
+
|
|
109
|
+
**원터치결제 대체 텍스트**
|
|
110
|
+
|
|
111
|
+
UI에 표시되는 `원터치결제`를 대신해 사용할 텍스트입니다. 값을 넣지 않으면 `원터치결제`로 표시됩니다.
|
|
112
|
+
|
|
113
|
+
</details>
|
|
114
|
+
|
|
115
|
+
</div>
|
|
116
|
+
|
|
117
|
+
</div>
|
|
118
|
+
|
|
119
|
+
## 모듈로드 결과값 정의
|
|
120
|
+
|
|
121
|
+
<div class="tabs-container">
|
|
122
|
+
|
|
123
|
+
<div class="tabs-content" data-title="모듈 로드 요청">
|
|
124
|
+
|
|
125
|
+
```ts title="Javascript SDK"
|
|
126
|
+
const brandpayModule = await IMP.loadModule(
|
|
127
|
+
"toss-brandpay",
|
|
128
|
+
{
|
|
129
|
+
userCode: "imp00000000", //// 관리자 콘솔 - 결제 연동 페이지에서 확인 가능합니다.
|
|
130
|
+
},
|
|
131
|
+
{
|
|
132
|
+
customerKey: "d005f081-830a-4b9c-b5e2-73e56fbe6ac3",
|
|
133
|
+
loadBrandpayOptions: {
|
|
134
|
+
ui: {
|
|
135
|
+
buttonStyle: "default",
|
|
136
|
+
highlightColor: "#3182f6",
|
|
137
|
+
navigationBar: {
|
|
138
|
+
visible: true,
|
|
139
|
+
paddingTop: 10,
|
|
140
|
+
},
|
|
141
|
+
labels: {
|
|
142
|
+
oneTouchPay: "원터치결제",
|
|
143
|
+
},
|
|
144
|
+
},
|
|
145
|
+
},
|
|
146
|
+
},
|
|
147
|
+
);
|
|
148
|
+
|
|
149
|
+
brandpayModule.setupPassword();
|
|
150
|
+
brandpayModule.getPaymentMethods();
|
|
151
|
+
brandpayModule.openSettings();
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
<details>
|
|
155
|
+
|
|
156
|
+
<summary>
|
|
157
|
+
|
|
158
|
+
<strong>setupPassword 설명</strong>
|
|
159
|
+
|
|
160
|
+
</summary>
|
|
161
|
+
|
|
162
|
+
결제할 때 사용할 비밀번호를 설정할 수 있는 메서드입니다. 비밀번호 등록・변경이 완료되면 Promise가 resolve됩니다.
|
|
163
|
+
|
|
164
|
+
자세한 내용은 [토스페이먼츠의 개발자센터 문서](http://docs.tosspayments.com/reference/brandpay-sdk#setuppassword) 를 참고하세요.
|
|
165
|
+
|
|
166
|
+
```ts title="Javascript SDK"
|
|
167
|
+
brandpayModule.setupPassword().catch(function (error) {
|
|
168
|
+
if (error.code === "USER_CANCEL") {
|
|
169
|
+
// 사용자가 창을 닫아 취소한 경우에 대한 처리
|
|
170
|
+
}
|
|
171
|
+
});
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
</details>
|
|
175
|
+
|
|
176
|
+
<details>
|
|
177
|
+
|
|
178
|
+
<summary>
|
|
179
|
+
|
|
180
|
+
<strong>getPaymentMethods 설명</strong>
|
|
181
|
+
|
|
182
|
+
</summary>
|
|
183
|
+
|
|
184
|
+
등록되어 있는 결제 수단을 조회하는 메서드입니다. 조회가 성공했을 때 Promise가 resolve되고 고객의 결제수단 정보(BrandpayMethodResponse)가 반환됩니다.
|
|
185
|
+
|
|
186
|
+
자세한 내용은 [토스페이먼츠의 개발자센터 문서](http://docs.tosspayments.com/reference/brandpay-sdk#getpaymentmethods) 를 참고하세요.
|
|
187
|
+
|
|
188
|
+
```ts title="Javascript SDK"
|
|
189
|
+
brandpayModule
|
|
190
|
+
.getPaymentMethods()
|
|
191
|
+
.then(function (methods) {
|
|
192
|
+
// 성공 처리
|
|
193
|
+
})
|
|
194
|
+
.catch(function (error) {
|
|
195
|
+
if (error.code === "USER_CANCEL") {
|
|
196
|
+
// 사용자가 결제창을 닫은 경우 에러 처리
|
|
197
|
+
}
|
|
198
|
+
});
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
</details>
|
|
202
|
+
|
|
203
|
+
<details>
|
|
204
|
+
|
|
205
|
+
<summary>
|
|
206
|
+
|
|
207
|
+
<strong>openSettings 설명</strong>
|
|
208
|
+
|
|
209
|
+
</summary>
|
|
210
|
+
|
|
211
|
+
브랜드페이에서 사용하는 결제수단, 비밀번호 설정을 관리하는 결제 관리창을 열 수 있습니다.
|
|
212
|
+
|
|
213
|
+
자세한 내용은 [토스페이먼츠의 개발자센터 문서](http://docs.tosspayments.com/reference/brandpay-sdk#opensettings) 를 참고하세요.
|
|
214
|
+
|
|
215
|
+
```ts title="Javascript SDK"
|
|
216
|
+
brandpayModule.openSettings().catch(function (error) {
|
|
217
|
+
if (error.code === "USER_CANCEL") {
|
|
218
|
+
// 사용자가 창을 닫아 취소한 경우에 대한 처리
|
|
219
|
+
}
|
|
220
|
+
});
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
</details>
|
|
224
|
+
|
|
225
|
+
</div>
|
|
226
|
+
|
|
227
|
+
</div>
|
|
@@ -0,0 +1,404 @@
|
|
|
1
|
+
---
|
|
2
|
+
emoji: ⌨
|
|
3
|
+
title: 토스페이먼츠 브랜드페이
|
|
4
|
+
description: 토스페이먼츠 브랜드페이 연동 방법을 안내합니다.
|
|
5
|
+
targetVersions:
|
|
6
|
+
- v1
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 1. 토스페이먼츠 브랜드페이 채널 설정하기
|
|
10
|
+
|
|
11
|
+
[결제대행사 채널 설정하기](https://developers.portone.io/opi/ko/integration/ready/readme#3-결제대행사-채널-설정하기) 페이지의 내용을 참고하여 채널 설정을 진행합니다.
|
|
12
|
+
|
|
13
|
+
(관련 이미지 첨부)
|
|
14
|
+
|
|
15
|
+
## 2. 최신 JavaScript SDK로 업데이트하기
|
|
16
|
+
|
|
17
|
+
토스페이먼츠 브랜드페이 결제는 최신 SDK에서만 지원되는 기능입니다.
|
|
18
|
+
|
|
19
|
+
```html title="JS SDK"
|
|
20
|
+
<script src="https://cdn.iamport.kr/v1/iamport.js"></script>
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
<div class="hint" data-style="info">
|
|
24
|
+
|
|
25
|
+
**토스페이먼츠 브랜드페이를 연동하기 위해서는 위에 안내된 JS SDK를 이용하셔야 합니다**
|
|
26
|
+
|
|
27
|
+
</div>
|
|
28
|
+
|
|
29
|
+
<div class="hint" data-style="danger">
|
|
30
|
+
|
|
31
|
+
## **기존에 deprecated된 콜백 응답은 모두 제거**됐습니다.
|
|
32
|
+
|
|
33
|
+
신규 JS SDK는 기존 모듈에서 제공했던 CallBack 응답 파라미터가 대부분 삭제되었습니다.
|
|
34
|
+
(특히 deprecated 로 명시된 파라미터는 모두 삭제되었습니다.)
|
|
35
|
+
|
|
36
|
+
해당 JS SDK 사용시 Callback 으로 내려받을수 있는 데이터는 오직 아래 두가지 입니다.
|
|
37
|
+
|
|
38
|
+
**`imp_uid`, `merchant_uid`**
|
|
39
|
+
|
|
40
|
+
따라서 해당 SDK를 사용하실때는 `IMP.request_pay`로부터 응답된 객체(또는 쿼리 파라미터)에서
|
|
41
|
+
`imp_uid`를 가지고 **아임포트 REST API(GET `/payments/imp_uid`)로 결제 상세 내역(승인 상태, 승인 결과 등등)을 조회**하여
|
|
42
|
+
응답 파라미터 중 `status` 파라미터로 결제 상태를 파악하셔야 합니다.
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
[JavaScript SDK](https://developers.portone.io/sdk/ko/v1-sdk/javascript-sdk/readme) 문서를 통해 최신 SDK를 설치해주세요.
|
|
47
|
+
|
|
48
|
+
## 3. 결제 요청하기
|
|
49
|
+
|
|
50
|
+
- [JavaScript SDK](https://developers.portone.io/sdk/ko/v1-sdk/javascript-sdk/readme) `IMP.request_pay(param, callback)`을 호출하여
|
|
51
|
+
브랜드페이 결제창을 호출할 수 있습니다.
|
|
52
|
+
|
|
53
|
+
- **결제 결과**는 PC 환경과 모바일 환경 모두 **callback**으로
|
|
54
|
+
수신됩니다.
|
|
55
|
+
|
|
56
|
+
<div class="tabs-container">
|
|
57
|
+
|
|
58
|
+
<div class="tabs-content" data-title="인증결제창 요청">
|
|
59
|
+
|
|
60
|
+
```ts title="Javascript SDK"
|
|
61
|
+
IMP.request_pay(
|
|
62
|
+
{
|
|
63
|
+
channelKey: "{콘솔 내 연동 정보의 채널키}",
|
|
64
|
+
pay_method: "toss_brandpay",
|
|
65
|
+
merchant_uid: "orderNo0001",
|
|
66
|
+
name: "주문명:결제테스트",
|
|
67
|
+
amount: 1004,
|
|
68
|
+
buyer_email: "test@portone.io",
|
|
69
|
+
customer_id: "d005f081-830a-4b9c-b5e2-73e56fbe6ac3",
|
|
70
|
+
bypass: {
|
|
71
|
+
isCulturalExpense: true,
|
|
72
|
+
},
|
|
73
|
+
},
|
|
74
|
+
function (rsp) {
|
|
75
|
+
// callback 로직
|
|
76
|
+
},
|
|
77
|
+
);
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
<details>
|
|
81
|
+
|
|
82
|
+
<summary>
|
|
83
|
+
|
|
84
|
+
<strong>주요 파라미터 설명</strong>
|
|
85
|
+
|
|
86
|
+
</summary>
|
|
87
|
+
|
|
88
|
+
- channelKey: string
|
|
89
|
+
|
|
90
|
+
**채널키**
|
|
91
|
+
|
|
92
|
+
결제를 진행할 채널을 지정합니다.
|
|
93
|
+
|
|
94
|
+
포트원 콘솔 내 \[결제 연동] - \[연동 정보] - \[채널 관리] 에서 확인 가능합니다.
|
|
95
|
+
|
|
96
|
+
(최신 JavaScript SDK 버전부터 사용 가능합니다.)
|
|
97
|
+
|
|
98
|
+
- pg(deprecated)?: string
|
|
99
|
+
|
|
100
|
+
**PG사 구분코드**
|
|
101
|
+
|
|
102
|
+
`toss_brandpay` 로 지정하면 됩니다.
|
|
103
|
+
|
|
104
|
+
<div class="hint" data-style="warning">
|
|
105
|
+
|
|
106
|
+
`pg` 파라미터는 지원 중단 예정입니다.
|
|
107
|
+
|
|
108
|
+
JS SDK를 가장 최신 버전으로 업그레이드 후 `channelKey` 파라미터로 채널 설정(PG사 구분)을 대체해주세요.
|
|
109
|
+
|
|
110
|
+
</div>
|
|
111
|
+
|
|
112
|
+
- pay\_method: string
|
|
113
|
+
|
|
114
|
+
**결제수단 구분코드**
|
|
115
|
+
|
|
116
|
+
`toss_brandpay` 로 지정하면 됩니다.
|
|
117
|
+
|
|
118
|
+
- merchant\_uid: string
|
|
119
|
+
|
|
120
|
+
**주문번호**
|
|
121
|
+
|
|
122
|
+
매번 고유하게 채번되어야 합니다.
|
|
123
|
+
|
|
124
|
+
- name: string
|
|
125
|
+
|
|
126
|
+
**주문명**
|
|
127
|
+
|
|
128
|
+
- amount: number
|
|
129
|
+
|
|
130
|
+
**결제금액**
|
|
131
|
+
|
|
132
|
+
브랜드페이는 원화 결제만 지원합니다. KRW 기준으로 금액을 입력해주세요.
|
|
133
|
+
|
|
134
|
+
- buyer\_email?: string
|
|
135
|
+
|
|
136
|
+
**구매자 email 주소**
|
|
137
|
+
|
|
138
|
+
- customer\_id: string
|
|
139
|
+
|
|
140
|
+
**구매자 ID**
|
|
141
|
+
|
|
142
|
+
고객 ID입니다. 다른사용자에게 노출될 경우, 악의적 사용에 대한 문제가 있음으로 자동 증가하는 숫자는 허용되지 않습니다.\
|
|
143
|
+
UUID 등 유추가 불가능한 무작위 값을 사용하시길 권장드립니다.
|
|
144
|
+
|
|
145
|
+
- bypass?: object
|
|
146
|
+
|
|
147
|
+
- isCulturalExpense: string
|
|
148
|
+
|
|
149
|
+
**도서 문화비 결제 여부**
|
|
150
|
+
|
|
151
|
+
도서 문화비 소득 공제 결제 여부를 나타내는 파라미터입니다. 기본값은 `false`입니다.
|
|
152
|
+
|
|
153
|
+
</details>
|
|
154
|
+
|
|
155
|
+
</div>
|
|
156
|
+
|
|
157
|
+
</div>
|
|
158
|
+
|
|
159
|
+
## 3. UI 커스터마이징
|
|
160
|
+
|
|
161
|
+
- 브랜드페이의 경우 결제창의 UI를 커스터마이징이 가능하며, 아래의 옵션들을 제공하고 있습니다.
|
|
162
|
+
|
|
163
|
+
- 포트원을 통한 연동 후 `IMP.request_pay` 호출 시 `bypass.toss_brandpay.ui` 객체 정보를 추가하여 UI
|
|
164
|
+
커스터마이징 기능을 사용할 수 있습니다.
|
|
165
|
+
|
|
166
|
+
<div class="tabs-container">
|
|
167
|
+
|
|
168
|
+
<div class="tabs-content" data-title="UI 커스터마이징">
|
|
169
|
+
|
|
170
|
+
```ts title="Javascript SDK"
|
|
171
|
+
IMP.request_pay(
|
|
172
|
+
{
|
|
173
|
+
channelKey: "{콘솔 내 연동 정보의 채널키}",
|
|
174
|
+
pay_method: "toss_brandpay",
|
|
175
|
+
merchant_uid: "orderNo0001",
|
|
176
|
+
name: "주문명:결제테스트",
|
|
177
|
+
amount: 1004,
|
|
178
|
+
buyer_email: "test@portone.io",
|
|
179
|
+
bypass: {
|
|
180
|
+
toss_brandpay: {
|
|
181
|
+
brandpayOptions: {
|
|
182
|
+
ui: {
|
|
183
|
+
buttonStyle: "default",
|
|
184
|
+
highlightColor: "#3182f6",
|
|
185
|
+
navigationBar: {
|
|
186
|
+
visible: true,
|
|
187
|
+
paddingTop: 10,
|
|
188
|
+
},
|
|
189
|
+
labels: {
|
|
190
|
+
oneTouchPay: "원터치결제",
|
|
191
|
+
},
|
|
192
|
+
},
|
|
193
|
+
},
|
|
194
|
+
},
|
|
195
|
+
},
|
|
196
|
+
},
|
|
197
|
+
function (rsp) {
|
|
198
|
+
// callback 로직
|
|
199
|
+
},
|
|
200
|
+
);
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
- bypass?: object
|
|
204
|
+
|
|
205
|
+
- toss\_brandpay?: object
|
|
206
|
+
|
|
207
|
+
- brandpayOptions?: object
|
|
208
|
+
|
|
209
|
+
- buttonStyle?: string
|
|
210
|
+
|
|
211
|
+
**버튼스타일 구분코드**
|
|
212
|
+
|
|
213
|
+
- 버튼 스타일입니다. 값을 넣지 않으면 기본값인 `default`로 설정됩니다.
|
|
214
|
+
- `default`로 설정하면 모서리가 둥글고 주변에 여백을 가진 버튼을 사용할 수 있고, `full`로 설정하면 하단 영역이 전부 채워지는 형태의 버튼을 사용할 수 있습니다.
|
|
215
|
+
|
|
216
|
+
- highlightColor?: string
|
|
217
|
+
|
|
218
|
+
**UI 메인 색상**
|
|
219
|
+
|
|
220
|
+
- UI의 메인 색상입니다.
|
|
221
|
+
- 값을 넣지 않으면 기본 색상인 `#3182f6`로 설정됩니다.
|
|
222
|
+
- [웹에서 사용할 수 있는 색상 코드 형식](http://developer.mozilla.org/ko/docs/Web/CSS/color_value)을 모두 사용할 수 있습니다.
|
|
223
|
+
|
|
224
|
+
- navigationBar.visible?: boolean
|
|
225
|
+
|
|
226
|
+
**내비게이션 바 사용 여부**
|
|
227
|
+
|
|
228
|
+
- 화면 뒤로 가기 기능을 제공하는 내비게이션 바 사용 여부입니다.
|
|
229
|
+
- 값을 넣지 않으면 기본값인 `true`로 설정됩니다.
|
|
230
|
+
- 내비게이션 바를 사용하지 않으려면 `false`로 설정해야 합니다.
|
|
231
|
+
|
|
232
|
+
- navigationBar.paddingTop?: number
|
|
233
|
+
|
|
234
|
+
**내비게이션 바 상단 여백**
|
|
235
|
+
|
|
236
|
+
- 내비게이션 바 위쪽에 설정할 여백 값입니다. 값의 단위는 `px`입니다.
|
|
237
|
+
|
|
238
|
+
- labels.oneTouchPay?: string
|
|
239
|
+
|
|
240
|
+
**원터치결제 대체 텍스트**
|
|
241
|
+
|
|
242
|
+
- UI에 표시되는 `원터치결제`를 대신해 사용할 텍스트입니다. 값을 넣지 않으면 `원터치결제`로 표시됩니다.
|
|
243
|
+
|
|
244
|
+
</div>
|
|
245
|
+
|
|
246
|
+
</div>
|
|
247
|
+
|
|
248
|
+
## 4. 결제수단 지정 바로 결제
|
|
249
|
+
|
|
250
|
+
- 브랜드페이에 등록된 각 결제수단은 `methodId`라는 결제 수단 ID가 맵핑됩니다.
|
|
251
|
+
|
|
252
|
+
- 결제창 호출 시 `methodId` 중 하나를 지정하는 경우 UI에서 결제수단을 선택하지 않고 해당
|
|
253
|
+
결제수단으로 바로 결제를 할 수 있습니다.
|
|
254
|
+
|
|
255
|
+
- `methodId`는 [`IMP.loadModule()`](https://developers.portone.io/opi/ko/integration/pg/v1/toss-brandpay/module)을 호출 후 사용할 수
|
|
256
|
+
있는, `getPaymentMethods()` 함수를 통해 확인할 수 있습니다.
|
|
257
|
+
|
|
258
|
+
<div class="tabs-container">
|
|
259
|
+
|
|
260
|
+
<div class="tabs-content" data-title="바로 결제">
|
|
261
|
+
|
|
262
|
+
```ts title="Javascript SDK"
|
|
263
|
+
IMP.request_pay(
|
|
264
|
+
{
|
|
265
|
+
channelKey: "{콘솔 내 연동 정보의 채널키}",
|
|
266
|
+
pay_method: "toss_brandpay",
|
|
267
|
+
merchant_uid: "orderNo0001",
|
|
268
|
+
name: "주문명:결제테스트",
|
|
269
|
+
amount: 1004,
|
|
270
|
+
buyer_email: "test@portone.io",
|
|
271
|
+
customer_id: "d005f081-830a-4b9c-b5e2-73e56fbe6ac3",
|
|
272
|
+
useCardPoint: true,
|
|
273
|
+
display: {
|
|
274
|
+
card_quota: [6],
|
|
275
|
+
},
|
|
276
|
+
bypass: {
|
|
277
|
+
cashReceiptType: "personal",
|
|
278
|
+
customerIdentifier: "01000000000",
|
|
279
|
+
toss_brandpay: {
|
|
280
|
+
methodId: "3nKLoSBV7l8zUHU14cZxK",
|
|
281
|
+
discountCode: "001",
|
|
282
|
+
},
|
|
283
|
+
},
|
|
284
|
+
},
|
|
285
|
+
function (rsp) {
|
|
286
|
+
// callback 로직
|
|
287
|
+
},
|
|
288
|
+
);
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
### 기타 파라미터
|
|
292
|
+
|
|
293
|
+
아래 파라미터를 사용하기 위해서는 결제 수단 ID인 `methodId`를 지정하여 함께 결제 요청해야 합니다.
|
|
294
|
+
|
|
295
|
+
<div class="hint" data-style="danger">
|
|
296
|
+
|
|
297
|
+
#### **브랜드페이 위젯에서 사용할 수 없는 파라미터** 가 포함되어 있습니다.
|
|
298
|
+
|
|
299
|
+
아래 파라미터는 브랜드페이 위젯에서는 사용할 수 없습니다.
|
|
300
|
+
|
|
301
|
+
- **`display.card_quot`**
|
|
302
|
+
- **`useCardPoint`**
|
|
303
|
+
- **`bypass.cashReceiptType`**
|
|
304
|
+
- **`bypass.customerIdentifier`**
|
|
305
|
+
|
|
306
|
+
</div>
|
|
307
|
+
|
|
308
|
+
- useCardPoint?: boolean
|
|
309
|
+
|
|
310
|
+
**카드사 포인트 사용 여부**
|
|
311
|
+
|
|
312
|
+
- 카드사 포인트를 사용 여부를 지정하는 값입니다.
|
|
313
|
+
- `true` 입력 시 카드사 포인트 사용이 가능하며, 입력하지 않는 경우 기본값은 `false`입니다.
|
|
314
|
+
- (단, 카드사 포인트를 사용하기 위해서는 사전에 토스페이먼츠를 통해 계약이 진행되어야 합니다.)
|
|
315
|
+
|
|
316
|
+
- display?: object
|
|
317
|
+
|
|
318
|
+
**결제창에 렌더링될 카드 할부 개월수 리스트 설정값**
|
|
319
|
+
|
|
320
|
+
할부결제는 **5만원 이상 결제 요청시**에만 이용 가능합니다.
|
|
321
|
+
|
|
322
|
+
- card\_quota: number\[]
|
|
323
|
+
|
|
324
|
+
**할부 개월수**
|
|
325
|
+
|
|
326
|
+
예시
|
|
327
|
+
|
|
328
|
+
- `[]`: 일시불만 결제 가능
|
|
329
|
+
- `2,3,4,5,6`: 일시불을 포함한 2, 3, 4, 5, 6개월까지 할부개월 선택 가능
|
|
330
|
+
- `3`: 일시불을 포함한 2,3개월까지 할부개월 선택 가능
|
|
331
|
+
|
|
332
|
+
- bypass?: object
|
|
333
|
+
|
|
334
|
+
- cashReceiptType?: string
|
|
335
|
+
|
|
336
|
+
**현금영수증 발급 타입**
|
|
337
|
+
|
|
338
|
+
- `unable`로 설정시 현금영수증을 발행하지 않으며, `personal`로 설정 시에는 소득 공제용, `corporate`으로 설정 시에는 지출 증빙용으로 현금영수증을 발급합니다.
|
|
339
|
+
- `anonymous`으로 설정하는 경우 현금영수증 자진발급됩니다. 기본값은 `unable`입니다.
|
|
340
|
+
|
|
341
|
+
- customerIdentifier?: string
|
|
342
|
+
|
|
343
|
+
**현금영수증 발급 식별번호**
|
|
344
|
+
|
|
345
|
+
- 현금영수증 발급을 위한 식별번호입니다.
|
|
346
|
+
- 현금영수증 종류에 따라 휴대폰번호, 사업자등록번호, 현금영수증 카드번호를 입력할 수 있습니다.
|
|
347
|
+
|
|
348
|
+
- toss\_brandpay?: object
|
|
349
|
+
|
|
350
|
+
- discountCode?: string
|
|
351
|
+
|
|
352
|
+
**카드사 즉시 할인 코드**
|
|
353
|
+
|
|
354
|
+
- 토스페이먼츠의 [카드혜택 조회 API](http://docs.tosspayments.com/reference#%EC%B9%B4%EB%93%9C-%ED%98%9C%ED%83%9D-%EC%A1%B0%ED%9A%8C-1)로 적용할 수 있는 할인 코드 목록을 조회할 수 있습니다.
|
|
355
|
+
- 해당 API는 포트원을 통해 지원이 불가능하므로, 직접 토스페이먼츠 API를 연동하여 사용해야 합니다.
|
|
356
|
+
|
|
357
|
+
### 브랜드페이 위젯 전용 파라미터
|
|
358
|
+
|
|
359
|
+
아래 파라미터를 사용하기 위해서는 결제 수단 ID인 `methodId`를 지정하여 함께 결제 요청해야 합니다.
|
|
360
|
+
|
|
361
|
+
<div class="hint" data-style="info">
|
|
362
|
+
|
|
363
|
+
#### 브랜드페이 위젯에서만 사용 가능한 파라미터입니다.
|
|
364
|
+
|
|
365
|
+
`bypass.toss_brandpay.widgetOptions` 에 설정되어야 합니다.
|
|
366
|
+
|
|
367
|
+
</div>
|
|
368
|
+
|
|
369
|
+
- methodType?: string
|
|
370
|
+
|
|
371
|
+
**위젯에 보여줄 결제 수단**
|
|
372
|
+
|
|
373
|
+
- 위젯에 보여줄 결제수단을 선택합니다.
|
|
374
|
+
- `카드`, `계좌` 중 하나입니다. 예를 들어 `카드`를 선택하면 등록한 결제수단 중 `카드`만 노출됩니다.
|
|
375
|
+
|
|
376
|
+
- methodId?: string
|
|
377
|
+
|
|
378
|
+
**위젯에서 기본 결제수단으로 선택할 결제수단의 ID**
|
|
379
|
+
|
|
380
|
+
- 위젯을 열었을때, 해당 methodId에 해당하는 결제수단이 가장 먼저 보여집니다.
|
|
381
|
+
- 가장 최근에 결제한 카드를 보여주거나, 유저가 선호하는 카드를 보여줄 때 사용할 수 있습니다.
|
|
382
|
+
|
|
383
|
+
- ui.promotionSection.summary.visible?: boolean
|
|
384
|
+
|
|
385
|
+
**혜택 배지 영역 표시여부**
|
|
386
|
+
|
|
387
|
+
- 해택 배지 영역에서는 즉시 할인 대상 카드 정보 등을 간략히 보여줍니다. 기본값은 `true`입니다.
|
|
388
|
+
|
|
389
|
+
- ui.promotionSection.description.visible?: boolean
|
|
390
|
+
|
|
391
|
+
**혜택 배지 영역 표시여부**
|
|
392
|
+
|
|
393
|
+
- 결제 해택 영역을 보여주거나 숨깁니다. 기본값은 `true`입니다.
|
|
394
|
+
|
|
395
|
+
- ui.promotionSection.description.defaultOpen?: boolean
|
|
396
|
+
|
|
397
|
+
**결제 혜택 상세 설명 표시 여부**
|
|
398
|
+
|
|
399
|
+
- 결제 혜택의 상세 설명을 보여주거나 숨깁니다.
|
|
400
|
+
- `true`인 경우, 결제 카드사의 결제 혜택을 자세히 설명합니다. 기본값은 `false`입니다.
|
|
401
|
+
|
|
402
|
+
</div>
|
|
403
|
+
|
|
404
|
+
</div>
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 연동 유의사항
|
|
3
|
+
description: 토스페이먼츠 브랜드페이 연동 유의사항을 소개합니다.
|
|
4
|
+
targetVersions:
|
|
5
|
+
- v1
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## 카드 결제
|
|
9
|
+
|
|
10
|
+
### 고정 할부 개월 수 결제
|
|
11
|
+
|
|
12
|
+
- 포트원을 통해 다른 결제대행사(PG)를 이용하는 경우 `display.card_quota` 파라미터에 할부 개월 수를
|
|
13
|
+
입력하여 결제 요청을 하면, 구매자에게 노출할 할부 개월 수 정보를 리스트로 제어가 가능합니다.
|
|
14
|
+
|
|
15
|
+
- 하지만 포트원을 통해 브랜드페이를 이용하는 경우 해당 파라미터 값을 입력 후 결제 요청 시 입력한
|
|
16
|
+
할부 개월 수로 결제가 진행됩니다.
|
|
17
|
+
|
|
18
|
+
<details>
|
|
19
|
+
|
|
20
|
+
<summary>파라미터 사용 예시</summary>
|
|
21
|
+
|
|
22
|
+
- 예1. 6개월 할부로 결제를 하고자 하는 경우
|
|
23
|
+
|
|
24
|
+
```json
|
|
25
|
+
{
|
|
26
|
+
"display": {
|
|
27
|
+
"card_quota": [6]
|
|
28
|
+
},
|
|
29
|
+
"bypass": {
|
|
30
|
+
"toss_brandpay": {
|
|
31
|
+
"methodId": "c_j429K3djbS01dlk" // 브랜드페이에 등록된 결제 수단의 ID
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
</details>
|
|
38
|
+
|
|
39
|
+
## 현금영수증 유의사항
|
|
40
|
+
|
|
41
|
+
### 소득공제용 자진발급
|
|
42
|
+
|
|
43
|
+
- 결제창 내에서 현금영수증 미발행을 선택한 후 결제 승인이 되면 현금영수증이 소득공제용 자진발급으로
|
|
44
|
+
발급됩니다.
|
|
45
|
+
|
|
46
|
+
- 브랜드페이 결제 요청 시 `methodId` 와 함께 `bypass.cashReceiptType`을 `anonymous`로 입력한 후 결제
|
|
47
|
+
요청 및 승인이 완료되면 현금영수증이 소득공제용 자진발급으로 발급됩니다.
|
|
48
|
+
|
|
49
|
+
<details>
|
|
50
|
+
|
|
51
|
+
<summary>파라미터 사용 예시</summary>
|
|
52
|
+
|
|
53
|
+
```json
|
|
54
|
+
{
|
|
55
|
+
"bypass": {
|
|
56
|
+
"cashReceiptType": "anonymous",
|
|
57
|
+
"toss_brandpay": {
|
|
58
|
+
"methodId": "c_j429K3djbS01dlk" // 브랜드페이에 등록된 결제 수단의 ID
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
</details>
|
|
65
|
+
|
|
66
|
+
## 취소관련 유의사항
|
|
67
|
+
|
|
68
|
+
### 잔여 면세금액 계산
|
|
69
|
+
|
|
70
|
+
- 부분 취소 및 전체 취소시, 남은 면세 금액을 정확하게 계산하여 요청해야합니다.
|
|
71
|
+
|
|
72
|
+
## 테스트 관련 유의사항
|
|
73
|
+
|
|
74
|
+
### 더미 데이터 리턴
|
|
75
|
+
|
|
76
|
+
- 브랜드페이의 경우 토스페이먼츠의 정책상 테스트 환경의 API 키를 이용하여 결제 요청 및 승인을 하면 더미 데이터 값이 리턴됩니다.
|
|
77
|
+
- 연동 후 정상적인 데이터를 확인하기 위해서는 브랜드페이의 라이브 API 키를 이용해서 결제 요청 및 승인을 진행해야 합니다.
|
|
78
|
+
|
|
79
|
+
### 토스페이먼츠 제공 API 사용
|
|
80
|
+
|
|
81
|
+
- 결제 취소를 제외한 현금영수증 발급 API 및 결제조회 API는 토스페이먼츠에서 제공하는 API를 이용해야 합니다.
|