Class: Stripe::CustomerCashBalanceTransaction

Inherits:
APIResource show all
Defined in:
lib/stripe/resources/customer_cash_balance_transaction.rb

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.

Defined Under Namespace

Classes: AdjustedForOverdraft, AppliedToPayment, Funded, RefundedFromPayment, TransferredToBalance, UnappliedFromPayment

Constant Summary collapse

OBJECT_NAME = 
"customer_cash_balance_transaction"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#adjusted_for_overdraft ⇒ Object (readonly)

Attribute for field adjusted_for_overdraft



187
188
189
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 187

def adjusted_for_overdraft
  @adjusted_for_overdraft
end

#applied_to_payment ⇒ Object (readonly)

Attribute for field applied_to_payment



189
190
191
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 189

def applied_to_payment
  @applied_to_payment
end

#created ⇒ Object (readonly)

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



191
192
193
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 191

def created
  @created
end

#currency ⇒ Object (readonly)

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



193
194
195
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 193

def currency
  @currency
end

#customer ⇒ Object (readonly)

The customer whose available cash balance changed as a result of this transaction.



195
196
197
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 195

def customer
  @customer
end

#ending_balance ⇒ Object (readonly)

The total available cash balance for the specified currency after this transaction was applied. Represented in the [smallest currency unit](stripe.com/docs/currencies#zero-decimal).



197
198
199
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 197

def ending_balance
  @ending_balance
end

#funded ⇒ Object (readonly)

Attribute for field funded



199
200
201
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 199

def funded
  @funded
end

#id ⇒ Object (readonly)

Unique identifier for the object.



201
202
203
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 201

def id
  @id
end

#livemode ⇒ Object (readonly)

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



203
204
205
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 203

def livemode
  @livemode
end

#net_amount ⇒ Object (readonly)

The amount by which the cash balance changed, represented in the [smallest currency unit](stripe.com/docs/currencies#zero-decimal). A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance.



205
206
207
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 205

def net_amount
  @net_amount
end

#object ⇒ Object (readonly)

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



207
208
209
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 207

def object
  @object
end

#refunded_from_payment ⇒ Object (readonly)

Attribute for field refunded_from_payment



209
210
211
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 209

def refunded_from_payment
  @refunded_from_payment
end

#transferred_to_balance ⇒ Object (readonly)

Attribute for field transferred_to_balance



211
212
213
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 211

def transferred_to_balance
  @transferred_to_balance
end

#type ⇒ Object (readonly)

The type of the cash balance transaction. New types may be added in future. See [Customer Balance](stripe.com/docs/payments/customer-balance#types) to learn more about these types.



213
214
215
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 213

def type
  @type
end

#unapplied_from_payment ⇒ Object (readonly)

Attribute for field unapplied_from_payment



215
216
217
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 215

def unapplied_from_payment
  @unapplied_from_payment
end

Class Method Details

.field_remappings ⇒ Object 



228
229
230
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 228

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



217
218
219
220
221
222
223
224
225
226
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 217

def self.inner_class_types
  @inner_class_types = {
    adjusted_for_overdraft: AdjustedForOverdraft,
    applied_to_payment: AppliedToPayment,
    funded: Funded,
    refunded_from_payment: RefundedFromPayment,
    transferred_to_balance: TransferredToBalance,
    unapplied_from_payment: UnappliedFromPayment,
  }
end

.object_name ⇒ Object 



11
12
13
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 11

def self.object_name
  "customer_cash_balance_transaction"
end