Increase.Transactions (Increase v1.0.0)

Copy Markdown View Source

Transactions are the immutable additions and removals of money from your bank account. They're the equivalent of line items on your bank statement. To learn more, see [Transactions and Transfers]

See https://increase.com/documentation/api/transactions for the full API reference for this resource.

Summary

Functions

list(client, params \\ %{}, opts \\ [])

@spec list(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.Page.t()} | {:error, Increase.Error.t()}

List Transactions

Returns a %Increase.Page{} whose data is a list of %__MODULE__. Transaction{} structs. Page through results with Increase.Page.auto_paging_stream/1 or Increase.Page.auto_paging_each/2.

GET /transactions

retrieve(client, transaction_id, opts \\ [])

@spec retrieve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.Transactions.Transaction.t()} | {:error, Increase.Error.t()}

Retrieve a Transaction

GET /transactions/{transaction_id}