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

    Interface CreateInvoiceParams

    Parameters for creating an invoice. Identical to a checkout but chain is required — the deposit address is minted up front for that network (the response is an InvoiceCreated with the address, not a hosted-link URL).

    interface CreateInvoiceParams {
        amount: Money;
        chain: string;
        customerEmail?: string;
        description?: string;
        expiresAt?: number;
        redirectUrl?: string;
        reference: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    amount chain customerEmail? description? expiresAt? redirectUrl? reference

    Properties

    amount: Money

    Amount to bill (decimal-string amount + currency), e.g. { amount: "49.00", currency: "USDT" }. Required.

    chain: string

    Network to mint the deposit address on, e.g. "TRON" (from deposits.chains()). Required.

    customerEmail?: string

    Optional payer email (for receipts / notifications).

    description?: string

    Optional description shown to the payer / stored on the link.

    expiresAt?: number

    Optional link expiry as epoch milliseconds; past it the link reads EXPIRED and won't accept payment.

    redirectUrl?: string

    Optional http(s) URL the payer is redirected to once the checkout reaches a terminal state. The browser is returned with ?token=<token>&status=<PAID|EXPIRED|VOID> appended.

    reference: string

    Your order/reference shown to the payer (reconciliation handle). Required.

    Settings

    Member Visibility

    On This Page

    Properties