POST
/
v1
/
create-voucher

Description

Debits your Project wallet to create a single-time use ZBD Voucher. Returns a valid 8-digit voucher Code which can be redeemed by any ZBD user to claim the sats (crediting their account). Creating a voucher takes either a fee of 1 sat or 1% of the voucher amount.

ZBD Vouchers are redeemable by any ZBD user, via the Developer Dashboard or ZBD App.

Usage

You can create vouchers any time you want to send another ZBD user sats from a Project Wallet. For example, you could run a giveaway by programatically creating the required number of vouchers and distributing the Codes to users accordingly.

Configuration

Header Parameters

apikey
string
required

ZBD Project API Key

Content-Type
string

Content Type

Body

amount
string
required

The amount for the Charge -> in millisatoshis

description
string

Note or comment for this Charge (visible to payer)