adyen.com – ManagementService

Tools (121)

Extracted live via the executor SDK.

• accountCompanyLevel.getCompanies

  Returns 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 request, your API credential must have the following roles:

  • Management API—Account read
• accountCompanyLevel.getCompaniesCompanyId

  Returns 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 have the following roles:

  • Management API—Account read
• accountCompanyLevel.getCompaniesCompanyIdMerchants

  Returns the list of merchant accounts under the company account specified in the path. The list only includes merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters.

  To make this request, your API credential must have the following roles:

  • Management API—Account read
• accountMerchantLevel.getMerchants

  Returns 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 request, your API credential must have the following roles:

  • Management API—Account read
• accountMerchantLevel.getMerchantsMerchantId

  Returns the merchant account specified in the path. Your API credential must have access to the merchant account.

  To make this request, your API credential must have the following roles:

  • Management API—Account read
• accountMerchantLevel.postMerchants

  Creates a merchant account for the company account specified in the request.

  Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.

  To make this request, your API credential must have the following roles:

  • Management API—Accounts read and write
• accountMerchantLevel.postMerchantsMerchantIdActivate

  Sends a request to activate the merchant account identified in the path.

  You get the result of the activation asychronously through a merchant.updated webhook. Once the merchant account is activated, you can start using it to accept payments and payouts.

  Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.

  To make this request, your API credential must have the following roles:

  • Management API—Accounts read and write
• accountStoreLevel.getMerchantsMerchantIdStores

  Returns 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 request, your API credential must have one of the following roles:

  • Management API—Stores read
  • Management API—Stores read and write
• accountStoreLevel.getMerchantsMerchantIdStoresStoreId

  Returns the details of the store identified in the path.

  To make this request, your API credential must have one of the following roles:

  • Management API—Stores read
  • Management API—Stores read and write
• accountStoreLevel.getStores

  Returns 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 following roles:

  • Management API—Stores read
  • Management API—Stores read and write
• accountStoreLevel.getStoresStoreId

  Returns the details of the store identified in the path.

  To make this request, your API credential must have one of the following roles:

  • Management API—Stores read
  • Management API—Stores read and write
• accountStoreLevel.patchMerchantsMerchantIdStoresStoreId

  Updates 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:

  • Management API—Stores read and write
• accountStoreLevel.patchStoresStoreId

  Updates 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:

  • Management API—Stores read and write
• accountStoreLevel.postMerchantsMerchantIdStores

  Creates a store for the merchant account identified in the path.

  To make this request, your API credential must have the following role:

  • Management API—Stores read and write
• accountStoreLevel.postStores

  Creates a store for the merchant account specified in the request.

  To make this request, your API credential must have the following role:

  • Management API—Stores read and write
• allowedOriginsCompanyLevel.deleteCompaniesCompanyIdApiCredentialsApiCredentialIdAllowedOriginsOriginId

  Removes 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 this request, your API credential must have the following roles:

  • Management API—API credentials read and write
• allowedOriginsCompanyLevel.getCompaniesCompanyIdApiCredentialsApiCredentialIdAllowedOrigins

  Returns 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:

  • Management API—API credentials read and write
• allowedOriginsCompanyLevel.getCompaniesCompanyIdApiCredentialsApiCredentialIdAllowedOriginsOriginId

  Returns the allowed origin identified in the path.

  To make this request, your API credential must have the following roles:

  • Management API—API credentials read and write
• allowedOriginsCompanyLevel.postCompaniesCompanyIdApiCredentialsApiCredentialIdAllowedOrigins

  Adds 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:

  • Management API—API credentials read and write
• allowedOriginsMerchantLevel.deleteMerchantsMerchantIdApiCredentialsApiCredentialIdAllowedOriginsOriginId

  Removes 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 this request, your API credential must have the following roles:

  • Management API—API credentials read and write
