View Source Stripe.Treasury.TransactionEntry (stripity_stripe v3.2.0)

TransactionEntries represent individual units of money movements within a single Transaction.

Summary

Types

created()

effective_at()

t()

The treasury.transaction_entry type.

Functions

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

Retrieves a list of TransactionEntry objects.

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

Retrieves a TransactionEntry object.

Types

created()

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

effective_at()

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

t()

@type t() :: %Stripe.Treasury.TransactionEntry{
  balance_impact: term(),
  created: integer(),
  currency: binary(),
  effective_at: integer(),
  financial_account: binary(),
  flow: binary() | nil,
  flow_details: term() | nil,
  flow_type: binary(),
  id: binary(),
  livemode: boolean(),
  object: binary(),
  transaction: binary() | Stripe.Treasury.Transaction.t(),
  type: binary()
}

The treasury.transaction_entry type.

balance_impact
created Time at which the object was created. Measured in seconds since the Unix epoch.
currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
effective_at When the TransactionEntry will impact the FinancialAccount's balance.
financial_account The FinancialAccount associated with this object.
flow Token of the flow associated with the TransactionEntry.
flow_details Details of the flow associated with the TransactionEntry.
flow_type Type of the flow associated with the TransactionEntry.
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.
transaction The Transaction associated with this object.
type The specific money movement that generated the TransactionEntry.

Functions

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

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

Retrieves a list of TransactionEntry objects.

Details

Method: get
Path: /v1/treasury/transaction_entries

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

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

Retrieves a TransactionEntry object.

Details

Method: get
Path: /v1/treasury/transaction_entries/{id}