stripity_stripe v2.7.0 Stripe.BalanceTransaction View Source
Work with [Stripe balance_transaction objects] (https://stripe.com/docs/api#balance_transaction_object).
You can:
Link to this section Summary
Functions
Returns a list of transactions that have contributed to the Stripe account balance.
Retrieves the balance transaction with the given ID.
Link to this section Types
Link to this type
t()
View Source
t()
View Source
t() :: %Stripe.BalanceTransaction{
amount: integer(),
available_on: Stripe.timestamp(),
created: Stripe.timestamp(),
currency: String.t(),
description: String.t() | nil,
exchange_rate: integer() | nil,
fee: integer(),
fee_details: [Stripe.Types.fee()] | [],
id: Stripe.id(),
net: integer(),
object: String.t(),
source: Stripe.id() | Stripe.Source.t() | nil,
status: String.t(),
type: String.t()
}
t() :: %Stripe.BalanceTransaction{
amount: integer(),
available_on: Stripe.timestamp(),
created: Stripe.timestamp(),
currency: String.t(),
description: String.t() | nil,
exchange_rate: integer() | nil,
fee: integer(),
fee_details: [Stripe.Types.fee()] | [],
id: Stripe.id(),
net: integer(),
object: String.t(),
source: Stripe.id() | Stripe.Source.t() | nil,
status: String.t(),
type: String.t()
}
Link to this section Functions
Link to this function
all(params \\ %{}, opts \\ [])
View Source
all(params \\ %{}, opts \\ [])
View Source
all(params, Stripe.options()) ::
{:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params: %{
optional(:available_on) => String.t() | Stripe.date_query(),
optional(:created) => String.t() | Stripe.date_query(),
optional(:currency) => String.t(),
optional(:ending_before) => Stripe.id() | Stripe.BalanceTransaction.t(),
optional(:limit) => 1..100,
optional(:payout) => Stripe.id() | Stripe.Payout.t(),
optional(:source) => Stripe.id() | Stripe.Source.t(),
optional(:starting_after) => Stripe.id() | Stripe.BalanceTransaction.t(),
optional(:type) => String.t()
}
all(params, Stripe.options()) :: {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()} when params: %{ optional(:available_on) => String.t() | Stripe.date_query(), optional(:created) => String.t() | Stripe.date_query(), optional(:currency) => String.t(), optional(:ending_before) => Stripe.id() | Stripe.BalanceTransaction.t(), optional(:limit) => 1..100, optional(:payout) => Stripe.id() | Stripe.Payout.t(), optional(:source) => Stripe.id() | Stripe.Source.t(), optional(:starting_after) => Stripe.id() | Stripe.BalanceTransaction.t(), optional(:type) => String.t() }
Returns a list of transactions that have contributed to the Stripe account balance.
Examples of such transactions are charges, transfers, and so forth. The transactions are returned in sorted order, with the most recent transactions appearing first.
See t:Stripe.BalanceTransaction.All.t/0 or the
Stripe docs for parameter structure.
Link to this function
retrieve(id, opts \\ [])
View Source
retrieve(id, opts \\ [])
View Source
retrieve(Stripe.id(), Stripe.options()) ::
{:ok, t()} | {:error, Stripe.Error.t()}
retrieve(Stripe.id(), Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
Retrieves the balance transaction with the given ID.
Requires the ID of the balance transaction to retrieve and takes no other parameters.
See the Stripe docs.