Vouchers API

Overview

The CCVM (Centralized Coupon and Voucher Management) feature enables Vynamic Engage retailers to offer their customers a variety of discounts and promotions, including Vouchers. While Coupons constitute a benefit that grants a discount to the customer, Vouchers are value documents that can be used for payment for specific goods, and can be obtained when the customer meets the requirements specified for a given offer.

Voucher templates are preconfigured settings that can be used within the framework of offers as both a benefit and conditions.

Features

The Vouchers API provides the following features:

  • Search voucher templates
  • Create vouchers using a template
  • Retrieve a voucher based on the specified attribute
  • Activate a voucher
  • Recharge a voucher
  • Top-up a voucher
  • Redeem a voucher
  • Void the last operation of the voucher
  • Cancel a voucher
  • Retrieves a voucher's history
  • Check the status of the dependent backend service

Security

The Vouchers API supports OAuth 2.0 for authentication purposes.
The supported protocol for the Vouchers API is HTTPS.