Set up point of sale

Supported terminals

For a list of supported terminals, refer to our Terminal API Integration Overview.

Adyen's Terminal API allows you  to accept in-store payments from point-of-sale (POS) terminals. 

Each terminal is connected to Magento over the internet, so you can initiate a payment on the terminal, and manage orders in the Magento admin panel.  Online and POS transactions are processed through the same platform, giving you detailed insight into shopper behavior, and allowing for a consistent shopper experience regardless of their location or device.

Before you begin

We recommend that you set up a separate merchant account for processing POS payments. For more information about Adyen account structure, refer to Company and merchant accounts.

Step 1: Set up point of sale in Magento

  1. Log in to your Magento admin panel. 

  2. In the main menu, go to System > Configuration

  3. In the left navigation bar, go to Sales > Payment Methods.

  4. Go to the Point of sale (POS) with Terminal API section, and fill out the following fields: 

Field

Description

Enabled

Select  Yes  to enable POS payments.

Merchant Account for Terminal API

Name of your Adyen merchant account for which the POS payments will be processed.

Keep this window open. In the following steps, you will need to copy over here several settings from the Adyen Customer Area.

Checkout appearance

If you allow self-service checkout in a store, use the following fields to specify the appearance of the POS payment method in your checkout:

Field

Description

Title

The title that indicates the POS payment method  during checkout.

Sort Order

The position of the POS payment method during checkout. 

Step 2: Connect your Magento store to the Terminal API

To connect your Magento store to the Terminal API, you need to generate an API key in the Adyen Customer Area, and copy it over to the Magento admin panel. 

Generate an API key

  1. In the Adyen Customer Area, go to Account > Users.
  2. From the drop-down menu in the first column, select System.
  3. Click the ws user (ws@Company.[YourCompanyAccount]). 
    This opens a page with the settings for this ws user.
  4. In the Authentication pane, click Generate New API key.
  5. Copy the API key and store it securely in your system.
  6. In the lower-left corner of the screen, click Save.

Set up the API key in Magento

  1. In your Magento admin panel, go to the Point of sale (POS) with Terminal API section. 
  2. In the API key for Terminal API TEST (LIVE) box, enter your API key from the Adyen test (live) Customer Area. 

Step 3: Set up capture delay

To handle cases where the shopper changes their mind about the purchase, you can set up a capture delay.

For all cards, the POS payment is completed in two steps (for Alipay, WeChatPay, and some other wallets, the payment is always completed in one step): 

  1. Authorisation – The payment details of the shopper are verified, and the funds are reserved.
  2. Capture – The reserved funds are transferred from the shopper to your account. 

For payment methods that support separate authorsiation and capture, you can optionally specify a delay between authorisation and capture. 

Set up capture delay in the Adyen Customer Area

  1. Log in to the Adyen Customer Area with your merchant-level account.
  2. Go to Account > Settings.
  3. In the POS Capture Delay drop-down menu, select the capture delay that you wish to use. 
  4. Possible values:

    • immediate: payments are captured immediately after authorisation.

    • the amount of time between authorisation and capture (ranging from 1 minute to 2 days)

      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 Magento. This is useful if you wish to perform partial captures in cases where not all the goods could be delivered to the shopper.

      Multiple partial capture is not supported for POS. When you capture a part of the authorised amount, the rest of the authorised amount is automatically cancelled.

  5. Click Submit.

Set up capture delay in Magento

  1. In your Magento admin panel, go to the Point of sale (POS) with Terminal API section. 
  2. In the Capture Delay box, enter the POS Capture Delay that you set in your Adyen Customer Area.

Step 4: Set up a terminal

User roles

For account configuration, you need to have the Merchant POS Terminal Management Admin role. For more information, refer to User roles.

  1. Log in to the Adyen Customer Area with your company-level account.
  2. Go to Point-of-sale > Terminals.
  3. In the actions menu next to the search box, select Account configuration.
  4. Click the Terminal Api tab.
  5. Set Enable terminal API to Yes.
  6. Set Enable websockets to Yes.

Set up a terminal in Magento

To connect a terminal to Magento, you need to copy the unique terminal ID over to your Magento admin panel:

  1. In your Magento admin panel, go to the Point of sale (POS) with Terminal API section. 
  2. In the Unique Terminal ID for Terminal API box, enter the unique terminal ID of your terminal, for example, MX925-260193322.

The unique terminal ID = [Device model]-[Serial number].

To find the serial number of your terminal, press 5 on the terminal, and then press . This opens the quick info menu, and displays the serial number.

You can also find the device model and the serial number of the terminal in the Adyen Customer Area, under Point-of-sale > Terminals.

Step 5 (optional): Set up recurring payments

If you want to save the payment details of a shopper who is making a POS payment, you need to choose the type of recurring contract that you want to use:

Recurring payments

For more information about recurring transaction types, refer to Recurring payments.

  1. In your Magento admin panel, go to the Point of sale (POS) with Terminal API section.
  2. 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.

See also