Adyen Merchants API
The Merchants API from Adyen — 38 operation(s) for merchants.
Adyen Merchants 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 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.1.0, at version 6.
Requests are made against a single base URL, https://cal-test.adyen.com/cal/services/Account/v6.
67 operations
38 paths
132 schemas
5 DELETE29 GET14 PATCH19 POST
Metadata
The identity and technical contract details declared by the specification.
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
POST
/merchants
Adyen Create a Merchant Account
GET
/merchants/{merchantId}
Adyen Get a Merchant Account
POST
/merchants/{merchantId}/activate
Adyen Request to Activate a Merchant Account
GET
/merchants/{merchantId}/apiCredentials
Adyen Get a List of API Credentials
POST
/merchants/{merchantId}/apiCredentials
Adyen Create an API Credential
GET
/merchants/{merchantId}/apiCredentials/{apiCredentialId}
Adyen Get an API Credential
PATCH
/merchants/{merchantId}/apiCredentials/{apiCredentialId}
Adyen Update an API Credential
GET
/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins
Adyen Get a List of Allowed Origins
POST
/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins
Adyen Create an Allowed Origin
DELETE
/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}
Adyen Delete an Allowed Origin
GET
/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}
Adyen Get an Allowed Origin
POST
/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateApiKey
Adyen Generate New API Key
POST
/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateClientKey
Adyen Generate New Client Key
GET
/merchants/{merchantId}/billingEntities
Adyen Get a List of Billing Entities
GET
/merchants/{merchantId}/paymentMethodSettings
Adyen Get All Payment Methods
POST
/merchants/{merchantId}/paymentMethodSettings
Adyen Request a Payment Method
GET
/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}
Adyen Get Payment Method Details
PATCH
/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}
Adyen Update a Payment Method
POST
/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}/addApplePayDomains
Adyen Add an Apple Pay Domain
GET
/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}/getApplePayDomains
Adyen Get Apple Pay Domains
GET
/merchants/{merchantId}/payoutSettings
Adyen Get a List of Payout Settings
POST
/merchants/{merchantId}/payoutSettings
Adyen Add a Payout Setting
DELETE
/merchants/{merchantId}/payoutSettings/{payoutSettingsId}
Adyen Delete a Payout Setting
GET
/merchants/{merchantId}/payoutSettings/{payoutSettingsId}
Adyen Get a Payout Setting
PATCH
/merchants/{merchantId}/payoutSettings/{payoutSettingsId}
Adyen Update a Payout Setting
GET
/merchants/{merchantId}/shippingLocations
Adyen Get a List of Shipping Locations
POST
/merchants/{merchantId}/shippingLocations
Adyen Create a Shipping Location
GET
/merchants/{merchantId}/splitConfigurations
Adyen Get a List of Split Configurations
POST
/merchants/{merchantId}/splitConfigurations
Adyen Create a Split Configuration
DELETE
/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}
Adyen Delete a Split Configuration
GET
/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}
Adyen Get a Split Configuration
PATCH
/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}
Adyen Update Split Configuration Description
POST
/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}
Adyen Create a Rule
DELETE
/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}
Adyen Delete a Split Configuration Rule
PATCH
/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}
Adyen Update Split Conditions
PATCH
/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}/splitLogic/{splitLogicId}
Adyen Update the Split Logic
GET
/merchants/{merchantId}/stores
Adyen Get a List of Stores
POST
/merchants/{merchantId}/stores
Adyen Create a Store
GET
/merchants/{merchantId}/stores/{reference}/terminalLogos
Adyen Get the Terminal Logo
PATCH
/merchants/{merchantId}/stores/{reference}/terminalLogos
Adyen Update the Terminal Logo
GET
/merchants/{merchantId}/stores/{reference}/terminalSettings
Adyen Get Terminal Settings
PATCH
/merchants/{merchantId}/stores/{reference}/terminalSettings
Adyen Update Terminal Settings
GET
/merchants/{merchantId}/stores/{storeId}
Adyen Get a Store
PATCH
/merchants/{merchantId}/stores/{storeId}
Adyen Update a Store
GET
/merchants/{merchantId}/terminalLogos
Adyen Get the Terminal Logo
PATCH
/merchants/{merchantId}/terminalLogos
Adyen Update the Terminal Logo
GET
/merchants/{merchantId}/terminalModels
Adyen Get a List of Terminal Models
GET
/merchants/{merchantId}/terminalOrders
Adyen Get a List of Orders
POST
/merchants/{merchantId}/terminalOrders
Adyen Create an Order
GET
/merchants/{merchantId}/terminalOrders/{orderId}
Adyen Get an Order
PATCH
/merchants/{merchantId}/terminalOrders/{orderId}
Adyen Update an Order
POST
/merchants/{merchantId}/terminalOrders/{orderId}/cancel
Adyen Cancel an Order
GET
/merchants/{merchantId}/terminalProducts
Adyen Get a List of Terminal Products
GET
/merchants/{merchantId}/terminalSettings
Adyen Get Terminal Settings
PATCH
/merchants/{merchantId}/terminalSettings
Adyen Update Terminal Settings
GET
/merchants/{merchantId}/users
Adyen Get a List of Users
POST
/merchants/{merchantId}/users
Adyen Create a New User
GET
/merchants/{merchantId}/users/{userId}
Adyen Get User Details
PATCH
/merchants/{merchantId}/users/{userId}
Adyen Update a User
GET
/merchants/{merchantId}/webhooks
Adyen List All Webhooks
POST
/merchants/{merchantId}/webhooks
Adyen Set Up a Webhook
DELETE
/merchants/{merchantId}/webhooks/{webhookId}
Adyen Remove a Webhook
GET
/merchants/{merchantId}/webhooks/{webhookId}
Adyen Get a Webhook
PATCH
/merchants/{merchantId}/webhooks/{webhookId}
Adyen Update a Webhook
POST
/merchants/{merchantId}/webhooks/{webhookId}/generateHmac
Adyen Generate an HMAC Key
POST
/merchants/{merchantId}/webhooks/{webhookId}/test
Adyen Test a Webhook
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.
CreateApiCredentialResponse
object
11 properties
8 required
GooglePayInfo
object
2 properties
1 required
SofortInfo
object
2 properties
2 required
PaymentMethod
object
37 properties
1 required
CreateMerchantApiCredentialRequest
object
3 properties
CreateMerchantWebhookRequest
object
14 properties
4 required
Passcodes
object
4 properties
ShippingLocation
object
4 properties
PaymentMethodResponse
object
5 properties
2 required
Notification
object
5 properties
TransactionDescriptionInfo
object
2 properties
Standalone
object
2 properties
Logo
object
1 property
ListMerchantApiCredentialsResponse
object
4 properties
2 required
OrderItem
object
4 properties
TerminalProduct
object
5 properties
WebhookLinks
object
5 properties
3 required
Gratuity
object
4 properties
Address
object
7 properties
BillingEntity
object
5 properties
MinorUnitsMonetaryValue
object
2 properties
SwishInfo
object
1 property
1 required
UpdatePaymentMethodInfo
object
18 properties
GiroPayInfo
object
1 property
1 required
Key
object
3 properties
AdditionalSettings
object
2 properties
GenericPmWithTdiInfo
object
1 property
TapToPay
object
1 property
WifiProfiles
object
2 properties
Nexo
object
5 properties
Configuration
object
4 properties
2 required
Store
object
12 properties
EventUrl
object
2 properties
SplitConfiguration
object
4 properties
2 required
PayoutSettingsRequest
object
3 properties
1 required
BcmcInfo
object
2 properties
Links
object
1 property
1 required
ClearpayInfo
object
1 property
1 required
RequestActivationResponse
object
2 properties
TerminalProductPrice
object
2 properties
GenerateClientKeyResponse
object
1 property
1 required
ListStoresResponse
object
4 properties
2 required
UpdateMerchantApiCredentialRequest
object
4 properties
LinksElement
object
1 property
PaymentMethodSetupInfo
object
33 properties
1 required
ReceiptPrinting
object
16 properties
IdName
object
2 properties
CreateMerchantUserRequest
object
6 properties
3 required
RestServiceError
object
9 properties
5 required
TestWebhookResponse
object
1 property
Opi
object
3 properties
Payment
object
2 properties
GenerateHmacKeyResponse
object
1 property
1 required
KlarnaInfo
object
4 properties
3 required
SplitConfigurationLogic
object
15 properties
1 required
UpdateStoreRequest
object
7 properties
TerminalModelsResponse
object
1 property
SplitConfigurationList
object
1 property
User
object
10 properties
5 required
OfflineProcessing
object
2 properties
PayAtTable
object
3 properties
ApiCredentialLinks
object
6 properties
1 required
ListMerchantResponse
object
4 properties
2 required
Name2
object
2 properties
Url
object
4 properties
ReceiptOptions
object
3 properties
ShippingLocationsResponse
object
1 property
TerminalSettings
object
20 properties
InvalidField
object
3 properties
3 required
VippsInfo
object
2 properties
1 required
TestOutput
object
6 properties
1 required
UpdatePayoutSettingsRequest
object
1 property
AllowedOriginsResponse
object
1 property
JSONObject
object
MealVoucherFRInfo
object
3 properties
3 required
Timeouts
object
1 property
TwintInfo
object
1 property
1 required
TestWebhookRequest
object
2 properties
Webhook
object
22 properties
4 required
TerminalOrdersResponse
object
1 property
AfterpayTouchInfo
object
1 property
1 required
CreateMerchantResponse
object
7 properties
AllowedOrigin
object
3 properties
1 required
GenerateApiKeyResponse
object
1 property
1 required
AdditionalCommission
object
3 properties
CustomNotification
object
7 properties
NotificationUrl
object
2 properties
Name
object
2 properties
2 required
TerminalProductsResponse
object
1 property
StoreCreationRequest
object
8 properties
4 required
TerminalOrderRequest
object
6 properties
UpdateSplitConfigurationRequest
object
1 property
1 required
ListWebhooksResponse
object
5 properties
2 required
ListMerchantUsersResponse
object
4 properties
2 required
TerminalOrder
object
8 properties
ApiCredential
object
9 properties
6 required
Amount
object
2 properties
2 required
StoreSplitConfiguration
object
2 properties
DataCenter
object
2 properties
Refunds
object
1 property
Commission
object
2 properties
Settings
object
3 properties
UpdateSplitConfigurationRuleRequest
object
4 properties
3 required
UpdatableAddress
object
6 properties
Contact
object
5 properties
UpdateMerchantUserRequest
object
6 properties
StoreLocation
object
7 properties
1 required
UpdateMerchantWebhookRequest
object
13 properties
Merchant
object
14 properties
PaginationLinks
object
5 properties
3 required
PayoutSettings
object
7 properties
2 required
Connectivity
object
1 property
Profile
object
18 properties
4 required
Currency
object
3 properties
1 required
Localization
object
3 properties
UpdateSplitConfigurationLogicRequest
object
15 properties
1 required
SplitConfigurationRule
object
6 properties
4 required
File
object
2 properties
2 required
CreateMerchantRequest
object
7 properties
1 required
MerchantLinks
object
4 properties
1 required
CartesBancairesInfo
object
2 properties
1 required
ApplePayInfo
object
1 property
1 required
BillingEntitiesResponse
object
1 property
Signature
object
4 properties
PayPalInfo
object
3 properties
2 required
Hardware
object
3 properties
AdditionalSettingsResponse
object
3 properties
Surcharge
object
2 properties
Referenced
object
1 property
CardholderReceipt
object
1 property
CreateUserResponse
object
10 properties
5 required
PayoutSettingsResponse
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Adyen 12
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
#Merchants