Installation

Quickstart

ZBD is your one-stop shop API for all things instant payments in TypeScript.

TypeScript SDK

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.

ZBD Documentation

Global Payment Service Provider for Gaming and Interactive Entertainment

Overview

ZBD is the global Bitcoin payments API for developers.

Introduction

Learn how to send and receive instant Bitcoin payments with Node.js and ZBD.

Learn how to use the ZBD with Next.js and our Playground Starter Kit.

Next.js

Learn how to send and receive instant Bitcoin payments with Express and ZBD.

Express

Learn how to send and receive instant Bitcoin payments with Rust and ZBD.

Learn how to send and receive instant Bitcoin payments with Go and ZBD.

Learn how to send and receive instant Bitcoin payments with C# and ZBD.

Learn how to use ZBD API using HTTP calls.

1 API away from adding Bitcoin to the fabric of your games, apps, and systems.

Instant Bitcoin Payments with Replit and ZBD API

ZBD API

Learn about the robust ZBD Dev Dashboard and its functionalities.

Learn about ZBD Vouchers and how to best leverage this feature.

Vouchers

Learn about the features and capabilities of ZBD Login (ZBD OAuth2 API).

Learn how to integrate ZBD Login into your application.

Integrating

Brand and technical guidelines for using ZBD Login.

Guidelines

Detailed walkthrough of an implementation of ZBD Login.

Walkthrough

Implementation Walkthrough

Learn about more advanced information about ZBD Login.

Advanced

Advanced OAuth2

Download

Download ZBD

Learn about the URI schemes ZBD App subscribes to.

URI Schemes

NBD (ZBD Open Source)

Explore the OpenAPI specification for the ZBD API.

OpenAPI

Explore sample apps for different use cases.

Examples

Open source client libraries for your favorite platforms.

SDKs

Integrate ZBD with the tools you already use.

Integrations

List of global regions where ZBD apps and services are supported.

Global Support

Collection of developer guides and tutorials leveraging ZBD API.

Learn how to instantly send Bitcoin to any Lightning Address.

Send Bitcoin to Lightning Address

Learn how to instantly send Bitcoin to a ZBD user.

Send Bitcoin to ZBD Gamertag

Learn how to instantly send Bitcoin to any Email.

Send Bitcoin to Email

Understanding the Lightning Charge Workflow Problem

Using Withdrawal QR Codes

Learn how to pay Lightning Network Charges using ZBD.

Pay Lightning Network Charges

Learn how to receive Lightning payments using the ZBD API.

Receiving Lightning Payments

Learn how to generate payment requests specifically for ZBD users.

Request Charge for ZBD Gamertag

Learn how to boost player engagement with Bitcoin rewards through ZBD.

Bitcoin Rewards in Game

Add Bitcoin Rewards to your Game

Learn how to set up a paid Nostr relay with ZBD.

Nostr Relay Quick Start

Learn about the Lightning Address protocol and some use cases (andre@zbd.gg).

The Lightning Address

Learn how to use Static Charges and common use cases.

Static Charge QR Codes

Learn how to create custom Lightning Addresses with ZBD API

Custom Lightning Addresses

Creating custom Lightning Addresses with ZBD

Pay to Lightning Address

Building a `Pay to Lightning Address` App

Glossary

Learn how the Lightning Network revolutionizes global payments.

Lightning Network

Bitcoin Lightning Network

Comprehensive video guides for mastering Bitcoin apps and games with ZBD.

Learn the ins and outs of the Bitcoin Lightning Network.

Lightning 101

Lightning Network 101

Learn how to handle Lightning payment orchestration on Web.

LNURL 101

Learn about all the tools ZBD has to make your development experience great.

ZBD API Workshop

Learn how to build a simple Lightning paywall app with ZBD.

Building a Lightning App

Understand common UI and UX patterns for Lightning-enabled apps.

Common UI Patterns

Lightning App UX Patterns

How to design apps and lightning network user experiences.

Designing Lightning Apps

Understanding the reasons, benefits and best practices behind implementing real-money player rewards into games.

Introduction to Rewarded Play

From setting up your account, to using our APIs in a secure way and massively engaging your users with Bitcoin rewards!

