List Vouchers

Retrieve a paginated list of all Vouchers for an Account, with the option to filter by Promotion, Contact, Voucher status, and more.

Create Voucher

Creates a new Voucher for a Promotion. Only the promotion_uuid is required. A specific code can be given to be used, or else a code will be generated by the system. Similarly, if no activation_date and/or expiration_date is given, the system will calculate those dates by the validity rules set up for the promotion. It is recommended to send in the expiration and activation date only if business logic demands its, and the validity logic in the Piggy system is unable to handle that logic. Note: If you do send in activation- or expiration dates, keep in mind they need to be in ISO 8601 format and will be stored in UTC time. If the date-time you're sending in is not already in UTC time, please either parse it to UTC beforehand, or pass along the timezone.

Create Batch of Vouchers

Create multiple Vouchers at once for a specific Promotion. Specify the quantity and, optionally, a Contact UUID, activation_date and/or expiration_date. The system will generate a batch of Vouchers according to the Promotion's rules.

Find Voucher

Finds a Voucher by its unique code. This call will help you with identifying individual Vouchers and viewing their specifications like whether the Voucher is redeemed or not or when it expires.

Update Voucher

Update the status of a Voucher. This endpoint allows you to activate or deactivate a Voucher, changing its usability status as needed.

Check Voucher Validity

Validates if the Voucher can be redeemed at this point by the Contact.

Redeem Voucher

Redeems a Voucher for a Contact. If the Voucher is already linked to a Contact – because it was sent in an automated email for instance – the call only requires the Voucher's code for redeeming it.

If the Voucher isn't yet linked to a Contact – because a series of Vouchers were printed as flyers to be given away for instance – then the contact_uuidis required as well as the Voucher code.

Please note that when using locked Vouchers, you should send in your release_keyhere as well.

Lock Voucher (Optional)

Using the lock functionality, you can make sure that a Voucher cannot be used by another process at the same time as well as return the Voucher to its ACTIVE state when a failure occurs on your side (using the Release call). Using the locking method, you can make sure the Voucher only reaches a REDEEMED state when everything completed successful on your side.

When locking a Voucher, a release key is returned which should then be used to either redeem the Voucher later on, or to restore the Voucher to its ACTIVE state using the release call.

If the lock is not released within an hour, the lock will be released by the system automatically and the Voucher will be restored to its ACTIVE state.

Release Voucher (Optional)

When using Voucher locking, there is also the process of releasing the Voucher. Using the call you can release the Voucher from its lock using the release key that was retrieved during the initial lock.

Extra information:

When redeeming a Voucher that was previously locked, the system will release the lock automatically (you need to provide the release key as well). However, if your system wants to release the Voucher manually you can do so using this call. If the release is not done within the hour, the system will release it automatically.

Reverse Voucher Redemption

Reverses a Voucher Redemption.

Multi Redeem Voucher

Redeems a Voucher multiple times at once for a Contact.

If the Voucher isn't yet linked to a Contact – because a series of Vouchers were printed as flyers to be given away for instance – then the contact_uuidis required as well as the Voucher code.

Please note that when using locked Vouchers, you should send in your release_keyhere as well.