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

The Display API from Adyen — 1 operation(s) for display.

Adyen Display 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 Display. 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 Display 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.

Display 1
POST
/display
Adyen Display Request
body → 200

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are OutputText (11 properties), DisplayOutput (7 properties), MenuEntry (6 properties), OutputContent (5 properties). Each schema is shown below with its type and property counts.

DisplayOutput
object
It contains a complete display operation for a Display or an Input Device type. For the Input Devices, Diagnosis and EnableService, ResponseRequiredFlag and Mi…
7 properties 3 required
ErrorCondition
string
InfoQualify
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
Result
string
CharacterWidth
string
DisplayResponse
object
It conveys the result of the display, parallel to the message request, except if response not required and absent. Content of the Display Response message.
1 property 1 required
OutputContent
object
This is a sequence of elements if they have different formats. Content to display or print.
5 properties 1 required
BarcodeType
string
Color
string
OutputFormat
string
OutputResult
object
In the message response, it contains the result of the output, if required in the message request. Information related to the result the output (display, print…
3 properties 3 required
Alignment
string
MenuEntry
object
It conveys message text and parameters of the menu entry. This output data could be only provided for an input command, in order to choose an entryof the menu.…
6 properties 1 required
CharacterStyle
string
CharacterHeight
string
OutputBarcode
object
2 properties 1 required
OutputText
object
It conveys Information related to the content of the text message and its format. All the data elements related to the format of the text to display or print a…
11 properties 1 required
MenuEntryTag
string
Characteristics related to the selection of a menu entry.
PredefinedContent
object
It conveys Information related to the predefined message. Reference of a predefined message to display or print.
2 properties 1 required
DisplayRequest
object
It conveys the data to display and the way to process the display. It contains the complete content to display. It might contain an operation (the DisplayOutpu…
1 property 1 required
Device
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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