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

#==, #[], #[]=, 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



107
108
109
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 107

def adjusted_for_overdraft
  @adjusted_for_overdraft
end

#applied_to_payment ⇒ Object (readonly)

Attribute for field applied_to_payment



110
111
112
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 110

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.



113
114
115
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 113

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



116
117
118
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 116

def currency
  @currency
end

#customer ⇒ Object (readonly)

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



119
120
121
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 119

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



122
123
124
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 122

def ending_balance
  @ending_balance
end

#funded ⇒ Object (readonly)

Attribute for field funded



125
126
127
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 125

def funded
  @funded
end

#id ⇒ Object (readonly)

Unique identifier for the object.



128
129
130
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 128

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.



131
132
133
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 131

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.



134
135
136
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 134

def net_amount
  @net_amount
end

#object ⇒ Object (readonly)

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



137
138
139
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 137

def object
  @object
end

#refunded_from_payment ⇒ Object (readonly)

Attribute for field refunded_from_payment



140
141
142
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 140

def refunded_from_payment
  @refunded_from_payment
end

#transferred_to_balance ⇒ Object (readonly)

Attribute for field transferred_to_balance



143
144
145
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 143

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.



146
147
148
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 146

def type
  @type
end

#unapplied_from_payment ⇒ Object (readonly)

Attribute for field unapplied_from_payment



149
150
151
 
# File 'lib/stripe/resources/customer_cash_balance_transaction.rb', line 149

def unapplied_from_payment
  @unapplied_from_payment
end

Class Method Details

.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