Viva Wallet for WooCommerce

Integrate Viva Wallet with your WooCommerce store to process and sync your payments and help you sell more.

Overview ↑ Back to top

Viva Wallet for WooCommerce lets you accept payments directly to your store without being redirected. It supports the following payment cards:

  • Visa
  • Mastercard
  • American Express
  • Maestro
  • Apple Pay
  • Bancontact
  • JCB
  • Diners Club (Greece only currently)
Translation ready!
See Generating a New Translation for instructions on how to support additional languages. Our translation template, Viva-Wallet-for-WooCommerce.pot
is available in the /languages directory of the plugin.

Requirements ↑ Back to top

  • Viva Wallet account and sandbox
  • PHP 5.4+ (you can see this under WooCommerce > Status)
  • WordPress 5.1+
  • WooCommerce 3+
  • An active domain name that points to your e-commerce site
  • Domain must have a valid SSL certificate
  • php cURL support

Installation (if installing for the first time) ↑ Back to top

  1. Click on the Free Download button on our product page.
    A shopping cart is displayed
  2. Complete the form with your details and click on the Purchase button. Note that as this is a free download you will not be asked for payment.
    A confirmation page is displayed.
  3. Click on the Download link to download to your local machine.
  4. Go to Plugins > Add New > Upload Plugin and select the ZIP file you just downloaded.
  5. Click Install Now then Activate Plugin.
  6. Find Viva Wallet for WooCommerce in the list and click Settings.
  7. Now proceed to the next section, below, to find out how to configure the plugin.

Installation (if upgrading from a previous version) ↑ Back to top

See upgrading the plugin further down this page. Once you have enabled the new plugin in the plugins list, proceed to Step 1 of ‘Getting started’, below.

Getting started ↑ Back to top

Before going any further, you need to ensure your WooCommerce currency is set to the same as your Viva Wallet account currency: WooCommerce > Settings > General > Currency options. There are 5 currencies available. Which one you should choose is dependent on the country in which you registered your Viva Wallet account:

  • EUR – Euro (Austria, Belgium, Cyprus, Finland, France, Germany, Greece, Ireland, Italy, Malta, Netherlands, Portugal, Spain)
  • GBP – Pound sterling (UK)
  • BGN – Bulgarian lev (Bulgaria)
  • PLN – Polish złoty (Poland)
  • RON – Romanian leu (Romania)
  • DKK – Danish krone (Denmark)

Step 1: Capture Viva Wallet for WooCommerce credentials ↑ Back to top

First, you need to grab your WooCommerce credentials from your Viva Wallet account:

  1. Log in to Viva Wallet, demo or live, and select the required account.
  2. Go to Settings > API access.
  3. Scroll down to WooCommerce Credentials and click on Generate a pair of credentials.
  4. Make a temporary copy of the values in notepad (or similar).

Step 2: Specify required settings ↑ Back to top

From WooCommerce > Settings > Payments on your WordPress site, do the following:

  1. Select the Enable Viva Wallet checkbox.
    If you wish to offer your customers Apple Pay (Safari only), select the Enable Apple Pay checkbox.
  2. Tick the Enable demo mode checkbox, if you wish to test before going live. Untick to begin accepting payments with Viva Wallet.
  3. Enter your Live Client ID and Live Client Secret (obtained from your Viva Wallet account earlier). The Demo Client ID and Demo Client Secret are different and should only be used when ‘Enable demo mode’ is selected in step 2.
  4. Click on Save changes.
    A confirmation message will be displayed with the payment source code that the plugin set up automatically within your Viva Wallet account.
    Once the payment source is activated, you’re ready to start receiving payments from your customers through Viva Wallet.

Step 3: Specify advanced settings (optional) ↑ Back to top

Selecting the Show advanced settings checkbox on the same page reveals further options:

  • If you wish, you can edit the Title and Description seen by the customer during checkout.
  • Clicking the Source Code List dropdown displays the current payment source codes available in your Viva Wallet account.
  • The Show Viva Wallet logo checkbox can be deselected if you wish to remove any Viva Wallet branding from your checkout.
  • The Show credit card logo on checkout page can be deselected if you wish to disable the ability to show the issuer branding after card number validation.
  • The Order status after successful payment dropdown enables you to choose Processing if more appropriate than the default Completed option. Which option you should select depends on the type of business you operate. E.g., for instantly available digital downloads, ‘Completed’ is appropriate, but for products where you need to check stock levels after taking payment, ‘Processing’ is more meaningful.

Apple Pay ↑ Back to top

For Apple Pay to function correctly, all requirements for the native plugin must be met (i.e. you must have a verified Viva Wallet account and valid credentials set. Your account must be active and able to receive payments).

If your credentials are valid and Enable Apple Pay is checked, the installation process and registration of your domain with Apple Pay services are initialized.

Once the installation process is complete, you will see a new notice on the top of the page Your domain is verified with Apple Pay and you are ready to accept payments!

Requirements ↑ Back to top

Stores that wish to accept Apple Pay must meet the following requirements:

  • Your entire website must be served over a secure network (HTTPS)
  • Apple Pay works only in the Safari browser (iOS and macOS) on an Apple device with Bluetooth enabled. In all the other browsers and operating systems the Pay with Apple Pay button will not be visible to users.
  • To use in demo mode, you need to have a Sandbox Tester Account, a paid developer subscription with Apple. To find out how to set one up, see Create a Sandbox Tester Account under Sandbox Testing  on the Apple developer portal.

