Class Event.PaymentSent

  • Enclosing class:
    Event

    public static final class Event.PaymentSent
    extends Event
    Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target and we got back the payment preimage for it). Note for MPP payments: in rare cases, this event may be preceded by a `PaymentPathFailed` event. In this situation, you SHOULD treat this payment as having succeeded.
    • Field Detail

      • payment_id

        @Nullable
        public final byte[] payment_id
        The `payment_id` passed to [`ChannelManager::send_payment`]. [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
      • payment_preimage

        public final byte[] payment_preimage
        The preimage to the hash given to ChannelManager::send_payment. Note that this serves as a payment receipt, if you wish to have such a thing, you must store it somehow!
      • 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
      • fee_paid_msat

        public final Option_u64Z fee_paid_msat
        The total fee which was spent at intermediate hops in this payment, across all paths. Note that, like [`Route::get_total_fees`] this does *not* include any potential overpayment to the recipient node. If the recipient or an intermediate node misbehaves and gives us free money, this may overstate the amount paid, though this is unlikely. [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees