POST
/
v0
/
redeem-voucher
curl --request POST \
  --url https://api.zebedee.io/v0/redeem-voucher \
  --header 'Content-Type: application/json' \
  --header 'apikey: <apikey>' \
  --data '{
  "code": "<string>"
}'
{
    "success": true,
    "data": {
        "amount": "1000",
        "code": "7EE15185",
        "createdAt": "2023-08-24T15:01:56.408Z",
        "description": "Voucher for user.",
        "id": "a2eb43c4-af7f-4eb9-839c-ca31db34b3fc",
        "redeemedAt": "2023-08-24T15:03:43.333Z",
        "redeemedById": "4a4bd549-297e-4e67-a594-386200e1bc21",
        "redeemedTransactionId": "656695f9-36e3-4b9c-abfa-8c2e90f61b45",
        "revokedAt": null,
        "revokedById": null,
        "revokedTransactionId": null,
        "unit": "msats"
    },
    "message": "Successfully redeemed Voucher."
}

​
Description

Credits your Project wallet by claiming a single-time use ZBD Voucher.

​
Usage

Enter a valid 8-digit voucher Code to redeem the sats to your Project wallet.

​
Configuration

​
Header Parameters

​
apikey
string
required

ZBD Project API Key

​
Content-Type
string

Content Type

​
Body

​
code
string
required

Valid 8-digit ZBD Voucher Code

{
    "success": true,
    "data": {
        "amount": "1000",
        "code": "7EE15185",
        "createdAt": "2023-08-24T15:01:56.408Z",
        "description": "Voucher for user.",
        "id": "a2eb43c4-af7f-4eb9-839c-ca31db34b3fc",
        "redeemedAt": "2023-08-24T15:03:43.333Z",
        "redeemedById": "4a4bd549-297e-4e67-a594-386200e1bc21",
        "redeemedTransactionId": "656695f9-36e3-4b9c-abfa-8c2e90f61b45",
        "revokedAt": null,
        "revokedById": null,
        "revokedTransactionId": null,
        "unit": "msats"
    },
    "message": "Successfully redeemed Voucher."
}

Was this page helpful?

Get VoucherRevoke Voucher