View Source Stripe.CustomerCashBalanceTransaction (stripity_stripe v3.2.0)

Customers with certain payments enabled have a cash balance, representing funds that were paid by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions represent when funds are moved into or out of this balance. This includes funding by the customer, allocation to payments, and refunds to the customer.

Summary

Types

t()

The customer_cash_balance_transaction type.

Functions

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

Returns a list of transactions that modified the customer’s cash balance.

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

Retrieves a specific cash balance transaction, which updated the customer’s cash balance.

Types

t()

@type t() :: %Stripe.CustomerCashBalanceTransaction{
  adjusted_for_overdraft: term(),
  applied_to_payment: term(),
  created: integer(),
  currency: binary(),
  customer: binary() | Stripe.Customer.t(),
  ending_balance: integer(),
  funded: term(),
  id: binary(),
  livemode: boolean(),
  net_amount: integer(),
  object: binary(),
  refunded_from_payment: term(),
  transferred_to_balance: term(),
  type: binary(),
  unapplied_from_payment: term()
}

The customer_cash_balance_transaction type.

adjusted_for_overdraft
applied_to_payment
created Time at which the object was created. Measured in seconds since the Unix epoch.
currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
customer The customer whose available cash balance changed as a result of this transaction.
ending_balance The total available cash balance for the specified currency after this transaction was applied. Represented in the smallest currency unit.
funded
id Unique identifier for the object.
livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
net_amount The amount by which the cash balance changed, represented in the smallest currency unit. A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance.
object String representing the object's type. Objects of the same type share the same value.
refunded_from_payment
transferred_to_balance
type The type of the cash balance transaction. New types may be added in future. See Customer Balance to learn more about these types.
unapplied_from_payment

Functions

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

@spec list(
  customer :: binary(),
  params :: %{
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:starting_after) => binary()
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Returns a list of transactions that modified the customer’s cash balance.

Details

Method: get
Path: /v1/customers/{customer}/cash_balance_transactions

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

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

Retrieves a specific cash balance transaction, which updated the customer’s cash balance.

Details

Method: get
Path: /v1/customers/{customer}/cash_balance_transactions/{transaction}