POST
/
v0
/
email
/
send-payment

Description

Leverage this API to programmatically perform payments to emails. You can view this more detailed guide, if needed.

  • If the email is associated with an existing ZBD App account, then that user account will be credited the sats.
  • Otherwise, the sats will be issued to the email in the form of a valid ZBD Voucher that the recipient can redeem in the ZBD Mobile App.

Usage

It’s as simple as collecting the destination email and hitting this API. The endpoint charges a small fee equal to the greater of 1 satoshi or 1% of the transaction amount.

Configuration

Header Parameters

apikey
string
required

ZBD Project API Key

Body

email
string
required

The Email of the intended recipient (e.g. info@zebedee.io)

amount
string
required

The amount for the Payment -> in millisatoshis

comment
string
required

Note / description of this Payment (may be shown to recipient)