Payments
Make payments through bolt11 or keysend.
BOLT11 payment
Scope needed: payments:send
Pay a lightning invoice (bolt11)
POST
https://api.getalby.com/payments/bolt11
Pay a bolt11 invoice.
Request Body
Name | Type | Description |
---|---|---|
invoice* | string | invoice to be paid |
Keysend payment
Scope needed: payments:send
Send a "spontaneous" payment (keysend). Used for push realtime/streaming push payments
Keysend payment
POST
https://api.getalby.com/payments/keysend
Make a spontaneous keysend payment, with optional custom records. See for example: https://github.com/lightning/blips/blob/master/blip-0010.md
Request Body
Name | Type | Description |
---|---|---|
amount* | int64 | Amount in satoshi. Must be a whole number greater than 0. (millisats are not supported) |
destination* | string | Destination hex-string pubkey (a string starting with 02 or 03) |
memo | string | Internal memo |
custom_records | map[string]string | map with custom records. See https://www.webln.guide/building-lightning-apps/webln-reference/webln.keysend |
Multi keysend payment
Scope needed: `payments:send` Send multiple spontaneous keysend payments. Useful for doing value4value splits. Request and response are an array of the single keysend payment request and response.
Make multiple keysend payments in 1 request
POST
https://api.getalby.com/payments/keysend/multi
Each of the payments can fail or succeed seperately.
Request Body
Name | Type | Description |
---|---|---|
keysends* | Array | Array of keysend objects as described in the body parameters of the section above. |
Last updated