Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Adyen Terminals API

The Terminals API from Adyen — 5 operation(s) for terminals.

Adyen Terminals API is one of 202 APIs that Adyen publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Terminals. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 7 operations across 5 paths, and defines 57 schemas. It is described by OpenAPI 3.1.0, at version 6.

Requests are made against a single base URL, https://cal-test.adyen.com/cal/services/Account/v6.

7 operations 5 paths 57 schemas 3 GET2 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
6
Base URL
https://cal-test.adyen.com
Authentication
API Key, HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 2

Adyen Terminals API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). It accepts HTTP basic authentication (BasicAuth).

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 3 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Terminals 7
GET
/terminals
Adyen Get a List of Terminals
get-terminals 8 params → 200400401403422500
POST
/terminals/scheduleActions
Adyen Create a Terminal Action
post-terminals-scheduleActions body → 200400401403422500
POST
/terminals/{terminalId}/reassign
Adyen Reassign a Terminal
post-terminals-terminalId-reassign 1 param body → 200400401403422500
GET
/terminals/{terminalId}/terminalLogos
Adyen Get the Terminal Logo
get-terminals-terminalId-terminalLogos 1 param → 200400401403422500
PATCH
/terminals/{terminalId}/terminalLogos
Adyen Update the Logo
patch-terminals-terminalId-terminalLogos 1 param body → 200400401403422500
GET
/terminals/{terminalId}/terminalSettings
Adyen Get Terminal Settings
get-terminals-terminalId-terminalSettings 1 param → 200400401403422500
PATCH
/terminals/{terminalId}/terminalSettings
Adyen Update Terminal Settings
patch-terminals-terminalId-terminalSettings 1 param body → 200400401403422500

Schemas 57

The contract defines 57 schemas that model the data the API accepts and returns. The most detailed are TerminalSettings (20 properties), Profile (18 properties), ReceiptPrinting (16 properties), RestServiceError (9 properties). Each schema is shown below with its type and property counts.

TerminalConnectivityWifi
object
3 properties
Settings
object
3 properties
LinksElement
object
1 property
UninstallAndroidCertificateDetails
object
2 properties
JSONObject
object
ReceiptPrinting
object
16 properties
Passcodes
object
4 properties
Notification
object
5 properties
Standalone
object
2 properties
TerminalConnectivity
object
4 properties
Logo
object
1 property
ListTerminalsResponse
object
4 properties 2 required
RestServiceError
object
9 properties 5 required
TerminalReassignmentRequest
object
4 properties
PaginationLinks
object
5 properties 3 required
Opi
object
3 properties
ScheduleTerminalActionsRequest
object
4 properties
Payment
object
2 properties
TerminalReassignmentTarget
object
4 properties 1 required
Connectivity
object
1 property
Profile
object
18 properties 4 required
Gratuity
object
4 properties
Currency
object
3 properties 1 required
ReceiptOptions
object
3 properties
MinorUnitsMonetaryValue
object
2 properties
Localization
object
3 properties
InstallAndroidAppDetails
object
2 properties
NotificationUrl
object
2 properties
TerminalAssignment
object
5 properties 2 required
File
object
2 properties 2 required
ReleaseUpdateDetails
object
2 properties
InvalidField
object
3 properties 3 required
ScheduleTerminalActionsResponse
object
7 properties
TerminalConnectivityBluetooth
object
2 properties
UninstallAndroidAppDetails
object
2 properties
Key
object
3 properties
TerminalActionScheduleDetail
object
2 properties
OfflineProcessing
object
2 properties
InstallAndroidCertificateDetails
object
2 properties
PayAtTable
object
3 properties
Terminal
object
8 properties
TerminalConnectivityCellular
object
2 properties
TapToPay
object
1 property
WifiProfiles
object
2 properties
Nexo
object
5 properties
Configuration
object
4 properties 2 required
Signature
object
4 properties
Hardware
object
3 properties
EventUrl
object
2 properties
Url
object
4 properties
Surcharge
object
2 properties
Referenced
object
1 property
CardholderReceipt
object
1 property
Timeouts
object
1 property
TerminalSettings
object
20 properties
Refunds
object
1 property
TerminalConnectivityEthernet
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adyen-terminals-api-openapi.yml Raw ↑

Other APIs Adyen publishes across the network.

Adyen acceptDispute API
Adyen Account API
Adyen accountHolderBalance API
Adyen accountHolders API
Adyen accountHolderTransactionList API
Adyen Accounting Notifications API
Adyen Accounts API
Adyen adjustAuthorisation API
Adyen Admin API
Adyen Amount API
Adyen Apple API
Adyen applePay API