• allowedOriginsMerchantLevel.getMerchantsMerchantIdApiCredentialsApiCredentialIdAllowedOrigins

  Returns 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:

  • Management API—API credentials read and write
• allowedOriginsMerchantLevel.getMerchantsMerchantIdApiCredentialsApiCredentialIdAllowedOriginsOriginId

  Returns the allowed origin identified in the path.

  To make this request, your API credential must have the following roles:

  • Management API—API credentials read and write
• allowedOriginsMerchantLevel.postMerchantsMerchantIdApiCredentialsApiCredentialIdAllowedOrigins

  Adds 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:

  • Management API—API credentials read and write
• apiCredentialsCompanyLevel.getCompaniesCompanyIdApiCredentials

  Returns 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 credential must have the following roles:

  • Management API—API credentials read and write
• apiCredentialsCompanyLevel.getCompaniesCompanyIdApiCredentialsApiCredentialId

  Returns the API credential identified in the path.

  To make this request, your API credential must have the following roles:

  • Management API—API credentials read and write
• apiCredentialsCompanyLevel.patchCompaniesCompanyIdApiCredentialsApiCredentialId

  Changes 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 response contains the full updated API credential, including the new values from the request.

  To make this request, your API credential must have the following roles:

  • Management API—API credentials read and write
• apiCredentialsCompanyLevel.postCompaniesCompanyIdApiCredentials

  Creates 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 have access to, as well as its roles and allowed origins.

  The response includes several types of authentication details:

  • API key: used for API request authentication.
  • Client key: public key used for client-side authentication.
  • Username and password: used for basic authentication.

  Make sure you store the API key securely in your system. You won't be able to retrieve it later.

  If your API key is lost or compromised, you need to generate a new API key.

  To make this request, your API credential must have the following roles:

  • Management API—API credentials read and write
• apiCredentialsMerchantLevel.getMerchantsMerchantIdApiCredentials

  Returns 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 API credential must have the following roles:

  • Management API—API credentials read and write
• apiCredentialsMerchantLevel.getMerchantsMerchantIdApiCredentialsApiCredentialId

  Returns the API credential identified in the path.

  To make this request, your API credential must have the following roles:

  • Management API—API credentials read and write
• apiCredentialsMerchantLevel.patchMerchantsMerchantIdApiCredentialsApiCredentialId

  Changes 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 updated API credential, including the new values from the request.

  To make this request, your API credential must have the following roles:

  • Management API—API credentials read and write
• apiCredentialsMerchantLevel.postMerchantsMerchantIdApiCredentials

  Creates 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 credential.

  The response includes the:

  • API key: used for API request authentication.
  • Client key: public key used for client-side authentication.
  • Username and password: used for basic authentication.

  Make sure you store the API key securely in your system. You won't be able to retrieve it later.

  If your API key is lost or compromised, you need to generate a new API key.

  To make this request, your API credential must have the following roles:

  • Management API—API credentials read and write
• apiKeyCompanyLevel.postCompaniesCompanyIdApiCredentialsApiCredentialIdGenerateApiKey

  Returns 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 generating a new one.

  To make this request, your API credential must have the following roles:

  • Management API—API credentials read and write
• apiKeyMerchantLevel.postMerchantsMerchantIdApiCredentialsApiCredentialIdGenerateApiKey

  Returns 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 generating a new one.

  To make this request, your API credential must have the following roles:

  • Management API—API credentials read and write
• clientKeyCompanyLevel.postCompaniesCompanyIdApiCredentialsApiCredentialIdGenerateClientKey

  Returns 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 stops working 24 hours after generating a new one.

  To make this request, your API credential must have the following roles:

  • Management API—API credentials read and write
• clientKeyMerchantLevel.postMerchantsMerchantIdApiCredentialsApiCredentialIdGenerateClientKey

  Returns 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 stops working 24 hours after generating a new one.

  To make this request, your API credential must have the following roles:

  • Management API—API credentials read and write
