absolutepay (Node SDK) - v0.7.1
    Preparing search index...

    Interface Invoice

    A checkout/invoice record as returned by list/get/update.

    null on a patch field clears it; omit a field on update to leave it unchanged. Extra fields may be present.

    interface Invoice {
        amount: Money;
        customerEmail?: string;
        description?: string;
        kind?: "invoice" | "checkout";
        merchantName: string;
        reference: string;
        status: InvoiceStatus;
        token: string;
        txId?: string;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

      Additional fields passed through untyped.

    Index

    Properties

    amount customerEmail? description? kind? merchantName reference status token txId?

    Properties

    amount: Money

    Billed amount (decimal-string amount + currency).

    customerEmail?: string

    Payer email, when set on create.

    description?: string

    Description, when set.

    kind?: "invoice" | "checkout"

    Which manager owns it: a billed invoice or a shareable checkout link.

    merchantName: string

    Display merchant name.

    reference: string

    Your order/reference.

    status: InvoiceStatus

    Current InvoiceStatus.

    token: string

    Public /pay/<token> link id.

    txId?: string

    On-chain transaction id once paid, when available.

    Settings

    Member Visibility

    On This Page

    Properties