stripity_stripe v2.2.1 Stripe.Balance View Source
Work with Stripe balance
objects.
You can:
Link to this section Summary
Functions
List balance history
Retrieves the current account balance
Retrieves a balance transaction
Link to this section Types
Link to this type
funds()
View Source
funds() :: %{ currency: String.t(), amount: integer(), source_types: %{optional(Stripe.Source.source_type()) => integer()} }
Link to this section Functions
Link to this function
list(params \\ %{}, opts \\ [])
View Source
list(params, Stripe.options()) :: {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()} when params: %{ optional(:available_on) => Stripe.date_query(), optional(:created) => Stripe.date_query(), optional(:currency) => String.t(), optional(:ending_before) => t() | Stripe.id(), optional(:limit) => 1..100, optional(:payout) => String.t(), optional(:source) => %{optional(:object) => String.t()}, optional(:starting_after) => t() | Stripe.id(), optional(:type) => String.t() }
List balance history
See the Stripe docs.
Link to this function
retrieve(opts \\ [])
View Source
retrieve(Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
Retrieves the current account balance.
This is based on the authentication that was used to make the request.
See the Stripe docs.
Link to this function
retrieve_transaction(id, opts \\ [])
View Source
retrieve_transaction(String.t(), Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
Retrieves a balance transaction
See the Stripe docs.