Inttegro.Balances (inttegro v0.2.0)

Copy Markdown View Source

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

Functions

get(client, options \\ [])

Fetch the latest GHS balance snapshot for your application. The response separates payout-eligible funds from funds that are still pending, held back from payout, or assigned to refund activity at the snapshot cutoff.

Functions

get(client, options \\ [])

@spec get(Inttegro.Client.t(), keyword()) ::
  {:ok, %{optional(String.t()) => Inttegro.Balances.CurrencySnapshot.t()}}
  | {:error, Exception.t()}

Fetch the latest GHS balance snapshot for your application. The response separates payout-eligible funds from funds that are still pending, held back from payout, or assigned to refund activity at the snapshot cutoff.

Parameters

  • client — an authenticated Inttegro.Client.
  • options — request options such as :idempotency_key and additional :headers.

Returns

Returns {:ok, the documented result} when Inttegro accepts and decodes the operation. Returns {:error, exception} for API, transport, or decoding failures. A successful API response can still describe an asynchronous resource that has not reached its terminal state.

Example

Inttegro.Balances.get(client)