Striped v0.5.0

View Source Stripe.Balance (Striped v0.5.0) (generated)

This is an object representing your Stripe balance. You can retrieve it to see the balance currently on your Stripe account.

You can also retrieve the balance history, which contains a list of transactions that contributed to the balance (charges, payouts, and so forth).

The available and pending amounts for each currency are broken down further by payment source types.

Related guide: Understanding Connect Account Balances.

Link to this section Summary

Types

t()

The balance type.

Functions

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

Retrieves the current account balance, based on the authentication that was used to make the request. For a sample request, see Accounting for negative balances.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Stripe.Balance{
  available: term(),
  connect_reserved: term(),
  instant_available: term(),
  issuing: term(),
  livemode: boolean(),
  object: binary(),
  pending: term()
}

The balance type.

  • available Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the Transfers API or Payouts API. The available balance for each currency and payment type can be found in the source_types property.
  • connect_reserved Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the source_types property.
  • instant_available Funds that can be paid out using Instant Payouts.
  • issuing
  • 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.
  • pending Funds that are not yet available in the balance, due to the 7-day rolling pay cycle. The pending balance for each currency, and for each payment type, can be found in the source_types property.

Link to this section Functions

Link to this function

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

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

Retrieves the current account balance, based on the authentication that was used to make the request. For a sample request, see Accounting for negative balances.

Details

  • Method: get
  • Path: /v1/balance