Create Static Charge
Start accepting payments on Lightning with Static QR codes.
Description
Static Charges are static Payment Requests in the Bitcoin Lightning Network. Whereas Charges 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
minAmountandmaxAmountproperties, 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.
-
Success Message -> When a payer completes the payment flow for this Static Charge, a Success Message is displayed to them.
-
Slots -> Static Charges can also have the notion of
allowedSlots. This means only N payments will be accepted at this Static Charge before disabling them.
Static Charges also have the same core properties of Charges such as internalId and callbackUrl.
Usage
Use this API endpoint to create advanced Payment Requests on the Bitcoin Lightning Network. Enjoy static QR codes that can accept any number of payments, for various amounts, with additional metadata in the payment flow.
You can create a multi-use Static Charge with a fixed amount too, simply by setting minAmount and maxAmount to the same amount.
To understand more use cases for Static Charges, check our in-depth guide.
Configuration
Header Parameters
ZBD Project API Key
Content Type
Body
Minimum allowed amount for the Static Charge -> in millisatoshis
Maximum allowed amount for the Static Charge -> in millisatoshis
Note or comment for this Static Charge (visible to payer)
Message displayed to the payer AFTER payment settles. Maximum of 144 characters.
Number of payments this Static Charge can accept
Open metadata string property
The endpoint ZBD will POST Charge updates to
Used for Custom Lightning Addresses (see guide)
Was this page helpful?