View Source Stripe.FinancialConnections.Transaction (stripity_stripe v3.2.0)

A Transaction represents a real transaction that affects a Financial Connections Account balance.

Summary

Types

t()

The financial_connections.transaction type.

transacted_at()

transaction_refresh()

Functions

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

Returns a list of Financial Connections Transaction objects.

retrieve(transaction, params \\ %{}, opts \\ [])

Retrieves the details of a Financial Connections Transaction

Types

t()

@type t() :: %Stripe.FinancialConnections.Transaction{
  account: binary(),
  amount: integer(),
  currency: binary(),
  description: binary(),
  id: binary(),
  livemode: boolean(),
  object: binary(),
  status: binary(),
  status_transitions: term(),
  transacted_at: integer(),
  transaction_refresh: binary(),
  updated: integer()
}

The financial_connections.transaction type.

account The ID of the Financial Connections Account this transaction belongs to.
amount The amount of this transaction, in cents (or local equivalent).
currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
description The description of this transaction.
id Unique identifier for the object.
livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
object String representing the object's type. Objects of the same type share the same value.
status The status of the transaction.
status_transitions
transacted_at Time at which the transaction was transacted. Measured in seconds since the Unix epoch.
transaction_refresh The token of the transaction refresh that last updated or created this transaction.
updated Time at which the object was last updated. Measured in seconds since the Unix epoch.

transacted_at()

@type transacted_at() :: %{
  optional(:gt) => integer(),
  optional(:gte) => integer(),
  optional(:lt) => integer(),
  optional(:lte) => integer()
}

transaction_refresh()

@type transaction_refresh() :: %{optional(:after) => binary()}

Functions

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

@spec list(
  params :: %{
    optional(:account) => binary(),
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:starting_after) => binary(),
    optional(:transacted_at) => transacted_at() | integer(),
    optional(:transaction_refresh) => transaction_refresh()
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Returns a list of Financial Connections Transaction objects.

Details

Method: get
Path: /v1/financial_connections/transactions

retrieve(transaction, params \\ %{}, opts \\ [])

@spec retrieve(
  transaction :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieves the details of a Financial Connections Transaction

Details

Method: get
Path: /v1/financial_connections/transactions/{transaction}