class

Stripe::CustomerCashBalanceTransaction

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

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.

Constants

ERROR_MESSAGE_FOR__TYPE = "invalid value for \"_type\", must be one of [adjusted_for_overdraft, applied_to_payment, funded, funding_reversed, refunded_from_payment, return_canceled, return_initiated, transferred_to_balance, unapplied_from_payment]."
ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [customer_cash_balance_transaction]."
MAX_LENGTH_FOR_CURRENCY = 5000
MAX_LENGTH_FOR_ID = 5000
VALID_VALUES_FOR__TYPE = String.static_array("adjusted_for_overdraft", "applied_to_payment", "funded", "funding_reversed", "refunded_from_payment", "return_canceled", "return_initiated", "transferred_to_balance", "unapplied_from_payment")
VALID_VALUES_FOR_OBJECT = String.static_array("customer_cash_balance_transaction")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, created : Int64 | Nil = nil, currency : String | Nil = nil, customer : Stripe::CustomerCashBalanceTransactionCustomer | Nil = nil, ending_balance : Int64 | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, net_amount : Int64 | Nil = nil, object : String | Nil = nil, _type : String | Nil = nil, adjusted_for_overdraft : Stripe::CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft | Nil = nil, applied_to_payment : Stripe::CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransaction | Nil = nil, funded : Stripe::CustomerBalanceResourceCashBalanceTransactionResourceFundedTransaction | Nil = nil, refunded_from_payment : Stripe::CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransaction | Nil = nil, transferred_to_balance : Stripe::CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalance | Nil = nil, unapplied_from_payment : Stripe::CustomerBalanceResourceCashBalanceTransactionResourceUnappliedFromPaymentTransaction | Nil = nil)

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

Source

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

_type

The type of the cash balance transaction. New types may be added in future. See Customer Balance to learn more about these types.

Source
_type=(new_value : String | Nil)

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

Source
adjusted_for_overdraft
Source
adjusted_for_overdraft=(new_value : Stripe::CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft | Nil)

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

Source
applied_to_payment
Source
applied_to_payment=(new_value : Stripe::CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransaction | Nil)

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

Source
created

Time at which the object was created. Measured in seconds since the Unix epoch.

Source
created=(new_value : Int64 | Nil)

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

Source
currency

Three-letter ISO currency code, in lowercase. Must be a supported currency.

Source
currency=(new_value : String | Nil)

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

Source
customer
Source
customer=(new_value : Stripe::CustomerCashBalanceTransactionCustomer | Nil)

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

Source
ending_balance

The total available cash balance for the specified currency after this transaction was applied. Represented in the smallest currency unit.

Source
ending_balance=(new_value : Int64 | Nil)

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

Source
funded
Source
funded=(new_value : Stripe::CustomerBalanceResourceCashBalanceTransactionResourceFundedTransaction | Nil)

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

Source
hash(hasher)

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

id

Unique identifier for the object.

Source
id=(new_value : String | Nil)

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

Source
list_invalid_properties

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

Source
livemode

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

Source
livemode=(new_value : Bool | Nil)

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

Source
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.

Source
net_amount=(new_value : Int64 | Nil)

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

Source
object

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

Source
object=(new_value : String | Nil)

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

Source
refunded_from_payment
Source
refunded_from_payment=(new_value : Stripe::CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransaction | Nil)

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

Source
transferred_to_balance
Source
transferred_to_balance=(new_value : Stripe::CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalance | Nil)

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

Source
unapplied_from_payment
Source
unapplied_from_payment=(new_value : Stripe::CustomerBalanceResourceCashBalanceTransactionResourceUnappliedFromPaymentTransaction | Nil)

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

Source
valid?

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

Source