Lightning Payments

Send Payment

Start sending instant Bitcoin payments through the ZBD API.

post/v0/payments

Request

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

Content-Typestring

Content Type

invoicestring

Lightning Network Payment Request / Charge

descriptionstring

Note or comment for this Payment

amountstring

Amount to be paid to this Charge/Invoice -> in millisatoshis (only valid if Amountless Invoice)

internalIdstring

Open metadata string property

callbackUrlstring

The endpoint ZBD will POST Payment updates to

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