Wallet

An organization's prepaid wallet balance.

  • object
    Type: string

    Resource type identifier.

  • currency
    Type: string

    ISO 4217 currency the balances are denominated in.

  • balance_amount
    Type: integer

    Spendable available balance, in the currency's minor unit. This is the amount an order may draw against.

  • pending_hold_amount
    Type: integer

    Funds held against pending spend, in the currency's minor unit. Zero today.

  • receivable_amount
    Type: integer

    Outstanding metered-usage debt the organization owes, in the currency's minor unit. Zero unless usage has overflowed the wallet.

  • net_balance_amount
    Type: integer

    Net position: the available and held balance minus the outstanding receivable, in the currency's minor unit. Negative when the debt exceeds the balance.