Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions api-reference/charges/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ api: "POST https://api.zebedee.io/v0/charges"

## Description

Creates a new [Charge](/docs/glossary#charge) / Payment Request in the Bitcoin Lightning Network, payable by any Lightning Network wallet.
Creates a new [Charge](/knowledge-base/glossary#charge) / Payment Request in the Bitcoin Lightning Network, payable by any Lightning Network wallet.

These payment requests are single-use, fixed-amount QR codes. If you're looking for multi-use and multi-amount payment requests you want [Static Charges](/api/static-charges/create/).
These payment requests are single-use, fixed-amount QR codes. If you're looking for multi-use and multi-amount payment requests you want [Static Charges](/api-reference/static-charges/create).

## Usage

Expand Down
2 changes: 1 addition & 1 deletion api-reference/charges/decode.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ api: "POST https://api.zebedee.io/v0/decode-invoice"

## Description

Decodes the inner properties of a given [Charge](/docs/glossary#charge) / Payment Request / Lightning Network invoice.
Decodes the inner properties of a given [Charge](/knowledge-base/glossary#charge) / Payment Request / Lightning Network invoice.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion api-reference/charges/get.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ api: "GET https://api.zebedee.io/v0/charges/{CHARGE_ID}"

## Description

Retrieves all information relating a specific [Charge](/docs/glossary#charge) / Payment Request.
Retrieves all information relating a specific [Charge](/knowledge-base/glossary#charge) / Payment Request.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion api-reference/gamertag/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ api: "POST https://api.zebedee.io/v0/gamertag/charges"

## Description

While you can use the [Send Payment to ZBD Gamertag](/api/gamertag/send) endpoint to make a direct Bitcoin payment to a given ZBD user, if for whatever reason you'd want to create a general Lightning Network Charge / Payment Request QR code, you can use this endpoint.
While you can use the [Send Payment to ZBD Gamertag](/api-reference/gamertag/send) endpoint to make a direct Bitcoin payment to a given ZBD user, if for whatever reason you'd want to create a general Lightning Network Charge / Payment Request QR code, you can use this endpoint.

## Usage

Expand Down
4 changes: 2 additions & 2 deletions api-reference/gamertag/get-gamertag.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ api: "GET https://api.zebedee.io/v0/gamertag/user-id/{USER_ID}"

## Description

This API endpoint is the reverse of the [Get User ID for ZBD Gamertag](/api/gamertag/get-user-id) endpoint. Use this endpoint to get a given user's ZBD Gamertag.
This API endpoint is the reverse of the [Get User ID for ZBD Gamertag](/api-reference/gamertag/get-user-id) endpoint. Use this endpoint to get a given user's ZBD Gamertag.

## Usage

If you've got a User ID and you wish to find out that user's ZBD Gamertag, perhaps to then [send that user payments](/api/gamertag/send), you may use this endpoint.
If you've got a User ID and you wish to find out that user's ZBD Gamertag, perhaps to then [send that user payments](/api-reference/gamertag/send), you may use this endpoint.

## Configuration

Expand Down
2 changes: 1 addition & 1 deletion api-reference/gamertag/get.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ In order to get data on payments sent to ZBD Gamertags, you can use this endpoin

## Usage

The idea here is to use the `transactionId` property returned from the [Send Payment to ZBD Gamertags](/api/gamertag/send) response, and use that ID to fetch the latest details of the given Payment.
The idea here is to use the `transactionId` property returned from the [Send Payment to ZBD Gamertags](/api-reference/gamertag/send) response, and use that ID to fetch the latest details of the given Payment.

## Configuration

Expand Down
2 changes: 1 addition & 1 deletion api-reference/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ ZBD offers a powerful REST API that supports Bitcoin Lightning Network nanotrans

## Guides & Walkthroughs

For detailed documentation, walkthroughs, and guides about how to best use the ZBD API head over to our [Documentation Portal](/docs/quick-start).
For detailed documentation, walkthroughs, and guides about how to best use the ZBD API head over to our [Documentation Portal](/docs/overview).

## Resources

Expand Down
2 changes: 1 addition & 1 deletion api-reference/keysend/send.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ api: "POST https://api.zebedee.io/v0/keysend-payment"

## Description

Every Lightning Network node has a Public Key identifying it to the wider network. While most payments in the Lightning Network require Payment Requests ([Charges](/docs/glossary#charges)) QR codes to be created and then paid for, there is another type of payment known as `Spontaneous Payment` or `Keysend Payment` on a more technical note.
Every Lightning Network node has a Public Key identifying it to the wider network. While most payments in the Lightning Network require Payment Requests ([Charges](/knowledge-base/glossary#charges)) QR codes to be created and then paid for, there is another type of payment known as `Spontaneous Payment` or `Keysend Payment` on a more technical note.

This endpoint exposes the ability to make payment directly to a Lightning Network node Public Key, without the need for a Payment Request / Charge.

Expand Down
4 changes: 2 additions & 2 deletions api-reference/lightning-address/send.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ Send Bitcoin payments directly to a Lightning Address.

A Lightning Address is an internet identifier (akin to an email address -- `andre@zbd.gg`) that anyone can send Bitcoin Lightning Network payments to. Leverage this API to programmatically perform these payments.

To learn more about Lightning Address, check out our [Glossary](/docs/glossary) or [lightningaddress.com](lightningaddress.com).
To learn more about Lightning Address, check out our [Glossary](/knowledge-base/glossary) or [lightningaddress.com](https://lightningaddress.com).

## Usage

As the creator of the Lightning Address open source standard, we believe this API to be the single most frictionless way of using Bitcoin today.

To learn about the many ways in which a Lightning Address could make sense for your application, game, or platform, [check out this in-depth guide on Lightning Addresses](/docs/guides/custom-lightning-address-app).
To learn about the many ways in which a Lightning Address could make sense for your application, game, or platform, [check out this in-depth guide on Lightning Addresses](/knowledge-base/guides/custom-lightning-address-app).

## Configuration

Expand Down
2 changes: 1 addition & 1 deletion api-reference/lightning-address/validate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Not all internet identifiers are Lightning Addresses / compatible with the Light

## Usage

The idea behind this API endpoint is to verify whether an internet-indentifier (e.g. `user@domain.com`) is in fact a Lightning Address and NOT an email address. Once verified, use the [Send Lightning Address Payment](/api/lightning-address/send) to perform the transaction.
The idea behind this API endpoint is to verify whether an internet-indentifier (e.g. `user@domain.com`) is in fact a Lightning Address and NOT an email address. Once verified, use the [Send Lightning Address Payment](/api-reference/lightning-address/send) to perform the transaction.

## Configuration

Expand Down
2 changes: 1 addition & 1 deletion api-reference/payments/send.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ api: "POST https://api.zebedee.io/v0/payments"

## Description

Pays a [Charge](/docs/glossary#charge) / Payment Request in the Bitcoin Lightning Network. This is one of the main APIs which allow you to pay any Lightning Network request.
Pays a [Charge](/knowledge-base/glossary#charge) / Payment Request in the Bitcoin Lightning Network. This is one of the main APIs which allow you to pay any Lightning Network request.

<Tip>The words `Charge`, `Payment Request`, and `Invoice` can be seen as equivalent in the context of requesting funds in Lightning Network.</Tip>

Expand Down
4 changes: 2 additions & 2 deletions api-reference/static-charges/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ api: "POST https://api.zebedee.io/v0/static-charges"

## Description

Static Charges are static Payment Requests in the Bitcoin Lightning Network. Whereas [Charges](/api/charges/create) create fixed-amount and single-use Payment Requests that expire, Static Charges provide you a lot more flexibility & capabilities, including:
Static Charges are static Payment Requests in the Bitcoin Lightning Network. Whereas [Charges](/api-reference/charges/create) create fixed-amount and single-use Payment Requests that expire, Static Charges provide you a lot more flexibility & capabilities, including:

- **Variable Amounts** -> Static Charges have both `minAmount` and `maxAmount` properties, allowing for variable amounts set by the payer.

Expand All @@ -25,7 +25,7 @@ Use this API endpoint to create advanced Payment Requests on the Bitcoin Lightni
You can create a `multi-use` Static Charge with a fixed amount too, simply by setting `minAmount` and `maxAmount` to the same amount.
</Tip>

To understand more use cases for Static Charges, [check our in-depth guide](/docs/static-charge).
To understand more use cases for Static Charges, [check our in-depth guide](/knowledge-base/guides/static-charges).

## Configuration

Expand Down
2 changes: 1 addition & 1 deletion api-reference/static-charges/get.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ api: "GET https://api.zebedee.io/v0/static-charges/{STATIC_CHARGE_ID}"

## Description

Retrieves all information relating to a specific [Static Charge](/docs/static-charge).
Retrieves all information relating to a specific [Static Charge](/knowledge-base/guides/static-charges).

## Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/dashboard/projects/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: 'Create Project'
---

Projects are the gateway into using the [ZBD API](/docs/zebedee-api/overview). Each project comes with a unique API key and a Bitcoin Lightning wallet. With this API key, you can receive funds, make payments, and withdraw Bitcoin — the API makes it possible to handle everything programmatically.
Projects are the gateway into using the [ZBD API](/knowledge-base/zebedee-api/overview). Each project comes with a unique API key and a Bitcoin Lightning wallet. With this API key, you can receive funds, make payments, and withdraw Bitcoin — the API makes it possible to handle everything programmatically.

1. If you're not already there, navigate to the `Projects` page in the sidebar menu, or use the keyboard shortcut `a + g`.

Expand Down
8 changes: 4 additions & 4 deletions docs/dashboard/projects/sandbox.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ You may top up as many times as you'd like.</Note>

As is expected, Sandbox Projects have their own Sandbox APIs and API Keys. These APIs are identical to the Live APIs, except that they are not connected to mainnet Bitcoin Lightning Network. This means that you can test your integration without having to spend real money.

You can view all Sandbox APIs by heading over to the [Sandbox API Reference page](/api/sandbox/gamertag/send-payment).
You can view all Sandbox APIs by heading over to the [Sandbox API Reference page](/api-reference/gamertag/send-gamertag).

<Note>At the moment we have exposed the [**Send Bitcoin to ZBD Gamertag Sandbox API**](/api/sandbox/gamertag/send-payment) for testing purposes. We will be adding more Sandbox APIs in the future, including the ability to create Sandbox Charges and Static Charges, as well as send Sandbox Payments.
<Note>At the moment we have exposed the [**Send Bitcoin to ZBD Gamertag Sandbox API**](/api-reference/gamertag/send-gamertag) for testing purposes. We will be adding more Sandbox APIs in the future, including the ability to create Sandbox Charges and Static Charges, as well as send Sandbox Payments.
**If you're looking to leverage any of the other ZBD Payment APIs, go through the Identity Verification Process and swap to a Live Project.**</Note>

## Sending Bitcoin to a Sandbox ZBD Gamertag[​](#sending-bitcoin-to-a-sandbox-zbd-gamertag "Direct link to heading")
Expand All @@ -60,7 +60,7 @@ First of, start by copying the `Sandbox API Key` from your Project's _API tab_.
</Frame>
<br />

Now that we have our Sandbox API Key, let's use the [**Send Bitcoin to ZBD Gamertag Sandbox API**](/api/sandbox/gamertag/send-payment) to send some _fake satoshis_ to our Sandbox Test User.
Now that we have our Sandbox API Key, let's use the [**Send Bitcoin to ZBD Gamertag Sandbox API**](/api-reference/gamertag/send-gamertag) to send some _fake satoshis_ to our Sandbox Test User.

You may write your own HTTP client to do this test, but the simplest way is to use the _API Playground Module_ available in the [ZBD API Reference](https://docs.zbd.dev/api). On every API Reference page you will find a _ZBD API Playground Module_ on the right-hand side that you can use to directly test an API endpoint by providing it an API Key and a payload (if necessary).

Expand Down Expand Up @@ -94,7 +94,7 @@ Click on the transaction to view the transaction details for more information ar

<Note>To confirm that the _fake satoshis_ were indeed sent to the right Test User, head on over to the Test Users tab in your Project.</Note>

### You have just used the [**Send Bitcoin to ZBD Gamertag Sandbox API**](/api/sandbox/gamertag/send-payment) to send _fake satoshis_ to your Sandbox Test User.[​](#you-have-just-used-the-send-bitcoin-to-zbd-gamertag-sandbox-api-to-send-fake-satoshis-to-your-sandbox-test-user "Direct link to heading")
### You have just used the [**Send Bitcoin to ZBD Gamertag Sandbox API**](/api-reference/gamertag/send-gamertag) to send _fake satoshis_ to your Sandbox Test User.[​](#you-have-just-used-the-send-bitcoin-to-zbd-gamertag-sandbox-api-to-send-fake-satoshis-to-your-sandbox-test-user "Direct link to heading")

### Congratulations![​](#congratulations "Direct link to heading")

Expand Down
10 changes: 5 additions & 5 deletions docs/quick-start.mdx → docs/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Quick Start'
title: 'Overview'
---

<Frame type="glass" caption="">
Expand All @@ -15,16 +15,16 @@ We are thrilled you've chosen to leverage ZBD API to introduce next-gen payments

# What is ZBD?

ZBD is a global fintech focused on developing payments solutions on top of Bitcoin's [Lightning Network](/docs/lightning-network) rails. Our technology stack is vast and supports all kinds of applications: Game Developers, Fintechs, Social Platforms, and AdTechs.
ZBD is a global fintech focused on developing payments solutions on top of Bitcoin's [Lightning Network](/knowledge-base/lightning-network) rails. Our technology stack is vast and supports all kinds of applications: Game Developers, Fintechs, Social Platforms, and AdTechs.

Our Lightning Network-powered infrastructure enables secure and instant Bitcoin transactions, and allows for frictionless payments of any size at extremely low fees. We remove the compliance, regulatory, and technical lift associated with incorporating modern global payment infrastructure into the fabric of any digital experience.

# Getting Started

Know what you want to build? [Sign up today for a ZBD Dev Dashboard account](https://dashboard.zebedee.io/signup) and get access to an API Key to get started with payments on the [ZBD API](/docs/zebedee-api/overview).
Know what you want to build? [Sign up today for a ZBD Dev Dashboard account](https://dashboard.zebedee.io/signup) and get access to an API Key to get started with payments on the [ZBD API](/knowledge-base/zebedee-api/overview).

You can use the REST API directly, or through one of the supported [Software Development Kits (SDK)](/docs/zebedee-api/sdks). Follow the detailed [ZBD Dev Dashboard product walkthrough](/docs/dashboard/signup) to set up your account and to understand the many parts of the ZBD product suite.
You can use the REST API directly, or through one of the supported [Software Development Kits (SDK)](/knowledge-base/zebedee-api/sdks). Follow the detailed [ZBD Dev Dashboard product walkthrough](/docs/dashboard/signup) to set up your account and to understand the many parts of the ZBD product suite.

New to Bitcoin or Lightning Network? [Learn more with our in-depth guides](/docs/lightning-network).
New to Bitcoin or Lightning Network? [Learn more with our in-depth guides](/knowledge-base/lightning-network).

<Tip>Want to earn some Bitcoin to get started? Download the [ZBD App](https://zbd.gg) and play games, participate in events, or listen to podcasts for Bitcoin rewards!</Tip>
2 changes: 1 addition & 1 deletion docs/zbd-shield/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### What does ZBD Shield do?[​](#what-does-zbd-shield-do "Direct link to heading")

ZBD Shield helps protect you from malicious and/or fraudulent activity by acting as a middleman between your project and the [ZBD API](/docs/zebedee-api/overview). The product helps you take action against bad actors by preventing transactions on entities (ZBD Gamertags, IPs, ISPs, and Device IDs).
ZBD Shield helps protect you from malicious and/or fraudulent activity by acting as a middleman between your project and the [ZBD API](/knowledge-base/zebedee-api/overview). The product helps you take action against bad actors by preventing transactions on entities (ZBD Gamertags, IPs, ISPs, and Device IDs).

### What does it mean to "ban" or "allow" an entity?[​](#what-does-it-mean-to-ban-or-allow-an-entity "Direct link to heading")

Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: 'Static Charges'

# Static Charges

Static Charges are a type of Payment Request QR code in the Bitcoin Lightning Network that has some incredible characteristics and capabiltiies. Whereas [Charges](/api/charges/create) create `fixed-amount` and `single-use` Payment Requests that expire, [Static Charges](/api-reference/static-charges/create) provide you a lot more flexibility & capabilities, including:
Static Charges are a type of Payment Request QR code in the Bitcoin Lightning Network that has some incredible characteristics and capabiltiies. Whereas [Charges](/api-reference/charges/create) create `fixed-amount` and `single-use` Payment Requests that expire, [Static Charges](/api-reference/static-charges/create) provide you a lot more flexibility & capabilities, including:

* **Variable Amounts** -> Static Charges have both `minAmount` and `maxAmount` properties, allowing for variable amounts set by the payer.
* **Multi-use** -> By default Static Charges have no expiration time, making them usable for any N payers/payments.
Expand Down Expand Up @@ -53,7 +53,7 @@ Please check out [ZBD Streamer](https://streamer.zebedee.io) to view this live i

### User Tips / Zaps / User-to-User Payments[​](#user-tips--zaps--user-to-user-payments "Direct link to heading")

Static Charges are great for tips or commonly referred to as “zaps”. It can also be used for user-to-user payments, since they are a static QR code. Though the best user experience for these use cases is a [Lightning Address](/api/lightning-address/send-payment).
Static Charges are great for tips or commonly referred to as “zaps”. It can also be used for user-to-user payments, since they are a static QR code. Though the best user experience for these use cases is a [Lightning Address](/api-reference/lightning-address/send).

### Deposits[​](#deposits "Direct link to heading")

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ In order to receive Bitcoin through the Lightning Network using the ZBD API, you
| **callbackUrl** | _String_ | The URL ZBD API will make a POST HTTP request to with information about the Charges's status updates. |
| **expiresIn** | _Number_ | The desired expiration time for this Charge (in seconds). |

To create a Charge, use the [`/charges`](/api/charges/create) API (or leverage one of our SDKs) by passing the correct attributes:
To create a Charge, use the [`/charges`](/api-reference/charges/create) API (or leverage one of our SDKs) by passing the correct attributes:

<CodeGroup>

Expand Down
Loading