Interface WalletInterface

Wallet entity interface

Mirrors macs-node-sdk/lib/payments/models/wallet.js. Balances are tracked in USD. stripe_customer_id and the subscription fields are server-managed.

interface WalletInterface {
    active?: boolean;
    external_id?: string;
    extensors?: { [key: string]: string };
    record_history?: RecordHistory;
    id?: string;
    org?: string;
    user?: string;
    usd_balance?: number;
    renewal_threshold_usd?: number;
    renewal_amount_usd?: number;
    auto_reload_on?: boolean;
    stripe_customer_id?: string;
    subscription?: WalletSubscription;
}

Hierarchy (View Summary)

Properties

active? external_id? extensors? record_history? id? org? user? usd_balance? renewal_threshold_usd? renewal_amount_usd? auto_reload_on? stripe_customer_id? subscription?

Properties

Optionalactive

active?: boolean

Whether the entity is active

Optionalexternal_id

external_id?: string

External system identifier for integration with third-party systems

Optionalextensors

extensors?: { [key: string]: string }

Extended properties for custom integrations

Optionalrecord_history

record_history?: RecordHistory

Record history tracking information

Optionalid

id?: string

Unique identifier for the entity

Optionalorg

org?: string

Optionaluser

user?: string

Optionalusd_balance

usd_balance?: number

Current balance in USD

Optionalrenewal_threshold_usd

renewal_threshold_usd?: number

Auto-reload threshold in USD (balance triggers reload below this)

Optionalrenewal_amount_usd

renewal_amount_usd?: number

Auto-reload amount in USD

Optionalauto_reload_on

auto_reload_on?: boolean

Whether auto-reload is enabled

Optionalstripe_customer_id

stripe_customer_id?: string

Linked Stripe customer — server-managed

Optionalsubscription

subscription?: WalletSubscription

Active Stripe subscription (if any)

Settings

Member Visibility

On This Page

Properties