Marqeta.Transactions (marqeta v1.0.0)

Retrieve transaction records. Transactions are read-only — they are created by Marqeta when cardholders transact.

Transaction Types

authorization, authorization.clearing, authorization.reversal, pindebit, pindebit.reversal, refund, refund.clearing, gpa.credit, gpa.credit.reversal, gpa.debit, transfer.peer, fee.charge, msa.credit, msa.debit, account.funding

Transaction States

PENDING, COMPLETION, DECLINED, ERROR

For large datasets, use Marqeta.DiVA.Authorizations or Marqeta.DiVA.Settlements which are optimised for bulk reads.

Summary

Functions

get(token, opts \\ [])

Retrieves a transaction by token.

get!(token, opts \\ [])

Retrieves a transaction by token. Raises Marqeta.Error on failure.

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

Lists transaction resources.

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

Lists transaction resources. Raises Marqeta.Error on failure.

list_by_business(token, params \\ %{}, opts \\ [])

Lists transactions for a business.

list_by_card(card_token, params \\ %{}, opts \\ [])

Lists transactions for a card.

list_by_user(user_token, params \\ %{}, opts \\ [])

Lists transactions for a user.

list_related(token, params \\ %{}, opts \\ [])

Lists related transactions (e.g. reversals, clearings) for a transaction.

stream(params \\ %{}, opts \\ [])

Returns a lazy Stream that auto-paginates transaction resources.

stream_by_business(token, params \\ %{})

Streams transactions for a business.

stream_by_card(token, params \\ %{})

Streams transactions for a card.

stream_by_user(token, params \\ %{})

Streams transactions for a user.

Functions

get(token, opts \\ [])

@spec get(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Retrieves a transaction by token.

Returns {:ok, map()} on success, {:error, %Marqeta.Error{}} on failure.

get!(token, opts \\ [])

@spec get!(
  String.t(),
  keyword()
) :: map()

Retrieves a transaction by token. Raises Marqeta.Error on failure.

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

@spec list(
  map(),
  keyword()
) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Lists transaction resources.

Accepts standard Marqeta pagination params: count, start_index, sort_by, sort_order, fields.

Use stream/2 to lazily iterate all pages automatically.

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

@spec list!(
  map(),
  keyword()
) :: map()

Lists transaction resources. Raises Marqeta.Error on failure.

list_by_business(token, params \\ %{}, opts \\ [])

@spec list_by_business(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, Marqeta.Error.t()}

Lists transactions for a business.

list_by_card(card_token, params \\ %{}, opts \\ [])

@spec list_by_card(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, Marqeta.Error.t()}

Lists transactions for a card.

list_by_user(user_token, params \\ %{}, opts \\ [])

@spec list_by_user(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, Marqeta.Error.t()}

Lists transactions for a user.

list_related(token, params \\ %{}, opts \\ [])

@spec list_related(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, Marqeta.Error.t()}

Lists related transactions (e.g. reversals, clearings) for a transaction.

stream(params \\ %{}, opts \\ [])

@spec stream(
  map(),
  keyword()
) :: Enumerable.t()

Returns a lazy Stream that auto-paginates transaction resources.

stream_by_business(token, params \\ %{})

@spec stream_by_business(String.t(), map()) :: Enumerable.t()

Streams transactions for a business.

stream_by_card(token, params \\ %{})

@spec stream_by_card(String.t(), map()) :: Enumerable.t()

Streams transactions for a card.

stream_by_user(token, params \\ %{})

@spec stream_by_user(String.t(), map()) :: Enumerable.t()

Streams transactions for a user.