Unit.API.Transactions (Unit v1.0.0)

Copy Markdown View Source

API module for Unit Transactions.

Transactions are immutable ledger entries — they cannot be created or modified via API. To reverse a transaction, create a new opposite payment/refund.

Summary

Functions

Get a transaction by account ID and transaction ID.

List transactions.

Functions

get(account_id, transaction_id, opts \\ [])

@spec get(String.t(), String.t(), keyword()) ::
  {:ok, Unit.Resource.Transaction.t()} | {:error, term()}

Get a transaction by account ID and transaction ID.

list(opts \\ [])

@spec list(keyword()) ::
  {:ok, [Unit.Resource.Transaction.t()], map()} | {:error, term()}

List transactions.

Filter options

  • :account_id, :customer_id, :card_id, :type
  • :since, :until, :tags, :sort
  • :page_limit, :page_offset

update(account_id, transaction_id, params, opts \\ [])

@spec update(String.t(), String.t(), map(), keyword()) ::
  {:ok, Unit.Resource.Transaction.t()} | {:error, term()}

Update a transaction's tags.