OpenCart

By integrating with our OpenCart plugin, you'll gain access to the full range of our solutions, credit and debit processing, card management and order management.

• Categories: Extensions, Payments & Security, Payment Integration
• Compatibility: 2.3 (obsolete), 3.0.3 (current)
• Tags: creditcard, payment, gateway, debit, credit, secure, currency, free, globalpayments, cardstorage, token, tokenize, save cards, digital

Click the button below to download the plugin that is compatible with your OpenCart version and view any related documentation available.

Activate the extension:

1. In your OpenCart Admin panel, go to Extension Installer.
2. Upload the archive, and wait for the upload to finish successfully.
3. When the upload is complete, go to Extensions > Payment Methods and locate our plugin.
4. Activate it according to the documentation.

Sandbox credentials

Our OpenCart plugin requires credentials to our Payments gateway. You can get your Test credentials when you register with our developer portal. Once registration is complete, you can find the required Public and Secret Keys in your account.

Configuration

To configure this plugin, follow these steps.

1. Log in to the Admin panel for OpenCart.
2. Navigate to Extensions > Extensions, and choose the Payments plugin type.
3. Locate the Heartland Payment Method and click Install, then Edit.
4. From here, you can configure the Payments gateway.

Payments settings

The Payments gateway offers payment through credit and debit cards.

The Payments Settings tab allows you to enter your overall account credentials. You can enter specific credentials for different websites by changing the website scope in OpenCart.

The following table describes the fields that appear on the Payments Settings tab for OpenCart.

The Payments Settings tab allows you to enter your account credentials. These global settings apply to all integration types. The table below describes the fields you’ll see in the Payments Settings tab for OpenCart.

Use the test card numbers below to verify that your integration was set up properly. For testing, you can use any cardholder name, any expiry date in the future, and any CVN security code.

For a full list of test cards, see our Test Cards article.

Now that you’ve successfully installed the plugin and tested to see if it was installed properly, you’re all set to go live in the Production environment.

To do this, you’ll need to connect your integration with the gateway.

1. Input your Production Public and Secret Key into your gateway configuration in the OpenCart Admin panel, and enable the Live Mode for the gateway.

This section contains information on payment solutions such as card management and order management.

Card management

Registered customers can save their card information by selecting the Save to account checkbox in the checkout form. The OpenCart plugin securely stores card data with us and receives a token representation of the card, which is stored in the OpenCart vault, with no increased PCI compliance requirements.

1. The customer can choose from the list of their stored cards.
   
2. Registered customers can see the list of their stored cards under My Account > Cards. Here, they can delete the stored cards or add new ones.

Order management

1. Detailed information relating to the transaction outcome is available in the Orders section for OpenCart.
2. If payment was successful, the order status will be set to Processing.

Create an invoice – capture a transaction

Merchants who use “Authorize only” at checkout will authorize the funds on the customer's card, but the transaction won't be placed in the settlement file until we capture it.

The amount of time the funds can remain ring-fenced on the customer's card may vary between different Issuers and Acquirers. Card brands like Visa and Mastercard have their own rules around how long transactions can wait to be captured.

1. You can view the response returned by us in the Payments tab.
2. When viewing the order, scroll down to the bottom of the page. The details of the response from us will be displayed.
3. If successfully authorized, the funds will now be ring-fenced on the customer's account. When you want to include the transaction in the next settlement file (also known as a batch) you can simply send a Capture (Settle) request. When the transaction is captured with the Acquirer, the funds are deducted from the customer's account and settled into the merchant's account.
4. Once complete, the result of the Settle request will be displayed.

Refund a captured transaction

Once an order has been successfully settled with your Acquirer, you can refund the customer for 0% to 115% of the original order value. To do this, you must create a Partial Refund in OpenCart.

1. Navigate to Sales > Orders, and select the order you want to credit.
2. Click Refund. If no amount entered, a full refund of the authorized amount will be requested.
3. This will send the refund request to us. You can change the amount to credit by editing the input field.
4. Once complete, you will be returned to the Order page. A message will display indicating the outcome of the refund request. A comment will be also added to the Payments tab.

Reverse a transaction

You can cancel a transaction before it is sent for funding. The transaction will be fully reversed. If you already captured (settled) the transaction, see the Refund a captured transaction section.

1. Scenario 1: If the gateway has the payment action set to Authorize only:
   1. In the Admin panel, select the order you want to reverse. It will have the status Processing.
   2. Open the Order History, and select the Unified Payments tab.
2. Scenario 2: If the gateway has the payment action set to Authorize & Capture:
   1. In the Admin panel, select the order you want to reverse. It will have the status Processing.
   2. Open the Order History, and select the Unified Payments tab.
3. Next, click Reverse. A warning message will appear, asking if you want to proceed with the reverse.
4. Click OK.
5. Notice that a new entry line was added to the Payment Information list indicating the voided (reversed) amount with the Payment Action reverse.
6. Finally, go to Add Order History and manually change the Order Status from Processing to Reversed. Click Add History.