home | help 
LIGHTNING-NOTIFI...-SENDPAY_FAILURE(7)	  LIGHTNING-NOTIFI...-SENDPAY_FAILURE(7)

NAME
     sendpay_failure -- Notification for failed sendpay completion

DESCRIPTION
     The  sendpay_failure  notification  informs whenever a payment attempt com-
     pletes with failed status.

NOTIFICATION PAYLOAD
     *	code (integer): The JSON-RPC error code for the payment failure.
     *	message (string): The human-readable payment failure message.
     *	data (object): The structured payment failure details.:
	*  created_index (u64, optional): 1-based index  indicating  order  this
	   payment was created in. (added v23.11)
	*  id (u64, optional): Old synonym for created_index.
	*  payment_hash (hash, optional): The hash of the payment preimage.
	*  groupid  (u64,  optional):  Grouping key for multiple attempts on the
	   same payment.
	*  updated_index (u64, optional): 1-based index  indicating  order  this
	   payment was updated in. (added v23.11)
	*  partid (u64, optional): Part number for a multi-part payment.
	*  destination (pubkey, optional): The final destination of the payment,
	   if known.
	*  amount_msat	(msat,	optional):  The amount intended for the destina-
	   tion, if known.
	*  amount_sent_msat (msat, optional): The total  amount  sent  including
	   fees.
	*  created_at  (u64, optional): The UNIX timestamp when this payment was
	   initiated.
	*  completed_at (u64, optional): The UNIX timestamp  when  this  payment
	   completed.
	*  status  (string,  optional) (one of "failed", "pending", "complete"):
	   The terminal status for a failed sendpay notification.
	*  payment_preimage (secret, optional): The  payment  preimage,  if  the
	   payment later completed through another path.
	*  label (string, optional): The optional label associated with the pay-
	   ment.
	*  bolt11 (string, optional): The bolt11 invoice string, if present.
	*  bolt12  (string,  optional):  The  bolt12 invoice or offer string, if
	   present. (added v24.02)
	*  description (string, optional): The description associated  with  the
	   payment, if present.
	*  erroronion  (hex,  optional): The raw error onion if one was retained
	   for the payment.
	*  onionreply (hex, optional): The onion reply for an unparseable  onion
	   failure.
	*  erring_index  (u32,	optional):  The  position in the route where the
	   failure occurred.
	*  failcode (u32, optional): The BOLT 4 failcode.
	*  failcodename (string, optional): The symbolic name for the  failcode,
	   if known.
	*  erring_node	(pubkey,  optional): The node that produced the failure,
	   if known.
	*  erring_channel (short_channel_id, optional): The  channel  that  pro-
	   duced the failure, if known.
	*  erring_direction  (u32,  optional):	The  direction within the erring
	   channel.
	*  raw_message (hex, optional): The  raw  failure  message  payload,  if
	   present.

Core Lightning v26.06.1 		  LIGHTNING-NOTIFI...-SENDPAY_FAILURE(7)
home | help