Payment request button ↑ Back to top

Customers need to have a payment method from a supported bank or payment card provider listed at the Apple Pay support page, and a compatible Apple device .

Enabling Apple Pay on your site via the Viva Wallet for WooCommerce payment gateway is an automated process. When you select the Enable Apple Pay checkbox (see under Step 2: Specify required settings, above), the plugin configures Apple Pay and registers your domain automatically.

Upgrading the plugin  ↑ Back to top

There are two ways in which you can perform a plugin upgrade.

Automatic update ↑ Back to top

If you need to update the extension you can do this automatically from the WordPress plugins page. However, first you need to make sure you have connected your site to WooCommerce.com. To do that:

  1. Go to WooCommerce > Extensions on your WordPress site and select the WooCommerce.com Subscriptions tab.
  2. Click on the Connect button:

    A confirmation message is displayed.
  3. Click on the Approve button.
  4. Open the Plugins page and click on the Enable auto-updates link next to the Viva Wallet for WooCommerce entry.
    Now, with each new release of our plugin, you’ll be prompted to update it. Clicking on the Update now link under the Viva Wallet for WooCommerce entry on the plugins page will do this immediately. Your previous settings will be retained.

Manual update ↑ Back to top

You can also update manually by downloading the latest version from your WooCommerce account. Once you have the zip file downloaded, you should deactivate and delete the existing version from the Plugins page on your WordPress site. Then you can install the new version using the Upload Plugin option. Now go to Step 1 of ‘Getting started’.

FAQs ↑ Back to top

What card numbers can I use for testing? ↑ Back to top

Yes, please see card details below, for use in demo mode only. No actual payments can be made within this environment but you can use these cards to make demo payments of 30p or more.

Long card number Issuer CVC Expiry date
4111 1111 1111 1111 Visa Any 3 digits Any future date
5900000000000000022 Mastercard Any 3 digits Any future date
378282246310005 American Express Any 4 digits Any future date

After submitting a payment request, you will see a popup which gives you the option of simulating either a successful authentication or a payment failure. This is useful for test purposes.

Can I test Apple Pay? 

Yes, please follow the link here for instructions Apple Pay Sandbox Testing.

Is there any difference in the setup process between demo and live? ↑ Back to top

In both cases, the new payment source is activated immediately. However, on live, our team also checks the WooCommerce website assigned to the payment source in case of any potential issues.

Can I test the plugin using a development server? ↑ Back to top

For test purposes, the best option is to have a staging site, e.g. staging.yourdomain.com. You can replicate your live site and try out the Viva Wallet for WooCommerce plugin without using a public domain name.

Another way is to set up a development environment on a local machine, but in this case you’ll need to use domain masking as localhost won’t work. You’ll need a directive in your hosts file so that you can navigate to www.yourdomain.com but the browser will serve the local site. This way you can test locally, make sure everything works, then apply the changes to your production website.

For both these options you should try the plugin in demo mode, configured with the WooCommerce credentials from your Viva Wallet sandbox account.

Another option for local testing is to use ngrok, an application for exposing a web server running on your local machine to the internet. View ngrok documentation.

Can I refund a customer from Viva Wallet? ↑ Back to top

Yes, you can do this through the WooCommerce ‘Orders’ page as follows:

  1. Click on the required order to view the order details page.
  2. Enter refund amount, full or partial.
  3. Click Refund via Viva Wallet button:
  4. The order status is amended accordingly on the ‘Orders’ page:

Where can I get support? ↑ Back to top

Please email woosupport@vivawallet.com.

Troubleshooting  ↑ Back to top

Solutions to common problems.

I’m getting an API error ↑ Back to top

Ensure that you have entered the correct credentials. If you are in live mode, you should have entered live credentials (not demo keys). If this does not solve the error and you need to troubleshoot the issue, we have a log facility you can access. From within WP Admin, do the following:

  1. Go to WooCommerce > Status > Logs tab.
  2. Select required date from the dropdown and click on the View button.
  3. Copy the contents into a text file and save it with an appropriate name.

Apple Pay – setup issues  ↑ Back to top

The domain registration process with Apple Services is a two-step process. The plugin first attempts to create a new folder named .well-known located in your domain root folder (https://YOURDOMAIN.com/.well-known). It then tries to save a file named apple-developer-merchantid-domain-association in that folder.

If the first step is successful, a call to Viva Wallet API endpoints is fired. This registers the domain with Apple Pay services. When this call is made, the .well-known directory is scanned for the file that contains the relevant key. This is how the registration gets authenticated.    In the case of errors produced while writing the file to your domain root, you will receive relevant error messages, for instance, unable to create folder / copy file. The most common cause of this is a permissions issue.

To resolve, do one or more of the following:

  • You can try to create the folder .well-known manually in your server root directory and set permissions to 755.
  • If the folder already exists, you can delete it and try the installation again.
  • Attempt to visit Viva Wallet plugin page and save your settings (complete the registration).

If the above fails:

  1. Download the Apple Pay verification file containing the domain association key.
  2. Upload the file to the .well-known directory.
  3. Go to the Viva Wallet plugin settings and reload/save your settings to complete the registration.

WooCommerce - the most customizable eCommerce platform for building your online business.

Back to the top