class Stripe::CustomerCashBalanceTransaction

• Stripe::CustomerCashBalanceTransaction
• Reference
• Object

Overview

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.

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

Constant Summary

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)
• .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

Instance Method Summary

• #==(other : self)

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

• #_type : String | Nil
• #_type=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #adjusted_for_overdraft : Stripe::CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft | Nil
• #adjusted_for_overdraft=(new_value : Stripe::CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft | Nil)

  Custom attribute writer method checking allowed values (enum).

• #applied_to_payment : Stripe::CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransaction | Nil
• #applied_to_payment=(new_value : Stripe::CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransaction | Nil)

  Custom attribute writer method checking allowed values (enum).

• #created : Int64 | Nil
• #created=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #currency : String | Nil
• #currency=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #customer : Stripe::CustomerCashBalanceTransactionCustomer | Nil
• #customer=(new_value : Stripe::CustomerCashBalanceTransactionCustomer | Nil)

  Custom attribute writer method checking allowed values (enum).

• #ending_balance : Int64 | Nil
• #ending_balance=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #funded : Stripe::CustomerBalanceResourceCashBalanceTransactionResourceFundedTransaction | Nil
• #funded=(new_value : Stripe::CustomerBalanceResourceCashBalanceTransactionResourceFundedTransaction | Nil)

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

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

• #id : String | Nil
• #id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #livemode : Bool | Nil
• #livemode=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #net_amount : Int64 | Nil
• #net_amount=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #object : String | Nil
• #object=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #refunded_from_payment : Stripe::CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransaction | Nil
• #refunded_from_payment=(new_value : Stripe::CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransaction | Nil)

  Custom attribute writer method checking allowed values (enum).

• #transferred_to_balance : Stripe::CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalance | Nil
• #transferred_to_balance=(new_value : Stripe::CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalance | Nil)

  Custom attribute writer method checking allowed values (enum).

• #unapplied_from_payment : Stripe::CustomerBalanceResourceCashBalanceTransactionResourceUnappliedFromPaymentTransaction | Nil
• #unapplied_from_payment=(new_value : Stripe::CustomerBalanceResourceCashBalanceTransactionResourceUnappliedFromPaymentTransaction | Nil)

  Custom attribute writer method checking allowed values (enum).

• #valid? : Bool

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

Constructor Detail

Instance Method Detail