{"title":"Roles for API credentials","category":"default","creationDate":1683102180,"content":"

API credentials use web service (ws) roles to define exactly which actions you can perform. While Adyen assigns a set of default roles when your company account is created, you may need to enable additional roles<\/a> in your Customer Area<\/a> to unlock specific Configuration API<\/a> or Transfers API<\/a> functionality. These roles specify what API requests a user can perform with this credential.<\/p>\n

Requirements<\/h2>\n

Before you begin, take into account the following requirements, limitations, and preparations.<\/p>\n\n\n\n\n\n\n
Requirement<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
Integration type<\/strong><\/td>\nYou must have the Adyen for Platforms<\/a> integration.<\/td>\n<\/tr>\n
API credentials<\/a><\/strong><\/td>\nYou must have a Balance Platform API key<\/a> (for example, ws[_123456]@BalancePlatform.[YourBalancePlatform]<\/strong>) to access the Configuration API<\/a> and Transfers API<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Frequently used roles<\/h2>\n

The following table shows roles that you use to make requests related to fund transfers.<\/p>\n\n\n\n\n\n\n\n
Web service role<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
Bank Transfer Initiation Webservice role<\/td>\nYou can initiate transfers.
This is only available for Transfers API v1<\/a>. <\/div><\/div><\/td>\n<\/tr>\n
TransferService Webservice Initiate role<\/td>\nYou can initiate transfers.<\/td>\n<\/tr>\n
TransferService Webservice Retrieve role<\/td>\nYou can view initiated transfers.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

See also<\/h2>\n