Webhooks for payments

Set up webhooks to receive notifications for events within your Viva Wallet account.

Overview

Viva Wallet supports webhooks, a simple and powerful solution that allows you to receive notifications each time a specific event takes place. Webhooks are particularly useful for asynchronous events such as asynchronous payments, for example, when the funds of the customer are transferred from his bank account into your Viva Wallet account.

You do not need to set up webhooks for the WooCommerce Standard Checkout plugin or the Shopify Smart Checkout plugin, as they are automatically created by the plugins

Webhook Events

The following events are available for which a notification can be sent. Please see the table below for a list of available webhooks and the unique IDs (EventTypeId) which can be used to identify these events:

Webhook EventTypeId Description
Transaction Payment Created 1796 A customer’s payment has been successful
Transaction Failed 1798 A customer’s payment failed (but the customer may retry and the customer’s payment may - eventually - be successful)
Transaction Price Calculated 1799 A commission payment has been withdrawn from your account by Viva Wallet
Transaction Reversal Created 1797 A customer refund has been successfully actioned
Account Transaction Created 2054 A wallet account balance change
Command Bank Transfer Created 768 A bank transfer to an external IBAN has been created but not executed yet (the money has not yet been transferred from your wallet)
Command Bank Transfer Executed 769 A bank transfer to an external IBAN has been executed. In case of instant bank account transfer, money has been transferred immediately from your wallet - which is linked with your IBAN - to the external IBAN. In case of non-instant bank account transfer, money has been transferred from your wallet - which is linked with your IBAN - but not necessarily received yet to the external IBAN
Obligation Created 5632 A marketplace obligation (e.g. refund request) has been successfully sent to a marketplace seller
Obligation Captured 5633 A marketplace obligation (e.g. refund request) has been successfully paid by a marketplace seller
Sale Transactions The requested sale transactions are available to download

Webhook notifications will not be triggered for expired payment orders, cancelled transactions, or payments that failed 3DS user authentication (see the Event ID codes). If you wish to test a Transaction Failed webhook, please use our Issuer declines functionality

Setting up Webhooks

You can start receiving webhook notifications by following the below steps:

Whitelist the Viva Wallet addresses

To successfully receive webhook notifications, you should whitelist the below IP addresses/ranges in both your server and in your network firewall. The webhooks’ IP source will be from the below IP addresses/ranges:

Production accounts
51.138.37.23820.54.89.1613.80.70.18113.80.71.223
13.79.28.7040.127.253.112/2851.105.129.192/28
Demo accounts
20.50.240.5740.74.20.7894.70.170.6594.70.174.36
94.70.255.7394.70.248.1883.235.24.226

Generate a webhook verification key

Before receiving a webhook notification to your website, you need to create a unique verification code for Viva Wallet to identify you as a merchant. To do this, make a simple GET request to the following API endpoint with basic authentication headers.

get    /api/messages/config/token

This call will give you a “Key”:“Value” pair in a JSON response(example below) which you can print it as is. You can disable a webhook (without deleting it) to temporarily stop receiving notifications.

Request example

The example below uses basic auth for authentication.

Run in Postman

Environment URL
Production https://www.vivapayments.com/api/messages/config/token
Demo https://demo.vivapayments.com/api/messages/config/token
curl '[Environment URL]'
-H 'Authorization: Basic [Base64-encoded Merchant ID and API key]'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '[Environment URL]',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Basic [Base64-encoded Merchant ID and API key]'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response example
{
  "Key":"B3248222FDCD1885AEAFE51CCC1B5607F00903F6"
}

In order to use a new webhook URL, Viva Wallet needs to verify that the given URL is available for immediate use.

Each time you enter a new webhook URL via the banking app, you need to verify it (by clicking on the “verify” link next to URL input textbox). This action will start the process of a simple GET http call to your URL. We send this request using TLS 1.2 so your server configuration needs to match that. Your page should print a JSON response such as the one shown above.

Create a webhook endpoint

To receive webhooks, Viva Wallet requires that you respond to every notification. This is to ensure that your server is properly accepting notifications.

You should set up an HTTP endpoint on your server and make be sure that you can accept webhook requests with a POST method.

For test purposes, you can generate your webhook URL using Pipedream web application.

Handle requests from Viva Wallet

You should configure your endpoint to read all the provided by Viva Wallet objects-parameters for every event type of webhook notifications you want to receive.

Every webhook notification includes the following properties:

The TransactionEventData will have different parameters in the webhook you will define for each event type.

You may confirm the transactions status through the StatusId parameter.

Viva Wallet sends all the events to your webhook endpoint as part of a POST request with a JSON payload. In order for Viva Wallet to assume you have successfully received a webhook notification, you need to respond with http status 200 to the POST calls received from us

The below Node JS may be useful as an example of the code you can use:

Environment URL
Production https://www.vivapayments.com/api/messages/config/token
Demo https://demo.vivapayments.com/api/messages/config/token
  if (steps.webhookEndpoint.event.method === 'POST') {
    console.dir(steps.webhookEndpoint.event.body);
    $respond({
      status: 200,
      body: { message: 'ok' }
    })
    return;
  }

  const axios = require("axios");

  var merchantId = '[your demo/production Viva Wallet Merchant ID]';
  var apiKey = '[your demo/production Viva Wallet API key]';

  var credentials = Buffer.from(merchantId + ':' + apiKey).toString('base64');

  const resp = await axios({
    method: "GET",
    url: "[Environment URL]",
    headers: {
      "Authorization": "Basic " + credentials,
    }
  });

  var code = resp.data.Key;

  $respond({
    status: 200,
    headers: { "test-header": "value" },
    body: { key: code }
  })
  console.log('Webhook has been validated')

Deploy your webhook

Deploy your webhook and make it public; not private. You can confirm it, visiting your URL using a browser and getting the key string number, as String parameter type in base64 format.

In the below example, the webhook URL was generated using the ‘Pipedream’ web application.

Verify Webhook

If you don’t get any key value then the authentication is not executed successfully, and your account credentials are not validated.

Set up and verify your webhook in Self Care

To set up your webhook endpoint within the Viva Wallet banking app:

Obligation Created webhook

Retry policy

Viva Wallet will assume you have successfully received a webhook notification if you respond with http status 200 to the POST calls received from us.

In any other case (HTTP error codes 3xx, 4xx, or 5xx) a retry mechanism will apply (72 retries / 3 days) will start and run once per hour until a status 200 is received or the maximum retries threshold is reached.

Get Support

If you would like to integrate with Viva Wallet, or if you have any queries about our products and solutions, please see our Get Support page to see how we can help!