AppleSauce
    Preparing search index...

    Interface Transaction

    Transaction object used in multiple response types

    interface Transaction {
        amount: number;
        created_at: number;
        description?: string;
        description_hash?: string;
        expires_at?: number;
        fees_paid: number;
        invoice?: string;
        metadata?: Record<string, any>;
        payment_hash?: string;
        preimage?: string;
        settled_at?: number;
        state: "pending" | "settled" | "expired" | "failed";
        type: "incoming" | "outgoing";
    }
    Index

    Properties

    amount created_at description? description_hash? expires_at? fees_paid invoice? metadata? payment_hash? preimage? settled_at? state type

    Properties

    amount: number

    Value in msats

    created_at: number

    Invoice/payment creation unix timestamp

    description?: string

    Invoice's description, optional

    description_hash?: string

    Invoice's description hash, optional

    expires_at?: number

    Invoice expiration unix timestamp, optional if not applicable

    fees_paid: number

    Value in msats

    invoice?: string

    Encoded invoice, optional

    metadata?: Record<string, any>

    Generic metadata that can be used to add things like zap/boostagram details

    payment_hash?: string

    Payment hash for the payment, optional

    preimage?: string

    Payment's preimage, optional if unpaid

    settled_at?: number

    Invoice/payment settlement unix timestamp, optional if unpaid

    state: "pending" | "settled" | "expired" | "failed"

    State of the transaction

    type: "incoming" | "outgoing"

    Type of transaction

    Settings

    Member Visibility

    On This Page

    Properties