{
    "success": true,
    "data": {
        "amount": "1000",
        "code": "CB6A2DC5",
        "createdAt": "2023-08-29T22:07:25.736Z",
        "createTransactionId": "a3742c93-be3b-49aa-9414-79deb04137b9",
        "description": "Sending to an email!",
        "fee": "1000",
        "id": "bdd0ee12-5231-4759-88aa-bb3634ed99e4",
        "unit": "msats",
        "walletId": "0701cf1b-059b-4b88-854e-3362d9b96aab"
    },
    "message": "Voucher was sent to email address."
}

​
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)

Was this page helpful?

Create ChargeCreate Withdrawal Request