Adyen POS terminal onboarding (Cloud / Terminal API)
Onboard an Adyen payment terminal in Cloud / Terminal API mode for EU merchants integrating POS collection.
Before overseas (including EU) properties can use POS collection, the Adyen payment terminal must be onboarded in Cloud / Terminal API mode. Use this flow when you can sign in to Adyen Customer Area and at least one POS terminal is assigned to the merchant account. It does not apply to domestic properties (POS Payment is hidden on reservation detail) and does not replace collecting payment inside Console.
Entry: Adyen Customer Area (test or live). On-device menus follow the terminal UI.
For on-site collection in Console, see POS Payment. Field-level details for Adyen under Console → Finance → Property Settings → Payment are pending confirmation.
Prerequisites
- Access to Adyen Customer Area (test or live).
- At least one Adyen POS terminal assigned to the merchant account.
- Terminal admin PIN and boarding code (if required) from Adyen or your provider.
- Power and a working LAN or Wi‑Fi connection for the terminal.
Steps
Confirm terminal registration and assignment
Sign in to Adyen Customer Area.
Go to In-person payments → Payment devices (Terminals).
Confirm the terminal appears in the list and is assigned to the correct merchant account and store.
Note the device POIID (for example S1F2-000158255293113). The POIID uniquely identifies the physical device and is required by the POS / Terminal API integration.
Enable Cloud Terminal API (disable Standalone)
In Payment devices, open Device settings for the terminal.
In the left menu, select Integrations → Terminal API.
Set Enable terminal API and Enable WebSockets to Enabled.
In the Standalone section of device settings, set Enable standalone to Disabled (cloud mode — payments start from the POS).
If Standalone stays enabled, the terminal behaves like an independent card machine and cannot be fully controlled by the POS via Terminal API.
Configure payment methods (minimum for tests)
In Customer Area, go to Settings → Payment methods.
Add at least VISA for the store that uses this terminal.
One card scheme is enough for basic integration testing; add more schemes or local methods later as needed.
Create API credentials for POS integration
Go to Developers → API credentials.
Create a new credential or select an existing one for the POS integration.
Under server authentication, generate an API key for TEST and for LIVE.
Store the keys securely and configure them in your POS application or middleware (and later in Console payment settings; field list pending confirmation).
API keys can initiate real charges and refunds. Keep them secure — do not put them in public docs, screenshots, or ticket plaintext.
(Optional) UI language and receipts
Language and receipt settings are cosmetic and do not block Terminal API connectivity.
In the terminal’s Device settings, open Customization / Receipts.
Set UI language (for example English), receipt layout, logo, and footer text as needed.
Board the physical terminal and update configuration
Connect the terminal to power and LAN or Wi‑Fi.
Open the admin menu with the admin PIN and complete boarding on screen: enter the boarding code if required, and select the correct merchant account and store.
Wait until the terminal shows it is boarded and ready for payments.
On the terminal, go to Settings → Configuration, run Update configuration, and confirm status Up to date.
This pulls Terminal API, WebSocket, language, and payment method settings from Customer Area onto the device.
Insert receipt paper per the hardware manual. Blank or default receipts are acceptable during integration testing if receipts are not configured in the portal yet.
Connectivity and diagnostics
On the terminal, go to Settings → Diagnostics → PSP connection, run the test, and confirm Successful. If it fails, fix LAN/Wi‑Fi, firewall, and DNS until it passes.
Still under Diagnostics, select Terminal API, run the test, and confirm green checks for API enabled, WebSocket enabled, and WebSocket active / connection OK.
If any item is not green: re-check Terminal API and WebSockets in the portal → run Update configuration again on the terminal → confirm a stable network and a cloud icon on the status bar.
Configure the POS and run test transactions
In your POS / backend (or middleware):
- Set the Adyen API key (TEST or LIVE to match the environment).
- Set the terminal POIID so the POS targets the correct device.
- Ensure the POS environment (test vs live) matches the API key and merchant account in Customer Area.
Then run a small set of test transactions (successful card sale, declined sale, and refund where applicable). Confirm each appears in POS back office / reports and in Customer Area → Transactions / In-person payments.
Front-desk collection in Console: POS Payment.
Result
- Terminal is correctly assigned in Customer Area; POIID is recorded.
- Terminal API and WebSockets are enabled; Standalone is disabled.
- Terminal configuration is Up to date; PSP connection succeeds; Terminal API diagnostics are all green.
- POS (and later Console payment settings) use a matching API key and POIID; test transactions appear in both POS and Customer Area.
FAQ
- Terminal diagnostics not all green, or terminal acts like a standalone card machine?
- POS cannot wake the terminal for payment — what to check first?