This article describes how to integrate HiPay as Gateway for your Shopify Store, how to set up the module and how to handle your transactions on a daily basis.
Hosted Payment Page Integration
Manual or auto capture
Partial capture and refund available
Adding HiPay as your Gateway
The process to add HiPay as your Gateway for your Shopify Store is the following one:
Go to the HiPay’s Gateway on Shopify.
Once you click the link, you’ll be asked to log into their store.
After logging in, click on “Install payment provider”.
The next step after having installed Hipay’s module is to configure it. In order to do so go to the Alternative Payments section of the Payments Settings page.
The first thing you need to configure are your private credentials username and passphrase. You can find this information on the TPP Backoffice : Integration > Security Settings.
If you are testing your integration, introduce the credentials username and passphrase of your staging HiPay TPP Account.
You can choose the payment means that you want to display on your checkout.
Please, make sure that you have contracted all the selected payment means on your HiPay Entreprise account. You can verify it on the TPP Back Office : Account > Payment Means.
Some payment means like Multibanco, MB Way and Sisal won’t appear on the Shopify Admin, but they will be displayed on the Hosted Payment Page if you have contracted them.
Test your integration
Once you have configured the HiPay Module, we strongly recommend testing it on a testing environment, by activating the Test Mode on the HiPay Module.
After filling the contact information, the customer is redirected to the Payment tab of the Shopify checkout.
In this tab, the customer can choose the payment processor that they want to use to pay. Once the review of the order is done, the customer will be redirected to the HiPay’s Hosted Payment Page.
HiPay’s Hosted Payment Page
HiPay’s Hosted Page will display all the payment means of your HiPay TPP Account. Once the payment is done, HiPay will redirect the customer to the success or failure Shopify page.
By default we will display the following Hosted Page layout, but you can customize it by contacting our support team or your Account Manager.
You can manually capture, refund and cancel an order that has been created directly from Shopify. You can also do this using HiPay’s Backoffice, but the status of the transaction won’t be updated on Shopify.
You can activate the manual capture on the Payment Capture section of the payment settings page.
Once this is done, you can manually capture an order, going into the authorized order (payment status: Payment authorized). More information about how to manually capture an order here.
Refunding an order results in the payment being sent back to the customer. You can refund an entire order or part of an order.
In order to refund an order you should:
From your Shopify admin, go to Orders
Open the order you want to refund.
Once you are in the order page, click on Refund items at the top of the page.
Choose the number of items that you want to refund.
Optional. You can manually adjust the total amount you want to refund using the Refund Amount Field above the Refund button.
Click Refund Order
Cancel an order
The most common reasons for canceling an order include the following:
The customer changed their mind.
The ordered items aren’t available.
The order was fraudulent.
In order to cancel an order, you should:
From your Shopify admin, go to Orders.
Click the order that you want to cancel.
Click More actions > Cancel order.
If payment is captured: By default, a full refund is issued. If you want to issue a partial refund, then use the product quantity boxes, the shipping field, or the refund total field to edit the refund amount.
If payment isn’t captured: When you cancel the order, the payment is void and isn’t collected from your customer. You can’t issue a partial refund.
Select the reason for cancellation from the drop-down menu.
Click Cancel order.