Integration Player Rewards

Integrating Player Rewards in a Game

How to integrate ZBD into your Beamable project.

Beamable Integration

A series of helpful video tutorials to help you get started with bitcoin game development

Game Dev: Getting Started

Getting Started with Bitcoin Game Dev

ZBD's Head of R&D and Game Security Christian Moss introduces us to the series.

Coding a purposefully insecure game with ZBD.

1. Insecure Game

1. An Insecure Game

Understand the risks of storing sensitive data in local storage.

2. Hacking Saved Game Data

Learn how attackers may modify game data through memory injection.

3. Hacking Memory Values

Learn how attackers can decompile your game and steal your API keys.

4. Decompiling Source Code

Understand how hackers can alter network traffic to cheat and steal in games.

5. Altering Network Traffic

Learn how to make your game more secure by moving game logic to the server.

6. Improving Game Security

Making A More Secure Game

Understand how hackers can replicate request to increase their score.

7. Replay/Mirror Attacks

Replay/Mirror Attacks

Stop attackers from altering data sent to the server.

8. Securing server requests

Securing data sent to the server

9. Fake devices and apps

Detecting fake devices and apps

How to integrate Login with ZBD into a Unity app

Login with ZBD: Unity

OAuth2 Login with ZBD in Unity

Learn about the NOSTR protocol and how to build Nostr apps.

Nostr 101

Nostr Crash Course

Learn how to setup your own paid Nostr Relay with Bitcoin.

Paid Nostr Relay

Setup Paid Nostr Relay with ZBD

Understand general API concepts and authentication strategies.

Errors

Receive secure payment status updates from ZBD servers.

Callbacks

Learn about common use tools for developers integrating ZBD.

Resources

Send instant Bitcoin payments to ZBD Users.

Pay to ZBD Gamertag

Retrieve all data about a Payment sent to ZBD User.

Get Payment

Generate a payment request for a ZBD User.

Create Charge

Get ID by ZBD Gamertag

Get Gamertag By ZBD ID

Send instant Bitcoin payments to any Lightning Address.

Verify the validity of a Lightning Address.

Validate Lightning Address

Generate a payment request for a Lightning Address.

Send instant Bitcoin payments to any email.

Pay to Email

Start sending instant Bitcoin payments through the ZBD API.

Send Payment

Retrieve all data about a single Payment.

Start receiving instant Bitcoin payments through the ZBD API.

Get Charge

Understand the inner properties of a Charge QR code.

Decode Charge

Create Withdrawal Request

Retrieve all data about a single Withdrawal Request.

Get Withdrawal Request

Create Voucher

Get Voucher

Redeem Voucher

Revoke Voucher

Retrieve all data about a ZBD Project's Wallet.

Get Wallet

Start accepting payments on Lightning with Static QR codes.

Create Static Charge

Retrieve all data about a single Static Charge.

Get Static Charge

Change the configuration of a Static Charge QR code.

Update Static Charge

Start sending Keysend payments on the Lightning Network.

Send Keysend Payment

Get the latest price for Bitcoin in US Dollars.

BTC USD Price Feed

Verify if a user is coming from a supported region.

API Supported Regions

Get the official IP addresses of ZBD servers.

ZBD IP Address

Performs a transfer of funds between two Projects.

Initiate Internal Transfer

Start sending test Bitcoin payments to ZBD Gamertags.

Create an authorization URL for ZBD Login.

Authorization

Fetch the user's access token from ZBD Login.

Fetch Access Token

Generate a new accessToken for a ZBD Login user.

Refresh Token

Fetch user-related information about a logged-in ZBD User.

Overview

TypeScript

Go

Rust

C#

TypeScript SDK

Installation

Quickstart

Next.js ZBD Playground Starter

Node.js Quick Start

Express.js Quick Start

Send/Receive Bitcoin on Vercel

Send/Receive Bitcoin with Supabase

Overview

TypeScript

Go

Rust

C#

​Installation

​Quickstart

Next.js ZBD Playground Starter

Node.js Quick Start

Express.js Quick Start

Send/Receive Bitcoin on Vercel

Send/Receive Bitcoin with Supabase

Installation

Quickstart