Management API
Configure and manage your Adyen company and merchant accounts, stores, and payment terminals. Authentication Each request to the Management API must be signed…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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/v3/companies/{companyId}/webhooksGoing 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/v3Release notes
Have a look at the release notes to find out what changed in this version!
Endpoints 166
Account - company level
- GETGet a list of company accounts
/companies?pageNumber=0&pageSize=0Returns the list of company accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. To make this… - GETGet a company account
/companies/:companyIdReturns the company account specified in the path. Your API credential must have access to the company account. To make this request, your API credential must… - GETGet a list of merchant accounts
/companies/:companyId/merchants?pageNumber=0&pageSize=0Returns the list of merchant accounts under the company account specified in the path. The list only includes merchant accounts that your API credential has…
Account - merchant level
- GETGet a list of merchant accounts
/merchants?pageNumber=0&pageSize=0Returns the list of merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. To make this… - POSTCreate a merchant account
/merchantsCreates a merchant account for the company account specified in the request. Use this endpoint if your integration requires it, such as Adyen for Platforms… - GETGet a merchant account
/merchants/:merchantIdReturns the merchant account specified in the path. Your API credential must have access to the merchant account. To make this request, your API credential… - POSTRequest to activate a merchant account
/merchants/:merchantId/activateSends a request to activate the merchant account identified in the path. You get the result of the activation asynchronously through a merchant.updated…
Account - store level
- GETGet a list of stores
/merchants/:merchantId/stores?pageNumber=0&pageSize=0&reference=stringReturns a list of stores for the merchant account identified in the path. The list is grouped into pages as defined by the query parameters. To make this… - POSTCreate a store
/merchants/:merchantId/storesCreates a store for the merchant account identified in the path. To make this request, your API credential must have the following role: * Management… - GETGet a store
/merchants/:merchantId/stores/:storeIdReturns the details of the store identified in the path. To make this request, your API credential must have one of the following roles: * Management… - PATCHUpdate a store
/merchants/:merchantId/stores/:storeIdUpdates the store identified in the path. You can only update some store parameters. To make this request, your API credential must have the following role: *… - GETGet a list of stores
/stores?pageNumber=0&pageSize=0&reference=string&merchantId=stringReturns a list of stores. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have one of the… - POSTCreate a store
/storesCreates a store for the merchant account specified in the request. To make this request, your API credential must have the following role: * Management… - GETGet a store
/stores/:storeIdReturns the details of the store identified in the path. To make this request, your API credential must have one of the following roles: * Management… - PATCHUpdate a store
/stores/:storeIdUpdates the store identified in the path. You can only update some store parameters. To make this request, your API credential must have the following role: *…
Payout settings - merchant level
- GETGet a list of payout settings
/merchants/:merchantId/payoutSettingsReturns the list of payout settings for the merchant account identified in the path. Use this endpoint if your integration requires it, such as Adyen for… - POSTAdd a payout setting
/merchants/:merchantId/payoutSettingsSends a request to add a payout setting for the merchant account specified in the path. A payout setting links the merchant account to the transfer instrument… - GETGet a payout setting
/merchants/:merchantId/payoutSettings/:payoutSettingsIdReturns the payout setting identified in the path. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact… - DELETEDelete a payout setting
/merchants/:merchantId/payoutSettings/:payoutSettingsIdDeletes the payout setting identified in the path. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact… - PATCHUpdate a payout setting
/merchants/:merchantId/payoutSettings/:payoutSettingsIdUpdates the payout setting identified in the path. You can enable or disable the payout setting. Use this endpoint if your integration requires it, such as…
Users - company level
- GETGet a list of users
/companies/:companyId/users?pageNumber=0&pageSize=0&username=stringReturns the list of users for the companyId identified in the path. To make this request, your API credential must have the following role: * Management… - POSTCreate a new user
/companies/:companyId/usersCreates the user for the companyId identified in the path. To make this request, your API credential must have the following role: * Management API—Users read… - GETGet user details
/companies/:companyId/users/:userIdReturns user details for the userId and the companyId identified in the path. To make this request, your API credential must have the following role: *… - PATCHUpdate user details
/companies/:companyId/users/:userIdUpdates user details for the userId and the companyId identified in the path. To make this request, your API credential must have the following role: *…
Users - merchant level
- GETGet a list of users
/merchants/:merchantId/users?pageNumber=0&pageSize=0&username=stringReturns a list of users associated with the merchantId specified in the path. To make this request, your API credential must have the following role: *… - POSTCreate a new user
/merchants/:merchantId/usersCreates a user for the merchantId specified in the path. To make this request, your API credential must have the following role: * Management API—Users read… - GETGet user details
/merchants/:merchantId/users/:userIdReturns user details for the userId and the merchantId specified in the path. To make this request, your API credential must have the following role: *… - PATCHUpdate a user
/merchants/:merchantId/users/:userIdUpdates user details for the userId and the merchantId specified in the path. To make this request, your API credential must have the following role: *…
My API credential
- GETGet API credential details
/meReturns your API credential details based on the API Key you used in the request. You can make this request with any of the Management API roles. - GETGet allowed origins
/me/allowedOriginsReturns the list of allowed origins of your API credential based on the API key you used in the request. You can make this request with any of the Management… - POSTAdd allowed origin
/me/allowedOriginsAdds an allowed origin to the list of allowed origins of your API credential. The API key from the request is used to identify the API credential. You can… - GETGet allowed origin details
/me/allowedOrigins/:originIdReturns the details of the allowed origin specified in the path. The API key from the request is used to identify the API credential. You can make this… - DELETERemove allowed origin
/me/allowedOrigins/:originIdRemoves the allowed origin specified in the path. The API key from the request is used to identify the API credential. You can make this request with any of… - POSTGenerate a client key
/me/generateClientKeyGenerates a new client key used to authenticate requests from your payment environment. You can use the new client key a few minutes after generating it. The…
API credentials - company level
- GETGet a list of API credentials
/companies/:companyId/apiCredentials?pageNumber=0&pageSize=0Returns the list of API credentials for the company account. The list is grouped into pages as defined by the query parameters. To make this request, your API… - POSTCreate an API credential.
/companies/:companyId/apiCredentialsCreates an API credential for the company account identified in the path. In the request, you can specify which merchant accounts the new API credential will… - GETGet an API credential
/companies/:companyId/apiCredentials/:apiCredentialIdReturns the API credential identified in the path. To make this request, your API credential must have the following roles: * Management API—API credentials… - PATCHUpdate an API credential.
/companies/:companyId/apiCredentials/:apiCredentialIdChanges the API credential's roles, merchant account access, or allowed origins. The request has the new values for the fields you want to change. The…
API credentials - merchant level
- GETGet a list of API credentials
/merchants/:merchantId/apiCredentials?pageNumber=0&pageSize=0Returns the list of API credentials for the merchant account. The list is grouped into pages as defined by the query parameters. To make this request, your… - POSTCreate an API credential
/merchants/:merchantId/apiCredentialsCreates an API credential for the company account identified in the path. In the request, you can specify the roles and allowed origins for the new API… - GETGet an API credential
/merchants/:merchantId/apiCredentials/:apiCredentialIdReturns the API credential identified in the path. To make this request, your API credential must have the following roles: * Management API—API credentials… - PATCHUpdate an API credential
/merchants/:merchantId/apiCredentials/:apiCredentialIdChanges the API credential's roles, or allowed origins. The request has the new values for the fields you want to change. The response contains the full…
API key - company level
- POSTGenerate new API key
/companies/:companyId/apiCredentials/:apiCredentialId/generateApiKeyReturns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after…
API key - merchant level
- POSTGenerate new API key
/merchants/:merchantId/apiCredentials/:apiCredentialId/generateApiKeyReturns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after…
Client key - company level
- POSTGenerate new client key
/companies/:companyId/apiCredentials/:apiCredentialId/generateClientKeyReturns a new client key for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key…
Client key - merchant level
- POSTGenerate new client key
/merchants/:merchantId/apiCredentials/:apiCredentialId/generateClientKeyReturns a new client key for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key…
Allowed origins - company level
- GETGet a list of allowed origins
/companies/:companyId/apiCredentials/:apiCredentialId/allowedOriginsReturns the list of allowed origins for the API credential identified in the path. To make this request, your API credential must have the following roles: *… - POSTCreate an allowed origin
/companies/:companyId/apiCredentials/:apiCredentialId/allowedOriginsAdds a new allowed origin to the API credential's list of allowed origins. To make this request, your API credential must have the following roles: *… - GETGet an allowed origin
/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins/:originIdReturns the allowed origin identified in the path. To make this request, your API credential must have the following roles: * Management API—API credentials… - DELETEDelete an allowed origin
/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins/:originIdRemoves the allowed origin identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain. To make…
Allowed origins - merchant level
- GETGet a list of allowed origins
/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOriginsReturns the list of allowed origins for the API credential identified in the path. To make this request, your API credential must have the following roles: *… - POSTCreate an allowed origin
/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOriginsAdds a new allowed origin to the API credential's list of allowed origins. To make this request, your API credential must have the following roles: *… - GETGet an allowed origin
/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins/:originIdReturns the allowed origin identified in the path. To make this request, your API credential must have the following roles: * Management API—API credentials… - DELETEDelete an allowed origin
/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins/:originIdRemoves the allowed origin identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain. To make…
Webhooks - company level
- GETList all webhooks
/companies/:companyId/webhooks?pageNumber=0&pageSize=0Lists all webhook configurations for the company account. To make this request, your API credential must have one of the following roles: * Management… - POSTSet up a webhook
/companies/:companyId/webhooksSubscribe to receive webhook notifications about events related to your company account. You can add basic authentication to make sure the data is secure. To… - GETGet a webhook
/companies/:companyId/webhooks/:webhookIdReturns the configuration for the webhook identified in the path. To make this request, your API credential must have one of the following roles: * Management… - DELETERemove a webhook
/companies/:companyId/webhooks/:webhookIdRemove the configuration for the webhook identified in the path. To make this request, your API credential must have the following roles: * Management… - PATCHUpdate a webhook
/companies/:companyId/webhooks/:webhookIdMake changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration.… - POSTGenerate an HMAC key
/companies/:companyId/webhooks/:webhookId/generateHmacReturns an HMAC key for the webhook identified in the path. This key allows you to check the integrity and the origin of the notifications you receive.By… - POSTTest a webhook
/companies/:companyId/webhooks/:webhookId/testSends sample notifications to test if the webhook is set up correctly. We send sample notifications for maximum 20 of the merchant accounts that the webhook…
Webhooks - merchant level
- GETList all webhooks
/merchants/:merchantId/webhooks?pageNumber=0&pageSize=0Lists all webhook configurations for the merchant account. > This call does not return webhook configurations for the company account to which the specified… - POSTSet up a webhook
/merchants/:merchantId/webhooksSubscribe to receive webhook notifications about events related to your merchant account. You can add basic authentication to make sure the data is secure. To… - GETGet a webhook
/merchants/:merchantId/webhooks/:webhookIdReturns the configuration for the webhook identified in the path. To make this request, your API credential must have one of the following roles: * Management… - DELETERemove a webhook
/merchants/:merchantId/webhooks/:webhookIdRemove the configuration for the webhook identified in the path. To make this request, your API credential must have the following roles: * Management… - PATCHUpdate a webhook
/merchants/:merchantId/webhooks/:webhookIdMake changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration.… - POSTGenerate an HMAC key
/merchants/:merchantId/webhooks/:webhookId/generateHmacReturns an HMAC key for the webhook identified in the path. This key allows you to check the integrity and the origin of the notifications you receive.By… - POSTTest a webhook
/merchants/:merchantId/webhooks/:webhookId/testSends sample notifications to test if the webhook is set up correctly. We send four test notifications for each event code you choose. They cover success and…
Payment methods - merchant level
- GETGet all payment methods
/merchants/:merchantId/paymentMethodSettings?storeId=string&businessLineId=string&pageSize=0&pageNumber=0Returns details for all payment methods of the merchant account identified in the path. To make this request, your API credential must have the following… - POSTRequest a payment method
/merchants/:merchantId/paymentMethodSettingsSends a request to add a new payment method to the merchant account identified in the path. Depending the payment method type, you may need to send an… - GETGet payment method details
/merchants/:merchantId/paymentMethodSettings/:paymentMethodIdReturns details for the merchant account and the payment method identified in the path. To make this request, your API credential must have the following… - PATCHUpdate a payment method
/merchants/:merchantId/paymentMethodSettings/:paymentMethodIdUpdates payment method details for the merchant account and the payment method identified in the path. Depending the payment method type, you may need to send… - POSTAdd an Apple Pay domain
/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/addApplePayDomainsAdds the new domain to the list of Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more… - GETGet Apple Pay domains
/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/getApplePayDomainsReturns all Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see Apple Pay…
Terminals - terminal level
- GETGet a list of terminals
/terminals?searchQuery=string&otpQuery=string&countries=string&merchantIds=string&storeIds=string&brandModels=string&pageNumber=0&pageSize=0Returns the payment terminals that the API credential has access to and that match the query parameters. To make this request, your API credential must have… - POSTReassign a terminal
/terminals/:terminalId/reassignReassigns a payment terminal to a company account, merchant account, merchant account inventory, or a store. To make this request, your API credential must…
Terminal actions - company level
- GETGet a list of terminal actions
/companies/:companyId/terminalActions?pageNumber=0&pageSize=0&status=string&type=stringReturns the terminal actions that have been scheduled for the company identified in the path.The response doesn't include actions that are scheduled by Adyen.… - GETGet terminal action
/companies/:companyId/terminalActions/:actionIdReturns the details of the terminal action identified in the path. To make this request, your API credential must have one of the following roles: *…
Terminal actions - terminal level
- POSTCreate a terminal action
/terminals/scheduleActionsSchedules a terminal action by specifying the action and the terminals that the action must be applied to. The following restrictions apply: * You can…
Terminal orders - company level
- GETGet a list of billing entities
/companies/:companyId/billingEntities?name=stringReturns the billing entities of the company identified in the path and all merchant accounts belonging to the company. A billing entity is a legal entity… - GETGet a list of shipping locations
/companies/:companyId/shippingLocations?name=string&offset=0&limit=0Returns the shipping locations for the company identified in the path and all merchant accounts belonging to the company. A shipping location includes the… - POSTCreate a shipping location
/companies/:companyId/shippingLocationsCreates a shipping location for the company identified in the path. A shipping location defines an address where orders can be delivered. To make this… - GETGet a list of terminal models
/companies/:companyId/terminalModelsReturns a list of payment terminal models that the company identified in the path has access to. The response includes the terminal model ID, which can be… - GETGet a list of orders
/companies/:companyId/terminalOrders?customerOrderReference=string&status=string&offset=0&limit=0Returns a lists of terminal products orders for the company identified in the path. To filter the list, use one or more of the query parameters. To make this… - POSTCreate an order
/companies/:companyId/terminalOrdersCreates an order for payment terminal products for the company identified in the path. To make this request, your API credential must have the following role:… - GETGet an order
/companies/:companyId/terminalOrders/:orderIdReturns the details of the terminal products order identified in the path. To make this request, your API credential must have one of the following roles: *… - PATCHUpdate an order
/companies/:companyId/terminalOrders/:orderIdUpdates the terminal products order identified in the path. Updating is only possible while the order has the status Placed. The request body only needs to… - POSTCancel an order
/companies/:companyId/terminalOrders/:orderId/cancelCancels the terminal products order identified in the path. Cancelling is only possible while the order has the status Placed. To cancel an order, make a POST… - GETGet a list of terminal products
/companies/:companyId/terminalProducts?country=string&terminalModelId=string&offset=0&limit=0Returns a country-specific list of payment terminal packages and parts that the company identified in the path has access to. To make this request, your API…
Terminal orders - merchant level
- GETGet a list of billing entities
/merchants/:merchantId/billingEntities?name=stringReturns the billing entities of the merchant account identified in the path. A billing entity is a legal entity where we charge orders to. An order for… - GETGet a list of shipping locations
/merchants/:merchantId/shippingLocations?name=string&offset=0&limit=0Returns the shipping locations for the merchant account identified in the path. A shipping location includes the address where orders can be delivered, and an… - POSTCreate a shipping location
/merchants/:merchantId/shippingLocationsCreates a shipping location for the merchant account identified in the path. A shipping location defines an address where orders can be shipped to. To make… - GETGet a list of terminal models
/merchants/:merchantId/terminalModelsReturns the payment terminal models that the merchant account identified in the path has access to. The response includes the terminal model ID, which can be… - GETGet a list of orders
/merchants/:merchantId/terminalOrders?customerOrderReference=string&status=string&offset=0&limit=0Returns a list of terminal products orders for the merchant account identified in the path. To make this request, your API credential must have one of the… - POSTCreate an order
/merchants/:merchantId/terminalOrdersCreates an order for payment terminal products for the merchant account identified in the path. To make this request, your API credential must have the… - GETGet an order
/merchants/:merchantId/terminalOrders/:orderIdReturns the details of the terminal products order identified in the path. To make this request, your API credential must have one of the following roles: *… - PATCHUpdate an order
/merchants/:merchantId/terminalOrders/:orderIdUpdates the terminal products order identified in the path. Updating is only possible while the order has the status Placed. The request body only needs to… - POSTCancel an order
/merchants/:merchantId/terminalOrders/:orderId/cancelCancels the terminal products order identified in the path. Cancelling is only possible while the order has the status Placed. To cancel an order, make a POST… - GETGet a list of terminal products
/merchants/:merchantId/terminalProducts?country=string&terminalModelId=string&offset=0&limit=0Returns a country-specific list of payment terminal packages and parts that the merchant account identified in the path has access to. To make this request,…
Terminal settings - company level
- GETGet the terminal logo
/companies/:companyId/terminalLogos?model=stringReturns the logo that is configured for a specific payment terminal model at the company identified in the path. The logo is returned as a Base64-encoded… - PATCHUpdate the terminal logo
/companies/:companyId/terminalLogos?model=stringUpdates the logo that is configured for a specific payment terminal model at the company identified in the path. You can update the logo for only one terminal… - GETGet terminal settings
/companies/:companyId/terminalSettingsReturns the payment terminal settings that are configured for the company identified in the path. These settings apply to all terminals under the company,… - PATCHUpdate terminal settings
/companies/:companyId/terminalSettingsUpdates payment terminal settings for the company identified in the path. These settings apply to all terminals under the company, unless different values are…
Terminal settings - merchant level
- GETGet the terminal logo
/merchants/:merchantId/terminalLogos?model=stringReturns the logo that is configured for a specific payment terminal model at the merchant account identified in the path. The logo is returned as a… - PATCHUpdate the terminal logo
/merchants/:merchantId/terminalLogos?model=stringUpdates the logo for a specific payment terminal model at the merchant account identified in the path. You can update the logo for only one terminal model at… - GETGet terminal settings
/merchants/:merchantId/terminalSettingsReturns the payment terminal settings that are configured for the merchant account identified in the path. These settings apply to all terminals under the… - PATCHUpdate terminal settings
/merchants/:merchantId/terminalSettingsUpdates payment terminal settings for the merchant account identified in the path. These settings apply to all terminals under the merchant account, unless…
Terminal settings - store level
- GETGet the terminal logo
/merchants/:merchantId/stores/:reference/terminalLogos?model=stringReturns the logo that is configured for a specific payment terminal model at the store identified in the path. The logo is returned as a Base64-encoded… - PATCHUpdate the terminal logo
/merchants/:merchantId/stores/:reference/terminalLogos?model=stringUpdates the logo that is configured for a specific payment terminal model at the store identified in the path. You can update the logo for only one terminal… - GETGet terminal settings
/merchants/:merchantId/stores/:reference/terminalSettingsReturns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless… - PATCHUpdate terminal settings
/merchants/:merchantId/stores/:reference/terminalSettingsUpdates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are… - GETGet the terminal logo
/stores/:storeId/terminalLogos?model=stringReturns the logo that is configured for a specific payment terminal model at the store identified in the path. The logo is returned as a Base64-encoded… - PATCHUpdate the terminal logo
/stores/:storeId/terminalLogos?model=stringUpdates the logo that is configured for a specific payment terminal model at the store identified in the path. You can update the logo for only one terminal… - GETGet terminal settings
/stores/:storeId/terminalSettingsReturns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless… - PATCHUpdate terminal settings
/stores/:storeId/terminalSettingsUpdates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are…
Terminal settings - terminal level
- GETGet the terminal logo
/terminals/:terminalId/terminalLogosReturns the logo that is configured for the payment terminal identified in the path. The logo is returned as a Base64-encoded string. You need to… - PATCHUpdate the logo
/terminals/:terminalId/terminalLogosUpdates the logo for the payment terminal identified in the path. * To change the logo, specify the image file as a Base64-encoded string. * To restore the… - GETGet terminal settings
/terminals/:terminalId/terminalSettingsReturns the settings that are configured for the payment terminal identified in the path. To make this request, your API credential must have one of the… - PATCHUpdate terminal settings
/terminals/:terminalId/terminalSettingsUpdates the settings that are configured for the payment terminal identified in the path. * To change a parameter value, include the full object that contains…
Android files - company level
- GETGet a list of Android apps
/companies/:companyId/androidApps?pageNumber=0&pageSize=0&packageName=string&versionCode=0Returns a list of the Android apps that are available for the company identified in the path. These apps have been uploaded to Adyen and can be installed or… - POSTUpload Android App
/companies/:companyId/androidAppsUploads an Android APK file to Adyen. The maximum APK file size is 200 MB. To make this request, your API credential must have the following role: *… - GETGet Android app
/companies/:companyId/androidApps/:idReturns the details of the Android app identified in the path. These apps have been uploaded to Adyen and can be installed or uninstalled on Android payment… - PATCHReprocess Android App
/companies/:companyId/androidApps/:idReuploads the Android app identified in the path. To make this request, your API credential must have this role: * Management API—Android files read and write… - GETGet a list of Android certificates
/companies/:companyId/androidCertificates?pageNumber=0&pageSize=0&certificateName=stringReturns a list of the Android certificates that are available for the company identified in the path. Typically, these certificates enable running apps on… - POSTUpload Android certificate
/companies/:companyId/androidCertificatesUploads an Android certificate file to Adyen. To make this request, your API credential must have the following role: * Management API—Android files read and…
Split configuration - merchant level
- GETGet a list of split configuration profiles
/merchants/:merchantId/splitConfigurationsReturns the list of split configuration profiles for the merchant account. To make this request, your API credential must have the following role: *… - POSTCreate a split configuration profile
/merchants/:merchantId/splitConfigurationsCreates a split configuration profile to split payments automatically. After you associate it with a store/stores/(storeId)#request-splitConfiguration) in… - GETGet a split configuration profile
/merchants/:merchantId/splitConfigurations/:splitConfigurationIdReturns the details of the split configuration profile specified in the path. To make this request, your API credential must have the following role: *… - POSTCreate a rule
/merchants/:merchantId/splitConfigurations/:splitConfigurationIdCreates a rule in the split configuration profile specified in the path. To make this request, your API credential must have the following role: * Management… - DELETEDelete a split configuration profile
/merchants/:merchantId/splitConfigurations/:splitConfigurationIdDeletes the split configuration profile specified in the path. To make this request, your API credential must have the following role: * Management API -… - PATCHUpdate the description of the split configuration profile
/merchants/:merchantId/splitConfigurations/:splitConfigurationIdChanges the description of the split configuration profile specified in the path. To make this request, your API credential must have the following role: *… - DELETEDelete a rule
/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleIdDeletes the rule specified in the path. To make this request, your API credential must have the following role: * Management API - SplitConfiguration read and… - PATCHUpdate the split conditions
/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleIdChanges the split conditions of the rule specified in the path. To make this request, your API credential must have the following role: * Management API -… - PATCHUpdate the split logic
/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId/splitLogic/:splitLogicIdChanges the split logic specified in the path. To make this request, your API credential must have the following role: * Management API - SplitConfiguration…
Client certificates - company level
- GETRetrieve all valid client certificates for this company
/companies/:companyId/clientCertificatesRetrieve all previously issued client certificates under this company account which are still valid (neither expired nor revoked). To make this request, your… - POSTGenerate a client certificate
/companies/:companyId/clientCertificatesGenerates a client certificate for secure communication with Adyen using mutual TLS (mTLS). Provide a certificate signing request (CSR). Adyen signs it and…
Donation campaigns
- POSTCreate a donation campaign
/companies/:companyId/campaignManagementCreates a new donation campaign, to give shoppers the option to donate to a nonprofit organization when making a payment. A campaign can be for online… - GETGet the donation campaigns for an account holder
/companies/:companyId/campaignManagement/accountHolders/:accountHolderId?status=string&pageNumber=1&pageSize=10Returns a paginated list of donation campaigns associated with the account holder specified in the path. You can filter the list by campaign status. To make… - DELETEDelete a donation campaign
/companies/:companyId/campaignManagement/:donationCampaignIdRemoves the donation campaign specified in the path. This request is only allowed if the campaign has the status inactive. To make this request, your API… - PATCHUpdate a donation campaign
/companies/:companyId/campaignManagement/:donationCampaignIdUpdates the properties of the donation campaign specified in the path. Note the following restrictions: * You cannot use a PATCH request to update the… - POSTActivate or end a donation campaign
/companies/:companyId/campaignManagement/:donationCampaignId/status/:statusStarts or stops the donation campaign specified in the path, by providing a path parameter. Use the path parameter activate to start an inactive campaign, or… - POSTGet a list of nonprofits
/companies/:companyId/nonprofits?searchTerm=string&pageNumber=1&pageSize=10&goal=stringReturns a list of supported nonprofit organizations to choose from when creating a donation campaign. The list only contains nonprofits that are compatible…
Terminal themes - company level
- GETList terminal themes
/companies/:companyId/terminalThemes?pageSize=10&page=1&search=stringReturns a paginated list of terminal themes for the company specified in the path and all the associated merchant accounts. The response provides only the… - POSTCreate a terminal theme
/companies/:companyId/terminalThemesCreates a terminal theme for the company specified in the path, to customize screens shown on Android payment terminals. This request only creates a basic… - POSTUnapply a terminal theme
/companies/:companyId/terminalThemes/unapplyResets the theme assignment for the company specified in the path. The terminals under this company will switch to the default Adyen theme. However, if a… - GETGet a terminal theme
/companies/:companyId/terminalThemes/:idReturns the details of the terminal theme specified in the path. The response includes the metadata of the theme and the content delivery network (CDN) URLs… - DELETEDelete a terminal theme
/companies/:companyId/terminalThemes/:idDeletes the terminal theme identified in the path. If the theme is currently in use, you must first deactivate it using a call to the… - PATCHUpdate the metadata of a terminal theme
/companies/:companyId/terminalThemes/:idChanges the metadata, consisting of the name and dark or light mode, of the terminal theme specified in the path. To make this request, your API credential… - POSTApply a terminal theme
/companies/:companyId/terminalThemes/:id/applyApplies the terminal theme specified by its ID to all Android terminals under this company, unless a different theme is applied at a lower level (merchant… - POSTAdd an asset to a terminal theme
/companies/:companyId/terminalThemes/:id/assets?type=logo&model=AllAdds an image or video (an 'asset') to a terminal theme owned by the company specified in the path. This endpoint is rate limited. An asset is used for a… - DELETEDelete an asset from a terminal theme
/companies/:companyId/terminalThemes/:id/assets?type=logo&model=AllDeletes a single asset from a terminal theme owned by the company specified in the path. To identify the asset you want to remove, you must use the query… - POSTReplace a theme asset
/companies/:companyId/terminalThemes/:id/assets/replace?type=logo&model=AllReplaces an existing image or video (an 'asset') of a terminal theme owned by the company specified in the path. This endpoint is rate limited.\n\n" An asset…
Terminal themes - merchant level
- GETList terminal themes
/merchants/:merchantId/terminalThemes?pageSize=10&page=1&search=stringReturns a paginated list of terminal themes for the merchant account specified in the path. The response provides only the metadata of the themes. Assets… - POSTCreate a terminal theme
/merchants/:merchantId/terminalThemesCreates a terminal theme for the merchant account specified in the path, to customize screens shown on Android payment terminals. This request only creates a… - POSTUnapply a terminal theme
/merchants/:merchantId/terminalThemes/unapplyResets the theme assignment for the merchant account specified in the path. The Android terminals under this merchant account will switch to the custom theme… - GETGet a terminal theme
/merchants/:merchantId/terminalThemes/:idReturns the details of the terminal theme specified in the path. The response includes the metadata of the theme and the content delivery network (CDN) URLs… - DELETEDelete a terminal theme
/merchants/:merchantId/terminalThemes/:idDeletes the terminal theme identified in the path. If the theme is currently in use, you must first deactivate it using a call to the… - PATCHUpdate the metadata of a terminal theme
/merchants/:merchantId/terminalThemes/:idChanges the metadata, consisting of the name and dark or light mode, of the terminal theme specified in the path. To make this request, your API credential… - POSTApply a terminal theme
/merchants/:merchantId/terminalThemes/:id/applyApplies the terminal theme specified by its ID to all Android terminals under this merchant account, unless a different theme is applied at a lower level… - POSTAdd an asset to a terminal theme
/merchants/:merchantId/terminalThemes/:id/assets?type=logo&model=AllAdds an image or video (an 'asset') to a terminal theme owned by the merchant account specified in the path. This endpoint is rate limited. An asset is used… - DELETEDelete an asset from a terminal theme
/merchants/:merchantId/terminalThemes/:id/assets?type=logo&model=AllDeletes a single asset from a terminal theme owned by the merchant account specified in the path. To identify the asset you want to remove, you must use the… - POSTReplace a theme asset
/merchants/:merchantId/terminalThemes/:id/assets/replace?type=logo&model=AllReplaces an existing image or video (an 'asset') of a terminal theme owned by the merchant account specified in the path. This endpoint is rate limited.\n\n"…
Terminal themes - store level
- POSTUnapply a terminal theme
/stores/:storeId/terminalThemes/unapplyResets the theme assignment for the store specified in the path. The Android terminals under this store will switch to the theme from the next higher level… - POSTApply a terminal theme
/stores/:storeId/terminalThemes/:id/applyApplies the terminal theme specified by its ID to all Android terminals under this store, unless a different theme is applied to an individual terminal. To…
Terminal themes - terminal level
- POSTUnapply a terminal theme
/terminals/:terminalId/terminalThemes/unapplyResets the theme assignment for the Android terminal specified in the path. The terminal will switch to the theme from the next higher level where a custom… - POSTApply a terminal theme
/terminals/:terminalId/terminalThemes/:id/applyApplies the terminal theme specified by its ID to the specified Android terminal. The terminal must be deployed or boarded. To make this request, your API…
API details
- Base URL
https://management-test.adyen.com/v3- Authentication
- An API key in the X-API-Key header
HTTP Basic authentication (username and password) - Operations
- 166 operations on 102 pathsGET 69POST 55PATCH 29DELETE 13
- Main resources
- Terminal orders - company level 10Terminal orders - merchant level 10Terminal themes - company level 10Terminal themes - merchant level 10Split configuration - merchant level 9Account - store level 8Terminal settings - store level 8Webhooks - company level 7Webhooks - merchant level 7Android files - company level 6
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
3 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Adyen's published OpenAPI description (Adyen/adyen-openapi) (MIT)
How to test the Management API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Management API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the X-API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get a list of company accounts” (GET /companies?pageNumber=0&pageSize=0), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Management API?
Configure and manage your Adyen company and merchant accounts, stores, and payment terminals. Authentication Each request to the Management API must be signed… It is listed under Payments and has 166 endpoints.
Who publishes the Management API?
It is listed from Adyen's public API description (an OpenAPI document), not published by Adyen on Swastik Codes. Anyone who controls adyen.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Management API?
Requests go to https://management-test.adyen.com/v3. Endpoint paths are added to this base URL.
How do I authenticate with the Management API?
It accepts 2 methods: an API key in the X-API-Key header; HTTP Basic authentication (username and password).
How many endpoints does the Management API have?
166 operations on 102 paths (69 GET, 55 POST, 29 PATCH, 13 DELETE). The largest groups are Terminal orders - company level, Terminal orders - merchant level, Terminal themes - company level, Terminal themes - merchant level.
Is forking the Management API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.