Skip to main content
GET
Get send status

Authorizations

Authorization
string
header
required

Base64url-encoded auth token

Path Parameters

identifier
string
required

Payment hash or invoice string to search for

Response

Returns the Lightning send status

payment_hash
string
required

The payment hash of the outgoing lightning payment

state
string
required

Lifecycle phase of the send: unknown, start, htlc-received, payment-initiated, revocable-htlcs, revocation-stuck, or paid.

invoice
string | null

The invoice string, if known.

preimage
string | null

The payment preimage, revealed once the payment succeeded.