Struct Payment

pub struct Payment {
    pub destination: Option<String>,
    pub tx_id: Option<String>,
    pub timestamp: u32,
    pub amount_sat: u64,
    pub fees_sat: u64,
    pub swapper_fees_sat: Option<u64>,
    pub payment_type: PaymentType,
    pub status: PaymentState,
    pub details: PaymentDetails,
}

Represents an SDK payment.

By default, this is an onchain tx. It may represent a swap, if swap metadata is available.

Fields

destination: Option<String>

The destination associated with the payment, if it was created via our SDK. Can be either a Liquid/Bitcoin address, a Liquid BIP21 URI or an invoice

tx_id: Option<String>

timestamp: u32

Composite timestamp that can be used for sorting or displaying the payment.

If this payment has an associated swap, it is the swap creation time. Otherwise, the point in time when the underlying tx was included in a block. If there is no associated swap available and the underlying tx is not yet confirmed, the value is now().

amount_sat: u64

The payment amount, which corresponds to the onchain tx amount.

In case of an outbound payment (Send), this is the payer amount. Otherwise it’s the receiver amount.

fees_sat: u64

Represents the fees paid by this wallet for this payment.

Swaps

If there is an associated Send Swap, these fees represent the total fees paid by this wallet (the sender). It is the difference between the amount that was sent and the amount received.

If there is an associated Receive Swap, these fees represent the total fees paid by this wallet (the receiver). It is also the difference between the amount that was sent and the amount received.

Pure onchain txs

If no swap is associated with this payment:

• for Send payments, this is the onchain tx fee
• for Receive payments, this is zero

swapper_fees_sat: Option<u64>

Service fees paid to the swapper service. This is only set for swaps (i.e. doesn’t apply to direct Liquid payments).

payment_type: PaymentType

If it is a Send or Receive payment

status: PaymentState

Composite status representing the overall status of the payment.

If the tx has no associated swap, this reflects the onchain tx status (confirmed or not).

If the tx has an associated swap, this is determined by the swap status (pending or complete).

details: PaymentDetails

The details of a payment, depending on its destination and type

Trait Implementations

impl Clone for Payment

fn clone(&self) -> Payment

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Payment

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl IntoDart for Payment

fn into_dart(self) -> DartAbi

Consumes Self and Performs the conversion.

impl IntoIntoDart<Payment> for Payment

fn into_into_dart(self) -> Payment

impl PartialEq for Payment

fn eq(&self, other: &Payment) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Payment

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl IntoDartExceptPrimitive for Payment

impl StructuralPartialEq for Payment