Roles

API credentials have roles which say what the credential is allowed to do.

Your company API credential, for example ws@Company.[YourCompanyAccount], has a set of roles that were assigned by default when the company account was created. These default roles are marked in the tables on this page. Any role that your ws credential has, can be assigned to other credentials in your company. These roles are available through the Customer Area UI and through Management API.

If you need roles that your ws credential doesn't have, contact our Support Team.

Roles for payments

The following table show the most frequently used API credential roles for payments.

Role name	Assigned by default	Description
Merchant PAL webservice role		Make API requests to Adyen. If you disable this role, you can no longer process transactions with this API credential.
Checkout webservice role		Use our Checkout API.
Merchant Recurring role		Use tokenization to save shopper's payment details and use them for future payments.
Data Protection API		Use the Data Protection API, which allowed you to delete data, as required by General Data Protection Regulation (GDPR).
Checkout encrypted cardholder data		Use our Drop-in, Components, or Custom Card fields to send in encrypted card data. For this role, you need to assess your PCI DSS compliance according to Self-Assessment Questionnaire A (SAQ A).
API PCI Payments role		If you want to submit payment requests with raw card data, you need to assess your PCI DSS compliance according to Self-Assessment Questionnaire D (SAQ D). If you are using a Service Provider who has access to your shoppers' cardholder data, see the requirements when using a Service Provider. To enable this role, contact our Support Team.
API Payment RefundWithData		Submit unreferenced refunds. To enable this role, contact our Support Team.
POS Terminal Management API role		Use our Terminal Management API.
Management API—Assign Terminal		Use our Management API to assign payment terminals.

Management API roles

The following table show the most frequently used API credential roles for using the Management API.

Role name	Assigned by default	Description
Management API—Account read		Get the company and merchant accounts that the API credential has access to.
Management API—Stores read		Get the stores that the API credential has access to.
Management API—Stores read and write		Get, create, and update the stores that the API credential has access to.
Management API—API credentials read and write		Get, create, update, and delete the API credentials that the API credential has access to.
Management API—Users read and write		Get, create, and update the users that the API credential has access to.
Management API—Webhooks read		Get the webhooks that the API credential has access to.
Management API—Webhooks read and write		Get, create, update, and delete the webhooks that the API credential has access to.
Management API—Payment methods read		Get the payment methods that the API credential has access to.
Management API—Payment methods read and write		Get, create, and update the payment methods that the API credential has access to.
Management API—Terminal ordering read		Get the payment terminal orders, shipping locations, and billing locations that the API credential has access to.
Management API—Terminal ordering read and write		Get, create, and update the payment terminal orders, shipping locations, and billing locations that the API credential has access to.
Management API—Terminal settings read		Get the payment terminal settings that the API credential has access to.
Management API—Terminal settings read and write		Get, create, and update the payment terminal general settings that the API credential has access to.
Management API—Terminal settings Advanced read and write		Get, create, and update the sensitive payment terminal settings that the API credential has access to.
Management API—Terminal actions read		Get the payment terminal actions that the API credential has access to.
Management API—Terminal actions read and write		Get, create, and update the payment terminal actions that the API credential has access to.
Management API—SplitConfiguration read and write		Get, create, update, and delete split configuration profiles that determine if and how to split payments in an Adyen for Platforms integration.