Inttegro.BalanceTransactions.Amount (inttegro v0.2.0)

Copy Markdown View Source

Represents Amount data in the BalanceTransactions 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.

Reads the immutable ledger entries behind an application's balance.

Balance transactions explain why funds moved: for example, a captured payment adds funds and a refund removes them. Use this API for reconciliation and audit trails rather than deriving a balance from orders or payments. Page through every result when calculating totals.

Summary

Types

t()

The decoded amount value.

Functions

new!(attrs \\ %{})

Builds a Inttegro.BalanceTransactions.Amount and raises KeyError when a required field is missing.

Types

t()

@type t() :: %Inttegro.BalanceTransactions.Amount{
  currency: String.t(),
  value: integer()
}

The decoded amount value.

Functions

new!(attrs \\ %{})

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

Builds a Inttegro.BalanceTransactions.Amount and raises KeyError when a required field is missing.