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 in your Customer Area to unlock specific Configuration API or Transfers API functionality. These roles specify what API requests a user can perform with this credential.
Requirements
Before you begin, take into account the following requirements, limitations, and preparations.
| Requirement | Description |
|---|---|
| Integration type | You must have the Adyen for Platforms integration. |
| API credentials | You must have a Balance Platform API key (for example, ws[_123456]@BalancePlatform.[YourBalancePlatform]) to access the Configuration API and Transfers API. |
Frequently used roles
The following table shows roles that you use to make requests related to fund transfers.
| Web service role | Description |
|---|---|
| Bank Transfer Initiation Webservice role | You can initiate transfers. This is only available for Transfers API v1. |
| TransferService Webservice Initiate role | You can initiate transfers. |
| TransferService Webservice Retrieve role | You can view initiated transfers. |