@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.
Files changed (576) hide show
  1. package/LICENSE-APACHE +201 -0
  2. package/LICENSE-MIT +21 -0
  3. package/README.md +165 -0
  4. package/assets/docs/README.md +27 -0
  5. package/assets/docs/api/backward-compatibility.md +40 -0
  6. package/assets/docs/blog/posts/2024-02/v2-oom.md +341 -0
  7. package/assets/docs/blog/posts/2024-02/v2-webhook.md +314 -0
  8. package/assets/docs/blog/posts/2024-02/v2-zio.md +529 -0
  9. package/assets/docs/blog/posts/2024-03/tgs.md +238 -0
  10. package/assets/docs/blog/posts/2024-04/gcp-datastream.md +307 -0
  11. package/assets/docs/blog/posts/2024-04/solid.md +558 -0
  12. package/assets/docs/blog/posts/2024-07/v2-event-sourcing-basic.md +231 -0
  13. package/assets/docs/help/admin-console/analytics/content32.md +270 -0
  14. package/assets/docs/help/admin-console/console-account/content31.md +94 -0
  15. package/assets/docs/help/admin-console/console_home/content34.md +82 -0
  16. package/assets/docs/help/admin-console/integration/content28.md +79 -0
  17. package/assets/docs/help/admin-console/payment-service/content29.md +260 -0
  18. package/assets/docs/help/admin-console/pg-settlement/content30.md +352 -0
  19. package/assets/docs/help/admin-console/platform-settlement/content33-1.md +201 -0
  20. package/assets/docs/help/api-sdk-2024-12-19.md +64 -0
  21. package/assets/docs/help/api-sdk-2025-01-15.md +84 -0
  22. package/assets/docs/help/applepay.md +46 -0
  23. package/assets/docs/help/content100000.md +46 -0
  24. package/assets/docs/help/content100002.md +52 -0
  25. package/assets/docs/help/content100004.md +29 -0
  26. package/assets/docs/help/content100014.md +50 -0
  27. package/assets/docs/help/content100015.md +20 -0
  28. package/assets/docs/help/content100016.md +28 -0
  29. package/assets/docs/help/content100020.md +28 -0
  30. package/assets/docs/help/content100022.md +40 -0
  31. package/assets/docs/help/content100023.md +21 -0
  32. package/assets/docs/help/content100024.md +25 -0
  33. package/assets/docs/help/content100025.md +40 -0
  34. package/assets/docs/help/content100026.md +20 -0
  35. package/assets/docs/help/content100027.md +24 -0
  36. package/assets/docs/help/content100029.md +29 -0
  37. package/assets/docs/help/content100030.md +82 -0
  38. package/assets/docs/help/content100033.md +44 -0
  39. package/assets/docs/help/content100035.md +34 -0
  40. package/assets/docs/help/content100036.md +14 -0
  41. package/assets/docs/help/content100037.md +16 -0
  42. package/assets/docs/help/content100038.md +32 -0
  43. package/assets/docs/help/content100039.md +28 -0
  44. package/assets/docs/help/content100040.md +31 -0
  45. package/assets/docs/help/content100041.md +37 -0
  46. package/assets/docs/help/content100044.md +15 -0
  47. package/assets/docs/help/content100045.md +21 -0
  48. package/assets/docs/help/content100046.md +34 -0
  49. package/assets/docs/help/content100047.md +32 -0
  50. package/assets/docs/help/content100048.md +25 -0
  51. package/assets/docs/help/content100049.md +20 -0
  52. package/assets/docs/help/content100052.md +147 -0
  53. package/assets/docs/help/content100053.md +40 -0
  54. package/assets/docs/help/content100054.md +18 -0
  55. package/assets/docs/help/content100055.md +37 -0
  56. package/assets/docs/help/content100056.md +15 -0
  57. package/assets/docs/help/content100057.md +28 -0
  58. package/assets/docs/help/content100058.md +36 -0
  59. package/assets/docs/help/content100059.md +23 -0
  60. package/assets/docs/help/content100060.md +43 -0
  61. package/assets/docs/help/content200001.md +21 -0
  62. package/assets/docs/help/content200002.md +38 -0
  63. package/assets/docs/help/content200005.md +30 -0
  64. package/assets/docs/help/content200012.md +91 -0
  65. package/assets/docs/help/content200013.md +52 -0
  66. package/assets/docs/help/content200015.md +41 -0
  67. package/assets/docs/help/content200016.md +30 -0
  68. package/assets/docs/help/content200017.md +39 -0
  69. package/assets/docs/help/content200018.md +105 -0
  70. package/assets/docs/help/content200019.md +59 -0
  71. package/assets/docs/help/content200020.md +42 -0
  72. package/assets/docs/help/content200023.md +54 -0
  73. package/assets/docs/help/content200024.md +49 -0
  74. package/assets/docs/help/content200025.md +68 -0
  75. package/assets/docs/help/content200027.md +34 -0
  76. package/assets/docs/help/content200028.md +70 -0
  77. package/assets/docs/help/content200029.md +71 -0
  78. package/assets/docs/help/content200030.md +67 -0
  79. package/assets/docs/help/content200032.md +39 -0
  80. package/assets/docs/help/content200033.md +21 -0
  81. package/assets/docs/help/content200034.md +34 -0
  82. package/assets/docs/help/content200037.md +38 -0
  83. package/assets/docs/help/content200038.md +50 -0
  84. package/assets/docs/help/content200039.md +45 -0
  85. package/assets/docs/help/content200040.md +15 -0
  86. package/assets/docs/help/content200043.md +23 -0
  87. package/assets/docs/help/content200044.md +33 -0
  88. package/assets/docs/help/content200045.md +25 -0
  89. package/assets/docs/help/content200046.md +104 -0
  90. package/assets/docs/help/content200048.md +34 -0
  91. package/assets/docs/help/content200049.md +54 -0
  92. package/assets/docs/help/content200050.md +43 -0
  93. package/assets/docs/help/content200051.md +81 -0
  94. package/assets/docs/help/content51.md +38 -0
  95. package/assets/docs/help/content61.md +165 -0
  96. package/assets/docs/help/core-service/channel-setting/danal.md +170 -0
  97. package/assets/docs/help/core-service/channel-setting/daou.md +118 -0
  98. package/assets/docs/help/core-service/channel-setting/eximbay.md +136 -0
  99. package/assets/docs/help/core-service/channel-setting/inicis.md +340 -0
  100. package/assets/docs/help/core-service/channel-setting/kakaopay.md +107 -0
  101. package/assets/docs/help/core-service/channel-setting/kcp_channel.md +235 -0
  102. package/assets/docs/help/core-service/channel-setting/kicc.md +114 -0
  103. package/assets/docs/help/core-service/channel-setting/kpn.md +93 -0
  104. package/assets/docs/help/core-service/channel-setting/ksnet.md +116 -0
  105. package/assets/docs/help/core-service/channel-setting/mobilians.md +107 -0
  106. package/assets/docs/help/core-service/channel-setting/naverpay.md +179 -0
  107. package/assets/docs/help/core-service/channel-setting/nice.md +210 -0
  108. package/assets/docs/help/core-service/channel-setting/payco.md +124 -0
  109. package/assets/docs/help/core-service/channel-setting/paymentwall.md +107 -0
  110. package/assets/docs/help/core-service/channel-setting/paypal.md +247 -0
  111. package/assets/docs/help/core-service/channel-setting/settle.md +123 -0
  112. package/assets/docs/help/core-service/channel-setting/smartro.md +164 -0
  113. package/assets/docs/help/core-service/channel-setting/smilepay.md +83 -0
  114. package/assets/docs/help/core-service/channel-setting/tosspay.md +168 -0
  115. package/assets/docs/help/core-service/channel-setting/tosspayments.md +232 -0
  116. package/assets/docs/help/core-service/channel-setting/welcome.md +110 -0
  117. package/assets/docs/help/core-service/how-to-use/additional-danal.md +71 -0
  118. package/assets/docs/help/core-service/how-to-use/additional-daou.md +65 -0
  119. package/assets/docs/help/core-service/how-to-use/additional-eximbay.md +54 -0
  120. package/assets/docs/help/core-service/how-to-use/additional-inicis.md +97 -0
  121. package/assets/docs/help/core-service/how-to-use/additional-kakaopay.md +56 -0
  122. package/assets/docs/help/core-service/how-to-use/additional-kcp.md +53 -0
  123. package/assets/docs/help/core-service/how-to-use/additional-kicc.md +67 -0
  124. package/assets/docs/help/core-service/how-to-use/additional-ksnet.md +68 -0
  125. package/assets/docs/help/core-service/how-to-use/additional-mobilians.md +71 -0
  126. package/assets/docs/help/core-service/how-to-use/additional-naverpay-order.md +69 -0
  127. package/assets/docs/help/core-service/how-to-use/additional-naverpay.md +72 -0
  128. package/assets/docs/help/core-service/how-to-use/additional-nice.md +112 -0
  129. package/assets/docs/help/core-service/how-to-use/additional-payco.md +68 -0
  130. package/assets/docs/help/core-service/how-to-use/additional-settle.md +70 -0
  131. package/assets/docs/help/core-service/how-to-use/additional-smartro.md +70 -0
  132. package/assets/docs/help/core-service/how-to-use/additional-tosspay.md +57 -0
  133. package/assets/docs/help/core-service/how-to-use/additional-tosspayments.md +47 -0
  134. package/assets/docs/help/core-service/how-to-use/additional-welcome.md +72 -0
  135. package/assets/docs/help/core-service/how-to-use/cancel-deadline-by-paymethod.md +68 -0
  136. package/assets/docs/help/core-service/how-to-use/cancel-guide-using-admin-console.md +49 -0
  137. package/assets/docs/help/core-service/how-to-use/cancel-reversal.md +114 -0
  138. package/assets/docs/help/core-service/how-to-use/cellphone-identity-verification.md +62 -0
  139. package/assets/docs/help/core-service/how-to-use/content200000.md +72 -0
  140. package/assets/docs/help/core-service/how-to-use/content200009.md +83 -0
  141. package/assets/docs/help/core-service/how-to-use/danal-contract.md +82 -0
  142. package/assets/docs/help/core-service/how-to-use/daou-contract.md +82 -0
  143. package/assets/docs/help/core-service/how-to-use/eximbay-contract.md +75 -0
  144. package/assets/docs/help/core-service/how-to-use/high-risk-industry.md +554 -0
  145. package/assets/docs/help/core-service/how-to-use/identity-verification-value.md +61 -0
  146. package/assets/docs/help/core-service/how-to-use/impossible-partial-cancel.md +53 -0
  147. package/assets/docs/help/core-service/how-to-use/information-pg.md +151 -0
  148. package/assets/docs/help/core-service/how-to-use/inicis-contract.md +95 -0
  149. package/assets/docs/help/core-service/how-to-use/inicis-vat.md +45 -0
  150. package/assets/docs/help/core-service/how-to-use/inicis-vbank-refund.md +45 -0
  151. package/assets/docs/help/core-service/how-to-use/kakao-contract.md +73 -0
  152. package/assets/docs/help/core-service/how-to-use/kakaopay-contract.md +41 -0
  153. package/assets/docs/help/core-service/how-to-use/kcp-contract.md +82 -0
  154. package/assets/docs/help/core-service/how-to-use/kcp-vat.md +39 -0
  155. package/assets/docs/help/core-service/how-to-use/kcp-vbank-refund.md +46 -0
  156. package/assets/docs/help/core-service/how-to-use/kicc-contract.md +81 -0
  157. package/assets/docs/help/core-service/how-to-use/ksnet-contract.md +78 -0
  158. package/assets/docs/help/core-service/how-to-use/mobilians-contract.md +81 -0
  159. package/assets/docs/help/core-service/how-to-use/naverpay-contract.md +86 -0
  160. package/assets/docs/help/core-service/how-to-use/naverpay-order-1.md +36 -0
  161. package/assets/docs/help/core-service/how-to-use/naverpay-order-contract.md +88 -0
  162. package/assets/docs/help/core-service/how-to-use/naverpay-order-diff.md +66 -0
  163. package/assets/docs/help/core-service/how-to-use/naverpay-order-review-items.md +66 -0
  164. package/assets/docs/help/core-service/how-to-use/naverpay-review-items.md +199 -0
  165. package/assets/docs/help/core-service/how-to-use/nice-contract.md +81 -0
  166. package/assets/docs/help/core-service/how-to-use/open-immediately.md +60 -0
  167. package/assets/docs/help/core-service/how-to-use/other-hosting-company.md +38 -0
  168. package/assets/docs/help/core-service/how-to-use/payco-contract.md +74 -0
  169. package/assets/docs/help/core-service/how-to-use/payment-settlement-method.md +30 -0
  170. package/assets/docs/help/core-service/how-to-use/paymentwall-contract.md +85 -0
  171. package/assets/docs/help/core-service/how-to-use/paypal-contract.md +66 -0
  172. package/assets/docs/help/core-service/how-to-use/point-service.md +293 -0
  173. package/assets/docs/help/core-service/how-to-use/refund-date.md +66 -0
  174. package/assets/docs/help/core-service/how-to-use/requirements.md +100 -0
  175. package/assets/docs/help/core-service/how-to-use/settle-contract.md +79 -0
  176. package/assets/docs/help/core-service/how-to-use/shopify-available-list.md +65 -0
  177. package/assets/docs/help/core-service/how-to-use/shopify-guide.md +62 -0
  178. package/assets/docs/help/core-service/how-to-use/small-business-commission-fee.md +55 -0
  179. package/assets/docs/help/core-service/how-to-use/smartro-contract.md +77 -0
  180. package/assets/docs/help/core-service/how-to-use/test-mode-cancel.md +63 -0
  181. package/assets/docs/help/core-service/how-to-use/tosspay-contract.md +82 -0
  182. package/assets/docs/help/core-service/how-to-use/tosspayments-contract.md +82 -0
  183. package/assets/docs/help/core-service/how-to-use/welcome-contract.md +81 -0
  184. package/assets/docs/help/core-service/how-to-use/withsoft-guide.md +69 -0
  185. package/assets/docs/help/core-service/how-to-use/wordpress-available-pg.md +49 -0
  186. package/assets/docs/help/core-service/how-to-use/wordpress-setting.md +50 -0
  187. package/assets/docs/help/core-service/payment-type/billing-key.md +72 -0
  188. package/assets/docs/help/core-service/payment-type/content200003.md +39 -0
  189. package/assets/docs/help/core-service/payment-type/content200007.md +176 -0
  190. package/assets/docs/help/core-service/payment-type/content200036.md +37 -0
  191. package/assets/docs/help/core-service/payment-type/content200042.md +150 -0
  192. package/assets/docs/help/core-service/payment-type/content200047.md +215 -0
  193. package/assets/docs/help/core-service/payment-type/content200052.md +142 -0
  194. package/assets/docs/help/core-service/payment-type/content200053.md +128 -0
  195. package/assets/docs/help/core-service/payment-type/crossborder.md +132 -0
  196. package/assets/docs/help/core-service/payment-type/eximbay-international.md +96 -0
  197. package/assets/docs/help/core-service/payment-type/hub-service-fee.md +79 -0
  198. package/assets/docs/help/core-service/payment-type/inicis-easypay-hub-fee.md +45 -0
  199. package/assets/docs/help/core-service/payment-type/inicis-international.md +65 -0
  200. package/assets/docs/help/core-service/payment-type/internationl-high-risk-industry.md +267 -0
  201. package/assets/docs/help/core-service/payment-type/internationl-pg.md +42 -0
  202. package/assets/docs/help/core-service/payment-type/kcp-easypay-hub-apply.md +49 -0
  203. package/assets/docs/help/core-service/payment-type/kcp-international.md +60 -0
  204. package/assets/docs/help/core-service/payment-type/nice-easypay-hub-fee.md +72 -0
  205. package/assets/docs/help/core-service/payment-type/nice-international.md +51 -0
  206. package/assets/docs/help/core-service/payment-type/paymentwall-international.md +84 -0
  207. package/assets/docs/help/core-service/payment-type/paypal-international.md +86 -0
  208. package/assets/docs/help/core-service/payment-type/paypal-payment-status.md +55 -0
  209. package/assets/docs/help/core-service/payment-type/schedule-logic-guide.md +49 -0
  210. package/assets/docs/help/core-service/payment-type/schedule-requirement.md +111 -0
  211. package/assets/docs/help/core-service/payment-type/schedule-validity-guide.md +68 -0
  212. package/assets/docs/help/core-service/payment-type/tosspayment-international.md +54 -0
  213. package/assets/docs/help/core-service/payment-type/tosspayments-easypay-hub-fee.md +42 -0
  214. package/assets/docs/help/core-service/payment-type/webhook-re-send.md +41 -0
  215. package/assets/docs/help/faq/console-faq/2-depth-auth.md +53 -0
  216. package/assets/docs/help/faq/console-faq/add-admin-account.md +42 -0
  217. package/assets/docs/help/faq/console-faq/change-console-url.md +51 -0
  218. package/assets/docs/help/faq/console-faq/impossible-login.md +30 -0
  219. package/assets/docs/help/faq/console-faq/payment-list.md +45 -0
  220. package/assets/docs/help/faq/console-faq/sub-store-mgnt.md +97 -0
  221. package/assets/docs/help/faq/general-inquiry/change-business-number.md +32 -0
  222. package/assets/docs/help/faq/general-inquiry/confirm-process.md +118 -0
  223. package/assets/docs/help/faq/general-inquiry/content200004.md +55 -0
  224. package/assets/docs/help/faq/general-inquiry/content200006.md +86 -0
  225. package/assets/docs/help/faq/general-inquiry/content200011.md +24 -0
  226. package/assets/docs/help/faq/general-inquiry/content200031.md +194 -0
  227. package/assets/docs/help/faq/general-inquiry/content200041.md +21 -0
  228. package/assets/docs/help/faq/general-inquiry/contract-checkpoint.md +49 -0
  229. package/assets/docs/help/faq/general-inquiry/main-user.md +56 -0
  230. package/assets/docs/help/faq/general-inquiry/platform-contract-method.md +67 -0
  231. package/assets/docs/help/faq/general-inquiry/platform-contract-pg.md +234 -0
  232. package/assets/docs/help/faq/general-inquiry/portone-advantages.md +71 -0
  233. package/assets/docs/help/faq/general-inquiry/real-channel-info.md +70 -0
  234. package/assets/docs/help/faq/general-inquiry/what-is-the-small-business-fee.md +41 -0
  235. package/assets/docs/help/faq/payment-faq/business-card-available.md +55 -0
  236. package/assets/docs/help/faq/payment-faq/business-info-change.md +96 -0
  237. package/assets/docs/help/faq/payment-faq/cancel-deadline.md +32 -0
  238. package/assets/docs/help/faq/payment-faq/cancel-guide.md +48 -0
  239. package/assets/docs/help/faq/payment-faq/cash-receipt-guide.md +64 -0
  240. package/assets/docs/help/faq/payment-faq/content200022.md +73 -0
  241. package/assets/docs/help/faq/payment-faq/pg-max-min-amount.md +158 -0
  242. package/assets/docs/help/faq/payment-faq/receipt-guide.md +38 -0
  243. package/assets/docs/help/faq/payment-faq/tosspayments-cash-receipt.md +32 -0
  244. package/assets/docs/help/faq/payment-faq/vbank-info.md +35 -0
  245. package/assets/docs/help/faq/payment-faq/vbank-service-detail.md +67 -0
  246. package/assets/docs/help/faq/payment-faq/vbank-test-guide.md +65 -0
  247. package/assets/docs/help/faq/platform-faq/platform_function_partnerbulkupload.md +190 -0
  248. package/assets/docs/help/faq/platform-faq/platform_infosec.md +56 -0
  249. package/assets/docs/help/faq/platform-faq/platform_nocode_guide.md +104 -0
  250. package/assets/docs/help/faq/platform-faq/platform_payout_guide.md +75 -0
  251. package/assets/docs/help/faq/platform-faq/platform_policymanagement_calculator.md +73 -0
  252. package/assets/docs/help/faq/platform-faq/platform_settlmentandpayout_guide.md +83 -0
  253. package/assets/docs/help/faq/platform-faq/platform_tax_setting_guide.md +108 -0
  254. package/assets/docs/help/faq/platform-faq/taxinvoice_guide.md +107 -0
  255. package/assets/docs/help/faq/platform-faq/taxinvoice_signupemail.md +67 -0
  256. package/assets/docs/help/holidays.md +29 -0
  257. package/assets/docs/help/notice-kakaopay-2025-06-30.md +47 -0
  258. package/assets/docs/help/platform-2024-11-07.md +73 -0
  259. package/assets/docs/help/platform-2024-11-25.md +91 -0
  260. package/assets/docs/help/platform-2024-12-10.md +71 -0
  261. package/assets/docs/help/platform-2025-03-04.md +54 -0
  262. package/assets/docs/help/platform-2025-04-03.md +105 -0
  263. package/assets/docs/help/platform-2025-04-08.md +120 -0
  264. package/assets/docs/help/platform-2025-05-14.md +70 -0
  265. package/assets/docs/help/platform-2025-1-16.md +65 -0
  266. package/assets/docs/help/platform-2025-2-10.md +75 -0
  267. package/assets/docs/help/platform-2025-2-13.md +43 -0
  268. package/assets/docs/help/portone-service/portone-service/content50.md +80 -0
  269. package/assets/docs/help/pricing/pg/domestic-and-oversea-fees.md +34 -0
  270. package/assets/docs/help/pricing/portone/portone-pricing.md +116 -0
  271. package/assets/docs/help/procedure/payment-integration/real-integration.md +43 -0
  272. package/assets/docs/help/procedure/payment-integration/test-integration.md +91 -0
  273. package/assets/docs/help/procedure/pg-application/content53.md +49 -0
  274. package/assets/docs/help/procedure/pg-application/content54.md +136 -0
  275. package/assets/docs/help/procedure/pg-application/content59.md +53 -0
  276. package/assets/docs/help/procedure/pg-application/start.md +154 -0
  277. package/assets/docs/help/procedure/recommendation/package.md +98 -0
  278. package/assets/docs/help/procedure/service-addition/add-service.md +98 -0
  279. package/assets/docs/help/recon_issue1.md +25 -0
  280. package/assets/docs/help/recon_issue2.md +29 -0
  281. package/assets/docs/help/service/identity-verification/identity-verification.md +65 -0
  282. package/assets/docs/help/service/integration-type/integration-type.md +49 -0
  283. package/assets/docs/help/service/payment-type/payment-type.md +100 -0
  284. package/assets/docs/help/service/paymethod/paymethod.md +100 -0
  285. package/assets/docs/help/service/pg/pg-service-list.md +339 -0
  286. package/assets/docs/help/service/version/portone-version.md +61 -0
  287. package/assets/docs/opi/ko/console/guide/account.md +111 -0
  288. package/assets/docs/opi/ko/console/guide/api-keys.md +34 -0
  289. package/assets/docs/opi/ko/console/guide/billing-payments.md +312 -0
  290. package/assets/docs/opi/ko/console/guide/channel-manage.md +303 -0
  291. package/assets/docs/opi/ko/console/guide/connect.md +84 -0
  292. package/assets/docs/opi/ko/console/guide/home.md +37 -0
  293. package/assets/docs/opi/ko/console/guide/integration.md +18 -0
  294. package/assets/docs/opi/ko/console/guide/list.md +183 -0
  295. package/assets/docs/opi/ko/console/guide/pay.md +14 -0
  296. package/assets/docs/opi/ko/console/guide/payments.md +298 -0
  297. package/assets/docs/opi/ko/console/guide/promotion.md +140 -0
  298. package/assets/docs/opi/ko/console/guide/readme.md +22 -0
  299. package/assets/docs/opi/ko/console/guide/reg.md +159 -0
  300. package/assets/docs/opi/ko/console/guide/smartrouting.md +74 -0
  301. package/assets/docs/opi/ko/console/pg.md +92 -0
  302. package/assets/docs/opi/ko/etc/recon.md +286 -0
  303. package/assets/docs/opi/ko/extra/confirm-process/readme-v1.md +98 -0
  304. package/assets/docs/opi/ko/extra/confirm-process/readme-v2.md +152 -0
  305. package/assets/docs/opi/ko/extra/identity-verification/readme-v2.md +261 -0
  306. package/assets/docs/opi/ko/extra/identity-verification/v1/all/0.md +35 -0
  307. package/assets/docs/opi/ko/extra/identity-verification/v1/all/1.md +44 -0
  308. package/assets/docs/opi/ko/extra/identity-verification/v1/all/2.md +75 -0
  309. package/assets/docs/opi/ko/extra/identity-verification/v1/all/3.md +134 -0
  310. package/assets/docs/opi/ko/extra/identity-verification/v1/all/readme.md +17 -0
  311. package/assets/docs/opi/ko/extra/identity-verification/v1/credit-auth/1.md +35 -0
  312. package/assets/docs/opi/ko/extra/identity-verification/v1/credit-auth/2.md +78 -0
  313. package/assets/docs/opi/ko/extra/identity-verification/v1/credit-auth/3.md +75 -0
  314. package/assets/docs/opi/ko/extra/identity-verification/v1/credit-auth/4.md +134 -0
  315. package/assets/docs/opi/ko/extra/identity-verification/v1/credit-auth/readme.md +17 -0
  316. package/assets/docs/opi/ko/extra/identity-verification/v1/phone/1.md +37 -0
  317. package/assets/docs/opi/ko/extra/identity-verification/v1/phone/2.md +86 -0
  318. package/assets/docs/opi/ko/extra/identity-verification/v1/phone/3.md +77 -0
  319. package/assets/docs/opi/ko/extra/identity-verification/v1/phone/4.md +149 -0
  320. package/assets/docs/opi/ko/extra/identity-verification/v1/phone/readme.md +19 -0
  321. package/assets/docs/opi/ko/extra/identity-verification/v1/readme.md +9 -0
  322. package/assets/docs/opi/ko/extra/link-pay/readme-v1.md +235 -0
  323. package/assets/docs/opi/ko/extra/plugins/readme-v1.md +7 -0
  324. package/assets/docs/opi/ko/extra/plugins/shopify/readme-v1.md +54 -0
  325. package/assets/docs/opi/ko/extra/plugins/shopify/shopify/shopify-1.md +16 -0
  326. package/assets/docs/opi/ko/extra/plugins/shopify/shopify/shopify-2.md +32 -0
  327. package/assets/docs/opi/ko/extra/plugins/shopify/shopify/shopify-3.md +16 -0
  328. package/assets/docs/opi/ko/extra/plugins/shopify/shopify/shopify-4.md +35 -0
  329. package/assets/docs/opi/ko/extra/plugins/shopify/shopify/shopify-5.md +27 -0
  330. package/assets/docs/opi/ko/extra/plugins/wordpress/button.md +166 -0
  331. package/assets/docs/opi/ko/extra/plugins/wordpress/edd.md +56 -0
  332. package/assets/docs/opi/ko/extra/plugins/wordpress/readme-v1.md +10 -0
  333. package/assets/docs/opi/ko/extra/plugins/wordpress/woocommerce/payment.md +62 -0
  334. package/assets/docs/opi/ko/extra/plugins/wordpress/woocommerce/readme.md +30 -0
  335. package/assets/docs/opi/ko/extra/plugins/wordpress/woocommerce/subscription.md +60 -0
  336. package/assets/docs/opi/ko/extra/plugins/wordpress/woocommerce/vbank.md +64 -0
  337. package/assets/docs/opi/ko/extra/promotion/console-guide.md +148 -0
  338. package/assets/docs/opi/ko/extra/promotion/integration.md +769 -0
  339. package/assets/docs/opi/ko/extra/promotion/intro.md +31 -0
  340. package/assets/docs/opi/ko/extra/promotion/refund.md +316 -0
  341. package/assets/docs/opi/ko/extra/smart-routing/console-guide.md +73 -0
  342. package/assets/docs/opi/ko/extra/smart-routing/integration.md +1324 -0
  343. package/assets/docs/opi/ko/extra/smart-routing/intro.md +155 -0
  344. package/assets/docs/opi/ko/integration/cancel/v1/basic.md +324 -0
  345. package/assets/docs/opi/ko/integration/cancel/v1/virtual-account.md +99 -0
  346. package/assets/docs/opi/ko/integration/cancel/v2/readme.md +378 -0
  347. package/assets/docs/opi/ko/integration/checklist/readme-v1.md +83 -0
  348. package/assets/docs/opi/ko/integration/pg/v1/blue.md +99 -0
  349. package/assets/docs/opi/ko/integration/pg/v1/danal.md +409 -0
  350. package/assets/docs/opi/ko/integration/pg/v1/daou/readme.md +305 -0
  351. package/assets/docs/opi/ko/integration/pg/v1/daou/undefined.md +214 -0
  352. package/assets/docs/opi/ko/integration/pg/v1/eximbay.md +242 -0
  353. package/assets/docs/opi/ko/integration/pg/v1/hyphen.md +196 -0
  354. package/assets/docs/opi/ko/integration/pg/v1/inicis.md +444 -0
  355. package/assets/docs/opi/ko/integration/pg/v1/kakaopay.md +207 -0
  356. package/assets/docs/opi/ko/integration/pg/v1/kcp-v2-identity-verification.md +188 -0
  357. package/assets/docs/opi/ko/integration/pg/v1/kg.md +177 -0
  358. package/assets/docs/opi/ko/integration/pg/v1/kicc.md +308 -0
  359. package/assets/docs/opi/ko/integration/pg/v1/ksnet/readme.md +533 -0
  360. package/assets/docs/opi/ko/integration/pg/v1/ksnet/warning.md +175 -0
  361. package/assets/docs/opi/ko/integration/pg/v1/naver.md +558 -0
  362. package/assets/docs/opi/ko/integration/pg/v1/newtoss/readme.md +503 -0
  363. package/assets/docs/opi/ko/integration/pg/v1/newtoss/warning.md +364 -0
  364. package/assets/docs/opi/ko/integration/pg/v1/nhn-kcp.md +1186 -0
  365. package/assets/docs/opi/ko/integration/pg/v1/nice-v2/billing-api-caution.md +150 -0
  366. package/assets/docs/opi/ko/integration/pg/v1/nice-v2/payment-caution.md +429 -0
  367. package/assets/docs/opi/ko/integration/pg/v1/nice-v2/readme.md +364 -0
  368. package/assets/docs/opi/ko/integration/pg/v1/nice.md +319 -0
  369. package/assets/docs/opi/ko/integration/pg/v1/payco.md +201 -0
  370. package/assets/docs/opi/ko/integration/pg/v1/paymentwall.md +283 -0
  371. package/assets/docs/opi/ko/integration/pg/v1/paypal.md +158 -0
  372. package/assets/docs/opi/ko/integration/pg/v1/readme.md +73 -0
  373. package/assets/docs/opi/ko/integration/pg/v1/rt/readme.md +501 -0
  374. package/assets/docs/opi/ko/integration/pg/v1/rt/warning.md +297 -0
  375. package/assets/docs/opi/ko/integration/pg/v1/settle/mybank.md +304 -0
  376. package/assets/docs/opi/ko/integration/pg/v1/settle/readme.md +185 -0
  377. package/assets/docs/opi/ko/integration/pg/v1/smartro-v2/api.md +197 -0
  378. package/assets/docs/opi/ko/integration/pg/v1/smartro-v2/caution.md +387 -0
  379. package/assets/docs/opi/ko/integration/pg/v1/smartro-v2/readme.md +293 -0
  380. package/assets/docs/opi/ko/integration/pg/v1/smartro.md +104 -0
  381. package/assets/docs/opi/ko/integration/pg/v1/smilepay.md +97 -0
  382. package/assets/docs/opi/ko/integration/pg/v1/spb/readme.md +441 -0
  383. package/assets/docs/opi/ko/integration/pg/v1/spb/stc.md +226 -0
  384. package/assets/docs/opi/ko/integration/pg/v1/spb/warning.md +729 -0
  385. package/assets/docs/opi/ko/integration/pg/v1/toss-brandpay/module.md +227 -0
  386. package/assets/docs/opi/ko/integration/pg/v1/toss-brandpay/readme.md +404 -0
  387. package/assets/docs/opi/ko/integration/pg/v1/toss-brandpay/warning.md +81 -0
  388. package/assets/docs/opi/ko/integration/pg/v1/toss-brandpay/widget.md +152 -0
  389. package/assets/docs/opi/ko/integration/pg/v1/toss.md +112 -0
  390. package/assets/docs/opi/ko/integration/pg/v1/tosspay-v2/caution.md +65 -0
  391. package/assets/docs/opi/ko/integration/pg/v1/tosspay-v2/readme.md +308 -0
  392. package/assets/docs/opi/ko/integration/pg/v1/tosspay.md +110 -0
  393. package/assets/docs/opi/ko/integration/pg/v1/welcome/api.md +229 -0
  394. package/assets/docs/opi/ko/integration/pg/v1/welcome/caution.md +517 -0
  395. package/assets/docs/opi/ko/integration/pg/v1/welcome/readme.md +795 -0
  396. package/assets/docs/opi/ko/integration/pg/v2/danal-identity-verification.md +121 -0
  397. package/assets/docs/opi/ko/integration/pg/v2/eximbay-v2.md +964 -0
  398. package/assets/docs/opi/ko/integration/pg/v2/hyphen.md +205 -0
  399. package/assets/docs/opi/ko/integration/pg/v2/inicis-jp.md +403 -0
  400. package/assets/docs/opi/ko/integration/pg/v2/inicis-unified-identity-verification.md +89 -0
  401. package/assets/docs/opi/ko/integration/pg/v2/inicis-v2.md +1598 -0
  402. package/assets/docs/opi/ko/integration/pg/v2/kakaopay.md +108 -0
  403. package/assets/docs/opi/ko/integration/pg/v2/kcp-v2-identity-verification.md +291 -0
  404. package/assets/docs/opi/ko/integration/pg/v2/kcp-v2.md +1273 -0
  405. package/assets/docs/opi/ko/integration/pg/v2/kpn.md +1133 -0
  406. package/assets/docs/opi/ko/integration/pg/v2/ksnet.md +526 -0
  407. package/assets/docs/opi/ko/integration/pg/v2/naverpay.md +186 -0
  408. package/assets/docs/opi/ko/integration/pg/v2/nice-v2.md +868 -0
  409. package/assets/docs/opi/ko/integration/pg/v2/payletter-global.md +62 -0
  410. package/assets/docs/opi/ko/integration/pg/v2/paypal-v2.md +1874 -0
  411. package/assets/docs/opi/ko/integration/pg/v2/readme.md +194 -0
  412. package/assets/docs/opi/ko/integration/pg/v2/smartro-v2.md +1043 -0
  413. package/assets/docs/opi/ko/integration/pg/v2/tosspay-v2.md +433 -0
  414. package/assets/docs/opi/ko/integration/pg/v2/tosspayments.md +551 -0
  415. package/assets/docs/opi/ko/integration/pg/v2/welcome.md +1441 -0
  416. package/assets/docs/opi/ko/integration/ready/readme.md +1069 -0
  417. package/assets/docs/opi/ko/integration/start/v1/auth.md +483 -0
  418. package/assets/docs/opi/ko/integration/start/v1/non-auth.md +420 -0
  419. package/assets/docs/opi/ko/integration/start/v1/readme.md +9 -0
  420. package/assets/docs/opi/ko/integration/start/v2/billing/issue.md +122 -0
  421. package/assets/docs/opi/ko/integration/start/v2/billing/payment.md +41 -0
  422. package/assets/docs/opi/ko/integration/start/v2/billing/readme.md +24 -0
  423. package/assets/docs/opi/ko/integration/start/v2/billing/schedule.md +54 -0
  424. package/assets/docs/opi/ko/integration/start/v2/checkout.md +258 -0
  425. package/assets/docs/opi/ko/integration/start/v2/keyin.md +54 -0
  426. package/assets/docs/opi/ko/integration/start/v2/readme.md +120 -0
  427. package/assets/docs/opi/ko/integration/using-ai-tools.md +140 -0
  428. package/assets/docs/opi/ko/integration/virtual-account/readme.md +268 -0
  429. package/assets/docs/opi/ko/integration/webhook/readme-v1.md +242 -0
  430. package/assets/docs/opi/ko/integration/webhook/readme-v2.md +599 -0
  431. package/assets/docs/opi/ko/quick-guide/payment.md +3305 -0
  432. package/assets/docs/opi/ko/readme.md +193 -0
  433. package/assets/docs/opi/ko/support/agency-and-tier.md +51 -0
  434. package/assets/docs/opi/ko/support/code-info/card-code.md +29 -0
  435. package/assets/docs/opi/ko/support/code-info/code.md +22 -0
  436. package/assets/docs/opi/ko/support/code-info/pg-1.md +161 -0
  437. package/assets/docs/opi/ko/support/code-info/pg-2.md +41 -0
  438. package/assets/docs/opi/ko/support/code-info/pg-3.md +36 -0
  439. package/assets/docs/opi/ko/support/code-info/pg.md +41 -0
  440. package/assets/docs/opi/ko/support/code-info/portone-code.md +15 -0
  441. package/assets/docs/opi/ko/support/code-info/readme.md +20 -0
  442. package/assets/docs/opi/ko/support/contact.md +23 -0
  443. package/assets/docs/opi/ko/support/faq/undefined.md +60 -0
  444. package/assets/docs/opi/ko/support/flow.md +24 -0
  445. package/assets/docs/opi/ko/support/redirect.md +26 -0
  446. package/assets/docs/opi/ko/support/tax.md +142 -0
  447. package/assets/docs/opi/ko/support/tls-support.md +497 -0
  448. package/assets/docs/platform/ko/guides/dictionary.md +20 -0
  449. package/assets/docs/platform/ko/guides/process.md +33 -0
  450. package/assets/docs/platform/ko/guides/webhook.md +171 -0
  451. package/assets/docs/platform/ko/readme.md +64 -0
  452. package/assets/docs/platform/ko/usages/client.md +17 -0
  453. package/assets/docs/platform/ko/usages/contract.md +126 -0
  454. package/assets/docs/platform/ko/usages/discount.md +89 -0
  455. package/assets/docs/platform/ko/usages/fee.md +97 -0
  456. package/assets/docs/platform/ko/usages/order.md +1666 -0
  457. package/assets/docs/platform/ko/usages/partner.md +115 -0
  458. package/assets/docs/platform/ko/using-ai-tools.md +140 -0
  459. package/assets/docs/release-notes/api-sdk/2023-04-24.md +10 -0
  460. package/assets/docs/release-notes/api-sdk/2023-05-08.md +22 -0
  461. package/assets/docs/release-notes/api-sdk/2023-05-12.md +24 -0
  462. package/assets/docs/release-notes/api-sdk/2023-05-22.md +46 -0
  463. package/assets/docs/release-notes/api-sdk/2023-05-25.md +15 -0
  464. package/assets/docs/release-notes/api-sdk/2023-06-19.md +20 -0
  465. package/assets/docs/release-notes/api-sdk/2023-07-03.md +26 -0
  466. package/assets/docs/release-notes/api-sdk/2023-07-10.md +35 -0
  467. package/assets/docs/release-notes/api-sdk/2023-07-17.md +31 -0
  468. package/assets/docs/release-notes/api-sdk/2023-07-31.md +14 -0
  469. package/assets/docs/release-notes/api-sdk/2023-08-31.md +29 -0
  470. package/assets/docs/release-notes/api-sdk/2023-12-15.md +12 -0
  471. package/assets/docs/release-notes/api-sdk/2024-01-08.md +36 -0
  472. package/assets/docs/release-notes/api-sdk/2024-01-11.md +18 -0
  473. package/assets/docs/release-notes/api-sdk/2024-01-25.md +35 -0
  474. package/assets/docs/release-notes/api-sdk/2024-01-30.md +19 -0
  475. package/assets/docs/release-notes/api-sdk/2024-02-23.md +26 -0
  476. package/assets/docs/release-notes/api-sdk/2024-03-08.md +12 -0
  477. package/assets/docs/release-notes/api-sdk/2024-03-15.md +30 -0
  478. package/assets/docs/release-notes/api-sdk/2024-03-25.md +23 -0
  479. package/assets/docs/release-notes/api-sdk/2024-04-01.md +37 -0
  480. package/assets/docs/release-notes/api-sdk/2024-04-05.md +10 -0
  481. package/assets/docs/release-notes/api-sdk/2024-04-12.md +32 -0
  482. package/assets/docs/release-notes/api-sdk/2024-05-08.md +34 -0
  483. package/assets/docs/release-notes/api-sdk/2024-05-14.md +17 -0
  484. package/assets/docs/release-notes/api-sdk/2024-06-03.md +48 -0
  485. package/assets/docs/release-notes/api-sdk/2024-06-17.md +37 -0
  486. package/assets/docs/release-notes/api-sdk/2024-06-19.md +39 -0
  487. package/assets/docs/release-notes/api-sdk/2024-06-20.md +13 -0
  488. package/assets/docs/release-notes/api-sdk/2024-07-04.md +15 -0
  489. package/assets/docs/release-notes/api-sdk/2024-07-11.md +47 -0
  490. package/assets/docs/release-notes/api-sdk/2024-09-05.md +36 -0
  491. package/assets/docs/release-notes/api-sdk/2024-09-27.md +27 -0
  492. package/assets/docs/release-notes/api-sdk/2024-12-19.md +52 -0
  493. package/assets/docs/release-notes/api-sdk/2025-01-15.md +76 -0
  494. package/assets/docs/release-notes/api-sdk/2025-05-19.md +49 -0
  495. package/assets/docs/release-notes/console/2023-04-24.md +41 -0
  496. package/assets/docs/release-notes/console/2023-05-08.md +6 -0
  497. package/assets/docs/release-notes/console/2023-05-22.md +15 -0
  498. package/assets/docs/release-notes/console/2023-07-05.md +29 -0
  499. package/assets/docs/release-notes/console/2023-07-07.md +25 -0
  500. package/assets/docs/release-notes/console/2023-07-17.md +16 -0
  501. package/assets/docs/release-notes/console/2023-08-23.md +17 -0
  502. package/assets/docs/release-notes/console/2023-09-12.md +16 -0
  503. package/assets/docs/release-notes/console/2023-12-27.md +24 -0
  504. package/assets/docs/release-notes/console/2024-09-05.md +23 -0
  505. package/assets/docs/release-notes/platform/2023-08-31.md +16 -0
  506. package/assets/docs/release-notes/platform/2023-11-08.md +37 -0
  507. package/assets/docs/release-notes/platform/2023-11-14.md +28 -0
  508. package/assets/docs/release-notes/platform/2023-12-15.md +11 -0
  509. package/assets/docs/release-notes/platform/2024-05-20.md +31 -0
  510. package/assets/docs/release-notes/platform/2024-05-29.md +159 -0
  511. package/assets/docs/release-notes/platform/2024-06-05.md +30 -0
  512. package/assets/docs/release-notes/platform/2024-07-05.md +49 -0
  513. package/assets/docs/release-notes/platform/2024-07-11.md +62 -0
  514. package/assets/docs/release-notes/platform/2024-07-30.md +44 -0
  515. package/assets/docs/release-notes/platform/2024-08-07.md +37 -0
  516. package/assets/docs/release-notes/platform/2024-08-22.md +111 -0
  517. package/assets/docs/release-notes/platform/2024-10-21.md +75 -0
  518. package/assets/docs/release-notes/platform/2024-11-07.md +65 -0
  519. package/assets/docs/release-notes/platform/2024-11-25.md +82 -0
  520. package/assets/docs/release-notes/platform/2024-12-10.md +61 -0
  521. package/assets/docs/release-notes/platform/2025-01-16.md +56 -0
  522. package/assets/docs/release-notes/platform/2025-02-10.md +67 -0
  523. package/assets/docs/release-notes/platform/2025-02-13.md +27 -0
  524. package/assets/docs/release-notes/platform/2025-03-04.md +49 -0
  525. package/assets/docs/release-notes/platform/2025-03-17.md +40 -0
  526. package/assets/docs/release-notes/platform/2025-04-03.md +96 -0
  527. package/assets/docs/release-notes/platform/2025-04-08.md +119 -0
  528. package/assets/docs/release-notes/platform/2025-05-14.md +77 -0
  529. package/assets/docs/release-notes/platform/2025-07-02.md +64 -0
  530. package/assets/docs/release-notes/platform/2025-07-07.md +55 -0
  531. package/assets/docs/schema/browser-sdk.yml +6349 -0
  532. package/assets/docs/schema/v1.openapi.json +11632 -0
  533. package/assets/docs/schema/v1.openapi.yml +11489 -0
  534. package/assets/docs/schema/v2.graphql +13849 -0
  535. package/assets/docs/schema/v2.openapi.json +47721 -0
  536. package/assets/docs/schema/v2.openapi.yml +34749 -0
  537. package/assets/docs/sdk/ko/readme.md +56 -0
  538. package/assets/docs/sdk/ko/v1-mobile-sdk/readme.md +31 -0
  539. package/assets/docs/sdk/ko/v1-sdk/javascript-sdk/cft-rt.md +32 -0
  540. package/assets/docs/sdk/ko/v1-sdk/javascript-sdk/cft.md +108 -0
  541. package/assets/docs/sdk/ko/v1-sdk/javascript-sdk/load-module-rt.md +10 -0
  542. package/assets/docs/sdk/ko/v1-sdk/javascript-sdk/load-module.md +55 -0
  543. package/assets/docs/sdk/ko/v1-sdk/javascript-sdk/payrq.md +502 -0
  544. package/assets/docs/sdk/ko/v1-sdk/javascript-sdk/payrt.md +300 -0
  545. package/assets/docs/sdk/ko/v1-sdk/javascript-sdk/readme.md +46 -0
  546. package/assets/docs/sdk/ko/v1-sdk/javascript-sdk-old/readme.md +33 -0
  547. package/assets/docs/sdk/ko/v2-mobile-sdk/android.md +268 -0
  548. package/assets/docs/sdk/ko/v2-mobile-sdk/react-native.md +239 -0
  549. package/assets/docs/sdk/ko/v2-mobile-sdk/readme.md +30 -0
  550. package/assets/docs/sdk/ko/v2-sdk/billing-key-and-pay-request.md +26 -0
  551. package/assets/docs/sdk/ko/v2-sdk/billing-key-and-pay-response.md +15 -0
  552. package/assets/docs/sdk/ko/v2-sdk/billing-key-request.md +24 -0
  553. package/assets/docs/sdk/ko/v2-sdk/billing-key-response.md +15 -0
  554. package/assets/docs/sdk/ko/v2-sdk/changelog.md +8 -0
  555. package/assets/docs/sdk/ko/v2-sdk/identity-verification-request.md +15 -0
  556. package/assets/docs/sdk/ko/v2-sdk/identity-verification-response.md +15 -0
  557. package/assets/docs/sdk/ko/v2-sdk/load-issue-billing-key-ui-request.md +15 -0
  558. package/assets/docs/sdk/ko/v2-sdk/load-issue-billing-key-ui-response.md +23 -0
  559. package/assets/docs/sdk/ko/v2-sdk/load-payment-ui-request.md +15 -0
  560. package/assets/docs/sdk/ko/v2-sdk/load-payment-ui-response.md +23 -0
  561. package/assets/docs/sdk/ko/v2-sdk/payment-request.md +15 -0
  562. package/assets/docs/sdk/ko/v2-sdk/payment-response.md +15 -0
  563. package/assets/docs/sdk/ko/v2-sdk/readme.md +73 -0
  564. package/assets/docs/sdk/ko/v2-sdk/update-load-issue-billing-key-ui-request.md +15 -0
  565. package/assets/docs/sdk/ko/v2-sdk/update-load-payment-ui-request.md +15 -0
  566. package/assets/docs/sdk/ko/v2-server-sdk/javascript.md +170 -0
  567. package/assets/docs/sdk/ko/v2-server-sdk/jvm.md +170 -0
  568. package/assets/docs/sdk/ko/v2-server-sdk/python.md +152 -0
  569. package/assets/docs/sdk/ko/v2-server-sdk/readme.md +259 -0
  570. package/assets/docs/v1-docs-full.md +36540 -0
  571. package/assets/docs/v2-docs-full.md +34980 -0
  572. package/assets/docs/website-links.md +331 -0
  573. package/assets/instructions.md +19 -0
  574. package/manifest.json +50 -0
  575. package/package.json +66 -0
  576. package/server/index.js +1764 -0
