POST
/
v0
/
static-charges
curl --request POST \
  --url https://api.zebedee.io/v0/static-charges \
  --header 'Content-Type: application/json' \
  --header 'apikey: <apikey>' \
  --data '{
  "minAmount": "<string>",
  "maxAmount": "<string>",
  "description": "<string>",
  "successMessage": "<string>",
  "allowedSlots": 123,
  "internalId": "<string>",
  "callbackUrl": "<string>",
  "identifier": "<string>"
}'
{
  "message":"Successfully created Static Charge.",
  "data":{
    "id":"45c225b1-022b-4a37-98d6-5a5568f78d11",
    "unit":"msats",
    "slots":0,
    "minAmount":"10000",
    "maxAmount":"100000",
    "createdAt":"2023-03-07T20:07:06.910Z",
    "expiresAt":null,
    "internalId":"myInternalId",
    "description":"Static Charge API Ref",
    "callbackUrl":"https://my-website/zbd-callback",
    "allowedSlots":1000,
    "successMessage":"Congratulations your payment was successful!",
    "status":"active",
    "invoice":{
      "request":"lnurl1dp68gurn8ghj7ctsdyh85etzv4jx2efwd9hj7a3s9aex2ut4v4ehgttnw3shg6tr943ksctjvajhxte5x43nyv34vgcj6vpjxf3z6drpxvmj6wfcvsmz6dtpx56nvwrxxuuxgvf3uzvpfy",
      "uri":"lightning:lnurl1dp68gurn8ghj7ctsdyh85etzv4jx2efwd9hj7a3s9aex2ut4v4ehgttnw3shg6tr943ksctjvajhxte5x43nyv34vgcj6vpjxf3z6drpxvmj6wfcvsmz6dtpx56nvwrxxuuxgvf3uzvpfy"
    }
  }
}

​
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 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.

  • 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

apikey
string
required

ZBD Project API Key

Content-Type
string

Content Type

​
Body

minAmount
string
required

Minimum allowed amount for the Static Charge -> in millisatoshis

maxAmount
string
required

Maximum allowed amount for the Static Charge -> in millisatoshis

description
string
required

Note or comment for this Static Charge (visible to payer)

successMessage
string

Message displayed to the payer AFTER payment settles. Maximum of 144 characters.

allowedSlots
number

Number of payments this Static Charge can accept

internalId
string

Open metadata string property

callbackUrl
string

The endpoint ZBD will POST Charge updates to

identifier
string

Used for Custom Lightning Addresses (see guide)

Was this page helpful?

Get WalletGet Static Charge