• myApiCredential.deleteMeAllowedOriginsOriginId

  Removes 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 the Management API roles.

• myApiCredential.getMe

  Returns 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.

• myApiCredential.getMeAllowedOrigins

  Returns 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 API roles.

• myApiCredential.getMeAllowedOriginsOriginId

  Returns 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 request with any of the Management API roles.

• myApiCredential.postMeAllowedOrigins

  Adds 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 make this request with any of the Management API roles.

• paymentMethodsMerchantLevel.getMerchantsMerchantIdPaymentMethodSettings

  Returns details for all payment methods of the merchant account identified in the path.

  To make this request, your API credential must have the following role:

  • Management API—Payment methods read
• paymentMethodsMerchantLevel.getMerchantsMerchantIdPaymentMethodSettingsPaymentMethodId

  Returns details for the merchant account and the payment method identified in the path.

  To make this request, your API credential must have the following role:

  • Management API—Payment methods read
• paymentMethodsMerchantLevel.getMerchantsMerchantIdPaymentMethodSettingsPaymentMethodIdGetApplePayDomains

  Returns 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 documentation.

  To make this request, your API credential must have the following role:

  • Management API—Payment methods read
• paymentMethodsMerchantLevel.patchMerchantsMerchantIdPaymentMethodSettingsPaymentMethodId

  Updates payment method details for the merchant account and the payment method identified in the path.

  To make this request, your API credential must have the following role:

  • Management API—Payment methods read and write
• paymentMethodsMerchantLevel.postMerchantsMerchantIdPaymentMethodSettings

  Sends a request to add a new payment method to the merchant account identified in the path.

  To make this request, your API credential must have the following role:

  • Management API—Payment methods read and write
• paymentMethodsMerchantLevel.postMerchantsMerchantIdPaymentMethodSettingsPaymentMethodIdAddApplePayDomains

  Adds 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 information, see Apple Pay documentation.

  To make this request, your API credential must have the following role:

  • Management API—Payment methods read and write
• payoutSettingsMerchantLevel.deleteMerchantsMerchantIdPayoutSettingsPayoutSettingsId

  Deletes the payout setting identified in the path.

  Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.

  To make this request, your API credential must have the following roles:

  • Management API—Payout account settings read and write
• payoutSettingsMerchantLevel.getMerchantsMerchantIdPayoutSettings

  Returns 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 Platforms Manage. Your Adyen contact will set up your access.

  To make this request, your API credential must have the following roles:

  • Management API—Payout account settings read
• payoutSettingsMerchantLevel.getMerchantsMerchantIdPayoutSettingsPayoutSettingsId

  Returns the payout setting identified in the path.

  Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.

  To make this request, your API credential must have the following roles:

  • Management API—Payout account settings read
• payoutSettingsMerchantLevel.patchMerchantsMerchantIdPayoutSettingsPayoutSettingsId

  Updates 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 Adyen for Platforms Manage. Your Adyen contact will set up your access.

  To make this request, your API credential must have the following roles:

  • Management API—Payout account settings read and write
• payoutSettingsMerchantLevel.postMerchantsMerchantIdPayoutSettings

  Sends 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 that contains the details of the payout bank account. Adyen verifies the bank account before allowing and enabling the payout setting.

  If you're accepting payments in multiple currencies, you may add multiple payout settings for the merchant account.

  Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.

  To make this request, your API credential must have the following roles:

  • Management API—Payout account settings read and write
• terminalActionsCompanyLevel.getCompaniesCompanyIdAndroidApps

  Returns 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 uninstalled on Android payment terminals through terminal actions.

  To make this request, your API credential must have one of the following roles:

  • Management API—Terminal actions read
  • Management API—Terminal actions read and write
