GoCardlessClient.Resources.PaymentAccountTransactions (GoCardlessClient v2.0.0)

Copy Markdown View Source

GoCardless Payment Account Transactions API.

Detailed transaction history within a Payment Account — credits, debits, fees, FX conversions, and payouts. All transactions are read-only.

Transaction types

payment_paid_in, refund_paid_out, outbound_payment, fee, fx_fee, payout

Summary

Functions

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

Eagerly collects all transactions into a list.

get(client, id, opts \\ [])

Retrieves a single payment account transaction by ID.

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

Returns a page of transactions.

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

Returns a lazy Stream over all pages of transactions.

Functions

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

@spec collect_all(GoCardlessClient.Client.t(), map(), keyword()) ::
  {:ok, [map()]}
  | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}

Eagerly collects all transactions into a list.

get(client, id, opts \\ [])

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

Retrieves a single payment account transaction by ID.

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

@spec list(GoCardlessClient.Client.t(), map(), keyword()) ::
  {:ok, %{items: [map()], meta: map()}}
  | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}

Returns a page of transactions.

Filter by :payment_account, :created_at[gte], :created_at[lte], :transaction_type.

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

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

Returns a lazy Stream over all pages of transactions.