API Reference

Flow

Flow

Septs by steps

  1. Call the add invoice endpoint

  2. When the Webhook is called you received funds.

  3. Notify the user that own this account that he received funds.

Invoice States Table

IDNameDescripton
0OPENInvoice is waiting to be paid
1SETTLEDInvoice is settled
2CANCELInvoice is canceled/expired
3ACCEPTEDPayment has arrived at the node. Invoice needs to be manually settled for the payment to complete

📘

Accepted State

The accepted state is present in the lightning network but is not used by hub invoices.

For hub implementations only OPEN, SETTLED and CANCEL apply.