• terminalActionsCompanyLevel.getCompaniesCompanyIdAndroidCertificates

  Returns a list of the Android certificates that are available for the company identified in the path. Typically, these certificates enable running apps on Android payment terminals. The certifcates in the list have been uploaded to Adyen and can be installed or uninstalled on Android terminals through terminal actions.

  To make this request, your API credential must have one of the following roles:

  • Management API—Terminal actions read
  • Management API—Terminal actions read and write
• terminalActionsCompanyLevel.getCompaniesCompanyIdTerminalActions

  Returns 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. To make this request, your API credential must have one of the following roles:

  • Management API—Terminal actions read
  • Management API—Terminal actions read and write
• terminalActionsCompanyLevel.getCompaniesCompanyIdTerminalActionsActionId

  Returns the details of the terminal action identified in the path. To make this request, your API credential must have one of the following roles:

  • Management API—Terminal actions read
  • Management API—Terminal actions read and write
• terminalActionsTerminalLevel.postTerminalsScheduleActions

  Schedules a terminal action by specifying the action and the terminals that the action must be applied to.

  The following restrictions apply:

  • You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests.
  • The maximum number of terminals in a request is 100. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests.
  • If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again.

  To make this request, your API credential must have the following role:

  • Management API—Terminal actions read and write
• terminalOrdersCompanyLevel.getCompaniesCompanyIdBillingEntities

  Returns 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 where we charge orders to. An order for terminal products must contain the ID of a billing entity.

  To make this request, your API credential must have one of the following roles:

  • Management API—Terminal ordering read
  • Management API—Terminal ordering read and write
• terminalOrdersCompanyLevel.getCompaniesCompanyIdShippingLocations

  Returns the shipping locations for the company identified in the path and all merchant accounts belonging to the company. A shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products.

  To make this request, your API credential must have one of the following roles:

  • Management API—Terminal ordering read
  • Management API—Terminal ordering read and write
• terminalOrdersCompanyLevel.getCompaniesCompanyIdTerminalModels

  Returns 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 used as a query parameter when getting a list of terminals or a list of products for ordering.

  To make this request, your API credential must have one of the following roles:

  • Management API—Terminal ordering read
  • Management API—Terminal ordering read and write
• terminalOrdersCompanyLevel.getCompaniesCompanyIdTerminalOrders

  Returns 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 request, your API credential must have one of the following roles:

  • Management API—Terminal ordering read
  • Management API—Terminal ordering read and write
• terminalOrdersCompanyLevel.getCompaniesCompanyIdTerminalOrdersOrderId

  Returns 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:

  • Management API—Terminal ordering read
  • Management API—Terminal ordering read and write
• terminalOrdersCompanyLevel.getCompaniesCompanyIdTerminalProducts

  Returns 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 credential must have one of the following roles:

  • Management API—Terminal ordering read
  • Management API—Terminal ordering read and write
• terminalOrdersCompanyLevel.patchCompaniesCompanyIdTerminalOrdersOrderId

  Updates 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 contain what you want to change. However, to update the products in the items array, you must provide the entire array. For example, if the array has three items: To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items.

  To make this request, your API credential must have the following role:

  • Management API—Terminal ordering read and write
• terminalOrdersCompanyLevel.postCompaniesCompanyIdShippingLocations

  Creates a shipping location for the company identified in the path. A shipping location defines an address where orders can be delivered.

  To make this request, your API credential must have the following role:

  • Management API—Terminal ordering read and write
• terminalOrdersCompanyLevel.postCompaniesCompanyIdTerminalOrders

  Creates 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:

  • Management API—Terminal ordering read and write
• terminalOrdersCompanyLevel.postCompaniesCompanyIdTerminalOrdersOrderIdCancel

  Cancels 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 call without a request body. The response returns the full order details, but with the status changed to Cancelled.

  To make this request, your API credential must have the following role:

  • Management API—Terminal ordering read and write
• terminalOrdersMerchantLevel.getMerchantsMerchantIdBillingEntities

  Returns 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 terminal products must contain the ID of a billing entity.

  To make this request, your API credential must have one of the following roles:

  • Management API—Terminal ordering read
  • Management API—Terminal ordering read and write
