eWAY - Deprecated

Magento Commerce only

The content on this page is for Magento Commerce only. Learn more

Deprecation Notice
Due to the Payment Service Directive PSD2 and the continued evolution of many APIs, this payment integration is at risk of becoming outdated and no longer security compliant in the future. For this reason, it is now deprecated, and we recommend that you disable it in your Magento configuration and transition to the corresponding Magento Marketplace extension.

This integration will be removed from the Magento 2.4.0 release and has been deprecated from current versions of 2.3.

For details about making a secure transition from deprecated payment integrations, see our DevBlog.

eWAY is based in Australia, and provides secure payment processing services to merchants throughout Australia, New Zealand, the United Kingdom, Singapore, Malaysia, and Hong Kong. Their latest Rapid 3.1 API enables real-time fraud protection.

Step 1: Get your eWAY credentials

Sign up for an eWAY merchant account, and get your credentials.

Step 2: Enable eWAY

  1. Log in to the Admin of your store. On the Admin sidebar, go to Stores > Settings > Configuration.

  2. In the left panel, expand Sales and choose Payment Methods.

  3. Expand the eWAY section and do the following:

    Enable eWay Enable eWAY

    • Set Enabled to Yes.

    • Set Connection Type to one of the following:

      • Direct connection - Completes the transaction without leaving your website.
      • Responsive shared page - Redirects to a page for your store that is hosted on the eWAY server to complete the transaction.
    • Enter a Title to identify eWAY as a payment option during checkout.

Step 3: Enter your eWAY credentials

  1. To run test transactions in a test environment, set Sandbox Mode to Yes.

    To learn more, see Sandbox/Testing on the eWAY website.

    When you are ready to go live with eWAY, set Sandbox Mode to No.

  2. Follow the instructions on the eWAY website to set up your Live API key and password. Then, enter the following:

    • Live API Key
    • Live API Password
    • Live Client-side Encryption Key
  3. Follow the instructions on the eWAY website to set up your sandbox credentials. Then, enter the following:

    • Sandbox API Key
    • Sandbox API Password
    • Sandbox Client-side Encryption Key

    eWAY Credentials

Step 4: Configure payments

  1. Set Payment Action to one of the following:

    Authorize Only Approves the purchase and puts a hold on the funds. The amount is not withdrawn from the customer’s bank account until the sale is “captured” by the merchant.
    Authorize and Capture The amount of the purchase is authorized and immediately withdrawn from the customer’s account.
  2. To save a record of communications between your store and the eWAY system in a log file, set Debug to Yes.

    In accordance with PCI Data Security Standards, credit card information is not recorded in the log file.

  3. In the Credit Card Types box, hold down the Ctrl key and select each credit card that is accepted as payment in your store.

    Configure Payments Configure Payments

  4. Set Payment from Applicable Countries to one of the following:

    All Allowed Countries Customers from all countries specified in your store configuration can use this payment method.
    Specific Countries After choosing this option, the Payment from Specific Countries list appears. Hold down the Ctrl key (PC) or the Cmd key (Mac) and select each country in the list where customers can make purchases from your store.

    Configure Countries Configure Countries

  5. In the Sort Order field, enter a number to determine the order in which eWAY appears when listed with other payment methods during checkout.

  6. When complete, click Save Config.