Voucher Structure

Voucher structure is not an API call, but it’s included as a part of APITUDE for Activities documentation to help understanding how to build a voucher including barcodes, specific images or any other requirement needed to build a voucher that enables the final customer to enjoy an activity. 

Some api calls can return a voucher list in their response (confirm and modify calls) and some of that vouchers can contain the voucher structure additionally or instead of the vouchers in PDF or HTML. 

When a voucher URL in XML or JSON is provided, you have the choice to;-

  • Build your own voucher with the information included in the XML or JSON message returned by the provided URL*
  • Directly download/forward the voucher URL to final customers;

*In case we send you in the response a voucher URL, it is mandatory to show that voucher. Also you can send the client your own, so they'll end up with 2.

 

The following table (also shown in the booking detail specifications) explains when it’s possible to build your own voucher and when you must deliver the generated voucher to your final customer:

Format

Deliver to the final customer

Build your own voucher

Both PDF/HTML and XML/JSON

Yes

No

Only XML and/or JSON

No

Yes

Here is the sample of voucher URL which will be returned in Booking Confirm response.  

"vouchers": [
                    {
                        "dateFrom": "2017-11-20",
                        "dateTo": "2017-11-20",
                        "code": "PQFY9R0W3Q",
                        "language": "CAS",
                        "url": "https://integrations.activitiesbank.com/vouser/rest/voucher/get/PQFY9R0W3Q",
                        "mimeType": "text/html"
                    },
                    {
                        "dateFrom": "2017-11-20",
                        "dateTo": "2017-11-20",
                        "code": "CIQOL4XH8X",
                        "language": "CAS",
                        "url": "https://integrations.activitiesbank.com/vouser/rest/voucher/get/CIQOL4XH8X",
                        "mimeType": "application/pdf"
                    },
                    {
                        "dateFrom": "2017-11-20",
                        "dateTo": "2017-11-20",
                        "code": "CJ8SE11GTF",
                        "language": "ENG",
                        "url": "https://integrations.activitiesbank.com/vouser/rest/voucher/get/CJ8SE11GTF",
                        "mimeType": "text/html"
                    },
                    {
                        "dateFrom": "2017-11-20",
                        "dateTo": "2017-11-20",
                        "code": "T32NJMIKQF",
                        "language": "ENG",
                        "url": "https://integrations.activitiesbank.com/vouser/rest/voucher/get/T32NJMIKQF",
                        "mimeType": "application/pdf"
                    }
                ],



Docs Navigation