Package org.ldk.structs
Class Event.PaymentFailed
- java.lang.Object
-
- org.ldk.structs.Event
-
- org.ldk.structs.Event.PaymentFailed
-
- Enclosing class:
- Event
public static final class Event.PaymentFailed extends Event
Indicates an outbound payment failed. Individual [`Event::PaymentPathFailed`] events provide failure information for each path attempt in the payment, including retries. This event is provided once there are no further pending HTLCs for the payment and the payment is no longer retryable, due either to the [`Retry`] provided or [`ChannelManager::abandon_payment`] having been called for the corresponding payment. [`Retry`]: crate::ln::channelmanager::Retry [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.ldk.structs.Event
Event.ChannelClosed, Event.ChannelPending, Event.ChannelReady, Event.DiscardFunding, Event.FundingGenerationReady, Event.HTLCHandlingFailed, Event.HTLCIntercepted, Event.OpenChannelRequest, Event.PaymentClaimable, Event.PaymentClaimed, Event.PaymentFailed, Event.PaymentForwarded, Event.PaymentPathFailed, Event.PaymentPathSuccessful, Event.PaymentSent, Event.PendingHTLCsForwardable, Event.ProbeFailed, Event.ProbeSuccessful, Event.SpendableOutputs
-
-
Field Summary
Fields Modifier and Type Field Description byte[]
payment_hash
The hash that was given to [`ChannelManager::send_payment`].byte[]
payment_id
The `payment_id` passed to [`ChannelManager::send_payment`].Option_PaymentFailureReasonZ
reason
The reason the payment failed.
-
Method Summary
-
Methods inherited from class org.ldk.structs.Event
channel_closed, channel_pending, channel_ready, clone, discard_funding, eq, equals, finalize, funding_generation_ready, htlchandling_failed, htlcintercepted, open_channel_request, payment_claimable, payment_claimed, payment_failed, payment_forwarded, payment_path_failed, payment_path_successful, payment_sent, pending_htlcs_forwardable, probe_failed, probe_successful, spendable_outputs, write
-
-
-
-
Field Detail
-
payment_id
public final byte[] payment_id
The `payment_id` passed to [`ChannelManager::send_payment`]. [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
-
payment_hash
public final byte[] payment_hash
The hash that was given to [`ChannelManager::send_payment`]. [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
-
reason
public final Option_PaymentFailureReasonZ reason
The reason the payment failed. This is only `None` for events generated or serialized by versions prior to 0.0.115.
-
-