Skip to content
Log in

Eway

On this page

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

  • Standard checkout and subscription payments
  • Additional and Salesforce payments
  • Pre-authorization
  • 3D Secure 2.0 (3DS2)
  • Google Pay and Apple Pay wallets
  • Express checkout

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

What you need

  • Eway account (sandbox or production)
  • Eway API Key and Password
  • For 3DS2: 3D Secure 2.0 enabled in your Eway dashboard
  • For Google Pay: a Google Merchant ID obtained from the Google Pay & Wallet Console
  • For Apple Pay: an Apple Developer account and OpenSSL installed on your computer

Get your Eway credentials

To generate your API credentials:

  • Sandbox: Follow Creating an Eway Sandbox API key in the Eway API documentation.
  • Production: Log in to your Eway account and go to My Account > API Keys to generate your API Key and Password.

Configure Eway in StoreConnect

  1. Open StoreConnect and go to Setup > Payments > Payment Providers.
  2. Select New. Complete the fields as follows, then Save:
StoreConnect field Eway value
Name Eway. For testing, add - Sandbox.
Provider Select Eway from the list
API Mode sandbox or production
API Key Your Eway API Key
API Secret Your Eway Password
API Options public_key: "YOUR_CLIENT_SIDE_ENCRYPTION_KEY"

The Client Side Encryption Key is used to encrypt card details in the browser before they reach the server. You can find this key in your Eway account under My Account > API Keys.

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 in Eway and then adding them to StoreConnect.

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

Enable 3DS2

From v21, Eway supports 3D Secure 2.0 (3DS2), which adds an additional authentication step during checkout to reduce fraud.

Step 1: Enable 3DS2 in your Eway dashboard

In your Eway dashboard, go to Settings and enable 3D Secure 2.0.

Step 2: Add to API Options in StoreConnect

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

yaml three_d_secure: true

Enable Google and Apple Pay

From v21, Eway supports Google Wallet 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

You will also need to complete the setup below for each wallet and add the resulting keys to API Options.

Google setup

StoreConnect uses the Direct Connection integration with Eway for Google Pay. Each store needs its own Google Merchant ID, obtained directly from Google.

Step 1: Get a Google Merchant ID

  1. Go to the Google Pay & Wallet Console and create a merchant account.
  2. Review and agree to Google’s terms:
  3. Note your Merchant ID — it looks something like BCR1234567.
  4. For production, follow Google’s process to request production access to Google Pay.

Step 2: Configure Google Pay in your Eway dashboard

In your Eway dashboard, go to Settings > Google Pay Settings and enter your Google Merchant ID.

Step 3: Add Google Pay options in StoreConnect

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

```yaml # For sandbox: merchant_id: GPewaymerchantid # For production, replace with: # merchant_id: BCR2DN6T266KBHAD

Your Google Merchant ID from Step 1

google_merchant_id: ‘BCR1234567’

Store name shown to customers at checkout

merchant_name: ‘Your Store Name’ ```

Apple Pay setup

Setting up Apple Pay with Eway involves three parts:

  1. Activate Apple Pay and create a Payment Processing Certificate
  2. Create a Merchant Identity Certificate
  3. Register your store domain

Part 1: Activate Apple Pay and create a Payment Processing Certificate

The Payment Processing Certificate establishes the relationship between eWAY gateway and Apple Pay. In your Eway dashboard:

  1. Go to Settings > Apple Pay.

  2. Activate Apple Pay. The status changes from inactive to active once enabled.

  3. Enter your admin email address and select Generate CSR.
  4. Click the blue public key link to download the .csr file.

In Apple Developer:

  1. Go to Certificates, Identifiers & Profiles and create or select your Eway merchant identifier.
  2. Under Payment Processing Certificate, click Create Certificate.
  3. Under Upload a Certificate Signing Request, choose the .csr file you downloaded from Eway, then click Continue.
  4. Click Download to receive apple_pay.cer.

Back in your Eway dashboard:

  1. Return to Settings > Apple Pay.
  2. Click Choose File, select the apple_pay.cer file, then click Upload.

In StoreConnect, add your Apple Merchant ID to API Options:

  1. In your Apple Developer account, note your Apple Merchant Identifier (it looks like merchant.storeconnect.eway).

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

    yaml apple_merchant_id: merchant.storeconnect.eway

Part 2: Create a Merchant Identity Certificate

The Merchant Identity Certificate establishes the relationship between the Payment Provider and Apple Pay, using certificates.

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 the Payment Provider record in StoreConnect, add the contents of the files to API Options. Make sure the apple_pay_merchant.key has a two-space indent.

    ```yaml apple_pay_private_key: | —–BEGIN RSA PRIVATE KEY—– (paste contents of apple_pay_merchant.key here) —–END RSA PRIVATE KEY—–

  3. In Apple Developer, select your merchant identifier and under Merchant Identity Certificate, click Create Certificate.
  4. Upload the apple_pay_merchant.csr file and click Continue.
  5. Click Download to receive merchant_id.cer.

  6. Convert the certificate to PEM format:

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

  7. In the Payment Provider record in StoreConnect, add the contents of both files to API Options:

    yaml 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 the domain verification file (apple-developer-merchantid-domain-association.txt).

  4. In the Payment Provider record in StoreConnect, add the file contents to API Options:

    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 Secret Sandbox Password Production Password
API Options: merchant_id GPewaymerchantid BCR2DN6T266KBHAD

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

Sandbox — complete API Options:

yaml public_key: "YOUR_CLIENT_SIDE_ENCRYPTION_KEY" three_d_secure: true show_wallets: true express_checkout_enabled: true merchant_id: GPewaymerchantid google_merchant_id: 'YOUR_GOOGLE_MERCHANT_ID' merchant_name: 'Your Store Name' apple_merchant_id: merchant.storeconnect.eway apple_pay_private_key: | -----BEGIN RSA PRIVATE KEY----- (contents of apple_pay_merchant.key) -----END RSA PRIVATE KEY----- apple_pay_certificate: | -----BEGIN CERTIFICATE----- (contents of merchant_id.pem) -----END CERTIFICATE-----

Production — complete API Options:

yaml public_key: "YOUR_CLIENT_SIDE_ENCRYPTION_KEY" three_d_secure: true show_wallets: true express_checkout_enabled: true merchant_id: BCR2DN6T266KBHAD google_merchant_id: 'YOUR_GOOGLE_MERCHANT_ID' merchant_name: 'Your Store Name' apple_merchant_id: merchant.storeconnect.eway apple_pay_private_key: | -----BEGIN RSA PRIVATE KEY----- (contents of apple_pay_merchant.key) -----END RSA 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. :::

Related articles

Documentation Adyen Documentation Authorize.Net ACH Documentation Authorize.Net

Was this article helpful?

Was this article helpful?