Get receive status
Returns the status of a specified Lightning receive, identified by its payment hash, invoice string, or preimage. The response tracks progress through timestamps: htlc_vtxos is populated once HTLCs are created by the Ark server, preimage_revealed_at records when the preimage was sent, and finished_at indicates the receive has settled or been canceled.
Authorizations
Base64url-encoded auth token
Path Parameters
Payment hash, invoice string or preimage to search for
Response
Returns the Lightning receive status
The amount of the lightning receive, if known.
x >= 0IDs of the HTLC-recv VTXOs granted by the server, if any.
Empty until the inbound HTLC has been received and prepared.
The HTLC VTXOs granted by the server for the lightning receive.
The invoice string, if known.
The payment hash linked to the lightning receive
Lifecycle phase of the receive: awaiting-payment, htlcs-ready,
preimage-revealed, delivering, or settled.
The timestamp at which the lightning receive was finished.
The payment preimage, if known.
The timestamp at which the preimage was revealed.
The timestamp at which the receive settled, if it has.