Inttegro.BalanceTransactions.Type (inttegro v0.2.0)

Copy Markdown View Source

Values accepted for Type in the BalanceTransactions API.

Prefer the documented atoms returned by values/0. The type also accepts strings so a newer server value can be preserved by an older SDK instead of failing during decoding.

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

A type atom or an unknown wire value preserved as a string.

Functions

Returns the documented Inttegro.BalanceTransactions.Type atoms known by this SDK version.

Types

t()

@type t() :: :payment | :refund | String.t()

A type atom or an unknown wire value preserved as a string.

Functions

values()

@spec values() :: [t()]

Returns the documented Inttegro.BalanceTransactions.Type atoms known by this SDK version.