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 Login API

The Login API from Adyen — 1 operation(s) for login.

Adyen Login 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 Login. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 1 operation across 1 path, and defines 22 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.

1 operations 1 paths 22 schemas 1 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 Login 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Login 1
POST
/login
Adyen Login Request
body → 200

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are LoginRequest (10 properties), POIStatus (8 properties), LoginResponse (4 properties), POITerminalData (4 properties). Each schema is shown below with its type and property counts.

POISoftware
object
4 properties 4 required
CashHandlingDevice
object
Indicate the status and the remaining coins and bill in a cash handling device. Status of cash handling device.
3 properties 3 required
ErrorCondition
string
POISystemData
object
4 properties 2 required
ServiceProfiles
array
PrinterStatus
string
Response
object
If Result is Success, ErrorCondition is absent or not used in the processing of the message. In the other cases, the ErrorCondition has to be present and can r…
3 properties 1 required
POICapabilities
array
Result
string
LoginRequest
object
It conveys Information related to the session (period between a Login and the following Logout) to process. Content of the Login Request message.
10 properties 3 required
POIProfile
object
2 properties
POIStatus
object
Indicate the availability of the POI Terminal components. The data element is absent if the component is not part of the POI Terminal. State of a POI Terminal.
8 properties 1 required
SaleSoftware
object
Information related to the software of the Sale System which manages the NEXO Sale to POI protocol.
4 properties 4 required
CoinsOrBills
object
Indicates the remaining number of coins or bills of a given value in a cash handling device. When the cash handling machine does not have any more coins or bil…
2 properties 2 required
GenericProfile
string
GlobalStatus
string
TerminalEnvironment
string
TokenRequestedType
string
POITerminalData
object
4 properties 3 required
SaleTerminalData
object
In the Login Request, if a Sale Terminal is involved in the login. In other messages, when a logical device is out of order (SaleCapabilites), or when the othe…
1 property
CustomerOrderReq
array
LoginResponse
object
It conveys Information related to the Login to process. Content of the Login Response message.
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adyen-login-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