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

The Diagnosis API from Adyen — 1 operation(s) for diagnosis.

Adyen Diagnosis 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 Diagnosis. 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 11 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 11 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 Diagnosis 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.

Diagnosis 1
POST
/diagnosis
Adyen Diagnosis Request
body → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are POIStatus (8 properties), DiagnosisResponse (4 properties), CashHandlingDevice (3 properties), Response (3 properties). Each schema is shown below with its type and property counts.

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
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
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
Result
string
DiagnosisResponse
object
It conveys the result of the requested diagnosis and a possible message to display on a logical device. Content of the Diagnosis Response message.
4 properties 1 required
ErrorCondition
string
HostStatus
object
Indicate the reachability of the host by the POI Terminal. State of a Host.
2 properties 1 required
DiagnosisRequest
object
It conveys Information related to the target POI for which the diagnosis is requested. Content of the Diagnosis Request message.
3 properties
GlobalStatus
string
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
PrinterStatus
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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