GuidesAPI Reference

Magento 2

Suggest Edits

Overview

🚧

Support for Magento version 2.2 and below

Adobe will be ending support for versions of Magento below version 2.3 in 2021.

If you have not already upgraded Magento to the latest version, we suggest doing so as soon as possible. If you are on an older version of Magento and would like assistance integrating Zip, please reach out to us at [email protected].

For Magento 2 stores, Zip offers a Magento 2 Extension for integrating our payment method into your store.

Follow the steps in these guides to integrate Zip into your Magento 2 store:

  1. Add the Payment Gateway
  2. Integrate the Widget

If you have any questions or need any support integrating, please email us.

Add the Payment Gateway

🚧

Magento 2 Extension Rebrand Update

For Zip branding, please update to version 1.6.0 or above.

📘

Compatibility

Zip extension requires Magento v.2.3.0 or above. Zip supports USD or CAD as Magento base currency.

Installation

Choose one of the installation methods described below.

🚧

Installation might require the assistance of a system integrator, developer, or IT resource to complete the process. Make sure to test the installation in a separate environment before doing this on live store.

> Install with Composer

This is the recommended installation method. Make sure you are familiar with Magento Composer workflow and everything is set accordingly on the project:

More information on Magento Composer.

  1. At Magento Marketplace, add the extension to the cart and go through the checkout process to be able to download with Composer (extension is free).
  2. Run following commands from command line:
    composer require mr/quadpay
    php bin/magento setup:upgrade

Follow any additional instructions from Magento.

> Install Manually

  1. At Magento Marketplace, add the extension to the cart, go through the checkout process and download
    the extension (extension is free).
  2. Create app/code/MR/QuadPay/ directories
  3. Unzip the extension to newly created Zip directory
  4. Using the command line, run this command:
    php bin/magento setup:upgrade

Follow any additional instructions from Magento.

Configuration

To enable and configure Zip, return to the Magento Admin Panel.

  1. Go to Stores > Configuration > Sales > Payment Methods > Zip

  2. Under Enabled, select Yes

  3. Select Territory (United States or Canada)

  4. Copy and paste the Client ID, Client Secret from the Zip Merchant Portal > Settings. (Take care not to add any additional spaces or characters to these fields.)

  1. Save and flush the cache after setup.

The Zip widget is automatically integrated as part of the extension and will be displayed on Product Detail Pages and at Cart upon enabling Zip in Magento administration.

Integrate the Widget

> Product Detail Page

886

> Cart Page

🚧

Widget Does not Appear

Have you tried refreshing the browser? If it still does not appear, please try flushing the cache.

Customize the Widget

🚧

Customizing the Widget

A technical background may be useful when attempting to customize the widget.

Many aspects of the widget can be customized. To find a complete list of items, please refer to the Zip widget documentation.

The widget styling can be adjusted in the Magento Admin Panel.

  1. Go to Stores > Configuration > Sales > Payment Methods > Zip > Zip Widget Design
  2. Adjust Product Widget Layout Spacing and Cart Widget Layout Spacing as necessary.
  3. Add attributes as necessary. For the full list of attributes, refer to the official documentation.
  4. Save your configuration.

Issuing Refunds

Issuing refunds for Zip orders is straightforward with the following instructions.

  1. In the Magento Admin Panel, go to Sales > Invoices.

  2. Find and click on the order to refund.

  1. Click the Credit Memo button.

  1. Update any refund values as needed. Then, click the Refund button.

  1. After successful refund, note the status update at the top of the Order screen.

  1. Zip will automatically credit the customer's existing and/or future installments as needed. Verify the order status both by noting the Status of the order in the Magento Admin Panel and also in the Zip Merchant Portal (staging environment).

📘

If the online store doesn't handle issuing refunds directly, the Zip Merchant Portal can be configured to issue refunds. Contact [email protected] to learn more.

Deferred Order Creation

Overview

If you are using an ERP or rely heavily on automation, we can assist you with setting up "Deferred Order Creation"(DOC) in Zip and Magento 2 to ensure that only successfully created Zip orders appear in your Magento 2 admin.

Steps to configure DOC in Magento 2:

  1. Reach out to our team at [email protected] to request that Deferred Order Creation be enabled for your account.

   2. Install the latest extension: Zip North America.

  1. Set "Defer Order Creation: Yes" under the Zip settings in Stores > Configuration > Sales > Payment Methods.

  2. Be sure to flush your Magento 2 cache after enabling this setting by navigating to System > Cache Management > Flush Magento Cache.

Updated 3 months ago