Management API

https://management-test.adyen.com/v1
Click to copy

Configure and manage your Adyen company and merchant accounts, stores, and payment terminals.

Authentication

Each request to the Management API must be signed with an API key. Generate your API key in the Customer Area and then set this key to the X-API-Key header value.

To access the live endpoints, you need to generate a new API key in your live Customer Area.

Versioning

Management API handles versioning as part of the endpoint URL. For example, to send a request to this version of the /companies/{companyId}/webhooks endpoint, use:

https://management-test.adyen.com/v1/companies/{companyId}/webhooks

Going live

To access the live endpoints, you need an API key from your live Customer Area. Use this API key to make requests to:

https://management-live.adyen.com/v1

Release notes

Have a look at the release notes to find out what changed in this version!

get/companies
Get a list of company accounts
get/companies/{companyId}
Get a company account
get/companies/{companyId}/androidApps
Get a list of Android apps
get/companies/{companyId}/androidCertificates
Get a list of Android certificates
get/companies/{companyId}/apiCredentials
Get a list of API credentials
post/companies/{companyId}/apiCredentials
Create an API credential.
get/companies/{companyId}/billingEntities
Get a list of billing entities
get/companies/{companyId}/merchants
Get a list of merchant accounts
get/companies/{companyId}/shippingLocations
Get a list of shipping locations
post/companies/{companyId}/shippingLocations
Create a shipping location
get/companies/{companyId}/terminalActions
Get a list of terminal actions
get/companies/{companyId}/terminalLogos
Get the terminal logo
patch/companies/{companyId}/terminalLogos
Update the terminal logo
get/companies/{companyId}/terminalModels
Get a list of terminal models
get/companies/{companyId}/terminalProducts
Get a list of terminal products
get/companies/{companyId}/terminalSettings
Get terminal settings
patch/companies/{companyId}/terminalSettings
Update terminal settings
get/companies/{companyId}/users
Get a list of users
post/companies/{companyId}/users
Create a new user
get/me
Get API credential details
get/me/allowedOrigins
Get allowed origins
post/me/allowedOrigins
Add allowed origin
get/me/allowedOrigins/{originId}
Get allowed origin details
delete/me/allowedOrigins/{originId}
Remove allowed origin
post/me/generateClientKey
Generate a client key
get/merchants
Get a list of merchant accounts
post/merchants
Create a merchant account
get/merchants/{merchantId}
Get a merchant account
post/merchants/{merchantId}/activate
Request to activate a merchant account
get/merchants/{merchantId}/apiCredentials
Get a list of API credentials
post/merchants/{merchantId}/apiCredentials
Create an API credential
get/merchants/{merchantId}/billingEntities
Get a list of billing entities
get/merchants/{merchantId}/payoutSettings
Get a list of payout settings
post/merchants/{merchantId}/payoutSettings
Add a payout setting
get/merchants/{merchantId}/shippingLocations
Get a list of shipping locations
post/merchants/{merchantId}/shippingLocations
Create a shipping location
get/merchants/{merchantId}/splitConfigurations
Get a list of split configurations
post/merchants/{merchantId}/splitConfigurations
Create a split configuration
get/merchants/{merchantId}/stores
Get a list of stores
post/merchants/{merchantId}/stores
Create a store
get/merchants/{merchantId}/terminalLogos
Get the terminal logo
patch/merchants/{merchantId}/terminalLogos
Update the terminal logo
get/merchants/{merchantId}/terminalModels
Get a list of terminal models
get/merchants/{merchantId}/terminalProducts
Get a list of terminal products
get/merchants/{merchantId}/users
Get a list of users
post/merchants/{merchantId}/users
Create a new user
get/stores
Get a list of stores
post/stores
Create a store
get/stores/{storeId}
Get a store
patch/stores/{storeId}
Update a store
get/stores/{storeId}/terminalLogos
Get the terminal logo
patch/stores/{storeId}/terminalLogos
Update the terminal logo
get/stores/{storeId}/terminalSettings
Get terminal settings
patch/stores/{storeId}/terminalSettings
Update terminal settings
get/terminals
Get a list of terminals
post/terminals/scheduleActions
Create a terminal action