Magento: Set up the Verifone Hosted Cart on your Magento store

Learn how to seamlessly integrate the Verifone Hosted Cart with Magento to accept eCommerce transactions

NOTE: To install and configure the Verifone Hosted Cart, you will need a Verifone Central account with an Online Payment facility. Contact us to set this up here.

There are three steps to setting up the Verifone Hosted Cart for your Magento store: 

  1. Download and install the plugin
  2. Configure the plugin
  3. Generate a secure card capture key

Download and install the plugin:

  1. Download the Verifone payment module here Offsite Link

  2. Upload the included Verifone directory to 'app/code/' under your Magento root directory on your server.

  3. Ensure each file is uploaded to the correct directory on your server.

    Integrate Magento 2 Plugin for Verifone_1

  4. Install the module by running 'bin/magento setup:upgrade' and 'bin/magento setup:di:compile'.

  5. Log in to your Magento 2 administration panel and navigate to System > Cache management.  

    Integrate Magento 2 Plugin for Verifone_2

  6. On the Cache management page, click on the Flush Magento cache button.

    Integrate Magento 2 Plugin for Verifone_3

  7. Go back to the System tab and select Index Management.

    Integrate Magento 2 Plugin for Verifone_4

  8. On the Index Management page, select the Update on save option and click on the Submit button to re-index all templates.
    Integrate Magento 2 Plugin for Verifone_5

Configure your Verifone Central Credentials:

After installing the Verifone payment module, follow these steps to configure the plugin and set up your payment settings:

In the Magento admin panel, go to Stores > Configuration.

Integrate Magento 2 Plugin for Verifone_6

Under Configuration, click on the Sales tab and scroll down to Payment Methods.

Integrate Magento 2 Plugin for Verifone_7

Select Payment Methods and then Verifone - Credit Card Hosted Payment module.

Integrate Magento 2 Plugin for Verifone_9

Fill in details for Verifone Account Settings, Display Settings, and Card Payment settings to configure your plugin.

Verifone account settings

Magento Verifone Account Settings

  1. Enabled: Select Yes
  2. Test Mode: Select No. If you choose to enable Test Mode, you will need to fill in the Test Credentials below from a Test environment. For more details about Test mode and how you can use it, you can contact our support team.
  3. Invoice: Select Yes to invoice the order automatically when successful
  4. New Order Status: Status for new orders. We recommend processing or complete should be selected.
  5. The following credentials need to be copied from your Verifone Central account. Login to Verifone Central here Offsite Link
  6. User ID & API Key:
    • Click your initials and then API Keys
    • Click Create API Key
    • Ensure you click Copy public key before closing the dialogue box! The API key can only be copied once.
    • Click on the API Key you created to find your API User ID.

      API Key
  7. Entity ID:
    • Go to Administration > Account Setup > Organisation Company and Sites
    • Select your Organisation from the table and copy the Organisation ID from the General Information section.
      Organisation ID
    • NOTE: There might be several organisations available as part of your account hierarchy. The correct Organisation usually does not have Account or Site in the Name. You can check that you've copied the right Organisation ID by reviewing the Payment Provider Contracts available. Scroll down and make sure the Organisation ID you copy is connected to your Payment Provider Contract for eCommerce.

  8. Test API User, Test API Key and Test Enity ID: Fill in these Test Credentials from your Test environment if you have enabled Test mode.
  9. Region: New Zealand
  10. Enable/Disable cURL verify host and peer: Enable host/SSL verification.

Display Settings

  1. Checkout type: Choose whether the Verifone checkout is displayed as a standalone page where your customers are redirected to perform the payment or as an iFrame (embedded onto your website page). 
    • Hosted Payment Page (HPP) - the shopper is redirected to a payment page hosted by Verifone to make the payment. Upon completion of the payment process, the shopper is redirected back to your website page.
    • iFRAME allows you to display a payment form component as part of your own website, without having to redirect the shopper to a new web page. The form is still securely hosted by Verifone, so there is no additional PCI scope required for you with this solution.
  2. Title - The customer-facing payment method label (Verifone Hosted Cart).
  3. Description - The customer-facing description for your payment solution.
  4. Theme ID: You can customise the look and feel of your Checkout. First, you need to create a custom theme for your payment page, by using the Checkout Theme tool Offsite Link on Verifone Central. Once the custom theme is created, you can copy the Theme ID and paste it into the Display Settings. 

Card payment settings

The card payment settings area allows you to configure the payment details needed to process card payments.


  1. Enable card payment: Select Yes
  2. Payment Contract ID:
    • The Payment provider contract ID can be found in Verifone Central. Go to Administration > Account Setup > Payment (Provider) Contracts.
    • Click the Payment Provider Contract with 'ECOMMERCE' in the Name field
    • Copy the Payment Provider Contract ID
  3. Test Payment Contract ID: Only used if you have enabled Test Mode. You will need a test Payment Contract ID from a Test environment.
  4. 3DS: Select Yes
  5. 3DS Contract ID
    • Go to Administration > Advanced Settings > 3DS Contracts
    • Copy your 3DS Contract ID
  6. Transaction type: Select Sale
  7. Click on Save Config to save your settings

Generate a Secure Card Capture Key

To start accepting eCommerce transactions, you must generate a Secure Card Capture Key on Verifone Central

1. Log in to Verifone Central Offsite Link

2. Go to Administration >Account Set up > Organisation Company and Sites, and select your Parent Organisation that starts with 'Account'

3. Scroll down to Secure Card Capture

4. Click Create new public key

Full documentation and troubleshooting guides are available on Verifone Cloud Offsite Link