Skip to main content
Source for Online payments
Updated over a week ago

Sources are used for online payments via Smart Checkout, plugins, and our payment tools.

Add a Source

To add a source for online payments, follow these steps:

  1. Log in to Viva.com and select the relevant account (demo or live).

  2. Go to SalesOnline PaymentsWebsites/Apps.

  3. Select Add Website/App.

  4. Fill in the required details in the pop-up window as follows:

  • Code – The four-digit number at the top left of the field is the "Source Code" – the unique identifier for this payment source. This code is generated automatically, but you can choose a different value if you prefer (for organizational purposes, for example). If you use our Payment API, this code is passed through the sourceCode parameter when creating a payment order.

  • Source Name – In addition to the Source Code, you can also assign a name to your payment source. This allows you to more easily identify the source within your account and reports (such as the Settlement Report, for example).

  • Linked Account – Select the account (wallet) you want to link to this payment source. When this payment source is used, the funds will be deposited into the selected account. You can link multiple different sources to a single account if desired.

  • Protocol – If your e-commerce platform uses SSL at checkout, select https. If your platform does not use SSL (as is the case in some development environments, for example), select http.

  • Domain Name – Enter the domain that will be linked to this payment source. You do not need to include the trailing slash (\) or the protocol (http:// or https://). For example:

    • If your website uses www: www.yourdomain.com

    • If your website does not use www: yourdomain.com

  • Integration Method – Leave it as Redirection/Native Checkout v2.

  • Company Logo – Upload your company’s logo to be linked with this payment source, in PNG format with transparency, up to 100KB (recommended size: 128 x 128 pixels). This is an important step, as the logo will appear on your payment page, helping customers recognize and confirm your company.

  • Success URL – This is the URL of the page where the customer will be redirected after a successful payment. For example, you can use it to display a payment confirmation page or a page that thanks the customer for their payment.

  • Failure URL – This is the URL of the page where the customer will be redirected after a failed payment. For example, you can use it to return the customer to the last step of the checkout process so they can retry the transaction.

If you are using one of our plugins, the Success and Failure URLs may require specific values. Refer to the plugin URL table below.

Plugin name

Success URL

WooCommerce Smart Checkout

index.php?wc-api=wc_vivawallet&vivawallet=success

OpenCart Smart Checkout

index.php?route=extension/payment/vivawallet/callback&success

Magento Smart Checkout

vivapayments/viva/callback

Plugin name

Failure URL

WooCommerce Smart Checkout

index.php?wc-api=wc_vivawallet&vivawallet=fail

OpenCart Smart Checkout

index.php?route=extension/payment/vivawallet/callback&fail

Magento Smart Checkout

vivapayments/viva/callback

  • Advanced Settings – At this point, you can enable the display of a Cancel Button in Smart Checkout, as well as modify the names of the URL parameters added to the Success/Failure URLs after a transaction (see Response information | Viva.com Developer Portal).

    To enable the Cancel Button in Smart Checkout, activate the Cancel Button option. When the Cancel Button is clicked, Smart Checkout will redirect to your Failure URL with the parameter cancel in the query.

Note:

  • Currently, the Cancel Button is supported for direct Smart Checkout integrations, as well as specific functionality in our plugins for Shopify and PrestaShop.

  • It is also possible to receive webhooks for order cancellation events. Follow this guide (Order Updated | Viva.com Developer Portal) to set up a webhook for order cancellations.

Default parameters are:

Parameter

Default Name

Cancellation status

cancel

Order Code

s

Transaction ID

t

Language

lang

It's recommended to keep these defaults unless specific changes are required to align with internal systems.

Finally, review the information next to each checkbox at the bottom of the screen. You must agree to these terms in order to create the payment source. Once you have selected all the options, click the Create button to complete the process.

Did this answer your question?