• terminalOrdersMerchantLevel.getMerchantsMerchantIdShippingLocations

  Returns the shipping locations for the merchant account identified in the path. A shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products.

  To make this request, your API credential must have one of the following roles:

  • Management API—Terminal ordering read
  • Management API—Terminal ordering read and write
• terminalOrdersMerchantLevel.getMerchantsMerchantIdTerminalModels

  Returns the payment terminal models that merchant account identified in the path has access to. The response includes the terminal model ID, which can be used as a query parameter when getting a list of terminals or a list of products for ordering.

  To make this request, your API credential must have one of the following roles:

  • Management API—Terminal ordering read
  • Management API—Terminal ordering read and write
• terminalOrdersMerchantLevel.getMerchantsMerchantIdTerminalOrders

  Returns 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 following roles:

  • Management API—Terminal ordering read
  • Management API—Terminal ordering read and write
• terminalOrdersMerchantLevel.getMerchantsMerchantIdTerminalOrdersOrderId

  Returns 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:

  • Management API—Terminal ordering read
  • Management API—Terminal ordering read and write
• terminalOrdersMerchantLevel.getMerchantsMerchantIdTerminalProducts

  Returns 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, your API credential must have one of the following roles:

  • Management API—Terminal ordering read
  • Management API—Terminal ordering read and write
• terminalOrdersMerchantLevel.patchMerchantsMerchantIdTerminalOrdersOrderId

  Updates 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 contain what you want to change. However, to update the products in the items array, you must provice the entire array. For example, if the array has three items: To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items.

  To make this request, your API credential must have the following role:

  • Management API—Terminal ordering read and write
• terminalOrdersMerchantLevel.postMerchantsMerchantIdShippingLocations

  Creates 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 this request, your API credential must have the following role:

  • Management API—Terminal ordering read and write
• terminalOrdersMerchantLevel.postMerchantsMerchantIdTerminalOrders

  Creates an order for payment terminal products for the merchant account identified in the path.

  To make this request, your API credential must have the following role:

  • Management API—Terminal ordering read and write
• terminalOrdersMerchantLevel.postMerchantsMerchantIdTerminalOrdersOrderIdCancel

  Cancels 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 call without a request body. The response returns the full order details, but with the status changed to Cancelled.

  To make this request, your API credential must have the following role:

  • Management API—Terminal ordering read and write
• terminalSettingsCompanyLevel.getCompaniesCompanyIdTerminalLogos

  Returns 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 string. You need to Base64-decode the string to get the actual image file. This logo applies to all terminals of the specified model under the company, unless a different logo is configured at a lower level (merchant account, store, or individual terminal).

  To make this request, your API credential must have one of the following roles:

  • Management API—Terminal settings read
  • Management API—Terminal settings read and write
• terminalSettingsCompanyLevel.getCompaniesCompanyIdTerminalSettings

  Returns the payment terminal settings that are configured for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level (merchant account, store, or individual terminal).

  To make this request, your API credential must have one of the following roles:

  • Management API—Terminal settings read
  • Management API—Terminal settings read and write

  For sensitive terminal settings, your API credential must have the following role:

  • Management API—Terminal settings Advanced read and write
• terminalSettingsCompanyLevel.patchCompaniesCompanyIdTerminalLogos

  Updates 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 model at a time. This logo applies to all terminals of the specified model under the company, unless a different logo is configured at a lower level (merchant account, store, or individual terminal).

  • To change the logo, specify the image file as a Base64-encoded string.
  • To restore the logo inherited from the Adyen PSP level, specify an empty logo value.

  To make this request, your API credential must have the following role:

  • Management API—Terminal settings read and write
