Table of Contents

PrestaShop

Team ViaBill Updated by Team ViaBill

ViaBill Integration for PrestaShop 1.7

If you have not yet contacted our Business Development Team to sign your service agreement, please contact merchants@viabill.com. Failure to do so will result in your account's deactivation.
Integrating ViaBill on your own? Please complete the ViaBill Integration Checklist to make sure that ViaBill is properly installed and configured on your store.

Description

ViaBill provides a seamless financing solution for thousands of merchants and customers across the world featuring low transaction costs and stellar support.

With ViaBill, you can increase your average order size and conversion rate, and put your customer in focus so they can get what they want when they want it — without your customer having to pay in full and up front.

ViaBill – seamless financing! Module is a module that allows you to accept payments via ViaBill on your PrestaShop store. You will be able to capture and refund your ViaBill orders directly in PrestaShop, and you can even activate the ViaBill PriceTag which ensures higher conversion rates and will increase your average order size.

We strive to make this module as functional and stable as possible.

Nevertheless, before installing the ViaBill – seamless financing! Module on your production site, it is your responsibility to test it in a pre-production environment to verify that it adheres to your needs and that you understand its behavior.

You can modify it to adapt it to your exact needs.

You are granted one license for a unique web site.

You are not allowed to change the author of the plugin.

You are not allowed to redistribute it, modified or not, in whatever the way of redistribution.

Installation

The ViaBill – seamless financing! Module is easily installed directly in your PrestaShop backend or direct upload. You can find the latest version and overview of the ViaBill – seamless financing! Module in the PrestaShop AddOns Official Marketplace.

Requirements
  • PrestaShop V1.5.6.3 - V1.7.6.3
PrestaShop Admin
We strongly advise that you install the ViaBill – seamless financing! Module on a pre-production environment, such as a staging or local installation of your store. This will reduce the risk of potential conflicts and allows you to test the plugin without affecting your live site and customer experience.

First, login to your PrestaShop backend with an account that has administrator privledges.

Next, click on the Modules tab located in the left side-menu.

Then, click Module Catalog.

In the search bar, search for "ViaBill". Find the ViaBill module and then click on the Install button below the star rating.

Then, click on the Configure button and you will be directed to configure the module.

If you wish to install the ViaBill – seamless financing! module by direct upload, click on Module Manager in the left side-menu, then click the Upload a module button in the top right corner of the Module manager page. Then, click the select file link in the center of the file upload section or drag the file for the plugin to the file upload section.

Connecting your ViaBill account

After clicking Configure for the first time, you will be automatically directed to the following window.

There are two possibilities to connect to ViaBill -

Create a New User or Login as an Existing User.

Create a new ViaBill user account

If you don’t already have a ViaBill merchant account, it is necessary to create a New User. Click the New User button and then fill out the following form.

  1. Email: Mandatory field for your email address. This email address will be used to create a MyViaBill account which holds all of your business, transaction, and payout information.
  2. Country: Mandatory field for the country in which your business operates in.
  3. Live shop URL: Mandatory field for your live store.
  4. Contact name: Field for the name of the contact person of your company.
  5. Phone: Field for your direct phone number. This may be used to contact you by a ViaBill representative for all matters requiring urgent communication.
  6. Terms And Conditions: Mandatory checkbox for acceptance of ViaBill's terms and conditions of the country your store operates in. The terms and conditions can be accessed by clicking on the link located next to the checkbox, and may also be accessed here: Click here to read ViaBill's terms & conditions.

When all necessary information is entered, click the Create ViaBill User button located at the bottom-right of the form. When your account is successfully created, you will receive a success notification.

Then, you will be redirected to the main settings of the module. 

Login to an existing ViaBill account

You should only choose this option if you already have a ViaBill merchant account.

Please enter the email and password associated with your ViaBill merchant account to log in. Then, click the Connect button (not pictured) on the far right side of the form. Upon connecting, you will be redirected to the main settings of the plugin.

If you forgot your password, click the Forgot password? button. You will be directed to MyViaBill, where you can reset your password by entering you email and recieving a temporary password via email.

Connect a different ViaBill account

To connect a different ViaBill merchant account to the ViaBill – seamless financing! Module, you should reset the module in the Module Manager.

To reset the module, please complete the following instructions –

  1. Navigate to Modules in the left side-menu
  2. Click Module Manager
  1. Navigate to the ViaBill module located within the Payment secions of the Module manager
  2. Select the dropdown and click Reset
  1. A confirmation message will appear. If you'd like to cancel the reset, click the Cancel button. If you'd like to continue to reset the module, click the Yes, reset it button.

When the reset has been complete, you may click the Configure button and select either New User or Existing User as outlined above.

Settings

