PHOENIXD API

Full reference: https://nodana.io/api-ref
Phoenixd reference version: 0.9.2

PHOENIXD

Example base URL: https://node-a1b2.nodana.app
Replace this dummy URL with your node connection URL.
Use HTTPS for remote nodes. The local daemon defaults to http://127.0.0.1:9740.
HTTP Basic authentication: empty username, PHOENIXD_PASSWORD as password.
Use the limited password for reads and invoices; each endpoint page lists access.
Keep credentials in backend secret storage. JavaScript examples use Node.js.
POST parameters are form encoded, except export filters which are query parameters.
Amounts named *Sat use satoshis; history fees use millisatoshis.
History filters and payment timestamps use Unix milliseconds.

POST /createinvoice
  Create BOLT11 invoice. See https://nodana.io/api-ref/payments/create-bolt11-invoice
POST /createoffer
  Create BOLT12 offer. See https://nodana.io/api-ref/payments/create-bolt12-offer
GET /getlnaddress
  Get Lightning address. See https://nodana.io/api-ref/payments/get-lightning-address
GET /getswapinaddress
  Get swap-in address. See https://nodana.io/api-ref/payments/get-swap-in-address
POST /payinvoice
  Pay BOLT11 invoice. See https://nodana.io/api-ref/payments/pay-bolt11-invoice
POST /payoffer
  Pay BOLT12 offer. See https://nodana.io/api-ref/payments/pay-bolt12-offer
POST /paylnaddress
  Pay Lightning address. See https://nodana.io/api-ref/payments/pay-lightning-address
POST /sendtoaddress
  Pay on-chain. See https://nodana.io/api-ref/payments/pay-on-chain
POST /bumpfee
  Bump fee. See https://nodana.io/api-ref/payments/bump-fee
GET /payments/incoming
  List incoming payments. See https://nodana.io/api-ref/payments/list-incoming-payments
GET /payments/incoming/{paymentHash}
  Get incoming payment. See https://nodana.io/api-ref/payments/get-incoming-payment
GET /payments/outgoing
  List outgoing payments. See https://nodana.io/api-ref/payments/list-outgoing-payments
GET /payments/outgoing/{paymentId}

GET /payments/outgoingbyhash/{paymentHash}
  Get outgoing payment. See https://nodana.io/api-ref/payments/get-outgoing-payment
POST /export
  CSV export. See https://nodana.io/api-ref/payments/csv-export
GET /getinfo
  Get node info. See https://nodana.io/api-ref/node/get-node-info
GET /getbalance
  Get balance. See https://nodana.io/api-ref/node/get-balance
GET /listchannels
  List channels. See https://nodana.io/api-ref/node/list-channels
POST /closechannel
  Close channel. See https://nodana.io/api-ref/node/close-channel
POST /decodeinvoice
  Decode invoice. See https://nodana.io/api-ref/node/decode-invoice
POST /decodeoffer
  Decode offer. See https://nodana.io/api-ref/node/decode-offer
GET /estimateliquidityfees
  Estimate liquidity fees. See https://nodana.io/api-ref/node/estimate-liquidity-fees
POST /lnurlpay
  LNURL Pay. See https://nodana.io/api-ref/lnurl/lnurl-pay
POST /lnurlwithdraw
  LNURL Withdraw. See https://nodana.io/api-ref/lnurl/lnurl-withdraw
POST /lnurlauth
  LNURL Auth. See https://nodana.io/api-ref/lnurl/lnurl-auth

Invoice creation returns serialized and paymentHash. externalId associates invoices
with orders; it does not deduplicate creation. Incoming lists use limit and offset.
Confirm isPaid and receivedSat before fulfilment. Payment attempts can return
payment_failed with HTTP 200. Reconcile interrupted outgoing payments by hash or ID.
CSV exports return a path on the node filesystem, not a file download.

Protected Nodana-host attestation: https://nodana.io/api-ref/attestation

NOTIFICATIONS

WS /websocket: https://nodana.io/api-ref/websocket
Nodana-managed webhook receivers: https://nodana.io/api-ref/webhooks

Authentication: https://nodana.io/api-ref/authentication
Errors: https://nodana.io/api-ref/errors