This page describes the in-person payments setup for v8 of the plugin. If you are using v9.0.1 or later, see the newer documentation.
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 Customer Area.
For an overview of supported payment terminals, refer to Select your terminals.
Before you begin
Set up a separate merchant account for processing in-person payments. For more information about Adyen account structure, refer to Company and merchant accounts.
Step 1: Generate an API key
For authenticating API requests from your Adobe Commerce platform, you need to provide an API key.
To generate an API Key:
- Log in to your Customer Area.
- Go to Developers > API credentials, and select the API credential username for your integration, for example ws@Company.[YourCompanyAccount].
- Under Server settings > Authentication select the API key tab.
- Select Generate API key.
- Select the copy icon and store your API key securely in your system.
- Select Save changes.
You will need the API key later when configuring the plugin in Adobe Commerce.
Before 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.
Step 2: Set up capture delay
For all cards, in-person payments are completed in two steps:
- Authorisation – The payment details of the shopper are verified and the funds are reserved.
- Capture – The reserved funds are transferred from the shopper to your account.
For payment methods that support separate authorisation and capture, you can specify a delay between authorisation and capture. This allows you to handle cases where the shopper changes their mind about the purchase.
The capture delay setting does not affect Alipay, WeChatPay, and some other wallets, as these payment methods are always completed in one step.
Set up capture delay in the Adyen Customer Area
Log in to the test Customer Area with your merchant account.
Go to Settings > Account settings.
On the POS Capture Delay drop-down menu, select the capture delay that you want to use.
immediate: Capture is performed immediately after authorisation.
[N] minutes/hours/days: Capture is performed [N] minutes/hours/days after authorisation.
We recommend that you set a capture delay of 2 hours, for cases where the shopper changes their mind about the purchase.
manual: You need to capture each payment manually by creating an invoice in Adobe Commerce. This is useful if you wish to perform a partial capture in case some goods can not be delivered to the shopper.
When you capture a part of the authorised amount, the rest of the authorised amount is automatically cancelled.
Step 3: Set up the terminal configuration
For account configuration, you need to have the Merchant POS Terminal Management Admin role. For more information, refer to User roles.
- Log in to the test Customer Area with your company account.
- Go to In-person payments > Terminals.
- In the actions menu next to the search box, select Account configuration.
- Click the Terminal API tab.
- Set Enable Terminal API to Yes.
- Set Enable WebSockets to Yes.
Step 4: Set up the plugin in Adobe Commerce
Log in to your Adobe Commerce admin panel.
In the left navigation bar, go to Stores > Configuration.
On the menu, go to Sales > Payment Methods.
Go to the Point of Sale (POS) Terminal Payment section, and fill out the following fields:
|Select Yes to enable this payment method.
|The title that indicates the POS payment method during checkout.
|The position of the POS payment method during checkout.
|Merchant Account for POS terminal
|Name of your Adyen merchant account that is used to process POS payments.
|(Optional) The type of recurring contract that you set in Adyen Customer Area.
|Terminal Store ID
|(Optional) Limit the terminal selection to a specific store in that merchant account.
|API key for TEST
|Your API key from Adyen test Customer Area
|API key for LIVE
|Your API key from Adyen live Customer Area.
|The capture delay that you set in Adyen Customer Area.
|Payment from Applicable countries
|(Optional) Specify a list of countries where the POS payment method will be shown during self-service checkout.
Step 5 (optional): Set up recurring payments
If you want to save the payment details of a POS shopper, you need to choose the type of recurring contract that you want to use:
For more information about recurring transaction types, refer to Recurring payments.
- In your Adobe Commerce admin panel, go to the Point of Sale (POS) Terminal Payment section.
- Set Agreement type to the type of the recurring contract that you want to use. Possible values:
- NONE – Do not enable stored payment methods.
- ONECLICK – Enable stored payment methods for one-click transactions, where the shopper needs to enter their CVC/CVV to complete the payment.
- RECURRING – Enable stored payment methods for recurring transactions, where you can complete the payment without the shopper being present.
- ONECLICK, RECURRING – Enable stored payment methods for both one-click and recurring transactions.