Class: Stripe::V2::MoneyManagement::Transaction

Inherits:
APIResource show all
Defined in:
lib/stripe/resources/v2/money_management/transaction.rb

Overview

Use Transactions to view changes to your FinancialAccount balance over time. Every flow that moves money, such as OutboundPayments or ReceivedCredits, will have one or more Transactions that describes how the flow impacted your balance. Note that while the FinancialAccount balance will always be up to date, be aware that Transactions and TransactionEntries are created shortly after to reflect changes.

Defined Under Namespace

Classes: BalanceImpact, Counterparty, Flow, StatusTransitions

Constant Summary collapse

OBJECT_NAME = 
"v2.money_management.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?, field_encodings, #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

#amount ⇒ Object (readonly)

The amount of the Transaction.



138
139
140
 
# File 'lib/stripe/resources/v2/money_management/transaction.rb', line 138

def amount
  @amount
end

#balance_impact ⇒ Object (readonly)

The delta to the FinancialAccount's balance. The balance_impact for the Transaction is equal to sum of its TransactionEntries that have effective_ats in the past.



141
142
143
 
# File 'lib/stripe/resources/v2/money_management/transaction.rb', line 141

def balance_impact
  @balance_impact
end

#category ⇒ Object (readonly)

Open Enum. A descriptive category used to classify the Transaction.



143
144
145
 
# File 'lib/stripe/resources/v2/money_management/transaction.rb', line 143

def category
  @category
end

#counterparty ⇒ Object (readonly)

Counterparty to this Transaction.



145
146
147
 
# File 'lib/stripe/resources/v2/money_management/transaction.rb', line 145

def counterparty
  @counterparty
end

#created ⇒ Object (readonly)

Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.



147
148
149
 
# File 'lib/stripe/resources/v2/money_management/transaction.rb', line 147

def created
  @created
end

#description ⇒ Object (readonly)

Description of this Transaction. When applicable, the description is copied from the Flow object at the time of transaction creation.



150
151
152
 
# File 'lib/stripe/resources/v2/money_management/transaction.rb', line 150

def description
  @description
end

#financial_account ⇒ Object (readonly)

Indicates the FinancialAccount affected by this Transaction.



152
153
154
 
# File 'lib/stripe/resources/v2/money_management/transaction.rb', line 152

def 
  @financial_account
end

#flow ⇒ Object (readonly)

Details about the Flow object that created the Transaction.



154
155
156
 
# File 'lib/stripe/resources/v2/money_management/transaction.rb', line 154

def flow
  @flow
end

#id ⇒ Object (readonly)

Unique identifier for the object.



156
157
158
 
# File 'lib/stripe/resources/v2/money_management/transaction.rb', line 156

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.



158
159
160
 
# File 'lib/stripe/resources/v2/money_management/transaction.rb', line 158

def livemode
  @livemode
end

#object ⇒ Object (readonly)

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



160
161
162
 
# File 'lib/stripe/resources/v2/money_management/transaction.rb', line 160

def object
  @object
end

#status ⇒ Object (readonly)

Closed Enum. Current status of the Transaction. A Transaction is pending if either balance_impact.inbound_pending or balance_impact.outbound_pending is non-zero. A Transaction is posted if only balance_impact.available is non-zero. A Transaction is void if there is no balance impact. posted and void are terminal states, and no additional entries will be added to the Transaction.



166
167
168
 
# File 'lib/stripe/resources/v2/money_management/transaction.rb', line 166

def status
  @status
end

#status_transitions ⇒ Object (readonly)

Timestamps for when the Transaction transitioned to a particular status.



168
169
170
 
# File 'lib/stripe/resources/v2/money_management/transaction.rb', line 168

def status_transitions
  @status_transitions
end

#treasury_transaction ⇒ Object (readonly)

The v1 Treasury transaction associated with this transaction.



170
171
172
 
# File 'lib/stripe/resources/v2/money_management/transaction.rb', line 170

def treasury_transaction
  @treasury_transaction
end

Class Method Details

.field_remappings ⇒ Object 



181
182
183
 
# File 'lib/stripe/resources/v2/money_management/transaction.rb', line 181

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



172
173
174
175
176
177
178
179
 
# File 'lib/stripe/resources/v2/money_management/transaction.rb', line 172

def self.inner_class_types
  @inner_class_types = {
    balance_impact: BalanceImpact,
    counterparty: Counterparty,
    flow: Flow,
    status_transitions: StatusTransitions,
  }
end

.object_name ⇒ Object 



10
11
12
 
# File 'lib/stripe/resources/v2/money_management/transaction.rb', line 10

def self.object_name
  "v2.money_management.transaction"
end