Skip to main content
Only a Customer Area user who can manage API credentials, such as a Merchant admin, can create API credentials, generate a basic auth password and assign roles. Test and live accounts use separate Customer Areas and separate credentials.

​
Creating an API credential

Basic auth uses the username and password of an Adyen API credential (a web service user). Create it at company level so every merchant account under the company is visible. Basic auth covers the Management, Checkout and Classic Payment and Recurring actions; Balance Platform, Legal Entity, Transfers, Capital and Disputes actions are available only with an API key.

1

Sign in to Adyen

Sign in to the Customer Area for the environment you are connecting:

The Developers menu expanded in the Adyen Customer Area sidebar with API credentials highlighted
2

Start a new credential

On the API credentials page, click Create credential.

The API credentials page with the Create credential button highlighted
3

Choose the credential type

In the Create API credential window, select Web service user under Credential type.

  • Description: StackOne Integration
  • Click Create credential.
  • Adyen generates the Username in the format ws_123456@Company.YourCompany. It is shown on the Configure API credential page under General settings. Paste it into the Username field in StackOne Hub.
The Create API credential window with Web service user, the Description field and the Create credential button highlighted
4

Generate a password

Under Server settings > Authentication, open the Basic auth tab and click Generate password.

  • Click the copy icon next to the password.
  • The password is shown only once and cannot be retrieved later. Store it securely for use later.
  • Generating a new password deactivates the previous one, so connections using it stop working.
  • Paste it into the Password field in StackOne Hub.
The Basic auth tab under Server settings with the copy icon and Generate password button highlighted and the password hidden

​
Assigning roles

Roles decide which Adyen APIs the credential can call. Assign the roles for the actions you plan to use on the same Configure API credential page.

1

Select Management API roles

Under Permissions > Roles, expand ACCOUNT and select the roles you need.

  • Management API - Accounts read and write for companies, merchant accounts and stores.
  • Management API - API credentials read and write for API credentials.
  • Management API - Webhooks read and write for webhooks.
  • Management API — Payment methods read and write for payment method settings.
The Roles section with the ACCOUNT category expanded and four Management API roles highlighted
2

Save the credential

Expand UNCATEGORIZED and select Checkout webservice role to make payments, refunds and payment links.

  • Click Save changes to store and enable the newly generated password.
  • Roles that are not listed, such as the ones for reading Customer Area users or terminals, must be enabled for your account by Adyen support.
The UNCATEGORIZED roles with Checkout webservice role and the Save changes button highlighted

​
Find your live URL prefix

Your live URL prefix identifies your company’s live Checkout and Classic API endpoints. Leave Live URL Prefix empty for Test connections.

1

Copy the live URL prefix

In the live Customer Area, expand Developers and click API URLs, then copy the prefix shown on that page.

  • Format: {random}-{CompanyName}
  • Example: a1b2c3-AcmeCorp
  • Paste it into the Live URL Prefix field in StackOne Hub.
The API URLs page explaining that the live environment uses a prefix for Checkout, Classic, Recurring, Payouts and BinLookup APIs

​
Webhooks

The Native Webhook URL field in StackOne Hub is filled in automatically after you connect. You only need it if you also set up Adyen webhooks for this account.

​
Linking the Account from the Hub

1

Navigate to the Hub

Use one of the three Linking Account Methods to access the Hub.
2

Fill out the fields

Fill out the following fields using details from your provider:
  • Username
  • Password
  • Live URL Prefix (Optional)
3

Connect

  • Click Connect
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup

If the account linking is successful, you will see the newly linked account on your Accounts page.

​
Next Steps

Webhooks setup

Configure receiving Events for Adyen into StackOne.