No momento, esta página não está disponível em português
Default icon

Account management API

Use APIs to manage your own company and merchant account details, and your user accounts.

The Account management API allows you to:

  • Retrieve user account information and modify user account details.
  • Manage your company and merchant accounts. For example, you can use the APIs to update cost contract information, contract details, and bank account or payout information.

Authentication

Each request to the Account management API must be signed with an API key. Generate an API Key from your Customer Area and then set this key to the X-API-Key header value, for example:

curl
-H 'content-type: application/json' \
-H 'X-API-Key: Your_Account_management_API_key' \
...

Note that when going live, you need to generate a new API Key to access the live endpoints.

Notifications

You can also enable automatic notifications that are triggered whenever your account settings are modified.

Integration guidelines

While integrating the plataforma de pagamentos da Adyen of products and services with a third-party system, we strongly recommend you follow defensive programming best practices.
This means, for example, that system-automated decisions should have defaulted to non-delivery of products and services:

  • Your system should deliver products and services only after receiving an explicit authorisation response to a corresponding payment request.
  • Your system should not deliver any products or services when it does not receive any explicit response.

When communicating with Adyen, it is important to respect the DNS Time-To-Live (TTL). Some technologies, for example Java, cache DNS lookups by default. Adyen routinely changes its DNS configuration. If your implementation caches DNS lookup, it may affect your ability to submit modifications and/or payments.

This functionality requires additional configuration on Adyen's end. To enable it, contact our Support Team.