Vouchers
Learn about ZBD Vouchers and how to best leverage this feature.
A ZBD Voucher is a single-time use coupon that can be redeemed by another ZBD user to transfer funds from your Developer Wallet into their wallet.
Voucher Use Cases
You can create Vouchers anytime you want to send another ZBD user sats from your Developer Wallet.
Examples:
- You want to gift a user but don’t know their ZBD Gamertag or Lightning Address
- You want to send a Voucher to a user’s email to re-engage them
- You want to run a promotion where you generate 100 Vouchers and give them away to people
Create Voucher
To create Vouchers, go to the Vouchers
page in the Dev Dashboard and click Create Voucher
. When you create a Voucher, it debits the funds from your Developer Wallet. Alternatively, you can use the Create Voucher API endpoint.
Redeem Voucher
Vouchers are redeemed by entering the unique 8-digit code within the Dev Dashboard or Mobile App, or using the Redeem Voucher API endpoint. The funds from the Voucher will be credited to your wallet balance.
Dev Dashboard users can redeem Vouchers by pressing z
+ m
, entering the 8-digit code, then pressing Redeem Voucher
. This will credit the sats to your Developer wallet.
ZBD Mobile App users can redeem Vouchers by following these steps:
- Tap your wallet balance in the navbar to open your Wallet details
- Press
Vouchers
- Press
Redeem
- Enter the Voucher Code
- Press
Redeem Voucher
Share Voucher
The unique 8-digit code from a Voucher can be shared with another ZBD user, who can redeem it to transfer the funds from your wallet to their own.
View Created Vouchers
There are multiple options to view Vouchers:
-
Navigate to the
Vouchers
page within the Dev Dashboard to view a list of your Vouchers created via the Dev Dashboard UI. -
Navigate to the applicable Project Wallet page within the Dev Dashboard and view the Transactions History table to view a list of your Vouchers created via API.
-
Use the Get Voucher endpoint to retrieve the details about a Voucher.
Revoke a Voucher
If you issue a Voucher, but want to revoke (cancel) it, you can:
- Revoke it via the Revoke Voucher API endpoint
- Revoke it within the Dev Dashboard:
- Navigate to the
Vouchers
page within the Dev Dashboard - Find the applicable Voucher within the data table
- Click on the Voucher to open the Voucher Details modal
- Click
Revoke
- The Voucher funds will be credited to your Developer Wallet
- Navigate to the
Voucher Statuses
Status | Description |
---|---|
Valid | This means the Voucher is active and available for another user to redeem. |
Redeemed | This means the Voucher has been redeemed by you or another user. Since Vouchers are single-time use, a Redeemed Voucher cannot be redeemed again. |
Revoked | This means the Voucher has been cancelled and can no longer be redeemed. |
Was this page helpful?