Inttegro.Balances.CurrencySnapshot (inttegro v0.2.0)

Represents Currency Snapshot data in the Balances API.

Inttegro decodes API responses into this struct. Required fields are always present; optional fields are nil when they do not apply or were not returned. Follow the linked types in t/0 for nested domain values.

Retrieves the application's current balances by currency and availability state.

A balance is a point-in-time projection of the ledger. It distinguishes funds that are available, reserved, or otherwise unavailable. Use balance transactions when you need the history behind a value.

Summary

Types

t()

The decoded currency snapshot value.

Functions

new!(attrs \\ %{})

Builds a Inttegro.Balances.CurrencySnapshot and raises KeyError when a required field is missing.

Types

t()

@type t() :: %Inttegro.Balances.CurrencySnapshot{
  available: Inttegro.Balances.Value.t(),
  includes_transactions_before: String.t(),
  pending: Inttegro.Balances.Value.t(),
  refund: Inttegro.Balances.CurrencySnapshotRefund.t(),
  reserved: Inttegro.Balances.CurrencySnapshotReserved.t()
}

The decoded currency snapshot value.

Functions

new!(attrs \\ %{})

@spec new!(map() | keyword()) :: t()

Builds a Inttegro.Balances.CurrencySnapshot and raises KeyError when a required field is missing.