After you've successfully connected to the ViaBill module, you are directed to the main settings window where you find three sections: PriceTag Settings, General Configuration, and MyViaBill.

PriceTag Settings

Enable PriceTag on Product page

By setting Enable on Product page to YES, the PriceTag will appear next to the price of the product on the Product page. While this is set to NO, the PriceTag will not be displayed on the Product page.

Here is an example of how the PriceTag is displayed when the PriceTag is enabled on the Product page.

If you click on the PriceTag, a modal popup will appear where your customers can learn more about how ViaBill works.

Enable PriceTag on Cart summary

By setting Enable on Cart Summary to YES, the PriceTag will appear near the cart total on the Cart Summary page. While this is set to NO, the PriceTag will not be displayed on the Cart Summary page.

Here is an example of how the PriceTag is displayed when the PriceTag is enabled on the Cart Summary page.

Enable PriceTag on Payment selection

By setting Enable on Payment Selection to YES, the PriceTag will appear next to the ViaBill Payment selection at checkout. While this is set to NO, the PriceTag will not be displayed at the Payment selection.

Here is an example of how the PriceTag is displayed when the PriceTag is enabled on Payment selection.

After you have updated the PriceTag settings, don't forget to save your selection by clicking the Save button on the bottom right corner of the General Configuration panel.

The following message will appear –

General Configuration

These settings are dedicated for capturing, refunding, and canceling the orders paid with ViaBill. The confirmation messages can be enabled for each individual action.

For settings 2 - 8, If the setting is YES, a browser confirmation will appear following the capture, refund, or cancellation that you have made. If the setting is NO, then no confirmation message will be displayed and the action will be immediately executed.

  1. ViaBill Test Mode
    By setting ViaBill Test Mode to YES, you can easily make a successful APPROVED or unsuccessful CANCELLED transaction without having to input any data in the ViaBill checkout.
    Click the Save button at the bottom right of the General Configuation settings to save the changes.
This mode is strictly for testing purposes only. Keep this disabled this for live stores.
  1. Display ViaBill logo in the checkout payment step
    By setting Display ViaBill logo in the checkout payment step to YES, the ViaBill logo will be displayed in the last check-out step where customers choose their payment option.
    Click the Save button at the bottom right of the General Configuation settings to save the changes.
  2. Capture confirmation message for single action
    By setting Capture confirmation message for single action to YES, when you attempt to capture a single order, a pop-up will appear with the following message: “Are you sure that you want to capture $X?
    By clicking the OK button, the order’s payment will be captured and the order status will be updated to Payment completed by ViaBill.
    By setting Capture confirmation message for single action to NO, the capture confirmation pop-up will not appear. Upon clicking the Capture payment button next to each order in the order list, the order will be immediately captured and the order status will be updated to Payment completed by ViaBill.
  3. Capture confirmation message for bulk action
    By setting Capture confirmation message for bulk action to YES, when you attempt to capture bulk orders, a pop-up will appear with the following message: “Are you sure that you want to capture selected orders?

    By clicking the OK button, you will receive the following notification –
    By setting Capture confirmation message for bulk action to NO, the capture confirmation pop-up will not appear. Upon completing a bulk capture action, the orders will be immediately captured and the order statuses will be updated to Payment completed by ViaBill.
    Orders that have been refunded or paid via another payment method cannot be captured within the same bulk capture as orders paid via ViaBill.

    If you attempt to capture orders that have been refunded, already captured, or paid via another payment method alongside orders paid via ViaBill, you will receive an error message alerting you that the non-ViaBill transactions were unable to be captured and failed.
  4. Refund confirmation message for single action
    By setting Refund confirmation message for single action to YES, when you attempt to refund a single order, a pop-up will appear with the following message: “Are you sure that you want to refund $X?

    By clicking the OK button, the order’s payment will be refunded and the order status will be updated to Payment refunded by ViaBill.

    By setting Refund confirmation message for single action to NO, the refund confirmation pop-up will not appear. Upon issuing a refund, the order will be immediately refunded and the order status will be updated to Payment refunded by ViaBill.

  1. Refund confirmation message for bulk action
    By setting Refund confirmation message for bulk action to YES, when you attempt to refund bulk orders, a pop-up will appear with the following message: “Are you sure that you want to refund these transactions?

    By clicking the OK button, the order’s payments will be refunded and the order statuses will be updated to Payment refunded by ViaBill.

    By setting Refund confirmation message for bulk action to NO, the refund confirmation pop-up will not appear. Upon issuing a bulk refund, the orders will be immediately refunded and the order statuses will be updated to Payment refunded by ViaBill.
    Orders that have already been refunded, cancelled, or paid via another payment method cannot be refunded within the same bulk refund as orders paid via ViaBill.

    If you attempt to refund orders that have already been refunded, cancelled, or paid via another payment method alongside orders paid via ViaBill, you will receive an error message alerting you that the non-ViaBill transactions were unable to be refunded and have failed.

  1. Cancel confirmation message for single action
    By setting Cancel confirmation message for single action to YES, when you attempt to cancel a single order, a pop-up will appear with the following message: “Are you sure that you want to cancel this order?

    By clicking the OK button, the order will cancelled and the order statuses will be updated to Payment cancelled by ViaBill.

    By setting Cancel confirmation message for single action to NO, the cancel confirmation pop-up will not appear. Upon cancelling an order, the order will be immediately cancelled and the order statue will be updated to Payment cancelled by ViaBill.

  1. Cancel confirmation message for bulk action
    By setting Cancel confirmation message for bulk action to YES, when you attempt to cancel bulk orders, a pop-up will appear with the following message: “Are you sure that you want to cancel selected orders?

    By clicking the OK button, the orders will be cancelled and the order statuses will be updated to Payment cancelled by ViaBill.

    By setting Cancel confirmation message for bulk action to NO, the cancel confirmation pop-up will not appear. Upon issuing a bulk cancellation, the orders will be immediately cancelled and the order statuses will be updated to Payment cancelled by ViaBill.
    Orders that have already been refunded, cancelled, or paid via another payment method cannot be cancelled within the same bulk refund as orders paid via ViaBill.

    If you attempt to cancel orders that have already been refunded, cancelled, or paid via another payment method alongside orders paid via ViaBill, you will receive an error message alerting you that the non-ViaBill transactions were unable to be cancelled and have failed.

