POST
/
v0
/
charges

Description

Creates a new Charge in the Bitcoin Lightning Network, payable by any Lightning-capable 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.

Usage

This API is used for receiving funds into your ZBD Project. The primary idea is to create one of these Charges anytime someone wishes to perform a payment TO you.

On a successful 200 HTTP response from the ZBD API, you should render the contents of data.invoice.uri in a QR code. This QR code can be scanned by any Bitcoin Lightning wallet.

Configuration

Header Parameters

apikey
string
required

ZBD Project API Key

Content-Type
string

Content Type

Body

amount
string
required

The amount for the Charge -> in millisatoshis

description
string
required

Note or comment for this Charge (visible to payer)

expiresIn
number

Time until Charge expiration -> in seconds

callbackUrl
string

The endpoint ZBD will POST Charge updates to

internalId
string

Open metadata string property