Adyen Sweep API
The Sweep API from Adyen — 1 operation(s) for sweep.
Adyen Sweep 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 Sweep. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.
This API exposes 3 operations across 1 path, and defines 8 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Adyen Sweep 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 3
Across 1 path, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.
Schemas 8
The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are SweepConfigurationV2 (13 properties), UpdateSweepConfigurationV2 (13 properties), RestServiceError (9 properties), InvalidField (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Adyen 12
Other APIs Adyen publishes across the network.