Getting Started

The Single Use Voucher Service Interface is a RESTful HTTP based messaging protocol, intended to enable interoperability between single use voucher vendors and retailers.

Throughout the Single Use Voucher Service Interface documentation and API the term ‘single use voucher’ and ‘single use voucher vendor’ may be abbreviated to simply ‘voucher’ and ‘voucher vendor’ respectively.

The Single Use Voucher Service interface is licensed under an Apache 2.0 license.

Language Support

Java

The Electrum implementation of the Single Use Voucher Service Interface is written in Java. It is highly recommended that if you are planning a Java implementation of the Single Use Voucher Service Interface you include the Single Use Voucher Service Interface dependency in your project to save you from having to re-implement the interface. This can be done using Maven using the dependency:

<dependency>
    <groupId>io.electrum</groupId>
    <artifactId>suv-service-interface</artifactId>
    <version>1.0.0</version>
</dependency>

Other languages

The Single Use Voucher Service Interface is described as a Swagger (OpenApi) document. It is highly recommended that widely available swagger tooling is used to generate a project in your preferred language as a starting point to a new integration project.