How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Adyen Merchants API

The Merchants API from Adyen — 38 operation(s) for merchants.

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

This API exposes 67 operations across 38 paths, and defines 132 schemas. It is described by OpenAPI 3.2.0, at version 3.

Requests are made against a single base URL, https://management-test.adyen.com/v3.

67 operations 38 paths 132 schemas 5 DELETE29 GET14 PATCH19 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3
Base URL
https://cal-test.adyen.com
Authentication
API Key, HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 2

Adyen Merchants 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 67

Across 38 paths, the API surfaces 67 operations — 5 DELETE, 29 GET, 14 PATCH, 19 POST. Each is listed below with its method, path, parameters, and response codes.

Merchants 67
GET
/merchants
Adyen Get a List of Merchant Accounts
get-merchants 2 params → 200204400401403422500
POST
/merchants
Adyen Create a Merchant Account
post-merchants body → 200204400401403422500
GET
/merchants/{merchantId}
Adyen Get a Merchant Account
get-merchants-merchantId 1 param → 200204400401403422500
POST
/merchants/{merchantId}/activate
Adyen Request to Activate a Merchant Account
post-merchants-merchantId-activate 1 param → 200204400401403422500
GET
/merchants/{merchantId}/apiCredentials
Adyen Get a List of API Credentials
get-merchants-merchantId-apiCredentials 3 params → 200204400401403422500
POST
/merchants/{merchantId}/apiCredentials
Adyen Create an API Credential
post-merchants-merchantId-apiCredentials 1 param body → 200204400401403422500
GET
/merchants/{merchantId}/apiCredentials/{apiCredentialId}
Adyen Get an API Credential
get-merchants-merchantId-apiCredentials-apiCredentialId 2 params → 200204400401403422500
PATCH
/merchants/{merchantId}/apiCredentials/{apiCredentialId}
Adyen Update an API Credential
patch-merchants-merchantId-apiCredentials-apiCredentialId 2 params body → 200204400401403422500
GET
/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins
Adyen Get a List of Allowed Origins
get-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins 2 params → 200204400401403422500
POST
/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins
Adyen Create an Allowed Origin
post-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins 2 params body → 200204400401403422500
DELETE
/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}
Adyen Delete an Allowed Origin
delete-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-originId 3 params → 204400401403422500
GET
/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}
Adyen Get an Allowed Origin
get-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-originId 3 params → 200204400401403422500
POST
/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateApiKey
Adyen Generate New API Key
post-merchants-merchantId-apiCredentials-apiCredentialId-generateApiKey 2 params → 200204400401403422500
POST
/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateClientKey
Adyen Generate New Client Key
post-merchants-merchantId-apiCredentials-apiCredentialId-generateClientKey 2 params → 200204400401403422500
GET
/merchants/{merchantId}/billingEntities
Adyen Get a List of Billing Entities
get-merchants-merchantId-billingEntities 2 params → 200204400401403422500
GET
/merchants/{merchantId}/paymentMethodSettings
Adyen Get All Payment Methods
get-merchants-merchantId-paymentMethodSettings 5 params → 200204400401403422500
POST
/merchants/{merchantId}/paymentMethodSettings
Adyen Request a Payment Method
post-merchants-merchantId-paymentMethodSettings 1 param body → 200204400401403422500
GET
/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}
Adyen Get Payment Method Details
get-merchants-merchantId-paymentMethodSettings-paymentMethodId 2 params → 200204400401403422500
PATCH
/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}
Adyen Update a Payment Method
patch-merchants-merchantId-paymentMethodSettings-paymentMethodId 2 params body → 200204400401403422500
POST
/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}/addApplePayDomains
Adyen Add an Apple Pay Domain
post-merchants-merchantId-paymentMethodSettings-paymentMethodId-addApplePayDomains 2 params body → 204400401403422500
GET
/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}/getApplePayDomains
Adyen Get Apple Pay Domains
get-merchants-merchantId-paymentMethodSettings-paymentMethodId-getApplePayDomains 2 params → 200204400401403422500
GET
/merchants/{merchantId}/payoutSettings
Adyen Get a List of Payout Settings
get-merchants-merchantId-payoutSettings 1 param → 200204400401403422500
POST
/merchants/{merchantId}/payoutSettings
Adyen Add a Payout Setting
post-merchants-merchantId-payoutSettings 1 param body → 200204400401403422500
DELETE
/merchants/{merchantId}/payoutSettings/{payoutSettingsId}
Adyen Delete a Payout Setting
delete-merchants-merchantId-payoutSettings-payoutSettingsId 2 params → 204400401403422500
GET
/merchants/{merchantId}/payoutSettings/{payoutSettingsId}
Adyen Get a Payout Setting
get-merchants-merchantId-payoutSettings-payoutSettingsId 2 params → 200204400401403422500
PATCH
/merchants/{merchantId}/payoutSettings/{payoutSettingsId}
Adyen Update a Payout Setting
patch-merchants-merchantId-payoutSettings-payoutSettingsId 2 params body → 200204400401403422500
GET
/merchants/{merchantId}/shippingLocations
Adyen Get a List of Shipping Locations
get-merchants-merchantId-shippingLocations 4 params → 200204400401403422500
POST
/merchants/{merchantId}/shippingLocations
Adyen Create a Shipping Location
post-merchants-merchantId-shippingLocations 1 param body → 200204400401403422500
GET
/merchants/{merchantId}/splitConfigurations
Adyen Get a List of Split Configurations
get-merchants-merchantId-splitConfigurations 1 param → 200204400401403422500
POST
/merchants/{merchantId}/splitConfigurations
Adyen Create a Split Configuration
post-merchants-merchantId-splitConfigurations 1 param body → 200204400401403422500
DELETE
/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}
Adyen Delete a Split Configuration
delete-merchants-merchantId-splitConfigurations-splitConfigurationId 2 params → 200204400401403422500
GET
/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}
Adyen Get a Split Configuration
get-merchants-merchantId-splitConfigurations-splitConfigurationId 2 params → 200204400401403422500
PATCH
/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}
Adyen Update Split Configuration Description
patch-merchants-merchantId-splitConfigurations-splitConfigurationId 2 params body → 200204400401403422500
POST
/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}
Adyen Create a Rule
post-merchants-merchantId-splitConfigurations-splitConfigurationId 2 params body → 200204400401403422500
DELETE
/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}
Adyen Delete a Split Configuration Rule
delete-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId 3 params → 200204400401403422500
PATCH
/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}
Adyen Update Split Conditions
patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId 3 params body → 200204400401403422500
PATCH
/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}/splitLogic/{splitLogicId}
Adyen Update the Split Logic
patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId-splitLogic-splitLogicId 4 params body → 200204400401403422500
GET
/merchants/{merchantId}/stores
Adyen Get a List of Stores
get-merchants-merchantId-stores 4 params → 200204400401403422500
POST
/merchants/{merchantId}/stores
Adyen Create a Store
post-merchants-merchantId-stores 1 param body → 200204400401403422500
GET
/merchants/{merchantId}/stores/{reference}/terminalLogos
Adyen Get the Terminal Logo
get-merchants-merchantId-stores-reference-terminalLogos 3 params → 200204400401403422500
PATCH
/merchants/{merchantId}/stores/{reference}/terminalLogos
Adyen Update the Terminal Logo
patch-merchants-merchantId-stores-reference-terminalLogos 3 params body → 200204400401403422500
GET
/merchants/{merchantId}/stores/{reference}/terminalSettings
Adyen Get Terminal Settings
get-merchants-merchantId-stores-reference-terminalSettings 2 params → 200204400401403422500
PATCH
/merchants/{merchantId}/stores/{reference}/terminalSettings
Adyen Update Terminal Settings
patch-merchants-merchantId-stores-reference-terminalSettings 2 params body → 200204400401403422500
GET
/merchants/{merchantId}/stores/{storeId}
Adyen Get a Store
get-merchants-merchantId-stores-storeId 2 params → 200204400401403422500
PATCH
/merchants/{merchantId}/stores/{storeId}
Adyen Update a Store
patch-merchants-merchantId-stores-storeId 2 params body → 200204400401403422500
GET
/merchants/{merchantId}/terminalLogos
Adyen Get the Terminal Logo
get-merchants-merchantId-terminalLogos 2 params → 200204400401403422500
PATCH
/merchants/{merchantId}/terminalLogos
Adyen Update the Terminal Logo
patch-merchants-merchantId-terminalLogos 2 params body → 200204400401403422500
GET
/merchants/{merchantId}/terminalModels
Adyen Get a List of Terminal Models
get-merchants-merchantId-terminalModels 1 param → 200204400401403422500
GET
/merchants/{merchantId}/terminalOrders
Adyen Get a List of Orders
get-merchants-merchantId-terminalOrders 5 params → 200204400401403422500
POST
/merchants/{merchantId}/terminalOrders
Adyen Create an Order
post-merchants-merchantId-terminalOrders 1 param body → 200204400401403422500
GET
/merchants/{merchantId}/terminalOrders/{orderId}
Adyen Get an Order
get-merchants-merchantId-terminalOrders-orderId 2 params → 200204400401403422500
PATCH
/merchants/{merchantId}/terminalOrders/{orderId}
Adyen Update an Order
patch-merchants-merchantId-terminalOrders-orderId 2 params body → 200204400401403422500
POST
/merchants/{merchantId}/terminalOrders/{orderId}/cancel
Adyen Cancel an Order
post-merchants-merchantId-terminalOrders-orderId-cancel 2 params → 200204400401403422500
GET
/merchants/{merchantId}/terminalProducts
Adyen Get a List of Terminal Products
get-merchants-merchantId-terminalProducts 5 params → 200204400401403422500
GET
/merchants/{merchantId}/terminalSettings
Adyen Get Terminal Settings
get-merchants-merchantId-terminalSettings 1 param → 200204400401403422500
PATCH
/merchants/{merchantId}/terminalSettings
Adyen Update Terminal Settings
patch-merchants-merchantId-terminalSettings 1 param body → 200204400401403422500
GET
/merchants/{merchantId}/users
Adyen Get a List of Users
get-merchants-merchantId-users 4 params → 200204400401403422500
POST
/merchants/{merchantId}/users
Adyen Create a New User
post-merchants-merchantId-users 1 param body → 200204400401403422500
GET
/merchants/{merchantId}/users/{userId}
Adyen Get User Details
get-merchants-merchantId-users-userId 2 params → 200204400401403422500
PATCH
/merchants/{merchantId}/users/{userId}
Adyen Update a User
patch-merchants-merchantId-users-userId 2 params body → 200204400401403422500
GET
/merchants/{merchantId}/webhooks
Adyen List All Webhooks
get-merchants-merchantId-webhooks 3 params → 200204400401403422500
POST
/merchants/{merchantId}/webhooks
Adyen Set Up a Webhook
post-merchants-merchantId-webhooks 1 param body → 200204400401403422500
DELETE
/merchants/{merchantId}/webhooks/{webhookId}
Adyen Remove a Webhook
delete-merchants-merchantId-webhooks-webhookId 2 params → 204400401403422500
GET
/merchants/{merchantId}/webhooks/{webhookId}
Adyen Get a Webhook
get-merchants-merchantId-webhooks-webhookId 2 params → 200204400401403422500
PATCH
/merchants/{merchantId}/webhooks/{webhookId}
Adyen Update a Webhook
patch-merchants-merchantId-webhooks-webhookId 2 params body → 200204400401403422500
POST
/merchants/{merchantId}/webhooks/{webhookId}/generateHmac
Adyen Generate an HMAC Key
post-merchants-merchantId-webhooks-webhookId-generateHmac 2 params → 200204400401403422500
POST
/merchants/{merchantId}/webhooks/{webhookId}/test
Adyen Test a Webhook
post-merchants-merchantId-webhooks-webhookId-test 2 params body → 200204400401403422500

