{"title":"Adyen","slug":"adyen-payment-provider","url":"https://support.storeconnect.com/articles/adyen-payment-provider","url_markdown":"https://support.storeconnect.com/articles/adyen-payment-provider.md","subtitle":null,"summary":"Configure Adyen as a payment provider in StoreConnect, including standard checkout, subscriptions, 3DS, Google Pay, Apple Pay, and express checkout.","type":"Help_Documentation","video_url":"","keywords":"adyen, payment provider, payment gateway, checkout, 3d secure, 3ds, google pay, apple pay, express checkout, subscriptions, pre-authorization, digital wallets","last_modified":"2026-08-21T07:12:35+0000","body_markdown":"Adyen is a payment provider that integrates directly with StoreConnect. You can use Adyen for:\n\n- Standard checkout payments with 3D Secure (3DS)\n- Subscription and update subscription payments\n- Additional and Salesforce payments\n- Pre-authorization\n- Google Pay and Apple Pay wallets\n- Express checkout\n\n\u003e Already have your credentials? Go to [Configure Adyen in StoreConnect](#configure-adyen-in-storeconnect).\n\n## What you need\n\n- [Adyen merchant account](https://www.adyen.com/online-payments)\n- Adyen API Key, Client Key, and Merchant Account name\n- For production: your Adyen live URL prefix\n- For Google Pay: a Google Merchant ID from the Google Pay \u0026 Wallet Console\n- For Apple Pay: an Apple Developer account and OpenSSL installed on your computer\n\n## Get your Adyen credentials\n\nAll credentials are found in your Adyen Customer Area.\n\n### API Key\n\n1. In Adyen, go to **Developers \u003e API credentials**.\n2. Select your credential or create a new one.\n3. Under **Authentication**, generate and copy your **API key**.\n\n   \u003c!-- Screenshot: Adyen API Credentials page showing API key --\u003e\n\n### Client Key\n\nThe Client Key is a public credential used by Adyen's JavaScript library to handle card entry and wallet payments in the browser.\n\n1. In the same **API credentials** page, copy the **Client key**.\n\n   \u003c!-- Screenshot: Adyen API Credentials page showing Client key --\u003e\n\n:::note\nYour 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.\n:::\n\n\u003c!-- Screenshot: Adyen API Credentials — Allowed origins section with store URL added --\u003e\n\n### Merchant Account name\n\nYour Merchant Account name appears at the top of every page in the Adyen Customer Area.\n\n\u003c!-- Screenshot: Adyen Customer Area header showing Merchant Account name --\u003e\n\n### Configure additional card data\n\nEnsure that Adyen returns the following additional data to StoreConnect with each transaction.\n\n1. In Adyen, Go to **Developers \u003e Additional Data**.\n2. Under **Acquirer**, enable **Payment account reference**.\n3. Under **Card**, enable **Card summary**, **Expiry data**, **Variant**.\n\n### ACH direct debit (US stores)\n\nFor US stores that want to accept ACH bank payments, see [Adyen ACH](adyen-ach-payment-provider).\n\n## Configure Adyen in StoreConnect\n\n1. Open StoreConnect and go to **Setup \u003e Payments \u003e Payment Providers**.\n2. Select **New**. Complete the fields as follows, then **Save**:\n\n| StoreConnect field | Adyen value                               |\n|--------------------|-------------------------------------------|\n| Name               | Adyen. For testing, add - Sandbox.        |\n| Provider           | Select Adyen from the list                |\n| API Mode           | sandbox or production                     |\n| API Key            | Your Adyen API Key                        |\n| API Secret         | Leave blank — not used by Adyen           |\n| API Options        | `api_client: 'YOUR_CLIENT_KEY'`           |\n|                     | `merchant_account: 'YourMerchantAccountName'` |\n\n## Enable other payment features in the API Options field\n\nThe **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. \n\n:::note\nThe API Options field uses YAML format. Each option goes on its own line.\n:::\n\n## Live URL prefix (production only)\n\nWhen using Adyen in production, you must add your live URL prefix to API Options. Without it, transactions will fail in production mode.\n\n1. In Adyen, go to your live Customer Area.\n2. Go to **Developers \u003e API URLs** and copy the **Prefix**.\n\n   \u003c!-- Screenshot: Adyen Developers \u003e API URLs showing the prefix value --\u003e\n\n3. Add it to the **API Options** field in StoreConnect:\n\n   ```yaml\n\n   live_url_prefix: 1797a841fbb37ca7-YourCompanyName\n   ```\n\n## Enable Google Pay and Apple Pay\n\nAdyen supports Google Pay and Apple Pay on standard checkout, subscriptions, and express checkout.\n\nTo enable wallets, add the following to the **API Options** field on the Payment Provider record in StoreConnect:\n\n```yaml\n\nshow_wallets: true\nexpress_checkout_enabled: true\n```\n\nThen continue with the setup below for each wallet.\n\n### Google Pay setup\n\n**Step 1: Get a Google Merchant ID**\n\n1. Go to the [Google Pay \u0026 Wallet Console](https://pay.google.com/business/console) and create a merchant account if you don't already have one.\n2. Note your **Merchant ID** at the top of the console — it looks like `BCR2DN4T7XDOFC2K`.\n\n   \u003c!-- Screenshot: Google Pay \u0026 Wallet Console showing Merchant ID at the top --\u003e\n\n**Step 2: Add Google Pay options in StoreConnect**\n\nIn the Payment Provider record in StoreConnect, add the following to the **API Options** field:\n\n```yaml\n\nmerchant_name: 'Your Store Name'\nmerchant_google_id: 'BCR2DN4T7XDOFC2K'\n```\n\nThe `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.\n\n\u003c!-- Screenshot: Google Pay button on a product page and at the checkout payment step --\u003e\n\n### Apple Pay setup\n\nSetting up Apple Pay with Adyen involves three parts:\n\n1. [Set up the Apple Pay Payment Processing Certificate](#part-1-set-up-the-apple-pay-payment-processing-certificate)\n2. [Create a Merchant Identity Certificate](#part-2-create-a-merchant-identity-certificate)\n3. [Register your store domain](#part-3-register-your-store-domain)\n\nBefore starting, find your Apple Merchant Identifier at the top of the **Certificates, Identifiers \u0026 Profiles** page in your Apple Developer account, then add it to the **API Options** field in StoreConnect:\n\n```yaml\n\napple_merchant_id: merchant.storeconnect.adyen\n```\n\n\u003c!-- Screenshot: Apple Developer Certificates, Identifiers \u0026 Profiles page showing the Merchant Identifier --\u003e\n\n#### Part 1: Set up the Apple Pay Payment Processing Certificate\n\nThis certificate links Apple Pay to Adyen. Adyen generates the Certificate Signing Request (CSR) for this step.\n\n**In Adyen:**\n\n1. In your Adyen Customer Area, go to **Settings** and open the Apple Pay configuration.\n2. Select **Use your own certificate**.\n3. Enter your Apple Merchant ID (for example, `merchant.storeconnect.adyen`).\n4. Click **Download CSR** to download the `.csr` file.\n\n   \u003c!-- Screenshot: Adyen Apple Pay setup — Use your own certificate, Merchant ID field, and Download CSR button --\u003e\n\n**In Apple Developer:**\n\n5. Go to your merchant identifier and under **Apple Pay Payment Processing Certificate**, click **Create Certificate**.\n6. Upload the `.csr` file you downloaded from Adyen, then click **Continue**.\n7. On the success page, click **Download** to receive `apple_pay.cer`.\n\n   \u003c!-- Screenshot: Apple Developer Payment Processing Certificate — download page after successful upload --\u003e\n\n**Back in Adyen:**\n\n8. Return to the Adyen Apple Pay setup page and skip Step 2.\n9. In Step 3, click **Choose File**, select `apple_pay.cer`, then click **Save changes**.\n\n   \u003c!-- Screenshot: Adyen Apple Pay setup showing successful certificate upload in Step 3 --\u003e\n\n#### Part 2: Create a Merchant Identity Certificate\n\nThe Merchant Identity Certificate authenticates your server when communicating with Apple Pay. You need OpenSSL installed to complete these steps.\n\n1. On your computer, open a terminal and run the following to generate a private key and Certificate Signing Request (CSR):\n\n   ```bash\n\n   openssl genrsa -out apple_pay_merchant.key 2048\n   openssl req -new -key apple_pay_merchant.key -out apple_pay_merchant.csr\n   ```\n\n2. In Apple Developer, go to your merchant identifier and under **Apple Pay Merchant Identity Certificate**, click **Create Certificate**.\n3. Upload `apple_pay_merchant.csr` and click **Continue**.\n4. Click **Download** to receive `merchant_id.cer`.\n5. Convert the certificate to PEM format:\n\n   ```bash\n\n   openssl x509 -inform DER -in merchant_id.cer -out merchant_id.pem\n   ```\n\n6. Add the contents of both files to the **API Options** field in StoreConnect:\n\n   ```yaml\n\n   apple_pay_private_key: |-\n     -----BEGIN PRIVATE KEY-----\n     (paste contents of apple_pay_merchant.key here)\n     -----END PRIVATE KEY-----\n   apple_pay_certificate: |-\n     -----BEGIN CERTIFICATE-----\n     (paste contents of merchant_id.pem here)\n     -----END CERTIFICATE-----\n   ```\n\n:::tip\nWhen 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.\n:::\n\n#### Part 3: Register your store domain\n\nApple requires your store domain to be registered and verified before Apple Pay will work in a browser.\n\n1. In Apple Developer, go to your merchant identifier and scroll to **Merchant Domains**.\n2. Click **Add Domain**, enter your store's hostname (for example, `store.yourdomain.com`), then click **Save**.\n3. Click **Download** to receive `apple-developer-merchantid-domain-association.txt`.\n4. Add the file contents to the **API Options** field in StoreConnect:\n\n   ```yaml\n\n   applepay_verification: |-\n     (paste the contents of apple-developer-merchantid-domain-association.txt here)\n   ```\n\n5. Back in Apple Developer, click **OK** next to the domain to trigger Apple's verification check.\n\n   \u003c!-- Screenshot: Apple Developer Merchant Domains page showing domain listed and verified --\u003e\n\n:::note\nApple 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.\n\nOnce verification is complete, you can remove the `applepay_verification` key from API Options — it is only needed during initial domain registration.\n:::\n\nWhen setup is complete, the Apple Pay button appears on product pages and at checkout in Safari.\n\n\u003c!-- Screenshot: Apple Pay button on a product page in Safari --\u003e\n\n## Sandbox and production configuration reference\n\nOnce all features are set up, use the reference below to see how sandbox and production configurations differ in StoreConnect.\n\n| StoreConnect field | Sandbox | Production |\n|--------------------|---------|------------|\n| API Mode | sandbox | production |\n| API Key | Sandbox API Key | Production API Key |\n| API Options: `live_url_prefix` | Not required | Required — your Adyen live URL prefix |\n\nAll other API Options values are the same for both environments.\n\n**Sandbox — complete API Options:**\n\n```yaml\n\napi_client: 'YOUR_CLIENT_KEY'\nmerchant_account: 'YourMerchantAccountName'\nshow_wallets: true\nexpress_checkout_enabled: true\nmerchant_name: 'Your Store Name'\nmerchant_google_id: 'YOUR_GOOGLE_MERCHANT_ID'\napple_merchant_id: merchant.storeconnect.Adyen\napple_pay_private_key: |-\n  -----BEGIN PRIVATE KEY-----\n  (contents of apple_pay_merchant.key)\n  -----END PRIVATE KEY-----\napple_pay_certificate: |-\n  -----BEGIN CERTIFICATE-----\n  (contents of merchant_id.pem)\n  -----END CERTIFICATE-----\n```\n\n**Production — complete API Options:**\n\n```yaml\n\napi_client: 'YOUR_CLIENT_KEY'\nmerchant_account: 'YourMerchantAccountName'\nlive_url_prefix: 1797a841fbb37ca7-YourCompanyName\nshow_wallets: true\nexpress_checkout_enabled: true\nmerchant_name: 'Your Store Name'\nmerchant_google_id: 'YOUR_GOOGLE_MERCHANT_ID'\napple_merchant_id: merchant.storeconnect.adyen\napple_pay_private_key: |-\n  -----BEGIN PRIVATE KEY-----\n  (contents of apple_pay_merchant.key)\n  -----END PRIVATE KEY-----\napple_pay_certificate: |-\n  -----BEGIN CERTIFICATE-----\n  (contents of merchant_id.pem)\n  -----END CERTIFICATE-----\n```\n\n:::note\nOnly 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.\n:::"}