lighthouse.dock.tech

Welcome to Lighthouse!

Find comprehensive guides and documentation on our products, as well as support if stuck. Come and get started!

Get Started

Service Vouchers

The Voucher API allows to create and confirm requisitions to purchase service vouchers (vouchers) from the registered merchants.

📘

What is a voucher?

The vouchers offered by this API are commonly called gift cards (virtual codes).

Step-by-Step


To purchase a voucher you must follow the step-by-step below:

1) List all merchants available.

GET List Voucher Merchants

2) Request a voucher purchase for a specific merchant. The API will return an identification code for the voucher purchase order (orderId) and the amount options provided by the specific merchant that can be purchased.

POST Create Voucher Order

📘

Order Expiration

As soon as the request is completed, the orderId begins a countdown to expire within 5 minutes. If the request expires, the orderId will become unavailable.

3) Choose the amount based on the available options and confirm the voucher purchase order according to the orderId, both returned in step 2.

POST Confirm Voucher Order

4) It is also possible to list receipts of all voucher purchases done by an account and filter the results.

GET List Voucher Receipts

Technical Documentation


To see the technical resources about this product, you can access our technical documentation by clicking here.

📘

Webhooks

The registration of the postbacks must be requested through Zendesk informing what is the URL to receive the JSON messages. To see the available webhooks for Voucher API click here.

Updated 28 days ago


Service Vouchers


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.