Striped v0.5.0

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

A customer's Cash balance represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.

Link to this section Summary

Types

settings()

A hash of settings for this cash balance.

t()

The cash_balance type.

Functions

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

Retrieves a customer’s cash balance.

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

Changes the settings on a customer’s cash balance.

Link to this section Types

Link to this type

settings()

View Source 
@type settings() :: %{optional(:reconciliation_mode) => :automatic | :manual}

A hash of settings for this cash balance.

Link to this type

t()

View Source 
@type t() :: %Stripe.CashBalance{
  available: term() | nil,
  customer: binary(),
  livemode: boolean(),
  object: binary(),
  settings: term()
}

The cash_balance type.

  • available A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the smallest currency unit.
  • customer The ID of the customer whose cash balance this object represents.
  • 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.
  • settings

Link to this section Functions

Link to this function

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

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

Retrieves a customer’s cash balance.

Details

  • Method: get
  • Path: /v1/customers/{customer}/cash_balance
Link to this function

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

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

Changes the settings on a customer’s cash balance.

Details

  • Method: post
  • Path: /v1/customers/{customer}/cash_balance