• terminalSettingsCompanyLevel.patchCompaniesCompanyIdTerminalSettings

  Updates payment terminal settings for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level (merchant account, store, or individual terminal).

  • To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.
  • To restore a parameter value inherited from the Adyen PSP level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.
  • Objects that are not included in the request are not updated.

  To make this request, your API credential must have the following role:

  • Management API—Terminal settings read and write

  For sensitive terminal settings, your API credential must have the following role:

  • Management API—Terminal settings Advanced read and write
• terminalSettingsMerchantLevel.getMerchantsMerchantIdTerminalLogos

  Returns 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 Base64-encoded string. You need to Base64-decode the string to get the actual image file. This logo applies to all terminals of the specified model under the merchant account, unless a different logo is configured at a lower level (store or individual terminal).

  To make this request, your API credential must have one of the following roles:

  • Management API—Terminal settings read
  • Management API—Terminal settings read and write
• terminalSettingsMerchantLevel.getMerchantsMerchantIdTerminalSettings

  Returns the payment terminal settings that are configured for the merchant account identified in the path. These settings apply to all terminals under the merchant account unless different values are configured at a lower level (store or individual terminal).

  To make this request, your API credential must have one of the following roles:

  • Management API—Terminal settings read
  • Management API—Terminal settings read and write
• terminalSettingsMerchantLevel.patchMerchantsMerchantIdTerminalLogos

  Updates 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 a time. This logo applies to all terminals of the specified model under the merchant account, unless a different logo is configured at a lower level (store or individual terminal).

  • To change the logo, specify the image file as a Base64-encoded string.
  • To restore the logo inherited from the company account, specify an empty logo value.

  To make this request, your API credential must have the following role:

  • Management API—Terminal settings read and write
• terminalSettingsMerchantLevel.patchMerchantsMerchantIdTerminalSettings

  Updates payment terminal settings for the merchant account identified in the path. These settings apply to all terminals under the merchant account, unless different values are configured at a lower level (store or individual terminal).

  • To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.
  • To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.
  • Objects that are not included in the request are not updated.

  To make this request, your API credential must have the following role:

  • Management API—Terminal settings read and write
• terminalSettingsStoreLevel.getMerchantsMerchantIdStoresReferenceTerminalLogos

  Returns 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 string. You need to Base64-decode the string to get the actual image file. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal.

  To make this request, your API credential must have one of the following roles:

  • Management API—Terminal settings read
  • Management API—Terminal settings read and write
• terminalSettingsStoreLevel.getMerchantsMerchantIdStoresReferenceTerminalSettings

  Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an individual terminal.

  To make this request, your API credential must have one of the following roles:

  • Management API—Terminal settings read
  • Management API—Terminal settings read and write

  For sensitive terminal settings, your API credential must have the following role:

  • Management API—Terminal settings Advanced read and write
• terminalSettingsStoreLevel.getStoresStoreIdTerminalLogos

  Returns 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 string. You need to Base64-decode the string to get the actual image file. This logo applies to all terminals of that model under the store unless a different logo is configured for an individual terminal.

  To make this request, your API credential must have one of the following roles:

  • Management API—Terminal settings read
  • Management API—Terminal settings read and write
• terminalSettingsStoreLevel.getStoresStoreIdTerminalSettings

  Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an individual terminal.

  To make this request, your API credential must have one of the following roles:

  • Management API—Terminal settings read
  • Management API—Terminal settings read and write

  For sensitive terminal settings, your API credential must have the following role:

  • Management API—Terminal settings Advanced read and write
• terminalSettingsStoreLevel.patchMerchantsMerchantIdStoresReferenceTerminalLogos

  Updates 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 model at a time. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal.

  • To change the logo, specify the image file as a Base64-encoded string.
  • To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value.

  To make this request, your API credential must have the following role:

  • Management API—Terminal settings read and write
• terminalSettingsStoreLevel.patchMerchantsMerchantIdStoresReferenceTerminalSettings

  Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal.

  • To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.
  • To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.
  • Objects that are not included in the request are not updated.

  To make this request, your API credential must have the following role:

  • Management API—Terminal settings read and write

  For sensitive terminal settings, your API credential must have the following role:

  • Management API—Terminal settings Advanced read and write
