The Withdrawal Request

The Withdrawal Object

The ZEBEDEE Withdrawal Request consists of the following attributes:

PropertyTypeDescription
idStringThe Withdrawal Request's unique indentifier.
descriptionStringThe description of the Withdrawal Request.
createdAtStringThe timestamp of when the Withdrawal Request was created.
callbackUrlStringA URL that ZEBEDEE's services will make a POST HTTP request to with information about the Withdrawal Request's status update.
internalIdStringAn optional free-use attribute. Usually used by setting the Player/User ID of your Game/Application in order to link specific Withdrawal Requests to specific Players.
amountStringThe total amount for the Withdrawal Request.
unitStringThe unit of account for the Withdrawal Request's amount. ZEBEDEE's API is based on millisatoshi (msats) amounts.
statusStringThe current status of the Withdrawal Request.
invoice.expiresAtStringThe timestamp for when this Withdrawal Request will expire.
invoice.requestStringThe Lightning invoice (LNURL).

To learn how to create a Withdrawal Request to allow Players/Users to withdraw their funds check our Guide.

tip

Withdrawal Requests are based on the LNURL open source specification. Only Lightning Wallets capable of understanding this specification are able to perform/process Withdrawals correctly.