ViaBill Orders in PrestaShop

After you've successfully connected to the ViaBill module, you are directed to the main settings window where you find three sections: PriceTag Settings, General Configuration, and MyViaBill.

New ViaBill orders

Once your customer initiates the ViaBill checkout, an order will be created in PrestaShop with an order status of Payment pending by ViaBill. The order status will automatically update once the order has been approved/authorized by ViaBill to Payment accepted by ViaBill.

Once approved, the order must be captured in order to trigger a charge to your customer and a payout to you. There are multiple options to capture your orders that are outlined below.

Once captured, the order status will automatically be updated to Payment completed by ViaBill.

How to Capture an order

Auto-capture

  1. You can choose to Enable ViaBill payment auto-capture in the module settings. This will automatically capture the order in full after it’s been approved by ViaBill.
    Mak sure to select the order status that you would like

Capture order on manual entry

  1. You can choose to Capture order on manual entry by navigating to the ViaBill Payment Actions panel within the order that you would like to capture. Type in the amount you would like to capture within the Charge field. The default value will be the total price of the order. Then, click on the Capture button to the right of the field.
    If you have enabled Capture confirmation message for single action, a pop-up will appear with the following message: “Are you sure that you want to capture $X?
    By clicking the OK button, the order’s payment will be captured and the order status will be updated to Payment completed by ViaBill.
    Otherwise, the order will be immediately captured and the order status will be updated to Payment completed by ViaBill.
How to Refund an order

To refund an order, the order must be paid via ViaBill and already captured. There are two available options to refund your ViaBill orders, where you can refund a single order or you can bulk refund. If you require the ability to refund less than the full order amount, we recommend to follow the refund a single order process listed below.

  1. You can choose to refund a single order by navigating to the ViaBill Payment Actions panel within the order that you would like to refund. Type in the amount you would like to refund within the Return field. The default value will be the total price of the order. Then, click on the Refund button to the right of the field.
    If you have enabled Refund confirmation message for single action, a pop-up will appear with the following message: “Are you sure that you want to refund $X?
    By clicking the OK button, the order’s payment will be refunded and the order status will be updated to Payment refunded by ViaBill.
    Otherwise, the order will be immediately captured and the order status will be updated to Payment refunded by ViaBill.

  1. You can choose to bulk refund orders by navigating to your order list. Then, select the orders that you would like to include in your bulk refund by checking the box on the far left of the specific orders. In order to perform a bulk refund, you need to select at least two orders that have been created with ViaBill and already have been captured.
    After you have selected the order that you would like to refund, click on the Bulk actions button and select Refund payments.
    If you have enabled Refund confirmation message for bulk action, a pop-up will appear with the following message: “Are you sure that you want to refund $X?
    By clicking the OK button, the order's will be refunded and the order statuses will be updated to Payment refunded by ViaBill.
    Otherwise, the orders will be immediately refunded and the order status will be updated to Payment refunded by ViaBill.
Need help with integrating ViaBill on your store? Reach out to our dedicated integration team at tech@viabill.com and we'll be happy to complete your ViaBill integration at no cost to you.

How did we do?

Magento

Contact