• terminalSettingsStoreLevel.patchStoresStoreIdTerminalLogos

  Updates 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 model at a time. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal.

  • To change the logo, specify the image file as a Base64-encoded string.
  • To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value.

  To make this request, your API credential must have the following role:

  • Management API—Terminal settings read and write
• terminalSettingsStoreLevel.patchStoresStoreIdTerminalSettings

  Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal.

  • To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.
  • To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.
  • Objects that are not included in the request are not updated.

  To make this request, your API credential must have the following role:

  • Management API—Terminal settings read and write

  For sensitive terminal settings, your API credential must have the following role:

  • Management API—Terminal settings Advanced read and write
• terminalSettingsTerminalLevel.getTerminalsTerminalIdTerminalLogos

  Returns 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 Base64-decode the string to get the actual image file.

  To make this request, your API credential must have one of the following roles:

  • Management API—Terminal settings read
  • Management API—Terminal settings read and write
• terminalSettingsTerminalLevel.getTerminalsTerminalIdTerminalSettings

  Returns 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 following roles:

  • Management API—Terminal settings read
  • Management API—Terminal settings read and write

  For sensitive terminal settings, your API credential must have the following role:

  • Management API—Terminal settings Advanced read and write
• terminalSettingsTerminalLevel.patchTerminalsTerminalIdTerminalLogos

  Updates 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 logo inherited from a higher level (store, merchant account, or company account), specify an empty logo value.

  To make this request, your API credential must have the following role:

  • Management API—Terminal settings read and write
• terminalSettingsTerminalLevel.patchTerminalsTerminalIdTerminalSettings

  Updates the settings that are configured for the payment terminal identified in the path.

  • To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.
  • To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.
  • Objects that are not included in the request are not updated.

  To make this request, your API credential must have the following role:

  • Management API—Terminal settings read and write

  For sensitive terminal settings, your API credential must have the following role:

  • Management API—Terminal settings Advanced read and write
• terminalsTerminalLevel.getTerminals

  Returns the payment terminals that the API credential has access to and that match the query parameters. When using searchQuery, other query parameters are ignored.

  To make this request, your API credential must have the following roles:

  • Management API — Terminal actions read
• usersCompanyLevel.getCompaniesCompanyIdUsers

  Returns the list of users for the companyId identified in the path.

  To make this request, your API credential must have the following role:

  • Management API—Users read and write
• usersCompanyLevel.getCompaniesCompanyIdUsersUserId

  Returns user details for the userId and the companyId identified in the path.

  To make this request, your API credential must have the following role:

  • Management API—Users read and write
• usersCompanyLevel.patchCompaniesCompanyIdUsersUserId

  Updates user details for the userId and the companyId identified in the path.

  To make this request, your API credential must have the following role:

  • Management API—Users read and write
• usersCompanyLevel.postCompaniesCompanyIdUsers

  Creates 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 and write
• usersMerchantLevel.getMerchantsMerchantIdUsers

  Returns a list of users associated with the merchantId specified in the path.

  To make this request, your API credential must have the following role:

  • Management API—Users read and write
• usersMerchantLevel.getMerchantsMerchantIdUsersUserId

  Returns user details for the userId and the merchantId specified in the path.

  To make this request, your API credential must have the following role:

  • Management API—Users read and write
• usersMerchantLevel.patchMerchantsMerchantIdUsersUserId

  Updates user details for the userId and the merchantId specified in the path.

  To make this request, your API credential must have the following role:

  • Management API—Users read and write
• usersMerchantLevel.postMerchantsMerchantIdUsers

  Creates 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 and write
• webhooksCompanyLevel.deleteCompaniesCompanyIdWebhooksWebhookId

  Remove the configuration for the webhook identified in the path.

  To make this request, your API credential must have the following roles:

  • Management API—Webhooks read and write