Schemas 132

The contract defines 132 schemas that model the data the API accepts and returns. The most detailed are PaymentMethod (37 properties), PaymentMethodSetupInfo (33 properties), Webhook (22 properties), TerminalSettings (20 properties). Each schema is shown below with its type and property counts.

KlarnaInfo
object
4 properties 3 required
SplitConfigurationList
object
1 property
TransactionDescriptionInfo
object
2 properties
AllowedOriginsResponse
object
1 property
CustomNotification
object
7 properties
SwishInfo
object
1 property 1 required
Payment
object
2 properties
ApiCredential
object
9 properties 6 required
CardholderReceipt
object
1 property
CreateMerchantResponse
object
7 properties
CreateMerchantWebhookRequest
object
14 properties 4 required
WebhookLinks
object
5 properties 3 required
Passcodes
object
4 properties
GenerateHmacKeyResponse
object
1 property 1 required
CreateUserResponse
object
10 properties 5 required
GenericPmWithTdiInfo
object
1 property
PayoutSettingsRequest
object
3 properties 1 required
TapToPay
object
1 property
Url
object
4 properties
ShippingLocation
object
4 properties
File
object
2 properties 2 required
Referenced
object
1 property
OrderItem
object
4 properties
AfterpayTouchInfo
object
1 property 1 required
Signature
object
4 properties
Configuration
object
4 properties 2 required
GiroPayInfo
object
1 property 1 required
EventUrl
object
2 properties
UpdateMerchantWebhookRequest
object
13 properties
IdName
object
2 properties
Surcharge
object
2 properties
TerminalProductsResponse
object
1 property
GooglePayInfo
object
2 properties 1 required
Profile
object
18 properties 4 required
ReceiptOptions
object
3 properties
UpdateMerchantApiCredentialRequest
object
4 properties
Commission
object
2 properties
Refunds
object
1 property
CreateApiCredentialResponse
object
11 properties 8 required
Links
object
1 property 1 required
ListWebhooksResponse
object
5 properties 2 required
UpdateMerchantUserRequest
object
6 properties
UpdatePayoutSettingsRequest
object
1 property
PaymentMethodResponse
object
5 properties 2 required
InvalidField
object
3 properties 3 required
OfflineProcessing
object
2 properties
Logo
object
1 property
TerminalModelsResponse
object
1 property
UpdateSplitConfigurationRuleRequest
object
4 properties 3 required
Name
object
2 properties 2 required
Currency
object
3 properties 1 required
Amount
object
2 properties 2 required
TerminalOrdersResponse
object
1 property
User
object
10 properties 5 required
Gratuity
object
4 properties
TerminalSettings
object
20 properties
StoreCreationRequest
object
8 properties 4 required
Opi
object
3 properties
UpdateSplitConfigurationRequest
object
1 property 1 required
PaginationLinks
object
5 properties 3 required
ListMerchantApiCredentialsResponse
object
4 properties 2 required
ApplePayInfo
object
1 property 1 required
Connectivity
object
1 property
Address
object
7 properties
SplitConfigurationLogic
object
15 properties 1 required
MinorUnitsMonetaryValue
object
2 properties
SplitConfigurationRule
object
6 properties 4 required
AdditionalCommission
object
3 properties
BillingEntitiesResponse
object
1 property
UpdateSplitConfigurationLogicRequest
object
15 properties 1 required
TestOutput
object
6 properties 1 required
Settings
object
3 properties
AdditionalSettingsResponse
object
3 properties
ClearpayInfo
object
1 property 1 required
PayoutSettings
object
7 properties 2 required
UpdatableAddress
object
6 properties
PaymentMethod
object
37 properties 1 required
Nexo
object
5 properties
Standalone
object
2 properties
TerminalOrder
object
8 properties
RestServiceError
object
9 properties 5 required
Contact
object
5 properties
SplitConfiguration
object
4 properties 2 required
VippsInfo
object
2 properties 1 required
Store
object
12 properties
CartesBancairesInfo
object
2 properties 1 required
CreateMerchantUserRequest
object
6 properties 3 required
UpdatePaymentMethodInfo
object
18 properties
MealVoucherFRInfo
object
3 properties 3 required
Webhook
object
22 properties 4 required
TerminalProduct
object
5 properties
PaymentMethodSetupInfo
object
33 properties 1 required
AdditionalSettings
object
2 properties
PayoutSettingsResponse
object
1 property
JSONObject
object
NotificationUrl
object
2 properties
Merchant
object
14 properties
CreateMerchantRequest
object
7 properties 1 required
PayAtTable
object
3 properties
BillingEntity
object
5 properties
UpdateStoreRequest
object
7 properties
GenerateClientKeyResponse
object
1 property 1 required
Localization
object
3 properties
WifiProfiles
object
2 properties
TestWebhookResponse
object
1 property
Name2
object
2 properties
SofortInfo
object
2 properties 2 required
AllowedOrigin
object
3 properties 1 required
Hardware
object
3 properties
StoreSplitConfiguration
object
2 properties
CreateMerchantApiCredentialRequest
object
3 properties
Key
object
3 properties
TerminalOrderRequest
object
6 properties
LinksElement
object
1 property
ShippingLocationsResponse
object
1 property
MerchantLinks
object
4 properties 1 required
ListStoresResponse
object
4 properties 2 required
TestWebhookRequest
object
2 properties
PayPalInfo
object
3 properties 2 required
ReceiptPrinting
object
16 properties
StoreLocation
object
7 properties 1 required
Notification
object
5 properties
TerminalProductPrice
object
2 properties
GenerateApiKeyResponse
object
1 property 1 required
TwintInfo
object
1 property 1 required
RequestActivationResponse
object
2 properties
ApiCredentialLinks
object
6 properties 1 required
ListMerchantUsersResponse
object
4 properties 2 required
ListMerchantResponse
object
4 properties 2 required
DataCenter
object
2 properties
Timeouts
object
1 property
BcmcInfo
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adyen-merchants-api-openapi.yml Raw ↑

Other APIs Adyen publishes across the network.

Adyen acceptDispute API
Adyen Account API
Adyen accountHolderBalance API
Adyen accountHolderTransactionList API
Adyen Accounts API
Adyen adjustAuthorisation API
Adyen Admin API
Adyen Amount API
Adyen Apple API
Adyen assignTerminals API
Adyen Authorise API
Adyen Authorise3d API
Where this information came from

This is an independent, third-party profile of Adyen Merchants API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.