Adyen

Adyen is a payment provider that integrates directly with StoreConnect. You can use Adyen for:

• Standard checkout payments with 3D Secure (3DS)
• Subscription and update subscription payments
• Additional and Salesforce payments
• Pre-authorization
• Google Pay and Apple Pay wallets
• Express checkout

Already have your credentials? Go to Configure Adyen in StoreConnect.

What you need

• Adyen merchant account
• Adyen API Key, Client Key, and Merchant Account name
• For production: your Adyen live URL prefix
• For Google Pay: a Google Merchant ID from the Google Pay & Wallet Console
• For Apple Pay: an Apple Developer account and OpenSSL installed on your computer

Get your Adyen credentials

All credentials are found in your Adyen Customer Area.

API Key

1. In Adyen, go to Developers > API credentials.
2. Select your credential or create a new one.

3. Under Authentication, generate and copy your API key.

Client Key

The Client Key is a public credential used by Adyen’s JavaScript library to handle card entry and wallet payments in the browser.

1. In the same API credentials page, copy the Client key.

:::note Your store URL must be added to the Allowed origins list on the API credentials page. This allows Adyen’s JavaScript library to run on your storefront. :::

Merchant Account name

Your Merchant Account name appears at the top of every page in the Adyen Customer Area.

Configure additional card data

Ensure that Adyen returns the following additional data to StoreConnect with each transaction.

1. In Adyen, Go to Developers > Additional Data.
2. Under Acquirer, enable Payment account reference.
3. Under Card, enable Card summary, Expiry data, Variant.

(Optional) For US stores wanting to enable direct debit/bank transfers.

1. Go to Adyen settings.
2. Change the country to United States.
3. Locate the ACH US Direct Debit option and click Add.
4. At the bottom right, click Submit to make the request.

Configure Adyen in StoreConnect

1. Open StoreConnect and go to Setup > Payments > Payment Providers.
2. Select New. Complete the fields as follows, then Save:

StoreConnect field	Adyen value
Name	Adyen. For testing, add - Sandbox.
Provider	Select Adyen from the list
API Mode	sandbox or production
API Key	Your Adyen API Key
API Secret	Leave blank — not used by Adyen
API Options	api_client: 'YOUR_CLIENT_KEY'
	merchant_account: 'YourMerchantAccountName'

Enable other payment features in the API Options field

The API Options field in the payment provider record is where you enable payment features such as 3DS, Apple Pay, Google Wallet, etc. The following sections step you through setting these up and then adding them to StoreConnect.

:::note The API Options field uses YAML format. Each option goes on its own line. :::

Live URL prefix (production only)

When using Adyen in production, you must add your live URL prefix to API Options. Without it, transactions will fail in production mode.

1. In Adyen, go to your live Customer Area.

2. Go to Developers > API URLs and copy the Prefix.

3. Add it to the API Options field in StoreConnect:

   yaml live_url_prefix: 1797a841fbb37ca7-YourCompanyName

Enable Google Pay and Apple Pay

Adyen supports Google Pay and Apple Pay on standard checkout, subscriptions, and express checkout.

To enable wallets, add the following to the API Options field on the Payment Provider record in StoreConnect:

yaml show_wallets: true express_checkout_enabled: true

Then continue with the setup below for each wallet.

Google Pay setup

Step 1: Get a Google Merchant ID

1. Go to the Google Pay & Wallet Console and create a merchant account if you don’t already have one.

2. Note your Merchant ID at the top of the console — it looks like BCR2DN4T7XDOFC2K.

Step 2: Add Google Pay options in StoreConnect

In the Payment Provider record in StoreConnect, add the following to the API Options field:

yaml merchant_name: 'Your Store Name' merchant_google_id: 'BCR2DN4T7XDOFC2K'

The merchant_name is the name displayed to customers on the Google Pay payment sheet. The merchant_google_id is your Google Merchant ID from Step 1. Your merchant_account (already set in basic config) is used by Adyen internally as the gateway merchant identifier.

Apple Pay setup

Setting up Apple Pay with Adyen involves three parts:

1. Set up the Apple Pay Payment Processing Certificate
2. Create a Merchant Identity Certificate
3. Register your store domain

Before starting, find your Apple Merchant Identifier at the top of the Certificates, Identifiers & Profiles page in your Apple Developer account, then add it to the API Options field in StoreConnect:

yaml apple_merchant_id: merchant.storeconnect.adyen

Part 1: Set up the Apple Pay Payment Processing Certificate

This certificate links Apple Pay to Adyen. Adyen generates the Certificate Signing Request (CSR) for this step.

In Adyen:

1. In your Adyen Customer Area, go to Settings and open the Apple Pay configuration.
2. Select Use your own certificate.
3. Enter your Apple Merchant ID (for example, merchant.storeconnect.adyen).