• webhooksCompanyLevel.getCompaniesCompanyIdWebhooks

  Lists all webhook configurations for the company account.

  To make this request, your API credential must have one of the following roles:

  • Management API—Webhooks read
  • Management API—Webhooks read and write
• webhooksCompanyLevel.getCompaniesCompanyIdWebhooksWebhookId

  Returns the configuration for the webhook identified in the path.

  To make this request, your API credential must have one of the following roles:

  • Management API—Webhooks read
  • Management API—Webhooks read and write
• webhooksCompanyLevel.patchCompaniesCompanyIdWebhooksWebhookId

  Make 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. The response contains the full configuration for the webhook, which includes the new values from the request.

  To make this request, your API credential must have the following roles:

  • Management API—Webhooks read and write
• webhooksCompanyLevel.postCompaniesCompanyIdWebhooks

  Subscribe to receive webhook notifications about events related to your company account. You can add basic authentication to make sure the data is secure.

  To make this request, your API credential must have the following roles:

  • Management API—Webhooks read and write
• webhooksCompanyLevel.postCompaniesCompanyIdWebhooksWebhookIdGenerateHmac

  Returns 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 creating an HMAC key, you start receiving HMAC-signed notifications from Adyen. Find out more about how to verify HMAC signatures.

  To make this request, your API credential must have the following roles:

  • Management API—Webhooks read and write
• webhooksCompanyLevel.postCompaniesCompanyIdWebhooksWebhookIdTest

  Sends 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 is configured for. If the webhook is configured for more than 20 merchant accounts, use the merchantIds array to specify a subset of the merchant accounts for which to send test notifications.

  We send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification.

  The response describes the result of the test. The status field tells you if the test was successful or not. You can use the other response fields to troubleshoot unsuccessful tests.

  To make this request, your API credential must have the following roles:

  • Management API—Webhooks read and write
• webhooksMerchantLevel.deleteMerchantsMerchantIdWebhooksWebhookId

  Remove the configuration for the webhook identified in the path.

  To make this request, your API credential must have the following roles:

  • Management API—Webhooks read and write
• webhooksMerchantLevel.getMerchantsMerchantIdWebhooks

  Lists all webhook configurations for the merchant account.

  To make this request, your API credential must have one of the following roles:

  • Management API—Webhooks read
  • Management API—Webhooks read and write
• webhooksMerchantLevel.getMerchantsMerchantIdWebhooksWebhookId

  Returns the configuration for the webhook identified in the path.

  To make this request, your API credential must have one of the following roles:

  • Management API—Webhooks read
  • Management API—Webhooks read and write
• webhooksMerchantLevel.patchMerchantsMerchantIdWebhooksWebhookId

  Make 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. The response contains the full configuration for the webhook, which includes the new values from the request.

  To make this request, your API credential must have the following roles:

  • Management API—Webhooks read and write
• webhooksMerchantLevel.postMerchantsMerchantIdWebhooks

  Subscribe to receive webhook notifications about events related to your merchant account. You can add basic authentication to make sure the data is secure.

  To make this request, your API credential must have the following roles:

  • Management API—Webhooks read and write
• webhooksMerchantLevel.postMerchantsMerchantIdWebhooksWebhookIdGenerateHmac

  Returns 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 creating an HMAC key, you start receiving HMAC-signed notifications from Adyen. Find out more about how to verify HMAC signatures.

  To make this request, your API credential must have the following roles:

  • Management API—Webhooks read and write
• webhooksMerchantLevel.postMerchantsMerchantIdWebhooksWebhookIdTest

  Sends 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 failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification.

  The response describes the result of the test. The status field tells you if the test was successful or not. You can use the other fields to troubleshoot unsuccessful tests.

  To make this request, your API credential must have the following roles:

  • Management API—Webhooks read and write
• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools