Connecting Adyen

Connecting Adyen uses API credentials rather than OAuth. To connect, you will
need three things from your Adyen account:

Your Merchant Account ID
An API key
Your domain prefix

Setup

Log in to your Adyen account.
Go to Account > Users (in newer Customer Area layouts, Developers > API
credentials).

You need a Web Service user (API credential) on your account with the roles
listed under API credential roles below, and, depending
on your needs, another for POS payments. The API PCI Payments role is what
allows card details to be passed via the Adyen API, and the Management API
roles are what let Shuttle register the webhook that completes captures and
refunds. If you do not have the user or permissions set up, contact Adyen to
have them added.
Generate an API key, and copy it into the Shuttle setup screen.
Grab your Merchant ID, and copy it into the Shuttle setup screen.
You will also need to know your domain prefix. This can be found by going to
Account > API URLs. On the API URLs and Response page, you can see the
configured endpoints for your company account.

📘
Tip
If you are having trouble connecting your account, make sure Adyen have enabled
the API PCI Payments role on your account. When requesting this role, say you
are using an integration by Shuttle Global.

API credential roles

The API credential you give Shuttle needs the following roles. Most can be
ticked on the credential yourself under Developers > API credentials >
Roles; the PCI role has to be requested from Adyen support.

Role	Why Shuttle needs it
Checkout webservice role	Taking payments and completing 3D Secure.
Merchant PAL webservice role	Capturing, refunding and voiding payments.
API PCI Payments role	Sending the card details entered in the Shuttle checkout to Adyen. Must be requested from Adyen support.
Management API - Account read	Reading your merchant account's settlement currency and company.
Management API - Webhooks read and write	Registering the webhook that tells Shuttle when a capture or refund has completed (see below).
Merchant Recurring role	Only if you save cards for later or recurring payments.
Cloud Device API role	Only if you take card-present payments on Adyen terminals.

Webhook

Adyen processes captures and refunds asynchronously. Shuttle sends the request,
Adyen accepts it, and the result arrives later on a webhook. Shuttle registers
this webhook on your Adyen account automatically when you save the connection,
using the Management API roles above.

If the credential is missing those roles, the webhook cannot be created. The
connection will still save and payments will still authorise, but every capture
and refund will stay pending in Shuttle and the refund option will not appear
against the payment. Add the roles to the credential, then open the Adyen
connection in Shuttle and save it again to have the webhook created.

📘
Note
The credential can be scoped to your company account or to a single merchant
account. Either works; Shuttle registers the webhook at whichever level the
credential can manage.

Extra settings

If you want to save card details, you will need to ask Adyen to enable
synchronous tokenisation on your account.

Interaction type

Choose eCommerce/MOTO. If you are using MOTO as well as eCommerce, check the
MOTO box so that transactions are passed correctly.

Address verification (AVS)

For AVS, you will need to ensure that this is configured in your Adyen portal.

Setting up a test account

If you need an Adyen test account before connecting, see
Creating an Adyen Sandbox Account.