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](https://docs.adyen.com/development-resources/api-credentials#generate-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 version 1 of the `/companies/{companyId}/webhooks` endpoint, use: ```text 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: ```text https://management-live.adyen.com/v1 ```
https://management-test.adyen.com/v1119 endpoints available
/meGet API credential details
/storesGet a list of stores
/storesCreate a store
/companiesGet a list of company accounts
/merchantsGet a list of merchant accounts
/merchantsCreate a merchant account
/terminalsGet a list of terminals
/stores/{storeId}Get a store
/stores/{storeId}Update a store
/me/allowedOriginsGet allowed origins
/me/allowedOriginsAdd allowed origin
/companies/{companyId}Get a company account
/merchants/{merchantId}Get a merchant account
/terminals/scheduleActionsCreate a terminal action
/companies/{companyId}/usersGet a list of users
/companies/{companyId}/usersCreate a new user
/me/allowedOrigins/{originId}Get allowed origin details
/me/allowedOrigins/{originId}Remove allowed origin
/merchants/{merchantId}/usersGet a list of users
/merchants/{merchantId}/usersCreate a new user
/merchants/{merchantId}/storesGet a list of stores
/merchants/{merchantId}/storesCreate a store
/companies/{companyId}/webhooksList all webhooks
/companies/{companyId}/webhooksSet up a webhook
/stores/{storeId}/terminalLogosGet the terminal logo
/stores/{storeId}/terminalLogosUpdate the terminal logo
/companies/{companyId}/merchantsGet a list of merchant accounts
/merchants/{merchantId}/activateRequest to activate a merchant account
/merchants/{merchantId}/webhooksList all webhooks
/merchants/{merchantId}/webhooksSet up a webhook
/companies/{companyId}/androidAppsGet a list of Android apps
/stores/{storeId}/terminalSettingsGet terminal settings
/stores/{storeId}/terminalSettingsUpdate terminal settings
/companies/{companyId}/terminalLogosGet the terminal logo
/companies/{companyId}/terminalLogosUpdate the terminal logo
/companies/{companyId}/apiCredentialsGet a list of API credentials
/companies/{companyId}/apiCredentialsCreate an API credential.
/companies/{companyId}/terminalModelsGet a list of terminal models
/companies/{companyId}/terminalOrdersGet a list of orders
/companies/{companyId}/terminalOrdersCreate an order
/companies/{companyId}/users/{userId}Get user details
/companies/{companyId}/users/{userId}Update user details
/merchants/{merchantId}/terminalLogosGet the terminal logo
/merchants/{merchantId}/terminalLogosUpdate the terminal logo
/terminals/{terminalId}/terminalLogosGet the terminal logo
/terminals/{terminalId}/terminalLogosUpdate the logo
/companies/{companyId}/billingEntitiesGet a list of billing entities
/companies/{companyId}/terminalActionsGet a list of terminal actions
/merchants/{merchantId}/apiCredentialsGet a list of API credentials
/merchants/{merchantId}/apiCredentialsCreate an API credential
/merchants/{merchantId}/payoutSettingsGet a list of payout settings
/merchants/{merchantId}/payoutSettingsAdd a payout setting
/merchants/{merchantId}/terminalModelsGet a list of terminal models
/merchants/{merchantId}/terminalOrdersGet a list of orders
/merchants/{merchantId}/terminalOrdersCreate an order
/merchants/{merchantId}/users/{userId}Get user details
/merchants/{merchantId}/users/{userId}Update a user
/companies/{companyId}/terminalProductsGet a list of terminal products
/companies/{companyId}/terminalSettingsGet terminal settings
/companies/{companyId}/terminalSettingsUpdate terminal settings
/merchants/{merchantId}/billingEntitiesGet a list of billing entities
/companies/{companyId}/shippingLocationsGet a list of shipping locations
/companies/{companyId}/shippingLocationsCreate a shipping location
/merchants/{merchantId}/stores/{storeId}Get a store
/merchants/{merchantId}/stores/{storeId}Update a store
/merchants/{merchantId}/terminalProductsGet a list of terminal products
/merchants/{merchantId}/terminalSettingsGet terminal settings
/merchants/{merchantId}/terminalSettingsUpdate terminal settings
/terminals/{terminalId}/terminalSettingsGet terminal settings
/terminals/{terminalId}/terminalSettingsUpdate terminal settings
/merchants/{merchantId}/shippingLocationsGet a list of shipping locations
/merchants/{merchantId}/shippingLocationsCreate a shipping location
/companies/{companyId}/androidCertificatesGet a list of Android certificates
/companies/{companyId}/webhooks/{webhookId}Get a webhook
/companies/{companyId}/webhooks/{webhookId}Update a webhook
/companies/{companyId}/webhooks/{webhookId}Remove a webhook
/merchants/{merchantId}/webhooks/{webhookId}Get a webhook
/merchants/{merchantId}/webhooks/{webhookId}Update a webhook
/merchants/{merchantId}/webhooks/{webhookId}Remove a webhook
/merchants/{merchantId}/paymentMethodSettingsGet all payment methods
/merchants/{merchantId}/paymentMethodSettingsRequest a payment method
/companies/{companyId}/terminalOrders/{orderId}Get an order
/companies/{companyId}/terminalOrders/{orderId}Update an order
/companies/{companyId}/webhooks/{webhookId}/testTest a webhook
/merchants/{merchantId}/terminalOrders/{orderId}Get an order
/merchants/{merchantId}/terminalOrders/{orderId}Update an order
/companies/{companyId}/terminalActions/{actionId}Get terminal action
/merchants/{merchantId}/webhooks/{webhookId}/testTest a webhook
/companies/{companyId}/terminalOrders/{orderId}/cancelCancel an order
/companies/{companyId}/apiCredentials/{apiCredentialId}Get an API credential
/companies/{companyId}/apiCredentials/{apiCredentialId}Update an API credential.
/merchants/{merchantId}/terminalOrders/{orderId}/cancelCancel an order
/companies/{companyId}/webhooks/{webhookId}/generateHmacGenerate an HMAC key
/merchants/{merchantId}/apiCredentials/{apiCredentialId}Get an API credential
/merchants/{merchantId}/apiCredentials/{apiCredentialId}Update an API credential
/merchants/{merchantId}/stores/{reference}/terminalLogosGet the terminal logo
/merchants/{merchantId}/stores/{reference}/terminalLogosUpdate the terminal logo
/merchants/{merchantId}/payoutSettings/{payoutSettingsId}Get a payout setting
/merchants/{merchantId}/payoutSettings/{payoutSettingsId}Update a payout setting
/merchants/{merchantId}/payoutSettings/{payoutSettingsId}Delete a payout setting
/merchants/{merchantId}/webhooks/{webhookId}/generateHmacGenerate an HMAC key
/merchants/{merchantId}/stores/{reference}/terminalSettingsGet terminal settings
/merchants/{merchantId}/stores/{reference}/terminalSettingsUpdate terminal settings
/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}Get payment method details
/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}Update a payment method
/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOriginsGet a list of allowed origins
/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOriginsCreate an allowed origin
/companies/{companyId}/apiCredentials/{apiCredentialId}/generateApiKeyGenerate new API key
/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOriginsGet a list of allowed origins
/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOriginsCreate an allowed origin
/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateApiKeyGenerate new API key
/companies/{companyId}/apiCredentials/{apiCredentialId}/generateClientKeyGenerate new client key
/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateClientKeyGenerate new client key
/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}Get an allowed origin
/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}Delete an allowed origin
/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}Get an allowed origin
/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}Delete an allowed origin
/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}/addApplePayDomainsAdd an Apple Pay domain
/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}/getApplePayDomainsGet Apple Pay domains
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](https://docs.adyen.com/development-resources/api-credentials#generate-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 version 1 of the `/companies/{companyId}/webhooks` endpoint, use: ```text 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: ```text https://management-live.adyen.com/v1 ```
https://management-test.adyen.com/v1119 endpoints available
/meGet API credential details
/storesGet a list of stores
/storesCreate a store
/companiesGet a list of company accounts
/merchantsGet a list of merchant accounts
/merchantsCreate a merchant account
/terminalsGet a list of terminals
/stores/{storeId}Get a store
/stores/{storeId}Update a store
/me/allowedOriginsGet allowed origins
/me/allowedOriginsAdd allowed origin
/companies/{companyId}Get a company account
/merchants/{merchantId}Get a merchant account
/terminals/scheduleActionsCreate a terminal action
/companies/{companyId}/usersGet a list of users
/companies/{companyId}/usersCreate a new user
/me/allowedOrigins/{originId}Get allowed origin details
/me/allowedOrigins/{originId}Remove allowed origin
/merchants/{merchantId}/usersGet a list of users
/merchants/{merchantId}/usersCreate a new user
/merchants/{merchantId}/storesGet a list of stores
/merchants/{merchantId}/storesCreate a store
/companies/{companyId}/webhooksList all webhooks
/companies/{companyId}/webhooksSet up a webhook
/stores/{storeId}/terminalLogosGet the terminal logo
/stores/{storeId}/terminalLogosUpdate the terminal logo
/companies/{companyId}/merchantsGet a list of merchant accounts
/merchants/{merchantId}/activateRequest to activate a merchant account
/merchants/{merchantId}/webhooksList all webhooks
/merchants/{merchantId}/webhooksSet up a webhook
/companies/{companyId}/androidAppsGet a list of Android apps
/stores/{storeId}/terminalSettingsGet terminal settings
/stores/{storeId}/terminalSettingsUpdate terminal settings
/companies/{companyId}/terminalLogosGet the terminal logo
/companies/{companyId}/terminalLogosUpdate the terminal logo
/companies/{companyId}/apiCredentialsGet a list of API credentials
/companies/{companyId}/apiCredentialsCreate an API credential.
/companies/{companyId}/terminalModelsGet a list of terminal models
/companies/{companyId}/terminalOrdersGet a list of orders
/companies/{companyId}/terminalOrdersCreate an order
/companies/{companyId}/users/{userId}Get user details
/companies/{companyId}/users/{userId}Update user details
/merchants/{merchantId}/terminalLogosGet the terminal logo
/merchants/{merchantId}/terminalLogosUpdate the terminal logo
/terminals/{terminalId}/terminalLogosGet the terminal logo
/terminals/{terminalId}/terminalLogosUpdate the logo
/companies/{companyId}/billingEntitiesGet a list of billing entities
/companies/{companyId}/terminalActionsGet a list of terminal actions
/merchants/{merchantId}/apiCredentialsGet a list of API credentials
/merchants/{merchantId}/apiCredentialsCreate an API credential
/merchants/{merchantId}/payoutSettingsGet a list of payout settings
/merchants/{merchantId}/payoutSettingsAdd a payout setting
/merchants/{merchantId}/terminalModelsGet a list of terminal models
/merchants/{merchantId}/terminalOrdersGet a list of orders
/merchants/{merchantId}/terminalOrdersCreate an order
/merchants/{merchantId}/users/{userId}Get user details
/merchants/{merchantId}/users/{userId}Update a user
/companies/{companyId}/terminalProductsGet a list of terminal products
/companies/{companyId}/terminalSettingsGet terminal settings
/companies/{companyId}/terminalSettingsUpdate terminal settings
/merchants/{merchantId}/billingEntitiesGet a list of billing entities
/companies/{companyId}/shippingLocationsGet a list of shipping locations
/companies/{companyId}/shippingLocationsCreate a shipping location
/merchants/{merchantId}/stores/{storeId}Get a store
/merchants/{merchantId}/stores/{storeId}Update a store
/merchants/{merchantId}/terminalProductsGet a list of terminal products
/merchants/{merchantId}/terminalSettingsGet terminal settings
/merchants/{merchantId}/terminalSettingsUpdate terminal settings
/terminals/{terminalId}/terminalSettingsGet terminal settings
/terminals/{terminalId}/terminalSettingsUpdate terminal settings
/merchants/{merchantId}/shippingLocationsGet a list of shipping locations
/merchants/{merchantId}/shippingLocationsCreate a shipping location
/companies/{companyId}/androidCertificatesGet a list of Android certificates
/companies/{companyId}/webhooks/{webhookId}Get a webhook
/companies/{companyId}/webhooks/{webhookId}Update a webhook
/companies/{companyId}/webhooks/{webhookId}Remove a webhook
/merchants/{merchantId}/webhooks/{webhookId}Get a webhook
/merchants/{merchantId}/webhooks/{webhookId}Update a webhook
/merchants/{merchantId}/webhooks/{webhookId}Remove a webhook
/merchants/{merchantId}/paymentMethodSettingsGet all payment methods
/merchants/{merchantId}/paymentMethodSettingsRequest a payment method
/companies/{companyId}/terminalOrders/{orderId}Get an order
/companies/{companyId}/terminalOrders/{orderId}Update an order
/companies/{companyId}/webhooks/{webhookId}/testTest a webhook
/merchants/{merchantId}/terminalOrders/{orderId}Get an order
/merchants/{merchantId}/terminalOrders/{orderId}Update an order
/companies/{companyId}/terminalActions/{actionId}Get terminal action
/merchants/{merchantId}/webhooks/{webhookId}/testTest a webhook
/companies/{companyId}/terminalOrders/{orderId}/cancelCancel an order
/companies/{companyId}/apiCredentials/{apiCredentialId}Get an API credential
/companies/{companyId}/apiCredentials/{apiCredentialId}Update an API credential.
/merchants/{merchantId}/terminalOrders/{orderId}/cancelCancel an order
/companies/{companyId}/webhooks/{webhookId}/generateHmacGenerate an HMAC key
/merchants/{merchantId}/apiCredentials/{apiCredentialId}Get an API credential
/merchants/{merchantId}/apiCredentials/{apiCredentialId}Update an API credential
/merchants/{merchantId}/stores/{reference}/terminalLogosGet the terminal logo
/merchants/{merchantId}/stores/{reference}/terminalLogosUpdate the terminal logo
/merchants/{merchantId}/payoutSettings/{payoutSettingsId}Get a payout setting
/merchants/{merchantId}/payoutSettings/{payoutSettingsId}Update a payout setting
/merchants/{merchantId}/payoutSettings/{payoutSettingsId}Delete a payout setting
/merchants/{merchantId}/webhooks/{webhookId}/generateHmacGenerate an HMAC key
/merchants/{merchantId}/stores/{reference}/terminalSettingsGet terminal settings
/merchants/{merchantId}/stores/{reference}/terminalSettingsUpdate terminal settings
/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}Get payment method details
/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}Update a payment method
/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOriginsGet a list of allowed origins
/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOriginsCreate an allowed origin
/companies/{companyId}/apiCredentials/{apiCredentialId}/generateApiKeyGenerate new API key
/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOriginsGet a list of allowed origins
/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOriginsCreate an allowed origin
/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateApiKeyGenerate new API key
/companies/{companyId}/apiCredentials/{apiCredentialId}/generateClientKeyGenerate new client key
/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateClientKeyGenerate new client key
/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}Get an allowed origin
/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}Delete an allowed origin
/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}Get an allowed origin
/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}Delete an allowed origin
/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}/addApplePayDomainsAdd an Apple Pay domain
/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}/getApplePayDomainsGet Apple Pay domains