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

    Gross available balance, in the currency's minor unit. The amount an order may actually draw against is this less pending_charges_amount; see net_balance_amount for the net position.

  • 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.

  • pending_charges_amount
    Type: integer

    Metered-usage charges already incurred but not yet settled to the wallet, in the currency's minor unit. Deducted from the available balance to gate spend, so in-flight usage is not drained by an order. Zero unless metered usage is awaiting settlement.

  • net_balance_amount
    Type: integer

    Net position: the available and held balance minus the outstanding receivable and the pending metered-usage charges, in the currency's minor unit. Negative when the debt and reservation together exceed the balance.