Inttegro.BalanceTransactions.PageRequest (inttegro v0.2.0)

Parameters for Page Request in the BalanceTransactions API.

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

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 validated page request request.

Functions

new!(attrs \\ %{})

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

Types

t()

@type t() :: %Inttegro.BalanceTransactions.PageRequest{
  page_number: integer(),
  page_size: integer()
}

A validated page request request.

Functions

new!(attrs \\ %{})

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

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