4. Click Download CSR to download the .csr file.

In Apple Developer:

1. Go to your merchant identifier and under Apple Pay Payment Processing Certificate, click Create Certificate.
2. Upload the .csr file you downloaded from Adyen, then click Continue.

3. On the success page, click Download to receive apple_pay.cer.

Back in Adyen:

1. Return to the Adyen Apple Pay setup page and skip Step 2.

2. In Step 3, click Choose File, select apple_pay.cer, then click Save changes.

Part 2: Create a Merchant Identity Certificate

The Merchant Identity Certificate authenticates your server when communicating with Apple Pay. You need OpenSSL installed to complete these steps.

1. On your computer, open a terminal and run the following to generate a private key and Certificate Signing Request (CSR):

   bash openssl genrsa -out apple_pay_merchant.key 2048 openssl req -new -key apple_pay_merchant.key -out apple_pay_merchant.csr

2. In Apple Developer, go to your merchant identifier and under Apple Pay Merchant Identity Certificate, click Create Certificate.
3. Upload apple_pay_merchant.csr and click Continue.
4. Click Download to receive merchant_id.cer.

5. Convert the certificate to PEM format:

   bash openssl x509 -inform DER -in merchant_id.cer -out merchant_id.pem

6. Add the contents of both files to the API Options field in StoreConnect:

   yaml apple_pay_private_key: |- -----BEGIN PRIVATE KEY----- (paste contents of apple_pay_merchant.key here) -----END PRIVATE KEY----- apple_pay_certificate: |- -----BEGIN CERTIFICATE----- (paste contents of merchant_id.pem here) -----END CERTIFICATE-----

:::tip When pasting multi-line certificate content into the API Options field, every line of the certificate must be indented consistently beneath the key name. Prepare the YAML in a text editor before pasting. :::

Part 3: Register your store domain

Apple requires your store domain to be registered and verified before Apple Pay will work in a browser.

1. In Apple Developer, go to your merchant identifier and scroll to Merchant Domains.
2. Click Add Domain, enter your store’s hostname (for example, store.yourdomain.com), then click Save.
3. Click Download to receive apple-developer-merchantid-domain-association.txt.

4. Add the file contents to the API Options field in StoreConnect:

   yaml applepay_verification: |- (paste the contents of apple-developer-merchantid-domain-association.txt here)

5. Back in Apple Developer, click OK next to the domain to trigger Apple’s verification check.

:::note Apple verifies your domain by requesting the verification file from https://yourstorename.com/.well-known/apple-developer-merchantid-domain-association.txt. StoreConnect serves this file automatically once it is saved in API Options.

Once verification is complete, you can remove the applepay_verification key from API Options — it is only needed during initial domain registration. :::

When setup is complete, the Apple Pay button appears on product pages and at checkout in Safari.

Sandbox and production configuration reference

Once all features are set up, use the reference below to see how sandbox and production configurations differ in StoreConnect.

StoreConnect field	Sandbox	Production
API Mode	sandbox	production
API Key	Sandbox API Key	Production API Key
API Options: live_url_prefix	Not required	Required — your Adyen live URL prefix

All other API Options values are the same for both environments.

Sandbox — complete API Options:

yaml api_client: 'YOUR_CLIENT_KEY' merchant_account: 'YourMerchantAccountName' show_wallets: true express_checkout_enabled: true merchant_name: 'Your Store Name' merchant_google_id: 'YOUR_GOOGLE_MERCHANT_ID' apple_merchant_id: merchant.storeconnect.Adyen apple_pay_private_key: |- -----BEGIN PRIVATE KEY----- (contents of apple_pay_merchant.key) -----END PRIVATE KEY----- apple_pay_certificate: |- -----BEGIN CERTIFICATE----- (contents of merchant_id.pem) -----END CERTIFICATE-----

Production — complete API Options:

yaml api_client: 'YOUR_CLIENT_KEY' merchant_account: 'YourMerchantAccountName' live_url_prefix: 1797a841fbb37ca7-YourCompanyName show_wallets: true express_checkout_enabled: true merchant_name: 'Your Store Name' merchant_google_id: 'YOUR_GOOGLE_MERCHANT_ID' apple_merchant_id: merchant.storeconnect.adyen apple_pay_private_key: |- -----BEGIN PRIVATE KEY----- (contents of apple_pay_merchant.key) -----END PRIVATE KEY----- apple_pay_certificate: |- -----BEGIN CERTIFICATE----- (contents of merchant_id.pem) -----END CERTIFICATE-----

:::note Only include the options for features you have set up. For example, if you are not using Apple Pay, omit the apple_merchant_id, apple_pay_private_key, and apple_pay_certificate keys. :::