[Skip to main content](#vessel-content) ☰ Documentation # Viva.com payment plugin Details Written by: Administrator Category: [Payment plugins](/support/documentation/hikashop/payment-plugins) Published: 09 November 2026 Hits: 7 ## Installation - 1) Open a Viva.com account (or a free demo account at demo.vivapayments.com to try it first). - 2) In your Viva.com dashboard, Settings, API Access: copy the Merchant ID and the API key, generate the Smart Checkout client ID and client secret and copy both, and tick Allow refunds. Tick also Allow recurring payments and pre-auth captures via API if you will use Authorise only. - 3) Install this plugin through the Joomla Extension Manager (or HikaShop, Plugins, Install Plugin on WordPress), then in HikaShop go to System > Payment methods, click New and choose Viva.com. - 4) Enter the credentials of step 2, set Demo account to Yes for a demo account, and save. The settings now show a Success and failure URL and a Webhook URL. - 5) In your Viva.com dashboard, Sales, Online payments, Websites/Apps: add a payment source for your shop, with the Success and failure URL of the plugin as both its success URL and its failure URL, and copy its 4-digit code into the Payment source code setting. - 6) In Settings, API Access, Webhooks: create a webhook with the Webhook URL of the plugin, click Verify, and choose the event Transaction Payment Created; create two more for Transaction Failed and Transaction Reversal Created. ## Configuration ![The settings of the Viva.com payment method in HikaShop](/images/doc/plugins/viva/viva_settings.png) - **Demo account**: Yes for an account of demo.vivapayments.com, where no real payment is taken, No for your live account. The checkout then says "demo" next to the method. - **Smart Checkout client ID**: from Settings, API Access, Smart Checkout Credentials. Without it, no payment can be taken. - **Smart Checkout client secret**: given with the client ID. Viva.com shows it only once: generate a new one if you did not keep it. Without it, no payment can be taken. - **Merchant ID**: from Settings, API Access. Needed for refunds, for Authorise only and for the webhook check. - **API key**: given with the Merchant ID. Needed for the same, and Allow refunds must be ticked next to it. - **Payment source code**: the 4-digit code of your shop's payment source. Empty, Viva.com uses its Default source, whose success URL is not your shop's. - **Success and failure URL**: shown by the plugin, to paste in your payment source. - **Webhook URL**: shown by the plugin, to paste in your webhooks. - **Payment page colour**: the main colour of the payment page, as a hex code such as 1a73e8. Empty for Viva.com's colours. - **Payment timeout**: how many seconds the customer has to pay, 1800 (30 minutes) by default; 65535 never cancels the payment. - **Only accept Viva.com's addresses**: refuses the notifications which do not come from the addresses Viva.com publishes. Leave it off when your site is behind a proxy or a CDN. Payments are read back from Viva.com in any case. - **Debug**: writes every call to Viva.com to the HikaShop payment log. - **Invalid status**: the status of an order whose payment was declined, cancelled by default. - **Pending status**: the status of an order whose payment is still on its way; created by default, which leaves the order as it is. - **Verified status**: the status of a paid order, confirmed by default. With Authorise only, moving an order to it takes the payment. - **Refunded status**: moving an order to this status refunds its payment on Viva.com (or releases its authorisation). - **Authorise only**: Yes to only hold the amount on the customer's card, and take it when you confirm the order. - **Authorised status**: the status of an order whose amount is held, pending by default. A hold not taken in time falls off: after 1 to 5 days on a debit card, up to 30 days on a credit card. ## Troubleshooting - "The payment could not be started" at the checkout, with Viva.com's reason: "does not have a source with code" means the payment source code is wrong or the source is disabled; "does not support currency" means your Viva.com account does not take the order's currency; a refusal of the credentials means the client ID and secret do not match the Demo account setting. - The customer does not come back to your shop after paying: check that your payment source has the plugin's Success and failure URL as both its success and failure URLs, and that its code is in the Payment source code setting. - Orders paid by bank or another delayed method stay pending: create the webhooks of step 6. - Viva.com does not verify the webhook URL: the Merchant ID and API key must be filled in, and your site must be reachable from the internet. - "Viva.com refused the refund": on the day of the payment, Viva.com only cancels it for its whole amount; a refund of part of it is possible once the payment is in your Viva.com balance. Check also that Allow refunds is ticked. - "Viva.com refused to capture the payment": tick Allow recurring payments and pre-auth captures via API, and capture before the hold falls off. - Turn Debug on and look at the HikaShop payment log (System > Configuration) for Viva.com's answers.