Inttegro.Balances.LookupRequest (inttegro v0.2.0)

Copy Markdown View Source

Parameters for Lookup Request in the Balances API.

Build this struct with new!/1 and pass it to the corresponding function on Inttegro.Balances. Required keys are enforced immediately; optional values left as nil are omitted from the request sent to Inttegro.

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()

A validated lookup request request.

Functions

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

Types

t()

@type t() :: %Inttegro.Balances.LookupRequest{}

A validated lookup request request.

Functions

new!(attrs \\ %{})

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

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