@@ -0,0 +1,1441 @@
1
+ ---
2
+ title: 웰컴페이먼츠
3
+ description: 웰컴페이먼츠 결제 연동 방법을 안내합니다.
4
+ targetVersions:
5
+ - v2
6
+ versionVariants:
7
+ v1: /opi/ko/integration/pg/v1/welcome/readme
8
+ ---
9
+
10
+ ## 채널 설정하기
11
+
12
+ - [결제대행사 채널 설정하기](https://developers.portone.io/opi/ko/integration/ready/readme#3-결제대행사-채널-설정하기)의 내용을 참고하여 PG 설정을 진행합니다.
13
+
14
+ ## 사전 계약 안내
15
+
16
+ 아래 기능을 사용하시려면 웰컴페이먼츠에 사전 신청 후 계약이 완료되어야 합니다.
17
+ 그렇지 않은 상태에서 해당 기능 이용시 결제 승인에 실패하거나,
18
+ 승인에 성공하더라도 의도한 바와는 다른 응답(ex. 결제창에서 에스크로 결제를 했으나 비-에스크로 결제 응답을 받음)을 얻게 될 수 있으니 주의해주시기 바랍니다.
19
+
20
+ - 간편결제 사용
21
+ - 면세 / 복합과세 / 지정금액 방식 사용
22
+ - 할부 사용
23
+ - 상점 부담 무이자 할부 사용
24
+ - 카드사 포인트 사용
25
+ - 에스크로 사용
26
+ - 휴대폰 실물 / 컨텐츠 사용
27
+ - 휴대폰 빌링키 발급과 동시에 결제 실물 / 컨텐츠 사용
28
+
29
+ ## 가능한 결제 수단
30
+
31
+ - **결제창 일반 결제**
32
+
33
+ `payMethod` 파라미터를 결제 수단에 따라 아래와 같이 설정해야 합니다.
34
+
35
+ - 카드 : `CARD`
36
+ - 계좌이체 : `TRANSFER`
37
+ - 가상계좌 : `VIRTUAL_ACCOUNT`
38
+ - 상품권 : `GIFT_CERTIFICATE`
39
+ - 휴대폰 소액 결제 : `MOBILE`
40
+ - 간편결제 : `EASY_PAY`
41
+
42
+ - **결제창 빌링키 발급**
43
+ 카드 결제는 `requestIssueBillingKey` 함수, 휴대폰 결제는 `requestIssueBillingKeyAndPay` 함수를 이용합니다. `requestIssueBillingKeyAndPay` 함수를 이용할 때에는 빌링키 발급과 동시에 결제가 일어납니다.
44
+
45
+ `billingKeyMethod` 파라미터를 결제 수단에 따라 아래와 같이 설정해야 합니다.
46
+
47
+ - 카드: `CARD`
48
+ - 휴대폰: `MOBILE`
49
+
50
+ - **API 수기(키인) 결제**
51
+
52
+ `method` 파라미터를 결제 수단에 따라 아래와 같이 설정해야 합니다.
53
+
54
+ - 카드: `card` 로 설졍하여 카드 관련 파라미터 입력
55
+ - 가상계좌: `virtualAccount` 로 설정하여 가상계좌 관련 파라미터 입력
56
+
57
+ 자세한 파라미터 구성은 [REST API Docs](https://developers.portone.io/api/rest-v2/payment#post%20%2Fpayments%2F%7BpaymentId%7D%2Finstant)
58
+ 를 참고해주시기 바랍니다.
59
+
60
+ - **API 빌링키 발급**
61
+
62
+ `method` 파라미터를 결제 수단에 따라 아래와 같이 설정해야 합니다.
63
+
64
+ - 카드: `card` 로 설졍하여 카드 관련 파라미터 입력
65
+
66
+ 자세한 파라미터 구성은 [REST API Docs](https://developers.portone.io/api/rest-v2/billingKey#post%20%2Fbilling-keys)를 참고해주시기 바랍니다.
67
+
68
+ ## SDK 결제 요청하기
69
+
70
+ 결제 요청 시에는 `requestPayment` 함수를 호출해야 합니다.
71
+ `channelKey`파라미터에 결제 채널 연동 후 생성된 채널 키값을 지정하여 웰컴페이먼츠 채널 사용을 명시해주세요.
72
+
73
+ 웰컴페이먼츠 기준으로 작성한 예시 코드는 아래와 같습니다.
74
+
75
+ <div class="tabs-container">
76
+
77
+ <div class="tabs-content" data-title="SDK 결제 요청">
78
+
79
+ ```javascript
80
+ import * as PortOne from "@portone/browser-sdk/v2";
81
+ function requestPayment() {
82
+ PortOne.requestPayment({
83
+ storeId: "store-4ff4af41-85e3-4559-8eb8-0d08a2c6ceec", // 고객사 storeId로 변경해주세요.
84
+ channelKey: "channel-key-9987cb87-6458-4888-b94e-68d9a2da896d", // 콘솔 결제 연동 화면에서 채널 연동 시 생성된 채널 키를 입력해주세요.
85
+ paymentId: `payment${crypto.randomUUID()}`,
86
+ orderName: "나이키 와플 트레이너 2 SD",
87
+ totalAmount: 1000,
88
+ currency: "CURRENCY_KRW",
89
+ payMethod: "CARD",
90
+ customer: {
91
+ fullName: "포트원",
92
+ phoneNumber: "010-0000-1234",
93
+ email: "test@portone.io",
94
+ },
95
+ });
96
+ }
97
+ ```
98
+
99
+ </div>
100
+
101
+ </div>
102
+
103
+ ### 주요 파라미터
104
+
105
+ - storeId: string
106
+
107
+ **상점 아이디**
108
+
109
+ 포트원 계정에 생성된 상점을 식별하는 고유한 값으로 관리자 콘솔에서 확인할 수 있습니다.
110
+
111
+ - paymentId: string
112
+
113
+ **고객사 주문 고유 번호**
114
+
115
+ 고객사에서 채번하는 주문 고유 번호로 매번 고유하게 채번되어야 합니다. 이미 승인 완료된 `paymentId`로 결제를 시도하는 경우 에러가 발생합니다.
116
+
117
+ - orderName: string
118
+
119
+ **주문명**
120
+
121
+ 주문명으로 고객사에서 자유롭게 입력합니다.
122
+
123
+ - channelKey: string
124
+
125
+ **채널 키**
126
+
127
+ 포트원 콘솔 내 \[결제연동] > \[채널관리] 화면에서 채널 추가 시 생성되는 값입니다. 결제 호출 시 채널을 지정할 때 사용됩니다.
128
+
129
+ - totalAmount: number
130
+
131
+ **결제 금액**
132
+
133
+ 결제 금액으로 결제를 원하는 통화(currency)별 scale factor(소수점 몇번째 자리까지 유효한지)를 고려한 number 형식만 허용됩니다.
134
+
135
+ - currency: string
136
+
137
+ **결제 통화**
138
+
139
+ 결제통화로 원화 결제 시 `KRW`로 입력해야 합니다.
140
+
141
+ - payMethod: string
142
+
143
+ **결제수단 구분코드**
144
+
145
+ 결제 호출 시 결제수단을 지정할 때 사용됩니다.
146
+
147
+ - 신용카드 : `CARD`
148
+ - 실시간 계좌이체 : `TRANSFER`
149
+ - 가상계좌 : `VIRTUAL_ACCOUNT`
150
+ - 휴대폰 소액결제 : `MOBILE`
151
+ - 간편 결제 : `EASY_PAY`
152
+
153
+ - customer?: object
154
+
155
+ **고객 정보**
156
+
157
+ - fullName?: string
158
+
159
+ **구매자 전체 이름**
160
+
161
+ - 웰컴페이먼츠의 경우 fullName 혹은 (firstName + lastName)을 필수로 입력해야 합니다.
162
+
163
+ - phoneNumber?: string
164
+
165
+ **구매자 연락처**
166
+
167
+ - 웰컴페이먼츠의 PC 결제의 경우 필수로 입력해야 합니다. (모바일인 경우에는 optional)
168
+
169
+ - email?: string
170
+
171
+ **구매자 이메일**
172
+
173
+ - 웰컴페이먼츠의 PC 결제의 경우 필수로 입력해야 합니다. (모바일인 경우에는 optional)
174
+
175
+ - bypass?: oneof object
176
+
177
+ **PG사 결제창 호출 시 PG사로 그대로 bypass할 파라미터들의 모음**
178
+
179
+ - welcome?: WelcomeBypassOnPc & WelcomeBypassOnMobile
180
+
181
+ **웰컴페이먼츠 bypass 파라미터**
182
+
183
+ 웰컴페이먼츠는 PC 결제 모듈과 모바일 결제 모듈이 분리되어 있기 때문에 bypass 파라미터 또한 PC용과 모바일용이 분리되어 있습니다.
184
+
185
+ - **bypass 예시 코드**
186
+
187
+ ```json
188
+ {
189
+ "bypass": {
190
+ "welcome": {
191
+ "logo_url": "https://portone.io/assets/portone.87061e94.avif",
192
+ "logo_2nd": "https://admin.portone.io/assets/img/auth/lock.png",
193
+ "acceptmethod": ["SKIN(#C1272C)", "below1000", "ocb"],
194
+ "P_CARD_OPTION": "selcode=14",
195
+ "P_NMANE": "포트원",
196
+ "P_RESERVED": ["below1000=Y", "noeasypay=Y"]
197
+ }
198
+ }
199
+ }
200
+ ```
201
+
202
+ - WelcomeBypassOnPc
203
+
204
+ **PC용 파라미터**
205
+
206
+ - logo\_url?: string
207
+
208
+ 결제창에 삽입할 메인 로고 url
209
+
210
+ 결제창 중앙 상단에 표시됩니다.
211
+ 이미지 권장 사이즈는 89\*18 입니다.
212
+
213
+ - logo\_2nd?: string
214
+
215
+ 결제창에 삽입할 서브 로고 url
216
+
217
+ 결제창 우측 상단에 표시됩니다.
218
+ 이미지 권장 사이즈는 64\*13 입니다.
219
+
220
+ - acceptmethod?: string\[]
221
+
222
+ **PC - 카드 결제 전용 파라미터**
223
+
224
+ |형식 |설명 |
225
+ |---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
226
+ |SKIN(색상코드) |결제 창의 배경 색상 <br /> - 기본값 : #c1272c <br /> - 예시: SKIN(#fc6b2d) |
227
+ |below1000 |1,000원 미만 결제 허용 여부 <br /> - 기본값: 허용하지 않음 |
228
+ |paypopup |안심클릭을 팝업 형태로 렌더링 시킬지 여부 <br /> - 기본값: 레이어 |
229
+ |onlyeasypaycode(간편 결제 리스트)|카드 결제창 내 렌더링 될 간편 결제 리스트 <br /> 예) 카카오페이, 엘페이, 페이코만 렌더링 → ”kakaopay:lpay:payco” 전달 <br /> - 카카오페이: `kakaopay` <br /> - 엘페이: `lpay` <br /> - 페이코: `payco` <br /> - 토스페이: `tosspay`|
230
+ |SLIMQUOTA(슬림 할부 설정) |부분 무이자 설정. 슬림 할부 <br /> - 형식) SLIMQUOTA(코드-개월:개월^코드-개월:개월 <br /> - 예시) SLIMQUOTA(11-2:3^34-2:3) |
231
+
232
+ **PC - 휴대폰 소액 결제 전용 파라미터**
233
+
234
+ |형식 |설명 |
235
+ |---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
236
+ |hppdefaultcorp(통신사 코드)|휴대폰 소액결제시 기본 선택되어있는 통신사 <br /> - 기본: 기본 선택되어있는 통신사 없음 <br /> 예) KT 기본 선택 → ”hppdefaultcorp(KT)” 전달 <br /> - SKT: `SKT` <br /> - KT: `KTF` <br /> - LG 유플러스: `LGT` <br /> - 알뜰폰 전체: `MVNO` <br /> - 알뜰폰 CJ 헬로 모바일: `CJH` <br /> - 알뜰폰 티플러스: `KCT` <br /> - 알뜰폰 SK 세븐모바일: `SKL` <br />|
237
+ |hppnofix(N 또는 Y) |휴대폰 소액결제창에 자동 입력되는 `buyer_tel`값을 수정할 수 있는지 여부 <br /> - 기본값: 수정 가능 <br /> - Y : 수정 불가능 <br /> - N : 수정 가능(기본) <br /> |
238
+
239
+ ```json
240
+ {
241
+ "channelKey": "{콘솔 내 연동 정보의 채널키}",
242
+ "bypass": {
243
+ "welcome": {
244
+ "acceptmethod": [
245
+ "SKIN(#fc6b2d)", // 결제창 배경 색상 #fc6b2d
246
+ "below1000", // 1,000원 이하 결제 허용
247
+ "paypopup", // 안심 클릭을 팝업으로 렌더링
248
+ "onlyeasypaycode(kakaopay:payco)", // 카드 결제창 내 간편결제는 카카오페이와 페이코만 렌더링
249
+ "hppdefaultcorp(KT)", // 휴대폰 소액결제시 KT 기본 선택
250
+ "hppnofix(Y)" // 휴대폰 소액결제시 결제 창 내에서 구매자 전화번호 수정 불가능
251
+ ]
252
+ }
253
+ }
254
+ }
255
+ ```
256
+
257
+ - WelcomeBypassOnMobile
258
+
259
+ **모바일용 파라미터**
260
+
261
+ - P\_CARD\_OPTION?: string
262
+
263
+ 신용카드 우선선택 옵션
264
+
265
+ 설정한 카드코드에 해당하는 카드가 선택된 채로 Display 됩니다.
266
+ `selcode=카드코드` 형식으로 입력합니다. (ex. `selcode=14`)
267
+
268
+ - P\_RESERVED?: string\[]
269
+
270
+ 추가 옵션
271
+
272
+ 아래 string 중 원하는 옵션들을 골라 array 형태로 입력합니다.
273
+
274
+ - below1000=Y?: string
275
+
276
+ (카드결제 & 간편결제 시) 1000원 미만 결제 허용 옵션
277
+
278
+ - noeasypay=Y?: string
279
+
280
+ (카드결제 시) 간편결제 미노출 옵션
281
+
282
+ - global\_visa3d=Y?: string
283
+
284
+ 해외카드 노출 옵션
285
+
286
+ - apprun\_check=Y?: string
287
+
288
+ (android의 경우) custom url scheme 대신 intent schema(intent://) 호출
289
+
290
+ ### 유의사항
291
+
292
+ #### 공통
293
+
294
+ <details>
295
+
296
+ <summary>PC와 모바일에서 파라미터 필수 여부가 상이합니다.</summary>
297
+
298
+ 위의 주요 파라미터 설명에도 안내되어 있듯이, PC 결제와 모바일 결제에서 필수 여부가 상이한 파라미터가 존재합니다. 아래 필드들은 PC 결제에서는 필수이지만, 모바일 결제에서는 선택입니다.
299
+
300
+ - `customer.fullName` 혹은 `customer.firstName + customer.lastName`
301
+ - `customer.phoneNumber`
302
+ - `customer.email`
303
+
304
+ </details>
305
+
306
+ <details>
307
+
308
+ <summary>`paymentId` 에는 ASCII 문자만 허용됩니다.</summary>
309
+
310
+ `paymentId` 에는 ASCII 문자만으로 이루어진 문자열만 입력할 수 있습니다.
311
+
312
+ ASCII 문자에 포함되지 않는 한글이나 `♤`, `♡`, `♧` 등의 특수 문자는 허용되지 않습니다.
313
+
314
+ 입력 가능한 ASCII 문자의 종류는 [링크](http://www.ascii-code.com/) → `ASCII printable characters` 섹션을 참고하세요.
315
+
316
+ </details>
317
+
318
+ <details>
319
+
320
+ <summary>지원되는 결제창 언어</summary>
321
+
322
+ SDK를 통한 결제 요청 파라미터에는 결제창 언어를 지정할 수 있는 `locale` 파라미터가 존재합니다.
323
+ PC 결제의 경우 `KO_KR`, `EN_US`, `ZH_CN`을 지원하며, 모바일 결제의 경우 `KO_KR`, `EN_US`만을 지원합니다.
324
+
325
+ </details>
326
+
327
+ <details>
328
+
329
+ <summary>지원되는 결제 통화</summary>
330
+
331
+ SDK를 통한 결제 요청 파라미터에는 결제 통화를 지정할 수 있는 `currency` 파라미터가 존재합니다.
332
+ 웰컴페이먼츠의 경우 `KRW`만을 지원합니다.
333
+
334
+ </details>
335
+
336
+ <details>
337
+
338
+ <summary>부가세, 면세금액 직접 지정을 위해서는 별도 계약이 필요합니다.</summary>
339
+
340
+ SDK를 통한 결제 요청 파라미터에는 부가세를 지정할 수 있는 `vat` 파라미터와 면세 금액을 지정할 수 있는 `taxFreeAmount` 파라미터가 존재합니다.
341
+ 웰컴페이먼츠의 경우 부가세 및 면세금액을 직접 지정하기 위해서는 별도 계약이 필요합니다. 별도 계약이 되지 않은 상태에서 `vat`와 `taxFreeAmount`에 값을 지정해 결제를 요청하면
342
+ 요청한 내용과 다른 금액으로 실결제가 발생할 수 있습니다.
343
+
344
+ </details>
345
+
346
+ <details>
347
+
348
+ <summary>웰컴페이먼츠에서 지원하는 현금영수증 발급 유형</summary>
349
+
350
+ 현금영수증은 현금성 거래인 실시간 계좌이체 및 가상계좌 발급 시 사용이 가능합니다.
351
+ 웰컴페이먼츠의 경우 현금영수증 발급 유형을 `CORPORATE` 혹은 `PERSONAL` 등 파라미터로 제어할 수 없습니다.
352
+ 어떤 유형의 현금영수증을 발행할지는 항상 결제창 내에서 선택 가능하며, 결제창 호출 파라미터로는 현금영수증을 발행 여부만을 제어할 수 있습니다.
353
+ `cashReceiptType` 파라미터를 `ANONYMOUS`로 설정 시 결제창에서 현금영수증 발급 UI가 미노출됩니다.
354
+
355
+ </details>
356
+
357
+ #### 카드 결제
358
+
359
+ <details>
360
+
361
+ <summary>카드사 다이렉트 호출 시 할부 개월 수 옵션은 고정 할부 개월 수만 지원합니다.</summary>
362
+
363
+ 웰컴페이먼츠 경우 **카드사 다이렉트 호출 시 할부 개월 수 옵션은** 고정 할부 개월 수만 지원합니다. 카드사 다이렉트 호출을 설정했으나 할부 개월 수 옵션을 `card.installment.monthOption.fixedMonth` 가 아닌
364
+ `card.installment.monthOption.availableMonthList`로 설정할 경우 에러가 발생합니다.
365
+
366
+ </details>
367
+
368
+ <details>
369
+
370
+ <summary>카드사 다이렉트 호출 시 지원하는 카드사 종류</summary>
371
+
372
+ 웰컴페이먼츠의 경우 **포트원에서 관리하는 카드사 중 토스뱅크를 제외한 모든 카드사를 지원**합니다. 포트원에서 관리하는 카드사 목록을 확인하시려면
373
+ [JS SDK 결제요청 파라미터](https://developers.portone.io/sdk/ko/v2-sdk/payment-request) 페이지에서 `card` -> `cardCompany` 필드 설명을 참고해주세요.
374
+
375
+ </details>
376
+
377
+ <details>
378
+
379
+ <summary>웰컴페이먼츠에서 지원하지 않는 카드 관련 파라미터</summary>
380
+
381
+ 웰컴페이먼츠의 경우 아래 파라미터들을 지원하지 않으며, 해당 파라미터들을 설정하더라도 결제 동작에 아무런 영향을 주지 않습니다.
382
+
383
+ - `useAppCardOnly`: 앱카드만 허용할지 여부
384
+ - `useInstallment`: 할부 사용 여부. (웰컴페이먼츠의 경우 `installment` 파라미터로 직접 설정 가능합니다.)
385
+ - `useFreeInterestFromMall`: 상점부담무이자 사용 여부. (웰컴페이먼츠의 경우 `installment.freeInstallmentPlans` 파라미터로 직접 설정 가능합니다.)
386
+
387
+ </details>
388
+
389
+ #### 간편 결제
390
+
391
+ <details>
392
+
393
+ <summary>웰컴페이먼츠에서 지원하는 간편결제사 종류</summary>
394
+
395
+ 웰컴페이먼츠의 경우 아래 간편결제사를 지원합니다. `easyPay.easyPayProvider` 파라미터에 아래 리스트 중 원하는 값을 입력하세요.
396
+
397
+ - 카카오페이: `KAKAOPAY`
398
+ - lpay: `LPAY`
399
+ - 토스페이: `TOSSPAY`
400
+ - 페이코: `PAYCO`
401
+
402
+ </details>
403
+
404
+ <details>
405
+
406
+ <summary>웰컴페이먼츠에서 지원하지 않는 간편결제 관련 파라미터</summary>
407
+
408
+ 웰컴페이먼츠의 경우 아래 파라미터들을 지원하지 않으며, 해당 파라미터들을 설정하더라도 결제 동작에 아무런 영향을 주지 않습니다.
409
+
410
+ - `useCardPoint`: 카드사 포인트 사용 여부
411
+ - `customerIdentifier`: 현금영수증 발행 대상 식별 정보
412
+ - `availablePayMethod`: 간편결제 세부 결제수단 지정 렌더링 옵션
413
+ - `availableCards`: 결제 수단으로써 사용 허가할 카드사 리스트
414
+ - `useInstallment`: 할부 사용 여부. (웰컴페이먼츠의 경우 `installment` 파라미터로 직접 설정 가능합니다.)
415
+ - `useFreeInterestFromMall`: 상점부담무이자 사용 여부. (웰컴페이먼츠의 경우 `installment.freeInstallmentPlans` 파라미터로 직접 설정 가능합니다.)
416
+
417
+ </details>
418
+
419
+ #### 계좌이체
420
+
421
+ <details>
422
+
423
+ <summary>웰컴페이먼츠에서 지원하지 않는 계좌이체 관련 파라미터</summary>
424
+
425
+ 웰컴페이먼츠의 경우 아래 파라미터들을 지원하지 않으며, 해당 파라미터들을 설정하더라도 결제 동작에 아무런 영향을 주지 않습니다.
426
+
427
+ - `bankCode`: 계좌이체 은행 다이렉트 호출 시 은행 코드
428
+ - `customerIdentifier`: 현금영수증 발행 대상 식별 정보
429
+
430
+ </details>
431
+
432
+ #### 가상계좌 결제
433
+
434
+ <details>
435
+
436
+ <summary>웰컴페이먼츠에서 지원하지 않는 가상계좌 관련 파라미터</summary>
437
+
438
+ 웰컴페이먼츠의 경우 아래 파라미터들을 지원하지 않으며, 해당 파라미터들을 설정하더라도 결제 동작에 아무런 영향을 주지 않습니다.
439
+
440
+ - `bankCode`: 가상계좌 은행 다이렉트 호출 시 은행 코드
441
+ - `customerIdentifier`: 현금영수증 발행 대상 식별 정보
442
+ - `fixedOption`: 고정식 가상계좌 옵션. (웰컴페이먼츠의 경우 API를 통해서만 고정식 가상계좌 발급이 가능합니다.)
443
+
444
+ </details>
445
+
446
+ #### 상품권 결제
447
+
448
+ <details>
449
+
450
+ <summary>웰컴페이먼츠에서 지원하는 상품권 종류 및 필수 여부</summary>
451
+
452
+ 웰컴페이먼츠 모바일 결제의 경우 `giftCertificateType`을 필수로 입력해야 하며, PC 결제의 경우는 선택 사항입니다.
453
+ PC 결제에서 해당 파라미터를 입력하지 않을 경우 결제창 내에서 상품권 종류를 선택할 수 있습니다. 웰컴페이먼츠에서 지원하는 상품권 종류는 아래와 같습니다.
454
+
455
+ - 도서문화상품권: `BOOKNLIFE`
456
+ - 스마트문상: `SMART_MUNSANG`
457
+ - 컬쳐랜드 문화상품권: `CULTURELAND`
458
+
459
+ </details>
460
+
461
+ #### 휴대폰 소액 결제
462
+
463
+ <details>
464
+
465
+ <summary>`productType` 파라미터는 필수 입력해야 합니다.</summary>
466
+
467
+ - 웰컴페이먼츠의 경우 **휴대폰 소액결제시 상품 유형을 구분 짓는 `productType` 파라미터가 필수**로 입력해야 합니다.
468
+ - `productType`의 값은 `PRODUCT_TYPE_REAL` 또는 `PRODUCT_TYPE_DIGITAL`를 입력해야 합니다.
469
+
470
+ </details>
471
+
472
+ <details>
473
+
474
+ <summary>결제창에 노출될 통신사 리스트 지정 옵션 지원 여부</summary>
475
+
476
+ 웰컴페이먼츠 모바일 결제의 경우 `availableCarriers` 필드를 통해 결제창에 노출될 통신사 리스트를 지정할 수 있습니다. PC에서는 해당 파라미터를 지원하지 않습니다.
477
+
478
+ </details>
479
+
480
+ <details>
481
+
482
+ <summary>웰컴페이먼츠에서 지원하지 않는 휴대폰 소액결제 관련 파라미터</summary>
483
+
484
+ 웰컴페이먼츠의 경우 아래 파라미터들을 지원하지 않으며, 해당 파라미터들을 설정하더라도 결제 동작에 아무런 영향을 주지 않습니다.
485
+
486
+ - `carrier`: 휴대폰 소액결제 통신사 바로 호출을 위한 통신사 구분 값
487
+
488
+ </details>
489
+
490
+ ## SDK 카드 빌링키 발급 요청하기
491
+
492
+ 카드 빌링키 발급 요청 시에는 `requestIssueBillingKey` 함수를 호출해야 합니다.
493
+ `channelKey` 파라미터에 결제 채널 연동 후 생성된 채널 키값을 지정하여 웰컴페이먼츠 채널 사용을 명시해주세요.
494
+
495
+ 웰컴페이먼츠 기준으로 작성한 예시 코드는 아래와 같습니다.
496
+
497
+ <div class="tabs-container">
498
+
499
+ <div class="tabs-content" data-title="SDK 빌링키 발급 요청">
500
+
501
+ ```javascript
502
+ import * as PortOne from "@portone/browser-sdk/v2";
503
+ function requestIssueBillingKey() {
504
+ PortOne.requestIssueBillingKey({
505
+ storeId: "store-4ff4af41-85e3-4559-8eb8-0d08a2c6ceec", // 고객사 storeId로 변경해주세요.
506
+ channelKey: "channel-key-3b37819a-1c72-4deb-a245-8c810af5403d", // 콘솔 결제 연동 화면에서 채널 연동 시 생성된 채널 키를 입력해주세요.
507
+ billingKeyMethod: "CARD",
508
+ issueId: "test-issueId",
509
+ issueName: "test-issueName",
510
+ customer: {
511
+ fullName: "포트원",
512
+ phoneNumber: "010-0000-1234",
513
+ email: "test@portone.io",
514
+ },
515
+ });
516
+ }
517
+ ```
518
+
519
+ </div>
520
+
521
+ </div>
522
+
523
+ ### 주요 파라미터
524
+
525
+ <br />
526
+
527
+ - storeId: string
528
+
529
+ **상점 아이디**
530
+
531
+ 포트원 계정에 생성된 상점을 식별하는 고유한 값으로 관리자 콘솔에서 확인할 수 있습니다.
532
+
533
+ - channelKey: string
534
+
535
+ **채널 키**
536
+
537
+ 포트원 콘솔 내 \[결제연동] > \[채널관리] 화면에서 채널 추가 시 생성되는 값입니다. 결제 호출 시 채널을 지정할 때 사용됩니다.
538
+
539
+ - billingKeyMethod: string
540
+
541
+ **빌링키 발급수단**
542
+
543
+ 웰컴페이먼츠는 빌링키 발급 수단으로 카드만을 지원하므로 해당 파라미터는 `CARD`로 고정해야 합니다.
544
+
545
+ - issueId: string
546
+
547
+ **빌링키 발급 건 고유 ID**
548
+
549
+ - 고객사에서 채번하여 사용해야 합니다.
550
+ - 웰컴페이먼츠의 경우 필수 입력해야 합니다.
551
+
552
+ - issueName: string
553
+
554
+ **빌링키 발급 시 결제창에 표시되는 제목**
555
+
556
+ - 웰컴페이먼츠의 경우 필수 입력해야 합니다.
557
+
558
+ - customer?: object
559
+
560
+ **고객 정보**
561
+
562
+ - fullName?: string
563
+
564
+ **구매자 전체 이름**
565
+
566
+ - 웰컴페이먼츠의 경우 fullName 혹은 (firstName + lastName)을 필수로 입력해야 합니다.
567
+
568
+ - phoneNumber?: string
569
+
570
+ **구매자 연락처**
571
+
572
+ - 웰컴페이먼츠의 PC 빌링키 발급의 경우 필수로 입력해야 합니다. (모바일인 경우에는 optional)
573
+
574
+ - email?: string
575
+
576
+ **구매자 이메일**
577
+
578
+ - 웰컴페이먼츠의 PC 빌링키 발급의 경우 필수로 입력해야 합니다. (모바일인 경우에는 optional)
579
+
580
+ - offerPeriod?: object
581
+
582
+ **제공 기간**
583
+
584
+ - 웰컴페이먼츠 모바일 빌링키 발급의 경우 필수로 입력해야 합니다. (PC인 경우에는 optional)
585
+
586
+ - bypass?: oneof object
587
+
588
+ **PG사 결제창 호출 시 PG사로 그대로 bypass할 파라미터들의 모음**
589
+
590
+ - welcome?: object
591
+
592
+ **웰컴페이먼츠에서 제공하는 파라미터 모음**
593
+
594
+ - carduse?: 'percard' | 'cocard'
595
+
596
+ **개인/법인카드 사용 선택 옵션**
597
+
598
+ - 모바일에서만 동작하는 파라미터입니다.
599
+ - 'percard' 혹은 'cocard'를 입력할 수 있습니다.
600
+ - 'percard' 입력 시 개인 카드로만 결제를 진행할 수 있으며, 'cocard' 입력 시 법인 카드로만 결제를 진행 할 수 있습니다.
601
+
602
+ ### 유의사항
603
+
604
+ <details>
605
+
606
+ <summary>PC와 모바일에서 파라미터 필수 여부가 상이합니다.</summary>
607
+
608
+ 위의 주요 파라미터 설명에도 안내되어 있듯이, PC 빌링키 발급과 모바일 빌링키 발급에서 필수 여부가 상이한 파라미터가 존재합니다.
609
+
610
+ 아래 필드들은 PC에서는 필수이지만, 모바일에서는 선택입니다.
611
+
612
+ - `customer.fullName` 혹은 `customer.firstName + customer.lastName`
613
+ - `customer.phoneNumber`
614
+ - `customer.email`
615
+
616
+ 아래 필드들은 모바일에서는 필수이지만, PC에서는 선택입니다.
617
+
618
+ - `offerPeriod`
619
+
620
+ </details>
621
+
622
+ <details>
623
+
624
+ <summary>`issueId` 에는 ASCII 문자만 허용됩니다.</summary>
625
+
626
+ `issueId` 에는 ASCII 문자만으로 이루어진 문자열만 입력할 수 있습니다.
627
+
628
+ ASCII 문자에 포함되지 않는 한글이나 `♤`, `♡`, `♧` 등의 특수 문자는 허용되지 않습니다.
629
+
630
+ 입력 가능한 ASCII 문자의 종류는 [링크](http://www.ascii-code.com/) → `ASCII printable characters` 섹션을 참고하세요.
631
+
632
+ </details>
633
+
634
+ <details>
635
+
636
+ <summary>`offerPeriod` 파라미터 제약 사항</summary>
637
+
638
+ SDK를 통한 빌링키 발급 요청 파라미터에는 제공 기간을 나타내는 `offerPeriod` 파라미터가 존재합니다.
639
+ 날짜 범위를 입력하는 방식(`range`)과 간격을 입력하는 방식(`interval`) 중 하나를 선택하여 입력할 수 있습니다.
640
+
641
+ - `range` 방식으로 입력할 경우 `from`과 `to` 모두를 입력하셔야 하, `from`은 `to`보다 과거 시간이어야 합니다.
642
+ - `interval` 방식으로 입력할 경우는 `1m` 또는 `1y`만 허용됩니다. `1m`를 입력할 경우 `월 정기결제`, `1y`를 입력할 경우 `연 정기결제` 로 빌링키 발급 창에 노출됩니다.
643
+
644
+ </details>
645
+
646
+ <details>
647
+
648
+ <summary>지원되는 결제창 언어</summary>
649
+
650
+ SDK를 통한 빌링키 발급 요청 파라미터에는 결제창 언어를 지정할 수 있는 `locale` 파라미터가 존재합니다.
651
+ PC 빌링키 발급의 경우 `KO_KR`, `EN_US`, `ZH_CN`을 지원하며, 모바일 빌링키 발급의 경우 해당 파라미터를 지원하지 않고 항상 한국어로 노출됩니다.
652
+
653
+ </details>
654
+
655
+ <details>
656
+
657
+ <summary>지원되는 결제 통화</summary>
658
+
659
+ SDK를 통한 빌링키 발급 요청 파라미터에는 displayAmount에 대한 통화를 지정할 수 있는 `currency` 파라미터가 존재합니다.
660
+ 웰컴페이먼츠는 `KRW`만 지원합니다.
661
+
662
+ </details>
663
+
664
+ <details>
665
+
666
+ <summary>카드사 다이렉트 호출을 지원하지 않습니다.</summary>
667
+
668
+ 웰컴페이먼츠 경우 카드사 다이렉트 호출을 통한 빌링키 발급을 지원하지 않습니다.
669
+ `card.cardCompany` 필드에 값을 채워도 빌링키 발급 동작에 아무런 영향을 미치지 않습니다.
670
+
671
+ </details>
672
+
673
+ ## SDK 휴대폰 빌링키 발급 및 결제 요청하기
674
+
675
+ 휴대폰 빌링키 발급 및 결제 요청 시에는 `requestIssueBillingKeyAndPay` 함수를 호출해야 합니다.
676
+ `channelKey` 파라미터에 결제 채널 연동 후 생성된 채널 키값을 지정하여 웰컴페이먼츠 채널 사용을 명시해주세요.
677
+
678
+ 웰컴페이먼츠 기준으로 작성한 예시 코드는 아래와 같습니다.
679
+
680
+ <div class="tabs-container">
681
+
682
+ <div class="tabs-content" data-title="SDK 빌링키 발급 요청">
683
+
684
+ ```javascript
685
+ import * as PortOne from "@portone/browser-sdk/v2";
686
+ function requestIssueBillingKeyAndPay() {
687
+ PortOne.requestIssueBillingKeyAndPay({
688
+ storeId: "store-4ff4af41-85e3-4559-8eb8-0d08a2c6ceec", // 고객사 storeId로 변경해주세요.
689
+ channelKey: "channel-key-3b37819a-1c72-4deb-a245-8c810af5403d", // 콘솔 결제 연동 화면에서 채널 연동 시 생성된 채널 키를 입력해주세요.
690
+ billingKeyAndPayMethod: "PHONE",
691
+ totalAmount: 1000,
692
+ currency: "KRW",
693
+ paymentId: "test-paymentId",
694
+ orderName: "test-orderName",
695
+ customer: {
696
+ fullName: "포트원",
697
+ phoneNumber: "010-0000-1234",
698
+ email: "test@portone.io",
699
+ },
700
+ });
701
+ }
702
+ ```
703
+
704
+ </div>
705
+
706
+ </div>
707
+
708
+ ### 주요 파라미터
709
+
710
+ <br />
711
+
712
+ - storeId: string
713
+
714
+ **상점 아이디**
715
+
716
+ 포트원 계정에 생성된 상점을 식별하는 고유한 값으로 관리자 콘솔에서 확인할 수 있습니다.
717
+
718
+ - channelKey: string
719
+
720
+ **채널 키**
721
+
722
+ 포트원 콘솔 내 \[결제연동] > \[채널관리] 화면에서 채널 추가 시 생성되는 값입니다. 결제 호출 시 채널을 지정할 때 사용됩니다.
723
+
724
+ - billingKeyAndPayMethod: string
725
+
726
+ **빌링키 발급 및 결제수단**
727
+
728
+ 웰컴페이먼츠는 빌링키 발급 및 결제 수단으로 휴대폰 소액 결제만을 지원하므로 해당 파라미터는 `PHONE`로 고정해야 합니다.
729
+
730
+ - paymentId: string
731
+
732
+ **빌링키 발급 및 결제 건 고유 ID**
733
+
734
+ - 고객사에서 채번하여 사용해야 합니다.
735
+ - 웰컴페이먼츠의 경우 필수 입력해야 합니다.
736
+
737
+ - orderName: string
738
+
739
+ **빌링키 발급 및 결제 시 결제창에 표시되는 제목**
740
+
741
+ - 웰컴페이먼츠의 경우 필수 입력해야 합니다.
742
+
743
+ - customer?: object
744
+
745
+ **고객 정보**
746
+
747
+ - fullName?: string
748
+
749
+ **구매자 전체 이름**
750
+
751
+ - 웰컴페이먼츠의 경우 fullName 혹은 (firstName + lastName)을 필수로 입력해야 합니다.
752
+
753
+ - phoneNumber?: string
754
+
755
+ **구매자 연락처**
756
+
757
+ - 웰컴페이먼츠의 경우 필수 입력해야 합니다.
758
+
759
+ - email?: string
760
+
761
+ **구매자 이메일**
762
+
763
+ - 웰컴페이먼츠의 경우 필수 입력해야 합니다.
764
+
765
+ - offerPeriod?: object
766
+
767
+ **제공 기간**
768
+
769
+ - 웰컴페이먼츠 모바일 빌링키 발급 및 결제의 경우 필수로 입력해야 합니다. (PC인 경우에는 optional)
770
+
771
+ ### 유의사항
772
+
773
+ <details>
774
+
775
+ <summary>PC와 모바일에서 파라미터 필수 여부가 상이합니다.</summary>
776
+
777
+ 위의 주요 파라미터 설명에도 안내되어 있듯이, PC 빌링키 발급 및 결제와 모바일 빌링키 발급 및 결제에서 필수 여부가 상이한 파라미터가 존재합니다.
778
+
779
+ 아래 필드들은 모바일에서는 필수이지만, PC에서는 선택입니다.
780
+
781
+ - `offerPeriod`
782
+
783
+ </details>
784
+
785
+ <details>
786
+
787
+ <summary>`paymentId` 에는 ASCII 문자만 허용됩니다.</summary>
788
+
789
+ `paymentId` 에는 ASCII 문자만으로 이루어진 문자열만 입력할 수 있습니다.
790
+
791
+ ASCII 문자에 포함되지 않는 한글이나 `♤`, `♡`, `♧` 등의 특수 문자는 허용되지 않습니다.
792
+
793
+ 입력 가능한 ASCII 문자의 종류는 [링크](http://www.ascii-code.com/) → `ASCII printable characters` 섹션을 참고하세요.
794
+
795
+ </details>
796
+
797
+ <details>
798
+
799
+ <summary>`productType` 파라미터는 필수 입력해야 합니다.</summary>
800
+
801
+ - 웰컴페이먼츠의 경우 **빌링키 발급 및 결제 시 상품 유형을 구분 짓는 `productType` 파라미터가 필수**로 입력해야 합니다.
802
+ - `productType`의 값은 `PRODUCT_TYPE_REAL` 또는 `PRODUCT_TYPE_DIGITAL`를 입력해야 합니다.
803
+
804
+ </details>
805
+
806
+ <details>
807
+
808
+ <summary>`offerPeriod` 파라미터 제약 사항</summary>
809
+
810
+ SDK를 통한 빌링키 발급 및 결제 요청 파라미터에는 제공 기간을 나타내는 `offerPeriod` 파라미터가 존재합니다.
811
+ 날짜 범위를 입력하는 방식(`range`)과 간격을 입력하는 방식(`interval`) 중 하나를 선택하여 입력할 수 있습니다.
812
+
813
+ - `range` 방식으로 입력할 경우 `from`과 `to` 모두를 입력하셔야 하, `from`은 `to`보다 과거 시간이어야 합니다.
814
+ - `interval` 방식으로 입력할 경우는 `1m` 또는 `1y`만 허용됩니다. `1m`를 입력할 경우 `월 정기결제`, `1y`를 입력할 경우 `연 정기결제` 로 빌링키 발급 및 결제 창에 노출됩니다.
815
+
816
+ </details>
817
+
818
+ <details>
819
+
820
+ <summary>웰컴페이먼츠에서 지원하지 않는 빌링키 발급 및 결제 파라미터</summary>
821
+
822
+ 웰컴페이먼츠의 경우 아래 파라미터들을 지원하지 않으며, 해당 파라미터들을 설정하더라도 결제 동작에 아무런 영향을 주지 않습니다.
823
+
824
+ - `locale`: 결제창 언어를 지정하기 위한 값
825
+ - `mobile.carrier`: 휴대폰 소액결제 통신사 바로 호출을 위한 통신사 구분 값
826
+ - `mobile.availableCarriers`: 빌링키 발급 및 결제창에 노출될 통신사 리스트
827
+
828
+ </details>
829
+
830
+ <details>
831
+
832
+ <summary>지원되는 결제 통화</summary>
833
+
834
+ SDK를 통한 빌링키 발급 및 결제 요청 파라미터에는 totalAmount에 대한 통화를 지정할 수 있는 `currency` 파라미터가 존재합니다.
835
+ 웰컴페이먼츠 빌링키 발급 및 결제의 경우, `KRW`만 지원합니다.
836
+
837
+ </details>
838
+
839
+ ## API 수기(키인)결제 요청하기
840
+
841
+ 수기(키인)로 결제하기 위해서는 `POST /payments/${PAYMENT_ID_HERE}/instant`를 이용하여 결제 요청을 해야합니다.
842
+
843
+ <div class="tabs-container">
844
+
845
+ <div class="tabs-content" data-title="API 수기(키인) 결제 요청">
846
+
847
+ ```javascript
848
+ // ... 수기(키인) 결제
849
+ const issueResponse = await axios({
850
+ url: `https://api.portone.io/payments/${PAYMENT_ID_HERE}/instant`,
851
+ method: "post",
852
+ headers: { Authorization: `PortOne ${PORTONE_API_SECRET}` },
853
+ data: {
854
+ channelKey: "channel-key-9987cb87-****-****-****-********896d", // 콘솔 결제 연동 화면에서 채널 연동 시 생성된 채널 키를 입력해주세요.
855
+ orderName: "나이키 와플 트레이너 2 SD",
856
+ amount: {
857
+ total: 10000,
858
+ },
859
+ currency: "KRW",
860
+ customer: {
861
+ name: {
862
+ full: "홍길동",
863
+ },
864
+ email: "test@test.com",
865
+ phoneNumber: "010-1234-0000",
866
+ },
867
+ method: {
868
+ virtualAccount: {
869
+ bank: `SHINHAN`,
870
+ expiry: {
871
+ dueDate: `2024-11-12T00:00:00+09+00`, //입금기한은 미래시간만 가능합니다.
872
+ },
873
+ cashReceipt: {
874
+ type: `PERSONAL`,
875
+ customerIdentityNumber: `010-1234-0000`,
876
+ },
877
+ remitteeName: `테스트`,
878
+ },
879
+ },
880
+ productCount: 1,
881
+ },
882
+ });
883
+ ```
884
+
885
+ </div>
886
+
887
+ </div>
888
+
889
+ ### 주요 파라미터
890
+
891
+ - paymentId: string
892
+
893
+ **고객사 주문 고유 번호**
894
+
895
+ 고객사에서 채번하는 주문 고유 번호로 매번 고유하게 채번되어야 합니다. 이미 승인 완료된 `paymentId`로 결제를 시도하는 경우 에러가 발생합니다.
896
+
897
+ - orderName: string
898
+
899
+ **주문명**
900
+
901
+ 주문명으로 고객사에서 자유롭게 입력합니다.
902
+
903
+ - channelKey: string
904
+
905
+ **채널 키**
906
+
907
+ 포트원 콘솔 내 \[결제연동] > \[채널관리] 화면에서 채널 추가 시 생성되는 값입니다. 결제 호출 시 채널을 지정할 때 사용됩니다.
908
+
909
+ - amount: object
910
+
911
+ **결제 금액**
912
+
913
+ - total: number
914
+
915
+ **총 결제 금액**
916
+
917
+ 결제 금액으로 결제를 원하는 통화(currency)별 scale factor(소수점 몇번째 자리까지 유효한지)를 고려한 number 형식만 허용됩니다.
918
+
919
+ - taxFree?: number
920
+
921
+ **면세액**
922
+
923
+ 결제 금액으로 결제를 원하는 통화(currency)별 scale factor(소수점 몇번째 자리까지 유효한지)를 고려한 number 형식만 허용됩니다.
924
+
925
+ - currency: string
926
+
927
+ **결제 통화**
928
+
929
+ 결제통화로 원화 결제 시 `KRW`로 입력해야 합니다.
930
+
931
+ - method: object
932
+
933
+ **결제수단 정보**
934
+
935
+ - virtualAccount?: object
936
+
937
+ **가상계좌 결제 시 파라미터**
938
+
939
+ - bank: string
940
+
941
+ **발급 은행**
942
+
943
+ - 은행코드는 ENUM으로 정의되어 있습니다.
944
+ - [BANK ENUM 바로가기](https://developers.portone.io/api/rest-v2/type-def#Bank)
945
+
946
+ - expiry: object
947
+
948
+ **입금 만료 기한**
949
+
950
+ - validHours?: integer
951
+
952
+ **유효 시간**
953
+
954
+ - dueDate?: string
955
+
956
+ **만료 시점**
957
+
958
+ 시간은 ISO8601 형식으로 입력해야 합니다.
959
+
960
+ - option: object
961
+
962
+ **가상계좌 발급 방식**
963
+
964
+ - type: string
965
+
966
+ **가상계좌 발급 유형**
967
+
968
+ 발급 유형은 ENUM으로 정의되어 있습니다.
969
+
970
+ - 회전식 가상계좌 : `NORMAL`
971
+ - 고정식 가상계좌 : `FIXED`
972
+ - 회전식 가상계좌는 일반적으로 사용되는 방식이며 PG사에서 직접 채번한 가상계좌번호를 사용합니다.
973
+
974
+ - fixed?: object
975
+
976
+ **고정식 가상계좌 발급 유형**
977
+
978
+ - accountNumber?: string
979
+
980
+ **고정식 가상계좌번호**
981
+
982
+ - PG사가 일정 개수만큼의 가상계좌번호를 발급하여 가맹점에게 미리 전달하고 가맹점이 그 중 하나를 선택하여 사용하는 방식입니다.
983
+ 웰컴페이먼츠에서는 해당 방식만 지원하고 있습니다.
984
+
985
+ - cashReceipt: object
986
+
987
+ **현금영수증 정보**
988
+
989
+ - type: string
990
+
991
+ **발급 유형**
992
+
993
+ 발급 유형은 ENUM으로 정의되어 있습니다.
994
+
995
+ - 소득공제용 : `PERSONAL`
996
+ - 지출증빙용 : `CORPORATE`
997
+ - 미발행 : `NO_RECEIPT`
998
+
999
+ - customerIdentityNumber: string
1000
+
1001
+ **현금영수증 식별 번호**
1002
+
1003
+ - 소득공제인 경우 주민등록번호 혹은 휴대폰 번호를 입력해야 합니다.
1004
+ - 지출증빙인 경우 사업자등록번호를 입력해야 합니다.
1005
+
1006
+ - remitteeName?: string
1007
+
1008
+ **예금주명**
1009
+
1010
+ - card?: object
1011
+
1012
+ - credential: object
1013
+
1014
+ **인증 관련 정보**
1015
+
1016
+ - number: string
1017
+
1018
+ **카드 번호**
1019
+
1020
+ - expiryYear: string
1021
+
1022
+ **유효 기간 만료 연도 (YY 형식 ex. 24)**
1023
+
1024
+ - expiryMonth: string
1025
+
1026
+ **유효기간 만료 월 (MM 형식 ex. 05)**
1027
+
1028
+ - birthOrBusinessRegistrationNumber?: string
1029
+
1030
+ **생년월일 또는 사업자 등록 번호**
1031
+
1032
+ - passwordTwoDigits?: string
1033
+
1034
+ **비밀번호 앞 두자리**
1035
+
1036
+ - customer?: object
1037
+
1038
+ **고객 정보**
1039
+
1040
+ - name: object
1041
+
1042
+ **고객 이름**
1043
+
1044
+ 웰컴페이먼츠의 경우 full 혹은 separated를 필수로 입력해야 합니다.
1045
+
1046
+ - full?: string
1047
+
1048
+ **한 줄 이름 형식 (ex. 김포트)**
1049
+
1050
+ - separated?: object
1051
+
1052
+ **분리된 이름**
1053
+
1054
+ - first: string
1055
+
1056
+ **이름**
1057
+
1058
+ - last: string
1059
+
1060
+ **성**
1061
+
1062
+ - phoneNumber: string
1063
+
1064
+ **구매자 연락처**
1065
+
1066
+ - 웰컴페이먼츠의 경우 필수로 입력해야 합니다.
1067
+
1068
+ - email: string
1069
+
1070
+ **구매자 이메일**
1071
+
1072
+ - 웰컴페이먼츠의 경우 필수로 입력해야 합니다.
1073
+
1074
+ - productCount?: integer
1075
+
1076
+ **상품 개수**
1077
+
1078
+ ## API 빌링키 발급 요청하기
1079
+
1080
+ 빌링키를 발급하기 위해서는 `POST /billing-keys`를 이용하여 빌링키 발급 요청을 해야합니다.
1081
+
1082
+ 웰컴페이먼츠 기준으로 작성한 예시 코드는 아래와 같습니다.
1083
+
1084
+ <div class="tabs-container">
1085
+
1086
+ <div class="tabs-content" data-title="API 빌링키 발급 요청">
1087
+
1088
+ ```javascript
1089
+ const issueResponse = await axios({
1090
+ url: "https://api.portone.io/billing-keys",
1091
+ method: "post",
1092
+ headers: { Authorization: `PortOne ${PORTONE_API_SECRET}` },
1093
+ data: {
1094
+ channelKey: "channel-key-9987cb87-****-****-****-********896d", // 콘솔 결제 연동 화면에서 채널 연동 시 생성된 채널 키를 입력해주세요.
1095
+ customer: {
1096
+ id: "customer-1234", // 고객사에서 관리하는 고객 고유번호
1097
+ },
1098
+ method: {
1099
+ card: {
1100
+ credential: {
1101
+ number: "1111111111111111",
1102
+ expiryMonth: "01",
1103
+ expiryYear: "20",
1104
+ birthOrBusinessRegistrationNumber: "900101",
1105
+ passwordTwoDigits: "00",
1106
+ },
1107
+ },
1108
+ },
1109
+ },
1110
+ });
1111
+ ```
1112
+
1113
+ </div>
1114
+
1115
+ </div>
1116
+
1117
+ ### 주요 파라미터
1118
+
1119
+ - channelKey: string
1120
+
1121
+ **채널 키**
1122
+
1123
+ 포트원 콘솔 내 \[결제연동] > \[채널관리] 화면에서 채널 추가 시 생성되는 값입니다. 결제 호출 시 채널을 지정할 때 사용됩니다.
1124
+
1125
+ - method: object
1126
+
1127
+ **결제수단 정보**
1128
+
1129
+ - card?: object
1130
+
1131
+ - credential: object
1132
+
1133
+ **인증 관련 정보**
1134
+
1135
+ - number: string
1136
+
1137
+ **카드 번호**
1138
+
1139
+ - expiryYear: string
1140
+
1141
+ **유효 기간 만료 연도 (YY 형식 ex. 24)**
1142
+
1143
+ - expiryMonth: string
1144
+
1145
+ **유효기간 만료 월 (MM 형식 ex. 05)**
1146
+
1147
+ - birthOrBusinessRegistrationNumber?: string
1148
+
1149
+ **생년월일 또는 사업자 등록 번호**
1150
+
1151
+ - passwordTwoDigits?: string
1152
+
1153
+ **비밀번호 앞 두자리**
1154
+
1155
+ - customer: object
1156
+
1157
+ **고객 정보**
1158
+
1159
+ - name: object
1160
+
1161
+ **고객 이름**
1162
+
1163
+ 웰컴페이먼츠의 경우 full 혹은 separated를 필수로 입력해야 합니다.
1164
+
1165
+ - full?: string
1166
+
1167
+ **한 줄 이름 형식 (ex. 김포트)**
1168
+
1169
+ - separated?: object
1170
+
1171
+ **분리된 이름**
1172
+
1173
+ - first: string
1174
+
1175
+ **이름**
1176
+
1177
+ - last: string
1178
+
1179
+ **성**
1180
+
1181
+ - phoneNumber: string
1182
+
1183
+ **구매자 연락처**
1184
+
1185
+ - 웰컴페이먼츠의 경우 필수로 입력해야 합니다.
1186
+
1187
+ - email: string
1188
+
1189
+ **구매자 이메일**
1190
+
1191
+ - 웰컴페이먼츠의 경우 필수로 입력해야 합니다.
1192
+
1193
+ ## API 빌링키 단건 결제 요청하기
1194
+
1195
+ 발급된 빌링키로 단건 결제를 하기 위해 `POST /payments/${PAYMENT_ID_HERE}/billing-key`를 이용하여 결제를 요청합니다.
1196
+
1197
+ 웰컴페이먼츠 기준으로 작성한 예시 코드는 아래와 같습니다.
1198
+
1199
+ <div class="tabs-container">
1200
+
1201
+ <div class="tabs-content" data-title="API 예약/반복 결제">
1202
+
1203
+ ```ts
1204
+ const response = await axios({
1205
+ url: `https://api.portone.io/payments/${PAYMENT_ID_HERE}/billing-key`,
1206
+ method: "post",
1207
+ headers: { Authorization: `PortOne ${PORTONE_API_SECRET}` },
1208
+ data: {
1209
+ billingKey: "billing-key-1", // 빌링키 발급 API를 통해 발급받은 빌링키
1210
+ orderName: "월간 이용권 정기결제",
1211
+ customer: {
1212
+ id: "customer-1234", // 고객사에서 관리하는 고객 고유번호
1213
+ phoneNumber: `010-1234-5678`,
1214
+ email: `test@test.com`,
1215
+ },
1216
+ amount: {
1217
+ total: 10000,
1218
+ },
1219
+ currency: "KRW",
1220
+ productCount: 1,
1221
+ },
1222
+ });
1223
+ ```
1224
+
1225
+ </div>
1226
+
1227
+ </div>
1228
+
1229
+ ### 주요 파라미터
1230
+
1231
+ - paymentId: string
1232
+
1233
+ **결제 주문 번호**
1234
+
1235
+ - 고객사에서 채번하여 사용하는 주문번호로 고유한 값이여야 합니다.
1236
+ - URL path에 포함하여 요청해야 합니다.
1237
+
1238
+ - billingKey: string
1239
+
1240
+ **빌링키 결제에 사용할 빌링키**
1241
+
1242
+ - orderName: string
1243
+
1244
+ **주문명**
1245
+
1246
+ - amount: object
1247
+
1248
+ **결제 금액**
1249
+
1250
+ - total: number
1251
+
1252
+ **총 결제 금액**
1253
+
1254
+ 결제 금액으로 결제를 원하는 통화(currency)별 scale factor(소수점 몇번째 자리까지 유효한지)를 고려한 number 형식만 허용됩니다.
1255
+
1256
+ - taxFree?: number
1257
+
1258
+ **면세액**
1259
+
1260
+ 결제 금액으로 결제를 원하는 통화(currency)별 scale factor(소수점 몇번째 자리까지 유효한지)를 고려한 number 형식만 허용됩니다.
1261
+
1262
+ - currency: string
1263
+
1264
+ **결제 통화**
1265
+
1266
+ 결제통화로 원화 결제 시 `KRW`로 입력해야 합니다.
1267
+
1268
+ - customer: object
1269
+
1270
+ **고객 정보**
1271
+
1272
+ - name: object
1273
+
1274
+ **고객 이름**
1275
+
1276
+ 웰컴페이먼츠의 경우 full 혹은 separated를 필수로 입력해야 합니다.
1277
+
1278
+ - full?: string
1279
+
1280
+ **한 줄 이름 형식 (ex. 김포트)**
1281
+
1282
+ - phoneNumber: string
1283
+
1284
+ **구매자 연락처**
1285
+
1286
+ - 웰컴페이먼츠의 경우 필수로 입력해야 합니다.
1287
+
1288
+ - email: string
1289
+
1290
+ **구매자 이메일**
1291
+
1292
+ - 웰컴페이먼츠의 경우 필수로 입력해야 합니다.
1293
+
1294
+ - productCount?: integer
1295
+
1296
+ **상품 개수**
1297
+
1298
+ ## API 빌링키 예약/반복 결제 요청하기
1299
+
1300
+ 예약 결제를 하기 위해서는 `POST /payments/${PAYMENT_ID_HERE}/schedule` 를 이용하여 결제를 예약합니다.
1301
+
1302
+ 웰컴페이먼츠 기준으로 작성한 예시 코드는 아래와 같습니다.
1303
+
1304
+ <div class="tabs-container">
1305
+
1306
+ <div class="tabs-content" data-title="API 예약/반복 결제">
1307
+
1308
+ ```ts
1309
+ const response = await axios({
1310
+ url: `https://api.portone.io/payments/${PAYMENT_ID_HERE}/schedule`,
1311
+ method: "post",
1312
+ headers: { Authorization: `PortOne ${PORTONE_API_SECRET}` },
1313
+ data: {
1314
+ payment: {
1315
+ billingKey: "billing-key-1", // 빌링키 발급 API를 통해 발급받은 빌링키
1316
+ orderName: "월간 이용권 정기결제",
1317
+ customer: {
1318
+ id: "customer-1234", // 고객사에서 관리하는 고객 고유번호
1319
+ },
1320
+ amount: {
1321
+ total: 10000,
1322
+ },
1323
+ currency: "KRW",
1324
+ },
1325
+ timeToPay: "2023-01-01 00:00:00", // 결제를 시도할 시각
1326
+ },
1327
+ });
1328
+ ```
1329
+
1330
+ </div>
1331
+
1332
+ </div>
1333
+
1334
+ ### 주요 파라미터
1335
+
1336
+ - paymentId: string
1337
+
1338
+ **결제 주문 번호**
1339
+
1340
+ - 고객사에서 채번하여 사용하는 주문번호로 고유한 값이여야 합니다.
1341
+ - URL path에 포함하여 요청해야 합니다.
1342
+
1343
+ - payment: object
1344
+
1345
+ **빌링키 결제 요청 입력정보**
1346
+
1347
+ - billingKey: string
1348
+
1349
+ **빌링키 결제에 사용할 빌링키**
1350
+
1351
+ - orderName: string
1352
+
1353
+ **주문명**
1354
+
1355
+ - amount: object
1356
+
1357
+ **결제 금액**
1358
+
1359
+ - total: number
1360
+
1361
+ **총 결제 금액**
1362
+
1363
+ 결제 금액으로 결제를 원하는 통화(currency)별 scale factor(소수점 몇번째 자리까지 유효한지)를 고려한 number 형식만 허용됩니다.
1364
+
1365
+ - taxFree?: number
1366
+
1367
+ **면세액**
1368
+
1369
+ 결제 금액으로 결제를 원하는 통화(currency)별 scale factor(소수점 몇번째 자리까지 유효한지)를 고려한 number 형식만 허용됩니다.
1370
+
1371
+ - currency: string
1372
+
1373
+ **결제 통화**
1374
+
1375
+ 결제통화로 원화 결제 시 `KRW`로 입력해야 합니다.
1376
+
1377
+ - timeToPay: string
1378
+
1379
+ **결제 예정 시점**
1380
+
1381
+ - customer: object
1382
+
1383
+ **고객 정보**
1384
+
1385
+ - name: object
1386
+
1387
+ **고객 이름**
1388
+
1389
+ 웰컴페이먼츠의 경우 full 혹은 separated를 필수로 입력해야 합니다.
1390
+
1391
+ - full?: string
1392
+
1393
+ **한 줄 이름 형식 (ex. 김포트)**
1394
+
1395
+ - phoneNumber: string
1396
+
1397
+ **구매자 연락처**
1398
+
1399
+ - 웰컴페이먼츠의 경우 필수로 입력해야 합니다.
1400
+
1401
+ - email: string
1402
+
1403
+ **구매자 이메일**
1404
+
1405
+ - 웰컴페이먼츠의 경우 필수로 입력해야 합니다.
1406
+
1407
+ ### 유의사항
1408
+
1409
+ #### 공통
1410
+
1411
+ <details>
1412
+
1413
+ <summary>웰컴페이먼츠 필수 파라미터</summary>
1414
+
1415
+ 웰컴페이먼츠의 경우에는 키인(수기)결제, 빌링키 발급, 빌링키 단건 결제 시 아래의 파라미터를 필수로 입력해야 합니다.
1416
+
1417
+ - `customer.name.full` 혹은 `customer.name.separated`
1418
+ - `customer.phoneNumber`
1419
+ - `customer.email`
1420
+
1421
+ </details>
1422
+
1423
+ #### 에스크로
1424
+
1425
+ <details>
1426
+
1427
+ <summary>웰컴페이먼츠에서 에스크로 배송 등록시 필수 파라미터</summary>
1428
+
1429
+ 웰컴페이먼츠의 경우 에스크로 배송 등록 시 아래의 파라미터를 필수로 입력해야 합니다.
1430
+
1431
+ - `sender.name`
1432
+ - `sender.phoneNumber`
1433
+ - `sender.zipcode`
1434
+ - `sender.address`
1435
+ - `receiver.name`
1436
+ - `receiver.phoneNumber`
1437
+ - `receiver.zipcode`
1438
+ - `receiver.address`
1439
+ - `products`
1440
+
1441
+ </details>