Data Services API

Information about our Data Services API.

Overview

Our Data Services API provides an easy way for merchants to manage their reconciliation processes programmatically. You can use our REST API to subscribe to daily sales transaction reports. You can configure subscribed events using the endpoints detailed below.

Please speak to your Viva Wallet sales representative to request access to Data Services. Alternatively, you can contact us directly via our live chat facility. Simply click on the live chat icon in the bottom right-hand corner of this page

API calls

The Viva Wallet Data Services API consists of the following API calls:

  1. Create a subscription
  2. Update a subscription
  3. Delete a subscription
  4. List subscriptions
  5. File Request

1. Create a subscription

This API call is used to subscribe to webhooks to get automated messages or information about specific events. A webhook subscription registers the notification URL that Viva Wallet sends notifications to and the events you want to be notified about.

A valid call will result in HTTP status code 200 and generation of a unique subscriptionId.

Currently, Webhook Subscription can be made for SaleTransactionsFileGenerated event only

Find out more about the Create a webhook subscription API call and its parameters

2. Update a subscription

This API call is used to update an existing webhook subscription.

A valid call will result in HTTP status code 200 and return a unique subscriptionId.

Find out more about the Update a webhook subscription API call and its parameters

3. Delete a subscription

This API call is used to delete a webhook subscription.

A valid call will result in HTTP status code 200 and return a message “Subscription deleted”.

Find out more about the Delete a webhook subscription API call and its parameters

4. List subscriptions

This API call is used to list the existing webhook subscriptions.

A valid call will result in HTTP status code 200 and generation of a list of webhook subscriptions.

Find out more about the List webhook subscriptions API call and its parameters

5. File Request

This API call is used to request the generation of a sale transactions report for a specific date.

A valid call will result in HTTP status code 200 and generation of a unique requestId. This request id will also be included in the header of the notification. You can save this value to match it with the incoming notifications.

Viva Wallet prepares your data and sends a notification to your webhook subscription URL with a POST request

Find out more about the File Request API call and its parameters

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!