Entities Overview

The ZEBEDEE API provides developers with access to a few core Entities: Wallet, Charge, Withdrawal Request, and Payment. This page aims to explain the overall division and general capabilities between these Entities within the ZEBEDEE platform. In addition to that, each of these Entities have their dedicated documentation pages. Check the sidebar for more details.

Wallet

Every developer has a Lightning-capable Wallet in their Dashboard. This Wallet serves as the primary source of funding for the activites you perform through the ZEBEDEE API. When making or receiving payments, or when withdrawing funds, this Wallet will be used. Through the Developer Dashboard you are also able to view detailed information about each of the transactions performed in the Wallet.

important

We are in the process of implementing support for developers to have multiple Wallets for better internal division of funds between Games and Applications.

Charge

A Charge represents anything that needs to be paid for. Any Charges that are completed (a user/player paid the Charge amount) will successfully credit the associated Wallet. Charges in the ZEBEDEE API are coupled 1-to-1 with a payable Lightning invoice. To learn more about receiving payments through Charges, read our Receiving Lightning Payments Guide.

Payment

A Payment in the ZEBEDEE platform represents an attempt at paying a Lightning invoice. Your developer Wallet is able to pay any Lightning invoice that follows the specification. ZEBEDEE's Bitcoin and Lightning Network node infrastructure will take care of finding the fastest and most liquid path to the destination. To learn more about making Lightning Payments, please check our Lightning Payments Guide.

Withdrawal Request

A Withdrawal Request in the ZEBEDEE platform is a capability for allowing players to safely withdraw funds/rewards from the Games in an intuitive and user-friendly manner. Withdrawal Requests are a great way for Players to leverage their own Lightning Wallets to communicate with the Game/ZEBEDEE and withdraw their funds. To learn more about Withdrawal Requests, take a look at our Withdrawal Requests Guide.