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

The Stores API from Adyen — 5 operation(s) for stores.

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

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

9 operations 5 paths 52 schemas 4 GET3 PATCH2 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 Stores 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 9

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

Stores 9
POST
/closeStores
Adyen Close Stores
post-closeStores body → 200400401403422500
GET
/stores
Adyen Get a List of Stores
get-stores 4 params → 200400401403422500
POST
/stores
Adyen Create a Store
post-stores body → 200400401403422500
GET
/stores/{storeId}
Adyen Get a Store
get-stores-storeId 1 param → 200400401403422500
PATCH
/stores/{storeId}
Adyen Update a Store
patch-stores-storeId 1 param body → 200400401403422500
GET
/stores/{storeId}/terminalLogos
Adyen Get the Terminal Logo
get-stores-storeId-terminalLogos 2 params → 200400401403422500
PATCH
/stores/{storeId}/terminalLogos
Adyen Update the Terminal Logo
patch-stores-storeId-terminalLogos 2 params body → 200400401403422500
GET
/stores/{storeId}/terminalSettings
Adyen Get Terminal Settings
get-stores-storeId-terminalSettings 1 param → 200400401403422500
PATCH
/stores/{storeId}/terminalSettings
Adyen Update Terminal Settings
patch-stores-storeId-terminalSettings 1 param body → 200400401403422500

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are TerminalSettings (20 properties), Profile (18 properties), ReceiptPrinting (16 properties), Store (12 properties). Each schema is shown below with its type and property counts.

Settings
object
3 properties
ListStoresResponse
object
4 properties 2 required
LinksElement
object
1 property
UpdatableAddress
object
6 properties
GenericResponse
object
3 properties
JSONObject
object
ReceiptPrinting
object
16 properties
Passcodes
object
4 properties
Notification
object
5 properties
StoreLocation
object
7 properties 1 required
Standalone
object
2 properties
ErrorFieldType
object
3 properties
Logo
object
1 property
RestServiceError
object
9 properties 5 required
PaginationLinks
object
5 properties 3 required
Opi
object
3 properties
Payment
object
2 properties
Connectivity
object
1 property
Profile
object
18 properties 4 required
Gratuity
object
4 properties
Currency
object
3 properties 1 required
ReceiptOptions
object
3 properties
MinorUnitsMonetaryValue
object
2 properties
Localization
object
3 properties
UpdateStoreRequest
object
7 properties
NotificationUrl
object
2 properties
File
object
2 properties 2 required
ServiceError
object
5 properties
StoreCreationWithMerchantCodeRequest
object
9 properties 5 required
Key
object
3 properties
OfflineProcessing
object
2 properties
PayAtTable
object
3 properties
TapToPay
object
1 property
WifiProfiles
object
2 properties
Nexo
object
5 properties
Configuration
object
4 properties 2 required
Store
object
12 properties
Signature
object
4 properties
FieldType
object
3 properties
Hardware
object
3 properties
EventUrl
object
2 properties
CloseStoresRequest
object
2 properties 2 required
Url
object
4 properties
Surcharge
object
2 properties
Referenced
object
1 property
Links
object
1 property 1 required
StoreSplitConfiguration
object
2 properties
CardholderReceipt
object
1 property
Timeouts
object
1 property
TerminalSettings
object
20 properties
Refunds
object
1 property
InvalidField
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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