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

Frequently used roles

The following tabs show the most frequently used web service roles that are available in your Balance Platform Customer Area.

The following table shows roles that you use to make requests for general configuration of your Balance Platform.

Web service role Description
Balance Platform BCL role You can create, update, and delete resources in your balance platform. For example: account holders, balance accounts, or transfer instruments.
Balance Platform BCL PCI role You can unmask and view PANs and CVVs/CVCs in the response of a POST /paymentInstruments request.
To use this role, you must also have the Balance Platform BCL role enabled.