class

Stripe::Balance

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

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

Constants

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [balance]."

VALID_VALUES_FOR_OBJECT = String.static_array("balance")

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

new(*, available : Array(Stripe::BalanceAmount) | Nil = nil, livemode : Bool | Nil = nil, object : String | Nil = nil, pending : Array(Stripe::BalanceAmount) | Nil = nil, connect_reserved : Array(Stripe::BalanceAmount) | Nil = nil, instant_available : Array(Stripe::BalanceAmountNet) | Nil = nil, issuing : Stripe::BalanceDetail | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

available

Available funds that you can transfer or pay out automatically by Stripe or explicitly through the Transfers API or Payouts API. You can find the available balance for each currency and payment type in the source_types property.

available=(new_value : Array(Stripe::BalanceAmount) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] available Object to be assigned

connect_reserved

Funds held due to negative balances on connected accounts where account.controller.requirement_collection is application, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the source_types property.

connect_reserved=(new_value : Array(Stripe::BalanceAmount) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] connect_reserved Object to be assigned

hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

instant_available

Funds that you can pay out using Instant Payouts.

instant_available=(new_value : Array(Stripe::BalanceAmountNet) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] instant_available Object to be assigned

issuing

issuing=(new_value : Stripe::BalanceDetail | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] issuing Object to be assigned

list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

livemode

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

livemode=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned

object

String representing the object's type. Objects of the same type share the same value.

object=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned

pending

Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the source_types property.

pending=(new_value : Array(Stripe::BalanceAmount) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] pending Object to be assigned

valid?

Check to see if the all the properties in the model are valid @return true if the model is valid