Sale Transactions

The purpose of this webhook is to send you the sale transactions, which you request with a File Request API call.

As soon as a report file is available, Viva Wallet sends a POST notification to your registered URL(webhook subscriptions). The payload contains a download link of the requested report. An HTTP GET request with a bearer authentication should be made to download the file.

Viva Wallet adds signatures to the File Request(Sale transactions) notifications. Please verify the HMAC signatures included in the request header before relying on any notification.

If the Viva Wallet server doesn’t receive a 200 response code from your server after the initial notification attempt, it retries sending the notification every hour and stops five hours later.

Find out more about the webhook notification for sale transactions and its parameters

Webhook Body

{
  "Text": "Download file from: https://api.vivapayments.com/dataservices/v1/FileRequests/File/408af3c8-fe36-11ec-b939-0242ac120003/aa86863b-09a6-4efc-8b40-09f426dfab5b",
  "Link": "https://api.vivapayments.com/dataservices/v1/FileRequests/File/408af3c8-fe36-11ec-b939-0242ac120003/aa86863b-09a6-4efc-8b40-09f426dfab5b",
  "Authorized": true,
  "ExpirationDate": "2022-07-08T01:09:06.239 +00:00",
  "FileType": ".csv"
}

Webhook Headers

You can find below the body parameters of this webhook

Parameter Description
Viva-Signature Contains the HMAC hex digest of the request body, and is generated using the SHA-1 hash function and the secret as the HMAC key
Viva-Signature-256 Contains the HMAC hex digest of the request body, and is generated using the SHA-256 hash function and the secret as the HMAC key.
Viva-Delivery-Id A webhook unique value to identify the delivery. On sale transactions file requests, this is equal to the request identifier.
Viva-Event Name of the event that triggered the delivery (SaleTransactionsFileGenerated).

This webhook can be triggered via File Request API call only. To be able to get the notification, you also need a one-time registration process to our Subscription API.

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!