Lightning Charges

Create Static Charge

Start accepting payments on Lightning with Static QR codes.

post/v0/static-charges

Request

The document declares no server URL.
Auth
API key in header apikey
TypeScript
https://skmtc.dev/zbdpay/apis/zbd-payments-api/docs/v0/static-charges/post.ts
A function with typed inputs. Its response is checked against the schema.

Content-Typestring

Content Type

minAmountstring

Minimum allowed amount for the Static Charge -> in millisatoshis

maxAmountstring

Maximum allowed amount for the Static Charge -> in millisatoshis

descriptionstring

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

successMessagestring

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

allowedSlotsnumber

Number of payments this Static Charge can accept

internalIdstring

Open metadata string property

callbackUrlstring

The endpoint ZBD will POST Charge updates to

identifierstring

Used for Custom Lightning Addresses (see guide)

Successful response

Apr 18, 2025b749c336df59 Revision changes
- warning
  deleted the header request parameter apikey
- info
  the endpoint scheme security apikeyAuth was added to the API
Apr 18, 2025028610bc46ff Revision changes
- breaking
  the header request parameter apikey became required