Lightning API Reference

Create a Lightning invoice for receiving BTC or asset payments

post
/lightning/create-invoice
Header parameters
xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body
amount_satsnumberOptional

Amount in satoshis for BTC invoice

expiry_secondsnumberOptional

Optional invoice expiration time in seconds

Responses
chevron-right
200

Successful response

application/json
idstringRequired

Invoice request ID

invoicestringRequired

Lightning invoice string

statusstring Β· enumRequired

Invoice status

Possible values:
payment_typestring Β· enumRequired

Payment type

Possible values:
amount_satsnumberOptional

Amount in satoshis (for BTC invoices)

created_atstringRequired

Creation timestamp

post
/lightning/create-invoice

Get the status of a Lightning invoice by request ID

get
/lightning/receive-request/{request_id}
Path parameters
request_idstringRequired

The request_id parameter

Header parameters
xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Responses
chevron-right
200

Successful response

application/json
idstringRequired

Invoice request ID

invoicestringRequired

Lightning invoice string

statusstring Β· enumRequired

Invoice status

Possible values:
payment_typestring Β· enumRequired

Payment type

Possible values:
amount_satsnumberOptional

Amount in satoshis (for BTC invoices)

created_atstringRequired

Creation timestamp

get
/lightning/receive-request/{request_id}

Begin a Lightning invoice payment process

post
/lightning/pay-invoice-begin
Header parameters
xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body
invoicestringRequired

Lightning invoice to pay

max_fee_satsnumberRequired

Maximum fee in satoshis you're willing to pay

Responses
chevron-right
200

Successful response

application/json
stringOptional
post
/lightning/pay-invoice-begin

Complete a Lightning invoice payment using signed PSBT

post
/lightning/pay-invoice-end
Header parameters
xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body
signed_psbtstringRequired

Signed PSBT in base64

Responses
chevron-right
200

Successful response

application/json
idstringRequired

Send request ID

statusstring Β· enumRequired

Payment status

Possible values:
payment_typestring Β· enumRequired

Payment type

Possible values:
amount_satsnumberOptional

Amount in satoshis

fee_satsnumberOptional

Fee paid in satoshis

created_atstringRequired

Creation timestamp

post
/lightning/pay-invoice-end

Estimate the routing fee required to pay a Lightning invoice

post
/lightning/fee-estimate
Header parameters
xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body
invoicestringRequired

Lightning invoice to pay

Responses
chevron-right
200

Successful response

application/json
numberOptional
post
/lightning/fee-estimate

List Lightning payments

get
/lightning/listpayments
Header parameters
xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Responses
chevron-right
200

Successful response

application/json
get
/lightning/listpayments

Get the status of a Lightning payment by request ID

get
/lightning/send-request/{request_id}
Path parameters
request_idstringRequired

The request_id parameter

Header parameters
xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Responses
chevron-right
200

Successful response

application/json
idstringRequired

Send request ID

statusstring Β· enumRequired

Payment status

Possible values:
payment_typestring Β· enumRequired

Payment type

Possible values:
amount_satsnumberOptional

Amount in satoshis

fee_satsnumberOptional

Fee paid in satoshis

created_atstringRequired

Creation timestamp

get
/lightning/send-request/{request_id}

Get an on-chain receive address for receiving assets

get
/lightning/onchain-receive
Header parameters
xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Responses
chevron-right
200

Successful response

application/json
btc_addressstringRequired

Bitcoin address for deposit

asset_invoicestringRequired

RGB asset invoice string

expires_atstringOptional

Optional expiration timestamp

get
/lightning/onchain-receive

Get wallet balance including BTC and asset balances

get
/lightning/balance
Header parameters
xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Responses
chevron-right
200

Successful response

application/json
get
/lightning/balance

Settle balances in the wallet

post
/lightning/settle
Header parameters
xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Responses
chevron-right
200

Successful response

application/json

Settlement result object

Other propertiesanyOptional
post
/lightning/settle

Begin an on-chain send process from UTEXO

post
/lightning/onchain-send-begin
Header parameters
xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body
address_or_rgbinvoicestringRequired

Bitcoin on-chain address or RGB invoice string

amount_satsnumberOptional

Amount in satoshis to send (optional)

fee_ratenumberRequired

Fee rate used to build the Bitcoin transaction

Responses
chevron-right
200

Successful response

application/json
stringOptional
post
/lightning/onchain-send-begin

Complete an on-chain send from UTEXO using signed PSBT

post
/lightning/onchain-send-end
Header parameters
xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body
signed_psbtstringRequired

Signed PSBT in base64

Responses
chevron-right
200

Successful response

application/json
send_idstringRequired

Unique on-chain send identifier

txidstringOptional

Bitcoin transaction id (if available)

post
/lightning/onchain-send-end

Get the status of an on-chain send by send ID

get
/onchain-send/{send_id}
Path parameters
send_idstringRequired

The send_id parameter

Header parameters
xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Responses
chevron-right
200

Successful response

application/json
send_idstringRequired

On-chain send identifier

statusstringRequired

Current on-chain send status

address_or_rgbinvoicestringRequired

Bitcoin address or RGB invoice used for on-chain send

amount_sats_requestednumberOptional

Amount in satoshis that was requested

amount_sats_sentnumberOptional

Amount in satoshis that was actually sent

close_txidsstring[]Required

Array of close transaction IDs

sweep_txidstringOptional

Sweep transaction ID if available

fee_satsnumberOptional

Fee paid in satoshis

error_codestringOptional

Error code if on-chain send failed

error_messagestringOptional

Error message if on-chain send failed

retryablebooleanRequired

Whether the on-chain send can be retried

get
/onchain-send/{send_id}

List on-chain transfers for a specific asset

post
/lightning/listtransfers
Header parameters
xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body
asset_idstringRequired

Asset ID to list transfers for

Responses
chevron-right
200

Successful response

application/json
idxnumberRequired
batch_transfer_idxnumberRequired
created_atnumberRequired
updated_atnumberRequired
statusnumber Β· enumRequired

0=WAITING_COUNTERPARTY, 1=WAITING_CONFIRMATIONS, 2=SETTLED, 3=FAILED

Possible values:
amountnumberRequired
kindnumber Β· enumRequired

Transfer kind: 0=ISSUANCE, 1=RECEIVE_BLIND, 2=RECEIVE_WITNESS, 3=SEND, 4=INFLATION

Possible values:
txidstring Β· nullableOptional
recipient_idstringRequired
expirationnumberRequired
post
/lightning/listtransfers

Last updated