Voucher Overview¶
Target Audience: Users, Developers, Stakeholders
Release version: 3.7.8
Introduction¶
Voucher is a feature that enables your customers to get access to a subscription in exchange of a voucher. There are various cases that this can be used for, they are described further down.
Our goal is to create a fast and easy way for you to engage with a customer and give them direct access to a digital try-out subscription. Either via an administrator or an integrator, that have the ability to create a voucher. The customer can redeem a voucher in our portal or by an administrator via the admin portal.
To redeem a voucher the customer only needs the voucher code and the link to the flow to redeem it.
Purchasable vouchers¶
Purchasable vouchers are by default disabled in Payway, and must be enabled by Adeprimo. To get started or learn more about purchasable vouchers, feel free to contact our support.
Furthermore, some things that are explicit to purchased vouchers:
- When redeeming a purchased voucher, the customer will be given the option to fill in their delivery address if the associated product is a print product.
- When redeeming a purchased voucher, a subscription system export will be generated.
- Vouchers bought by a customer can either be viewed in PAP, or fetched via the Me API.
Using Adyen payment methods¶
Introduced in Payway 4.5.7, voucher orders can be placed via the Adyen API. This will allow your customers to place an order and purchase a voucher for future use, instead of the customer placing an order and receiving a subscription. The purchase flow as presented to the end user stays the same, and the amount of days the receiver gains access is based on the length of the selected payment period.
Using payment method free¶
Introduced in Payway 4.6.0, free voucher orders can be placed via the Account API and Me API. This will allow you to create a free voucher for your customers. The amount of days the voucher receiver gains access to is based on the length of the selected payment period.
Requirements
- The product needs to have voucher purchase enabled
- The payment period needs to be limited and free
Possible cases¶
-
Collaboration with others, through the voucher API, 3rd parties can create vouchers from our platform and sell them to a customer.
-
A company can buy a number of vouchers for their employees and hand them over, meaning each employee will have their own account.
-
Moving print customers to digital, if the digital package has no integration, this can be a way to end a paper subscription and start a digital for the customer in Payway without having to perform a refund.
Fields¶
| Field Name | Example value | Description |
|---|---|---|
| organisation_id | adeprimo | The id of the organisation. |
| days_of_access | 30 | This describes for how long (n days) the access should be granted by this voucher. |
| voucher_code | 1382b0 | The length of the result string is 10 may contain 0-9 and a-f. |
| package_code | adeprimo_digital | The package code on the product that this should grant access for. |
| provision_service | tulo | This is the name of the system that created the voucher and will be used when the voucher is being redeemed. |
| redeemed | false | This described if the voucher is redeemed or not. |
| redeemed_at | 2018-10-01T13:50:00+01:00 | This is the date and t ime when the voucher was redeemed. |
| expires_at | 2018-12-31T23:59:59+01:00 | This is the date and time when the voucher will expire. |
| created_at | 2018-09-01T23:59:59+01:00 | This is the date and time when the voucher was created. |
| updated_at | 2018-09-01T23:59:59+01:00 | This is the date and time when the voucher was updated. |