# ZBD Documentation

> ZBD is the global Bitcoin payments API for app and game developers. Integrate ZBD into your app or game to enable multicurrency payments, rewards, and payouts in minutes.

## Docs

- [ZBD Documentation](https://zbd-earn-sdk-releases.mintlify.site/get-started.md): Global Payment Service Provider for Gaming and Interactive Entertainment
- [Developer Dashboard](https://zbd-earn-sdk-releases.mintlify.site/get-started/dev-dashboard.md): Your command center for global payments and real-money rewards
- [Create Account](https://zbd-earn-sdk-releases.mintlify.site/get-started/create-account.md): Get started with ZBD in minutes
- [Identity Verification](https://zbd-earn-sdk-releases.mintlify.site/get-started/verify-identity.md): Complete your profile to unlock production access and higher limits
- [Add Funds to your Account](https://zbd-earn-sdk-releases.mintlify.site/get-started/add-funds.md): Fund your ZBD wallet to start processing instant global payments
- [Create Project](https://zbd-earn-sdk-releases.mintlify.site/get-started/create-project.md): Set up your first ZBD project and unlock the power of Lightning payments
- [API Keys](https://zbd-earn-sdk-releases.mintlify.site/get-started/api-keys.md): Generate and secure your keys to unlock Lightning-fast payments
- [Project Wallet](https://zbd-earn-sdk-releases.mintlify.site/get-started/project-wallet.md): Understand how Bitcoin Lightning wallets power your projects
- [Manage Project](https://zbd-earn-sdk-releases.mintlify.site/get-started/manage-project.md): Edit project settings, manage access, and control your project lifecycle
- [MCP Server](https://zbd-earn-sdk-releases.mintlify.site/payments/mcp.md): Extend the capabilities of your AI Agents with ZBD Payments as an MCP Server
- [AI Ingestion](https://zbd-earn-sdk-releases.mintlify.site/payments/ai-ingestion.md): Understand how to use ZBD Payments with LLMs.
- [ZBD Ramp](https://zbd-earn-sdk-releases.mintlify.site/get-started/zbd-ramp.md)
- [ZBD Earn SDK](https://zbd-earn-sdk-releases.mintlify.site/get-started/zbd-earn-sdk.md)
- [ZBD Payments API](https://zbd-earn-sdk-releases.mintlify.site/get-started/zbd-payments-api.md)
- [Login with ZBD](https://zbd-earn-sdk-releases.mintlify.site/get-started/login-with-zbd.md)
- [ZBD App](https://zbd-earn-sdk-releases.mintlify.site/get-started/zbd-app.md)
- [Knowledge Base](https://zbd-earn-sdk-releases.mintlify.site/earn/knowledge-base.md): Learn best practices for implementing secure, scalable Bitcoin rewards in your games and apps
- [Introduction to Rewarded Play](https://zbd-earn-sdk-releases.mintlify.site/earn/knowledge-base/rewarded-play.md): Understanding the reasons, benefits and best practices behind implementing real-money player rewards into games.
- [Integrating Player Rewards in a Game](https://zbd-earn-sdk-releases.mintlify.site/earn/knowledge-base/rewarded-play/integrating.md): From setting up your account, to using our APIs in a secure way and massively engaging your users with Bitcoin rewards!
- [Introduction](https://zbd-earn-sdk-releases.mintlify.site/earn/knowledge-base/game-security.md): ZBD's Head of R&D and Game Security Christian Moss introduces us to the series.
- [1. An Insecure Game](https://zbd-earn-sdk-releases.mintlify.site/earn/knowledge-base/game-security/insecure-game.md): Coding a purposefully insecure game with ZBD.
- [2. Hacking Saved Game Data](https://zbd-earn-sdk-releases.mintlify.site/earn/knowledge-base/game-security/hacking-saved-game.md): Understand the risks of storing sensitive data in local storage.
- [3. Hacking Memory Values](https://zbd-earn-sdk-releases.mintlify.site/earn/knowledge-base/game-security/hacking-memory-values.md): Learn how attackers may modify game data through memory injection.
- [4. Decompiling Source Code](https://zbd-earn-sdk-releases.mintlify.site/earn/knowledge-base/game-security/decompiling-source-code.md): Learn how attackers can decompile your game and steal your API keys.
- [5. Altering Network Traffic](https://zbd-earn-sdk-releases.mintlify.site/earn/knowledge-base/game-security/altering-network-traffic.md): Understand how hackers can alter network traffic to cheat and steal in games.
- [Making A More Secure Game](https://zbd-earn-sdk-releases.mintlify.site/earn/knowledge-base/game-security/securing-game.md): Learn how to make your game more secure by moving game logic to the server.
- [Replay/Mirror Attacks](https://zbd-earn-sdk-releases.mintlify.site/earn/knowledge-base/game-security/replay-attacks.md): Understand how hackers can replicate request to increase their score.
- [Securing data sent to the server](https://zbd-earn-sdk-releases.mintlify.site/earn/knowledge-base/game-security/securing-data.md): Stop attackers from altering data sent to the server.
- [Detecting fake devices and apps](https://zbd-earn-sdk-releases.mintlify.site/earn/knowledge-base/game-security/app-check.md): Detect if the device or app are fake
- [OAuth2 Login with ZBD in Unity](https://zbd-earn-sdk-releases.mintlify.site/earn/knowledge-base/integrations/unity.md): How to integrate Login with ZBD into a Unity app
- [ZBD Earn SDK](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk.md): Add real-money rewards to your Unity mobile game. No backend required to get started.
- [Before You Build](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/planning.md): Three decisions to make before writing any code: reward currency, delivery method, and payout options.
- [Global Support](https://zbd-earn-sdk-releases.mintlify.site/earn/coverage.md): List of regions where ZBD App & Earn SDK is supported.
- [Reward Economics](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/reward-economics.md): Lock in these decisions before writing any code. Most are tunable server-side after launch, but getting them roughly right from the start avoids significant iteration.
- [Soft Currency Model](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/soft-currency.md): Show players virtual units, not dollar amounts. This page covers how to display rewards throughout your game and why it matters.
- [Best Practices](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/best-practices.md): How to balance earn rates with withdrawal limits, handle SDK failures gracefully, and keep the player experience smooth.
- [Security](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/security.md): How ZBD protects against reward farming and fraud, and what you can do to strengthen those protections.
- [Fraud Prevention](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/fraud-prevention.md): How ZBD protects your reward economy from fraud and farming — and the controls you can tune.
- [Player Communication Guide](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/player-comms.md): What to say to players at each stage of their rewards journey — from first session through daily engagement.
- [Modal Customization](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/customization.md): Customize the colors, graphics, and copy of the in-game rewards modal to match your game.
- [Download SDK](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/download.md): Download the ZBD Earn SDK Unity package.
- [Compatibility](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/compatibility.md): SDK compatibility with Unity and mobile platforms.
- [Integrating Earn SDK](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/integration.md): How to import and initialize the ZBD Earn SDK.
- [URL Scheme](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/url-scheme.md): Handle secure user redirection back to your app after ZBD OAuth login using a custom URL scheme.
- [Attestation Set Up](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/attestation-setup.md): Configure attestation to ensure your app has not been tampered with using required information for Android and iOS.
- [Walkthrough](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/video-walkthrough.md): Video instructions for integrating the ZBD Earn SDK into your Unity project.
- [Send Rewards (Client)](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/send-rewards-client.md): Instructions for sending rewards to users directly from the client using the ZBD Earn SDK.
- [Overview](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/send-rewards-server.md): Learn how to securely send rewards from your server using the ZBD Earn API.
- [Manage via Dashboard](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/manage-via-dashboard.md): Create API keys and control reward settings from the ZBD Dashboard
- [Restrict Client-Side Reward Sending](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/restrict-client-rewards.md): Disable client-side SendReward calls by adding an API version blocklist entry to enforce server-only rewards.
- [Revenue-Based Earning](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/revenue-based-earning.md): Tie a user's earning potential to the revenue they generate for your app.
- [Send Rewards from Server](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/send-rewards-api.md): Use your API key to send rewards securely from your backend using the Earn API (v2).
- [Withdrawal Limits (Server)](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/withdrawal-limits.md): Understand how withdrawal limits work and how to increase them from your server.
- [Player Balance](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/user-balance.md): Retrieve a player's current rewards balance from your game client using the SDK.
- [Adjust Player Balance (Dashboard)](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/manage-rewards-balance.md): Manually increase or decrease a player's rewards balance from the ZBD Developer Dashboard.
- [Gift Cards](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/gift-cards.md): Retrieve the gift cards available to a player and how close they are to unlocking each one.
- [Player Withdrawal Limits](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/user-withdrawal.md): Retrieve a player's current withdrawal limit using the SDK.
- [Manage Withdrawal Limits via Dashboard](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/manage-withdrawal-limits.md): Increase or decrease user withdrawal limits via the ZBD Dashboard
- [Player Account Status](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/user-status.md): Check whether a player has linked their account and is eligible to earn and withdraw rewards.
- [Manage User Linking via Dashboard](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/manage-user-linking.md): Link or unlink users to ZBD gamertags via the ZBD Dashboard
- [Earn Controls (Dashboard)](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/manage-controls-dashboard.md): Override a player's detected country and manage your project whitelist from the ZBD Developer Dashboard.
- [Error Handling](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/error-handling.md): How to handle every failure state the ZBD Earn SDK can return, and what your game should do in each case.
- [Go-Live Checklist](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/go-live-checklist.md): Make sure you have completed these steps before going live with the ZBD Earn SDK.
- [Troubleshooting](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/troubleshoot.md): General troubleshooting guides for the ZBD Earn SDK.
- [Building](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/building.md): Comprehensive video guides for mastering Bitcoin apps and games with ZBD.
- [Apple App Store Guidelines](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/ios-app-store.md): Instructions for successfully submitting your game to the Apple App Store.
- [Google Play Store Guidelines](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/android-app-store.md): Instructions for successfully submitting your game to the Google Play Store.
- [Releases](https://zbd-earn-sdk-releases.mintlify.site/earn/sdk/releases.md): Download the ZBD Earn SDK Unity package and see what changed in each version.
- [ZBD App](https://zbd-earn-sdk-releases.mintlify.site/earn/app.md): How Bitcoin cashout works for your players, and what you need to configure as a publisher.
- [URI Schemes](https://zbd-earn-sdk-releases.mintlify.site/earn/app/uri-schemes.md): Learn about the URI schemes ZBD App subscribes to.
- [ZBD Payments](https://zbd-earn-sdk-releases.mintlify.site/payments.md): Global instant payments infrastructure for apps and games with Bitcoin, Lightning Network, and multi-currency support
- [Lightning Network](https://zbd-earn-sdk-releases.mintlify.site/payments/lightning-network.md): Instant global payments that unlock new business models impossible with traditional systems
- [Lightning Address](https://zbd-earn-sdk-releases.mintlify.site/payments/lightning-address.md): The human-readable payment protocol that transformed Bitcoin UX forever
- [Receiving Lightning Payments](https://zbd-earn-sdk-releases.mintlify.site/payments/payins/lightning-charges.md): Learn how to receive Lightning payments using the ZBD API.
- [Request Charge for ZBD Gamertag](https://zbd-earn-sdk-releases.mintlify.site/payments/payins/gamertags.md): Learn how to generate payment requests specifically for ZBD users.
- [Send Bitcoin to Lightning Address](https://zbd-earn-sdk-releases.mintlify.site/payments/payouts/lightning-address.md): Learn how to instantly send Bitcoin to any Lightning Address.
- [Send Bitcoin to ZBD Gamertag](https://zbd-earn-sdk-releases.mintlify.site/payments/payouts/gamertags.md): Learn how to instantly send Bitcoin to a ZBD user.
- [Using Withdrawal QR Codes](https://zbd-earn-sdk-releases.mintlify.site/payments/payouts/withdrawal-requests.md): Understanding the Lightning Charge Workflow Problem
- [Pay Lightning Network Charges](https://zbd-earn-sdk-releases.mintlify.site/payments/payouts/lightning-charges.md): Learn how to pay Lightning Network Charges using ZBD.
- [Global Support](https://zbd-earn-sdk-releases.mintlify.site/payments/coverage.md): List of regions where ZBD Payments APIs, SDKs, and services are supported.
- [Glossary](https://zbd-earn-sdk-releases.mintlify.site/payments/glossary.md)
- [ZBD Payments SDK](https://zbd-earn-sdk-releases.mintlify.site/payments/sdk.md): Use ZBD Payments in your preferred development environment.
- [TypeScript SDK](https://zbd-earn-sdk-releases.mintlify.site/payments/sdk/typescript.md): ZBD is your one-stop shop API for all things instant payments in TypeScript.
- [Next.js](https://zbd-earn-sdk-releases.mintlify.site/payments/sdk/typescript/next.md): Learn how to use the ZBD with Next.js and our Playground Starter Kit.
- [Node.js](https://zbd-earn-sdk-releases.mintlify.site/payments/sdk/typescript/node.md): Learn how to send and receive instant Bitcoin payments with Node.js and ZBD.
- [Express](https://zbd-earn-sdk-releases.mintlify.site/payments/sdk/typescript/express.md): Learn how to send and receive instant Bitcoin payments with Express and ZBD.
- [Sending instant Bitcoin payments on Vercel](https://zbd-earn-sdk-releases.mintlify.site/payments/sdk/typescript/vercel/send.md): Learn how to send Bitcoin using Vercel Edge Functions.
- [Receiving instant Bitcoin payments on Vercel](https://zbd-earn-sdk-releases.mintlify.site/payments/sdk/typescript/vercel/receive.md): Learn how to receive Bitcoin using Vercel Edge Functions.
- [Sending instant Bitcoin payments with Supabase](https://zbd-earn-sdk-releases.mintlify.site/payments/sdk/typescript/supabase/send.md): Learn how to send Bitcoin using Supabase Edge Functions.
- [Receiving instant Bitcoin payments with Supabase](https://zbd-earn-sdk-releases.mintlify.site/payments/sdk/typescript/supabase/receive.md): Learn how to receive Bitcoin using Supabase Edge Functions.
- [Go SDK](https://zbd-earn-sdk-releases.mintlify.site/payments/sdk/go.md): Learn how to use the Go SDK to send Bitcoin to any Email.
- [Rust SDK](https://zbd-earn-sdk-releases.mintlify.site/payments/sdk/rust.md): Learn how to send and receive instant Bitcoin payments with Rust and ZBD.
- [C# SDK](https://zbd-earn-sdk-releases.mintlify.site/payments/sdk/csharp.md): Learn how to send and receive instant Bitcoin payments with C# and ZBD.
- [Payments API Reference](https://zbd-earn-sdk-releases.mintlify.site/payments/api.md): Understand general API concepts and authentication strategies.
- [Errors](https://zbd-earn-sdk-releases.mintlify.site/payments/api/errors.md): Troubleshoot problems with API calls.
- [Callbacks](https://zbd-earn-sdk-releases.mintlify.site/payments/api/callbacks.md): Receive secure payment status updates from ZBD servers.
- [OpenAPI](https://zbd-earn-sdk-releases.mintlify.site/payments/api/resources/openapi.md): Explore the OpenAPI specification for the ZBD Payments API.
- [Lightning Address](https://zbd-earn-sdk-releases.mintlify.site/payments/api/lightning-address.md): How to send instant payments to Lightning Addresses using ZBD Payments APIs.
- [Pay to Lightning Address](https://zbd-earn-sdk-releases.mintlify.site/payments/api/lightning-address/send.md): Send instant Bitcoin payments to any Lightning Address.
- [Validate Lightning Address](https://zbd-earn-sdk-releases.mintlify.site/payments/api/lightning-address/validate.md): Verify the validity of a Lightning Address.
- [Create Charge](https://zbd-earn-sdk-releases.mintlify.site/payments/api/lightning-address/create-charge.md): Generate a payment request for a Lightning Address.
- [Overview](https://zbd-earn-sdk-releases.mintlify.site/payments/api/lightning-charges.md): How to create and manage Lightning Charges.
- [Create Charge](https://zbd-earn-sdk-releases.mintlify.site/payments/api/lightning-charges/create.md): Start receiving instant Bitcoin payments through the ZBD API.
- [Retrieve Charge](https://zbd-earn-sdk-releases.mintlify.site/payments/api/lightning-charges/retrieve.md): Retrieve all data about a single Charge.
- [Decode Charge](https://zbd-earn-sdk-releases.mintlify.site/payments/api/lightning-charges/decode.md): Understand the inner properties of a Charge QR code.
- [Create Static Charge](https://zbd-earn-sdk-releases.mintlify.site/payments/api/lightning-charges/create-static.md): Start accepting payments on Lightning with Static QR codes.
- [Get Static Charge](https://zbd-earn-sdk-releases.mintlify.site/payments/api/lightning-charges/retrieve-static.md): Retrieve all data about a single Static Charge.
- [Update Static Charge](https://zbd-earn-sdk-releases.mintlify.site/payments/api/lightning-charges/update-static.md): Change the configuration of a Static Charge QR code.
- [Lightning Payments](https://zbd-earn-sdk-releases.mintlify.site/payments/api/lightning-payments.md): How to send instant payments to Lightning Addresses using ZBD Payments APIs.
- [Send Payment](https://zbd-earn-sdk-releases.mintlify.site/payments/api/lightning-payments/send.md): Start sending instant Bitcoin payments through the ZBD API.
- [Retrieve Payment](https://zbd-earn-sdk-releases.mintlify.site/payments/api/lightning-payments/retrieve.md): Retrieve all data about a single Payment.
- [Withdrawal Requests](https://zbd-earn-sdk-releases.mintlify.site/payments/api/withdrawal-requests.md): How to create and manage Withdrawal Requests using ZBD Payments APIs.
- [Create Withdrawal Request](https://zbd-earn-sdk-releases.mintlify.site/payments/api/withdrawal-requests/create.md): Start creating Bitcoin voucher QR codes.
- [Retrieve Withdrawal Request](https://zbd-earn-sdk-releases.mintlify.site/payments/api/withdrawal-requests/retrieve.md): Retrieve all data about a single Withdrawal Request.
- [ZBD Gamertags](https://zbd-earn-sdk-releases.mintlify.site/payments/api/gamertags.md): How to send instant payments to ZBD Gamertags using ZBD Payments APIs.
- [Pay to ZBD Gamertag](https://zbd-earn-sdk-releases.mintlify.site/payments/api/gamertags/send.md): Send instant Bitcoin payments to ZBD Users.
- [Get Payment](https://zbd-earn-sdk-releases.mintlify.site/payments/api/gamertags/retrieve-payment.md): Retrieve all data about a Payment sent to ZBD User.
- [Create Charge](https://zbd-earn-sdk-releases.mintlify.site/payments/api/gamertags/create-charge.md): Generate a payment request for a ZBD User.
- [Get ID by ZBD Gamertag](https://zbd-earn-sdk-releases.mintlify.site/payments/api/gamertags/retrieve-userid.md): Retrieve Gamertag from a ZBD user ID.
- [Get Gamertag By ZBD ID](https://zbd-earn-sdk-releases.mintlify.site/payments/api/gamertags/retrieve-from-userid.md): Retrieve ZBD user ID from a Gamertag.
- [Wallet](https://zbd-earn-sdk-releases.mintlify.site/payments/api/wallet.md): How to manage your ZBD Wallet using ZBD Payments APIs.
- [Get Wallet](https://zbd-earn-sdk-releases.mintlify.site/payments/api/wallet/retrieve-balance.md): Retrieve all data about a ZBD Project's Wallet.
- [Initiate Internal Transfer](https://zbd-earn-sdk-releases.mintlify.site/payments/api/wallet/internal-transfer.md): Performs a transfer of funds between two Projects.
- [Keysend](https://zbd-earn-sdk-releases.mintlify.site/payments/api/keysend.md): How to send Keysend payments using ZBD Payments APIs.
- [Send Keysend Payment](https://zbd-earn-sdk-releases.mintlify.site/payments/api/keysend/send.md): Start sending Keysend payments on the Lightning Network.
- [Utilities](https://zbd-earn-sdk-releases.mintlify.site/payments/api/utils.md): Utility APIs for developers integrating with ZBD Payments.
- [BTC USD Price Feed](https://zbd-earn-sdk-releases.mintlify.site/payments/api/utils/btc-usd.md): Get the latest price for Bitcoin in US Dollars.
- [API Supported Regions](https://zbd-earn-sdk-releases.mintlify.site/payments/api/utils/is-supported-region.md): Verify if a user is coming from a supported region.
- [ZBD IP Address](https://zbd-earn-sdk-releases.mintlify.site/payments/api/utils/ip.md): Get the official IP addresses of ZBD servers.
- [ZBD Ramp](https://zbd-earn-sdk-releases.mintlify.site/payments/ramp.md): Enable Bitcoin purchases directly in your app with our embeddable ramp widget
- [Integration Guide](https://zbd-earn-sdk-releases.mintlify.site/payments/ramp/quickstart.md): Complete guide to integrating ZBD Ramp into your application
- [User Flow Walkthrough](https://zbd-earn-sdk-releases.mintlify.site/payments/ramp/user-flow.md): Visual walkthrough of the complete ZBD Ramp user experience
- [Frequently Asked Questions](https://zbd-earn-sdk-releases.mintlify.site/payments/ramp/faq.md): Onboard into Bitcoin with ZBD Ramp.
- [TypeScript SDK](https://zbd-earn-sdk-releases.mintlify.site/payments/ramp/sdks/typescript.md): Core TypeScript/JavaScript SDK for ZBD Ramp integration
- [React SDK](https://zbd-earn-sdk-releases.mintlify.site/payments/ramp/sdks/react.md): React wrapper for ZBD Ramp
- [React Native SDK](https://zbd-earn-sdk-releases.mintlify.site/payments/ramp/sdks/react-native.md): React Native wrapper for ZBD Ramp
- [Flutter SDK](https://zbd-earn-sdk-releases.mintlify.site/payments/ramp/sdks/flutter.md): Flutter plugin for ZBD Ramp - Enable Bitcoin purchases in your Flutter apps
- [Create Ramp Session](https://zbd-earn-sdk-releases.mintlify.site/payments/ramp/session.md): Initialize a new ramp widget session for a user
- [Platform Details](https://zbd-earn-sdk-releases.mintlify.site/payments/ramp/platform.md): Configure your platform branding and identity in ZBD Ramp
- [Themes Customization](https://zbd-earn-sdk-releases.mintlify.site/payments/ramp/themes.md): Customize every visual element of ZBD Ramp to match your brand
- [AI-Generated Themes](https://zbd-earn-sdk-releases.mintlify.site/payments/ramp/ai-themes.md): Use AI to instantly generate custom themes that match your brand
- [Webhook Events](https://zbd-earn-sdk-releases.mintlify.site/payments/ramp/webhooks.md): Complete reference for ZBD Ramp webhook events
- [Email Receipts](https://zbd-earn-sdk-releases.mintlify.site/payments/ramp/emails.md): Email notifications and receipts for ZBD Ramp transactions
- [Introduction](https://zbd-earn-sdk-releases.mintlify.site/earn/oauth2.md): Learn about the features and capabilities of ZBD Login (ZBD OAuth2 API).
- [Integrating](https://zbd-earn-sdk-releases.mintlify.site/earn/oauth2/integration.md): Learn how to integrate ZBD Login into your application.
- [Guidelines](https://zbd-earn-sdk-releases.mintlify.site/earn/oauth2/guidelines.md): Brand and technical guidelines for using ZBD Login.
- [Implementation Walkthrough](https://zbd-earn-sdk-releases.mintlify.site/earn/oauth2/walkthrough.md): Detailed walkthrough of an implementation of ZBD Login.
- [Overview](https://zbd-earn-sdk-releases.mintlify.site/earn/oauth2/api.md): Learn about the features and capabilities of ZBD Login (ZBD OAuth2 API).
- [Authorization](https://zbd-earn-sdk-releases.mintlify.site/earn/oauth2/api/authorization.md): Create an authorization URL for ZBD Login.
- [Fetch Access Token](https://zbd-earn-sdk-releases.mintlify.site/earn/oauth2/api/retrieve-access-token.md): Fetch the user's access token from ZBD Login.
- [Refresh Token](https://zbd-earn-sdk-releases.mintlify.site/earn/oauth2/api/refresh-token.md): Generate a new accessToken for a ZBD Login user.
- [Data Fetching](https://zbd-earn-sdk-releases.mintlify.site/earn/oauth2/api/data-fetching.md): Learn about the features and capabilities of ZBD Login (ZBD OAuth2 API).
- [Get User Data](https://zbd-earn-sdk-releases.mintlify.site/earn/oauth2/api/retrieve-user.md): Fetch user-related information about a logged-in ZBD User.
- [Get Wallet Data](https://zbd-earn-sdk-releases.mintlify.site/earn/oauth2/api/retrieve-wallet.md): Fetch wallet-related information about a logged-in ZBD User.
- [ZBD Widget](https://zbd-earn-sdk-releases.mintlify.site/widget.md): Embed a hosted cashout experience so your users can withdraw earned balances to bank accounts, Cash App, and more.
- [Disclosure Agreements](https://zbd-earn-sdk-releases.mintlify.site/widget/disclosures.md): Understand how widget user disclosure acceptance works before cashout.
- [Browser Events](https://zbd-earn-sdk-releases.mintlify.site/widget/browser-events.md): Reference for ZBD Widget iframe events sent to your frontend with postMessage.
- [Server Webhooks](https://zbd-earn-sdk-releases.mintlify.site/widget/webhooks.md): Reference for ZBD Widget publisher webhook events, delivery, signing, retries, and payloads.
- [Create User](https://zbd-earn-sdk-releases.mintlify.site/widget/create-user.md): Create or fetch a publisher-linked widget user.
- [Update User](https://zbd-earn-sdk-releases.mintlify.site/widget/update-user.md): Update a widget user's details.
- [Fund User](https://zbd-earn-sdk-releases.mintlify.site/widget/fund-user.md): Credit USDZ points to a widget user's point balance.
- [Get User Balance](https://zbd-earn-sdk-releases.mintlify.site/widget/get-balance.md): Retrieve a widget user's available and total reward balance.
- [Create Session](https://zbd-earn-sdk-releases.mintlify.site/widget/create-session.md): Mint a widget session and get the embeddable URL.
- [Get Disclosure Status](https://zbd-earn-sdk-releases.mintlify.site/widget/get-disclosure-status.md): Check a widget user's current disclosure acceptance status.
- [Submit Disclosure Acceptance](https://zbd-earn-sdk-releases.mintlify.site/widget/submit-disclosure-acceptance.md): Record disclosure acceptance for a widget user.
- [Get User](https://zbd-earn-sdk-releases.mintlify.site/widget/get-user.md): Retrieve a widget user's details and verification status.
- [Get User Transactions](https://zbd-earn-sdk-releases.mintlify.site/widget/get-transactions.md): Retrieve a paginated transaction history for a widget user.
- [Deplete User](https://zbd-earn-sdk-releases.mintlify.site/widget/deplete-user.md): Debit USDZ points from a widget user's point balance.
- [Sandbox](https://zbd-earn-sdk-releases.mintlify.site/widget/sandbox.md): Test the full ZBD Widget flow without real money, real KYC, or real bank transfers.