Stripe.Balance (stripity_stripe v2.17.2) View Source

Work with Stripe balance objects.

You can:

Retrieve the current balance

Link to this section Summary

Types

funds()

issuing()

issuing_funds()

t()

Functions

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

List balance history

retrieve(opts \\ [])

Retrieves the current account balance.

retrieve_transaction(id, opts \\ [])

Retrieves a balance transaction

Link to this section Types

funds()

Specs

funds() :: %{
  currency: String.t(),
  amount: integer(),
  source_types: %{required(Stripe.Source.source_type()) => integer()}
}

issuing()

Specs

issuing() :: %{available: [issuing_funds()]}

issuing_funds()

Specs

issuing_funds() :: %{currency: String.t(), amount: integer()}

t()

Specs

t() :: %Stripe.Balance{
  available: [funds()],
  connect_reserved: [funds()] | nil,
  issuing: issuing(),
  livemode: boolean(),
  object: String.t(),
  pending: [funds()]
}

Link to this section Functions

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

Specs

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.

retrieve(opts \\ [])

Specs

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.

retrieve_transaction(id, opts \\ [])

Specs

retrieve_transaction(String.t(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

Retrieves a balance transaction

See the Stripe docs.