The Payment

The Payment Object

The ZEBEDEE Payment consists of the following attributes:

PropertyTypeDescription
idStringThe Charge's unique indentifier.
feeStringThe total fee paid for performing this payment. *May include Lightning routing fees, as well as ZEBEDEE service fees.
processedAtStringThe timestamp of when the Payment was processed.
descriptionStringA user-defined description for the Payment.
callbackUrlStringA URL that ZEBEDEE's services will make a POST HTTP request to with information about the Payment'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 Payments to specific Players.
amountStringThe total amount for the Payment.
unitStringThe unit of account for the Payment's amount. ZEBEDEE's API is based on millisatoshi (msats) amounts.
statusStringThe current status of the Payment.
invoiceStringThe Lightning invoice (BOLT11) this Payment relates to.

To learn how to make Lightning payments with the ZEBEDEE API check our Guide.

tip

While a Payment will usually settle instantaneously, depending on the destination node's properties (liquidity, connectivity, and availability) a Payment may be in-transit while it attempts payment paths. As soon as the Payment fails or succeeds, both the API request and the callbackUrl will return.