Issuin icon

Roles for API credentials

Learn what roles your API credential needs to perform an action

A credential for the Configuration API and Transfers API has web service (ws) roles assigned to it. These roles specify what API requests a user can perform with this credential.

Your ws API credential, for example, ws_[123456]@BalancePlatform.[YourBalancePlatform], has a set of default roles that is defined by Adyen. These default roles are assigned to your credential when your company account is created.

If you need additional ws roles for your credentials, enable these roles in your
Balance Platform Customer Area.

An API credential for web services must have at least one enabled role.

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