{"title":"Set up in-person payments","category":"default","creationDate":1673954280,"content":"<p>Our plugin for Adobe Commerce allows you to process both online and in-person payments, offering a consistent shopper experience regardless of their location or device. You can manage all orders in the Adobe Commerce admin panel, and get a detailed insight into your shopper behavior in the Adyen\u00a0<a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/p>\n<p>For an overview of supported payment terminals, refer to <a href=\"\/pt\/point-of-sale\/what-we-support\/select-your-terminals\">Select your terminals<\/a>.<\/p>\n<h2 id=\"before-you-begin\">Requirements<\/h2>\n<p>Set up a separate merchant account for processing in-person payments. For more information about Adyen account structure, refer to\u00a0<a href=\"\/pt\/account\/account-structure\">Company and merchant accounts<\/a>.<\/p>\n<h2 id=\"step-1-generate-an-api-key\">Step 1: Generate an API key<\/h2>\n<p>For authenticating API requests from your Adobe Commerce platform, you need to provide an API key.<\/p>\n<p>To generate an API Key:<\/p>\n<ol>\n<li>Log in to your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a> and select your <strong>Company<\/strong> account.<\/li>\n<li>Go to <strong>Developers<\/strong> &gt; <strong>API credentials<\/strong>.<\/li>\n<li>Select the <strong>Payments<\/strong> or <strong>Platforms<\/strong> tab, depending on your integration type.<\/li>\n<li>Select the credential username.<\/li>\n<li>Under <strong>Server settings<\/strong> &gt; <strong>Authentication<\/strong> select the <strong>API key<\/strong> tab.<\/li>\n<li>Select <strong>Generate API key<\/strong>.<\/li>\n<li>Select the copy icon <i class=\"adl-icon-copy\"><\/i> and store your API key securely in your system.\n<div class=\"notices yellow\">\n<p>You cannot copy the API key again after you leave the page.<\/p>\n<\/div><\/li>\n<li>Select <strong>Save changes<\/strong>.<\/li>\n<\/ol>\n<p>You will need the API key later when <a href=\"#step-4-set-up-the-plugin-in-adobe-commerce\">configuring the plugin in Adobe Commerce<\/a>.<\/p>\n<div class=\"notices yellow\">\n<p>Before going live, make sure that your API credential has the <strong>Merchant PAL webservice role<\/strong>. If you need to enable this role, contact our <a href=\"https:\/\/ca-test.adyen.com\/ca\/ca\/contactUs\/support.shtml?form=other\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Support Team<\/a>.<\/p>\n<\/div>\n<h2 id=\"step-2-set-up-capture-delay\">Step 2: Set up capture delay<\/h2>\n<p>For all\u00a0<a href=\"\/pt\/payment-methods\">cards<\/a>, in-person payments are completed in two steps:\u00a0<\/p>\n<ol>\n<li>Authorisation\u00a0\u2013 The payment details of the shopper are verified and the funds are reserved.<\/li>\n<li>Capture\u00a0\u2013\u00a0 The reserved funds are transferred from the shopper to your account.\u00a0<\/li>\n<\/ol>\n<p>For payment methods that support separate authorisation and capture, you can specify a delay between authorisation and capture. This allows you to\u00a0handle cases where the shopper changes their mind about the purchase.<\/p>\n<div class=\"sc-notice info\"><div>\n<p>The capture delay setting does not affect Alipay, WeChatPay, and some other wallets, as these payment methods are always completed in one step.<\/p>\n<\/div><\/div>\n<h3 id=\"set-up-capture-delay-in-the-adyen-customer-area\">Set up capture delay in the Adyen Customer Area<\/h3>\n<ol>\n<li>\n<p>Log in to the <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">test Customer Area<\/a>\u00a0with your merchant account.<\/p>\n<\/li>\n<li>\n<p>Go to\u00a0<strong>Settings<\/strong>\u00a0&gt;\u00a0<strong>Account settings<\/strong>.<\/p>\n<\/li>\n<li>\n<p>On the\u00a0<strong>POS\u00a0Capture Delay\u00a0<\/strong>drop-down menu, select the capture delay that you want to use.\u00a0<\/p>\n<\/li>\n<li>\n<p>Possible values:<\/p>\n<ul>\n<li>\n<p><strong>immediate<\/strong>: Capture is performed immediately after authorisation.<\/p>\n<\/li>\n<li>\n<p><strong>[N] minutes\/hours\/days<\/strong>: Capture is performed\u00a0[N] minutes\/hours\/days\u00a0after authorisation.\u00a0<\/p>\n<div class=\"sc-notice info\"><div>\n<p>We\u00a0recommend that you set a capture delay of\u00a0<strong>2 hours<\/strong>, for cases\u00a0where the shopper changes their mind about the purchase.\u00a0<\/p>\n<\/div><\/div>\n<\/li>\n<li>\n<p><strong>manual<\/strong>:\u00a0You need to capture each payment manually by creating an invoice in Adobe Commerce. This is useful if you\u00a0wish to perform a partial capture\u00a0in case some\u00a0goods can not be delivered to the shopper.<\/p>\n<div class=\"sc-notice note\"><div>\n<p>When you capture a part of the authorised amount, the rest of the authorised amount is automatically cancelled.<\/p>\n<\/div><\/div>\n<\/li>\n<\/ul>\n<\/li>\n<li>\n<p>Click\u00a0<strong>Submit<\/strong>.<\/p>\n<\/li>\n<\/ol>\n<h2 id=\"step-3-set-up-the-terminal-configuration\">Step 3: Set up the terminal configuration<\/h2>\n<div class=\"additional-info-block output-inline\">\n<div class=\"additional-info-block__body\"><h5 id=\"user-roles\">User roles<\/h5><p>For account configuration, you need to have the <em>Merchant POS Terminal Management Admin role<\/em>. For more information, refer to <a href=\"\/pt\/account\/user-roles\">User roles<\/a>.<\/p><\/div><\/div>\n\n<ol>\n<li>Log in to the \u00a0<a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">test Customer Area<\/a>\u00a0with your company account.<\/li>\n<li>Go to\u00a0<strong>In-person payments<\/strong> &gt; <strong>Payment devices<\/strong>, and select the <strong>Terminals<\/strong> tab..<\/li>\n<li>In the actions menu next to the search box, select\u00a0<strong>Account configuration<\/strong>.<\/li>\n<li>Click the\u00a0<strong>Terminal\u00a0API<\/strong>\u00a0tab.<\/li>\n<li>Set\u00a0<strong>Enable Terminal API<\/strong>\u00a0to\u00a0<strong>Yes<\/strong>.<\/li>\n<li>Set\u00a0<strong>Enable WebSockets<\/strong>\u00a0to\u00a0<strong>Yes<\/strong>.<\/li>\n<\/ol>\n<h2 id=\"step-4-set-up-the-plugin-in-adobe-commerce\">Step 4: Set up in-person payments in Adobe Commerce<\/h2>\n<ol>\n<li>Log in to your Adobe Commerce admin panel.\u00a0<\/li>\n<li>In the left navigation bar, go to\u00a0<strong>Stores<\/strong>\u00a0&gt;\u00a0<strong>Configuration<\/strong>.\u00a0<\/li>\n<li>On the menu, go to\u00a0<strong>Sales<\/strong>\u00a0&gt;\u00a0<strong>Payment Methods<\/strong>.<\/li>\n<li>Select <strong>Configure<\/strong> next to <strong>Adyen Payments<\/strong>.<\/li>\n<li>Go to the\u00a0<strong>In-person payments<\/strong> section,\u00a0and fill out the following fields:\u00a0<\/li>\n<\/ol>\n<table>\n<thead>\n<tr>\n<th>Field<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><strong>Enabled<\/strong><\/td>\n<td>Select <strong>Yes<\/strong> to enable this payment method.<\/td>\n<\/tr>\n<tr>\n<td><strong>Title<\/strong><\/td>\n<td>The title that indicates the POS payment method during checkout.<\/td>\n<\/tr>\n<tr>\n<td><strong>Sort Order<\/strong><\/td>\n<td>The\u00a0position of the POS payment method during checkout.\u00a0<\/td>\n<\/tr>\n<tr>\n<td><strong>Merchant Account for POS terminal<\/strong><\/td>\n<td>Name of your Adyen merchant account that is used to process POS payments.<\/td>\n<\/tr>\n<tr>\n<td><strong>Terminal Store ID<\/strong><\/td>\n<td>(Optional) Limit the terminal selection to a specific store in that merchant account.<\/td>\n<\/tr>\n<tr>\n<td><strong>API key for TEST<\/strong><\/td>\n<td>Your API key from the <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">test Customer Area<\/a>.<\/td>\n<\/tr>\n<tr>\n<td><strong>API key for LIVE<\/strong><\/td>\n<td>Your API key from the <a href=\"https:\/\/ca-live.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">live Customer Area<\/a>.<\/td>\n<\/tr>\n<tr>\n<td><strong>Capture Delay<\/strong><\/td>\n<td>The capture delay that you set in the Customer Area.<\/td>\n<\/tr>\n<tr>\n<td><strong>Enable Installments<\/strong><\/td>\n<td>Select <strong>Yes<\/strong> to enable installments for credit card payments. When enabled, use the <strong>Installments<\/strong> field to add installment rules that specify a <strong>Minimum Amount<\/strong> and <strong>Number Of Installments<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td><strong>Order Creation Time<\/strong><\/td>\n<td>The order creation time after the shopper selects <strong>Place order<\/strong>. Set to <strong>After payment<\/strong> by default. If you want orders to be created before a payment request is initiated, set to <strong>Before payment<\/strong>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<ol start=\"6\">\n<li>Select <strong>Save Config<\/strong> in the upper right corner.<\/li>\n<\/ol>\n<h2 id=\"step-5-optional-set-up-recurring-payments\">Step 5 (optional): Set up recurring payments<\/h2>\n<p>To set up <a href=\"\/pt\/point-of-sale\/recurring-payments\">recurring payments<\/a>:<\/p>\n<ol>\n<li>Log in to your Adobe Commerce admin panel, and go to <strong>Stores<\/strong> &gt; <strong>Configuration<\/strong>.<\/li>\n<li>In the menu, go to <strong>Sales<\/strong> &gt; <strong>Payment Methods<\/strong>.<\/li>\n<li>Select <strong>Configure<\/strong> next to <strong>Adyen Payments<\/strong>.<\/li>\n<li>Go to <strong>Payment Optimization<\/strong> &gt; <strong>Tokenization<\/strong> and fill in the following fields for the <strong>In-person payments<\/strong> field:<\/li>\n<\/ol>\n<table>\n<thead>\n<tr>\n<th>Field<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><strong>Payment method<\/strong><\/td>\n<td><strong>In-person payments<\/strong><\/td>\n<\/tr>\n<tr>\n<td><strong>Enable<\/strong><\/td>\n<td>Select <strong>Yes<\/strong> to enable tokenization for in-person payments.<\/td>\n<\/tr>\n<tr>\n<td><strong>Recurring Processing Model<\/strong><\/td>\n<td>Set to <strong>CardOnFile<\/strong>, <strong>UnscheduledCardOnFile<\/strong>, or <strong>Subscription<\/strong> depending on <a href=\"https:\/\/help.adyen.com\/knowledge\/ecommerce-integrations\/tokenization\/how-to-choose-recurring-processing-model\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">how you want to use tokenization<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<ol start=\"5\">\n<li>Select <strong>Save Config<\/strong> in the upper right corner.<\/li>\n<\/ol>\n<h2 id=\"see-also\">See also<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/point-of-sale\"\n                        target=\"_self\"\n                        >\n                    Terminal API\n                <\/a><\/li><li><a href=\"\/account\/account-structure\"\n                        target=\"_self\"\n                        >\n                    Company and merchant accounts\n                <\/a><\/li><li><a href=\"\/online-payments\/classic-integrations\/classic-api-integration\/tokenization\"\n                        target=\"_self\"\n                        >\n                    Recurring payments\n                <\/a><\/li><li><a href=\"\/payment-methods\"\n                        target=\"_self\"\n                        >\n                    Payment methods\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/plugins\/adobe-commerce\/set-up-in-person-payments","articleFields":{"id":"42853520","type":"page","_expandable":{"operations":""},"status":"current","description":"Use our Adobe Commerce plugin to process in-person payments with our terminal API.\u00a0","last_edit_on":"24-04-2024 14:14","feedback_component":true,"filters_component":false,"decision_tree":"[]","page_id":"13f7414e-82c4-4458-aa4c-71523f28d5b4"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/plugins\/adobe-commerce\/set-up-in-person-payments","title":"Set up in-person payments","content":"Our plugin for Adobe Commerce allows you to process both online and in-person payments, offering a consistent shopper experience regardless of their location or device. You can manage all orders in the Adobe Commerce admin panel, and get a detailed insight into your shopper behavior in the Adyen\u00a0Customer Area.\nFor an overview of supported payment terminals, refer to Select your terminals.\nRequirements\nSet up a separate merchant account for processing in-person payments. For more information about Adyen account structure, refer to\u00a0Company and merchant accounts.\nStep 1: Generate an API key\nFor authenticating API requests from your Adobe Commerce platform, you need to provide an API key.\nTo generate an API Key:\n\nLog in to your Customer Area and select your Company account.\nGo to Developers &gt; API credentials.\nSelect the Payments or Platforms tab, depending on your integration type.\nSelect the credential username.\nUnder Server settings &gt; Authentication select the API key tab.\nSelect Generate API key.\nSelect the copy icon  and store your API key securely in your system.\n\nYou cannot copy the API key again after you leave the page.\n\nSelect Save changes.\n\nYou will need the API key later when configuring the plugin in Adobe Commerce.\n\nBefore going live, make sure that your API credential has the Merchant PAL webservice role. If you need to enable this role, contact our Support Team.\n\nStep 2: Set up capture delay\nFor all\u00a0cards, in-person payments are completed in two steps:\u00a0\n\nAuthorisation\u00a0\u2013 The payment details of the shopper are verified and the funds are reserved.\nCapture\u00a0\u2013\u00a0 The reserved funds are transferred from the shopper to your account.\u00a0\n\nFor payment methods that support separate authorisation and capture, you can specify a delay between authorisation and capture. This allows you to\u00a0handle cases where the shopper changes their mind about the purchase.\n\nThe capture delay setting does not affect Alipay, WeChatPay, and some other wallets, as these payment methods are always completed in one step.\n\nSet up capture delay in the Adyen Customer Area\n\n\nLog in to the test Customer Area\u00a0with your merchant account.\n\n\nGo to\u00a0Settings\u00a0&gt;\u00a0Account settings.\n\n\nOn the\u00a0POS\u00a0Capture Delay\u00a0drop-down menu, select the capture delay that you want to use.\u00a0\n\n\nPossible values:\n\n\nimmediate: Capture is performed immediately after authorisation.\n\n\n[N] minutes\/hours\/days: Capture is performed\u00a0[N] minutes\/hours\/days\u00a0after authorisation.\u00a0\n\nWe\u00a0recommend that you set a capture delay of\u00a02 hours, for cases\u00a0where the shopper changes their mind about the purchase.\u00a0\n\n\n\nmanual:\u00a0You need to capture each payment manually by creating an invoice in Adobe Commerce. This is useful if you\u00a0wish to perform a partial capture\u00a0in case some\u00a0goods can not be delivered to the shopper.\n\nWhen you capture a part of the authorised amount, the rest of the authorised amount is automatically cancelled.\n\n\n\n\n\nClick\u00a0Submit.\n\n\nStep 3: Set up the terminal configuration\n\nUser rolesFor account configuration, you need to have the Merchant POS Terminal Management Admin role. For more information, refer to User roles.\n\n\nLog in to the \u00a0test Customer Area\u00a0with your company account.\nGo to\u00a0In-person payments &gt; Payment devices, and select the Terminals tab..\nIn the actions menu next to the search box, select\u00a0Account configuration.\nClick the\u00a0Terminal\u00a0API\u00a0tab.\nSet\u00a0Enable Terminal API\u00a0to\u00a0Yes.\nSet\u00a0Enable WebSockets\u00a0to\u00a0Yes.\n\nStep 4: Set up in-person payments in Adobe Commerce\n\nLog in to your Adobe Commerce admin panel.\u00a0\nIn the left navigation bar, go to\u00a0Stores\u00a0&gt;\u00a0Configuration.\u00a0\nOn the menu, go to\u00a0Sales\u00a0&gt;\u00a0Payment Methods.\nSelect Configure next to Adyen Payments.\nGo to the\u00a0In-person payments section,\u00a0and fill out the following fields:\u00a0\n\n\n\n\nField\nDescription\n\n\n\n\nEnabled\nSelect Yes to enable this payment method.\n\n\nTitle\nThe title that indicates the POS payment method during checkout.\n\n\nSort Order\nThe\u00a0position of the POS payment method during checkout.\u00a0\n\n\nMerchant Account for POS terminal\nName of your Adyen merchant account that is used to process POS payments.\n\n\nTerminal Store ID\n(Optional) Limit the terminal selection to a specific store in that merchant account.\n\n\nAPI key for TEST\nYour API key from the test Customer Area.\n\n\nAPI key for LIVE\nYour API key from the live Customer Area.\n\n\nCapture Delay\nThe capture delay that you set in the Customer Area.\n\n\nEnable Installments\nSelect Yes to enable installments for credit card payments. When enabled, use the Installments field to add installment rules that specify a Minimum Amount and Number Of Installments.\n\n\nOrder Creation Time\nThe order creation time after the shopper selects Place order. Set to After payment by default. If you want orders to be created before a payment request is initiated, set to Before payment.\n\n\n\n\nSelect Save Config in the upper right corner.\n\nStep 5 (optional): Set up recurring payments\nTo set up recurring payments:\n\nLog in to your Adobe Commerce admin panel, and go to Stores &gt; Configuration.\nIn the menu, go to Sales &gt; Payment Methods.\nSelect Configure next to Adyen Payments.\nGo to Payment Optimization &gt; Tokenization and fill in the following fields for the In-person payments field:\n\n\n\n\nField\nDescription\n\n\n\n\nPayment method\nIn-person payments\n\n\nEnable\nSelect Yes to enable tokenization for in-person payments.\n\n\nRecurring Processing Model\nSet to CardOnFile, UnscheduledCardOnFile, or Subscription depending on how you want to use tokenization.\n\n\n\n\nSelect Save Config in the upper right corner.\n\nSee also\n\n\n                    Terminal API\n                \n                    Company and merchant accounts\n                \n                    Recurring payments\n                \n                    Payment methods\n                \n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Plugins","lvl2":"Adobe Commerce","lvl3":"Set up in-person payments"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/plugins","lvl2":"https:\/\/docs.adyen.com\/pt\/plugins\/adobe-commerce","lvl3":"\/pt\/plugins\/adobe-commerce\/set-up-in-person-payments"},"levels":4,"category":"Plugins","category_color":"green","tags":["in-person","payments"]}}
