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

The Sweeps API from Adyen — 2 operation(s) for sweeps.

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

This API exposes 5 operations across 2 paths, and defines 10 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.

5 operations 2 paths 10 schemas 1 DELETE2 GET1 PATCH1 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 Sweeps 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 5

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

Sweeps 5
GET
/balanceAccounts/{balanceAccountId}/sweeps
Adyen Get All Sweeps for a Balance Account
get-balanceAccounts-balanceAccountId-sweeps 3 params → 200400401403422500
POST
/balanceAccounts/{balanceAccountId}/sweeps
Adyen Create a Sweep
post-balanceAccounts-balanceAccountId-sweeps 1 param body → 200400401403422500
DELETE
/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}
Adyen Delete a Sweep
delete-balanceAccounts-balanceAccountId-sweeps-sweepId 2 params → 204400401403422500
GET
/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}
Adyen Get a Sweep
get-balanceAccounts-balanceAccountId-sweeps-sweepId 2 params → 200400401403422500
PATCH
/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}
Adyen Update a Sweep
patch-balanceAccounts-balanceAccountId-sweeps-sweepId 2 params body → 200400401403422500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are UpdateSweepConfigurationV2 (13 properties), SweepConfigurationV2 (13 properties), CreateSweepConfigurationV2 (12 properties), RestServiceError (9 properties). Each schema is shown below with its type and property counts.

SweepCounterparty
object
3 properties
JSONObject
object
BalanceSweepConfigurationsResponse
object
3 properties 3 required
RestServiceError
object
9 properties 5 required
CreateSweepConfigurationV2
object
12 properties 3 required
SweepSchedule
object
2 properties 1 required
SweepConfigurationV2
object
13 properties 4 required
UpdateSweepConfigurationV2
object
13 properties
Amount
object
2 properties 2 required
InvalidField
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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