Class: Increase::Models::Transaction::Source

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/transaction.rb

Overview

See Also:

Defined Under Namespace

Modules: Category Classes: ACHTransferIntention, ACHTransferRejection, ACHTransferReturn, AccountRevenuePayment, AccountTransferIntention, CardDisputeAcceptance, CardDisputeFinancial, CardDisputeLoss, CardPushTransferAcceptance, CardRefund, CardRevenuePayment, CardSettlement, CashbackPayment, CheckDepositAcceptance, CheckDepositReturn, CheckTransferDeposit, FedNowTransferAcknowledgement, FeePayment, InboundACHTransfer, InboundACHTransferReturnIntention, InboundCheckAdjustment, InboundCheckDepositReturnIntention, InboundRealTimePaymentsTransferConfirmation, InboundWireReversal, InboundWireTransfer, InboundWireTransferReversal, InterestPayment, InternalSource, RealTimePaymentsTransferAcknowledgement, SampleFunds, SwiftTransferIntention, SwiftTransferReturn, WireTransferIntention

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(transfer_id: ) ⇒ Object

A Swift Transfer Return object. This field will be present in the JSON response if and only if ‘category` is equal to `swift_transfer_return`. A Swift Transfer Return is created when a Swift Transfer is returned by the receiving bank.

Parameters:

  • transfer_id (String) (defaults to: ) —

    The identifier of the Swift Transfer that led to this Transaction.




# File 'lib/increase/models/transaction.rb', line 521

Instance Attribute Details

#account_revenue_payment ⇒ Increase::Models::Transaction::Source::AccountRevenuePayment?

An Account Revenue Payment object. This field will be present in the JSON response if and only if ‘category` is equal to `account_revenue_payment`. An Account Revenue Payment represents a payment made to an account from the bank. Account revenue is a type of non-interest income.

Returns:



164
165
166
167
168
 
# File 'lib/increase/models/transaction.rb', line 164

required :account_revenue_payment,
-> {
  Increase::Transaction::Source::AccountRevenuePayment
},
nil?: true

#account_transfer_intention ⇒ Increase::Models::Transaction::Source::AccountTransferIntention?

An Account Transfer Intention object. This field will be present in the JSON response if and only if ‘category` is equal to `account_transfer_intention`. Two Account Transfer Intentions are created from each Account Transfer. One decrements the source account, and the other increments the destination account.

Returns:



177
178
179
 
# File 'lib/increase/models/transaction.rb', line 177

required :account_transfer_intention,
-> { Increase::Transaction::Source::AccountTransferIntention },
nil?: true

#ach_transfer_intention ⇒ Increase::Models::Transaction::Source::ACHTransferIntention?

An ACH Transfer Intention object. This field will be present in the JSON response if and only if ‘category` is equal to `ach_transfer_intention`. An ACH Transfer Intention is created from an ACH Transfer. It reflects the intention to move money into or out of an Increase account via the ACH network.

Returns:



188
189
190
191
192
 
# File 'lib/increase/models/transaction.rb', line 188

required :ach_transfer_intention,
-> {
  Increase::Transaction::Source::ACHTransferIntention
},
nil?: true

#ach_transfer_rejection ⇒ Increase::Models::Transaction::Source::ACHTransferRejection?

An ACH Transfer Rejection object. This field will be present in the JSON response if and only if ‘category` is equal to `ach_transfer_rejection`. An ACH Transfer Rejection is created when an ACH Transfer is rejected by Increase. It offsets the ACH Transfer Intention. These rejections are rare.

Returns:



201
202
203
204
205
 
# File 'lib/increase/models/transaction.rb', line 201

required :ach_transfer_rejection,
-> {
  Increase::Transaction::Source::ACHTransferRejection
},
nil?: true

#ach_transfer_return ⇒ Increase::Models::Transaction::Source::ACHTransferReturn?

An ACH Transfer Return object. This field will be present in the JSON response if and only if ‘category` is equal to `ach_transfer_return`. An ACH Transfer Return is created when an ACH Transfer is returned by the receiving bank. It offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within the first two business days after the transfer is initiated, but can occur much later.

Returns:



216
 
# File 'lib/increase/models/transaction.rb', line 216

required :ach_transfer_return, -> { Increase::Transaction::Source::ACHTransferReturn }, nil?: true

#card_dispute_acceptance ⇒ Increase::Models::Transaction::Source::CardDisputeAcceptance?

A Card Dispute Acceptance object. This field will be present in the JSON response if and only if ‘category` is equal to `card_dispute_acceptance`. Contains the details of a successful Card Dispute.

Returns:



224
225
226
227
228
 
# File 'lib/increase/models/transaction.rb', line 224

required :card_dispute_acceptance,
-> {
  Increase::Transaction::Source::CardDisputeAcceptance
},
nil?: true

#card_dispute_financial ⇒ Increase::Models::Transaction::Source::CardDisputeFinancial?

A Card Dispute Financial object. This field will be present in the JSON response if and only if ‘category` is equal to `card_dispute_financial`. Financial event related to a Card Dispute.

Returns:



236
237
238
239
240
 
# File 'lib/increase/models/transaction.rb', line 236

required :card_dispute_financial,
-> {
  Increase::Transaction::Source::CardDisputeFinancial
},
nil?: true

#card_dispute_loss ⇒ Increase::Models::Transaction::Source::CardDisputeLoss?

A Card Dispute Loss object. This field will be present in the JSON response if and only if ‘category` is equal to `card_dispute_loss`. Contains the details of a lost Card Dispute.

Returns:



248
 
# File 'lib/increase/models/transaction.rb', line 248

required :card_dispute_loss, -> { Increase::Transaction::Source::CardDisputeLoss }, nil?: true

#card_push_transfer_acceptance ⇒ Increase::Models::Transaction::Source::CardPushTransferAcceptance?

A Card Push Transfer Acceptance object. This field will be present in the JSON response if and only if ‘category` is equal to `card_push_transfer_acceptance`. A Card Push Transfer Acceptance is created when an Outbound Card Push Transfer sent from Increase is accepted by the receiving bank.

Returns:



257
258
259
 
# File 'lib/increase/models/transaction.rb', line 257

required :card_push_transfer_acceptance,
-> { Increase::Transaction::Source::CardPushTransferAcceptance },
nil?: true

#card_refund ⇒ Increase::Models::Transaction::Source::CardRefund?

A Card Refund object. This field will be present in the JSON response if and only if ‘category` is equal to `card_refund`. Card Refunds move money back to the cardholder. While they are usually connected to a Card Settlement an acquirer can also refund money directly to a card without relation to a transaction.

Returns:



269
 
# File 'lib/increase/models/transaction.rb', line 269

required :card_refund, -> { Increase::Transaction::Source::CardRefund }, nil?: true

#card_revenue_payment ⇒ Increase::Models::Transaction::Source::CardRevenuePayment?

A Card Revenue Payment object. This field will be present in the JSON response if and only if ‘category` is equal to `card_revenue_payment`. Card Revenue Payments reflect earnings from fees on card transactions.

Returns:



277
 
# File 'lib/increase/models/transaction.rb', line 277

required :card_revenue_payment, -> { Increase::Transaction::Source::CardRevenuePayment }, nil?: true

#card_settlement ⇒ Increase::Models::Transaction::Source::CardSettlement?

A Card Settlement object. This field will be present in the JSON response if and only if ‘category` is equal to `card_settlement`. Card Settlements are card transactions that have cleared and settled. While a settlement is usually preceded by an authorization, an acquirer can also directly clear a transaction without first authorizing it.

Returns:



287
 
# File 'lib/increase/models/transaction.rb', line 287

required :card_settlement, -> { Increase::Transaction::Source::CardSettlement }, nil?: true

#cashback_payment ⇒ Increase::Models::Transaction::Source::CashbackPayment?

A Cashback Payment object. This field will be present in the JSON response if and only if ‘category` is equal to `cashback_payment`. A Cashback Payment represents the cashback paid to a cardholder for a given period. Cashback is usually paid monthly for the prior month’s transactions.

Returns:



296
 
# File 'lib/increase/models/transaction.rb', line 296

required :cashback_payment, -> { Increase::Transaction::Source::CashbackPayment }, nil?: true

#category ⇒ Symbol, Increase::Models::Transaction::Source::Category

The type of the resource. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.

Returns:



303
 
# File 'lib/increase/models/transaction.rb', line 303

required :category, enum: -> { Increase::Transaction::Source::Category }

#check_deposit_acceptance ⇒ Increase::Models::Transaction::Source::CheckDepositAcceptance?

A Check Deposit Acceptance object. This field will be present in the JSON response if and only if ‘category` is equal to `check_deposit_acceptance`. A Check Deposit Acceptance is created when a Check Deposit is processed and its details confirmed. Check Deposits may be returned by the receiving bank, which will appear as a Check Deposit Return.

Returns:



313
314
315
 
# File 'lib/increase/models/transaction.rb', line 313

required :check_deposit_acceptance,
-> { Increase::Transaction::Source::CheckDepositAcceptance },
nil?: true

#check_deposit_return ⇒ Increase::Models::Transaction::Source::CheckDepositReturn?

A Check Deposit Return object. This field will be present in the JSON response if and only if ‘category` is equal to `check_deposit_return`. A Check Deposit Return is created when a Check Deposit is returned by the bank holding the account it was drawn against. Check Deposits may be returned for a variety of reasons, including insufficient funds or a mismatched account number. Usually, checks are returned within the first 7 days after the deposit is made.

Returns:



326
 
# File 'lib/increase/models/transaction.rb', line 326

required :check_deposit_return, -> { Increase::Transaction::Source::CheckDepositReturn }, nil?: true

#check_transfer_deposit ⇒ Increase::Models::Transaction::Source::CheckTransferDeposit?

A Check Transfer Deposit object. This field will be present in the JSON response if and only if ‘category` is equal to `check_transfer_deposit`. An Inbound Check is a check drawn on an Increase account that has been deposited by an external bank account. These types of checks are not pre-registered.

Returns:



335
336
337
338
339
 
# File 'lib/increase/models/transaction.rb', line 335

required :check_transfer_deposit,
-> {
  Increase::Transaction::Source::CheckTransferDeposit
},
nil?: true

#fed_now_transfer_acknowledgement ⇒ Increase::Models::Transaction::Source::FedNowTransferAcknowledgement?

A FedNow Transfer Acknowledgement object. This field will be present in the JSON response if and only if ‘category` is equal to `fed_now_transfer_acknowledgement`. A FedNow Transfer Acknowledgement is created when a FedNow Transfer sent from Increase is acknowledged by the receiving bank.

Returns:



348
349
350
 
# File 'lib/increase/models/transaction.rb', line 348

required :fed_now_transfer_acknowledgement,
-> { Increase::Transaction::Source::FedNowTransferAcknowledgement },
nil?: true

#fee_payment ⇒ Increase::Models::Transaction::Source::FeePayment?

A Fee Payment object. This field will be present in the JSON response if and only if ‘category` is equal to `fee_payment`. A Fee Payment represents a payment made to Increase.

Returns:



358
 
# File 'lib/increase/models/transaction.rb', line 358

required :fee_payment, -> { Increase::Transaction::Source::FeePayment }, nil?: true

#inbound_ach_transfer ⇒ Increase::Models::Transaction::Source::InboundACHTransfer?

An Inbound ACH Transfer Intention object. This field will be present in the JSON response if and only if ‘category` is equal to `inbound_ach_transfer`. An Inbound ACH Transfer Intention is created when an ACH transfer is initiated at another bank and received by Increase.

Returns:



367
 
# File 'lib/increase/models/transaction.rb', line 367

required :inbound_ach_transfer, -> { Increase::Transaction::Source::InboundACHTransfer }, nil?: true

#inbound_ach_transfer_return_intention ⇒ Increase::Models::Transaction::Source::InboundACHTransferReturnIntention?

An Inbound ACH Transfer Return Intention object. This field will be present in the JSON response if and only if ‘category` is equal to `inbound_ach_transfer_return_intention`. An Inbound ACH Transfer Return Intention is created when an ACH transfer is initiated at another bank and returned by Increase.

Returns:



377
378
379
 
# File 'lib/increase/models/transaction.rb', line 377

required :inbound_ach_transfer_return_intention,
-> { Increase::Transaction::Source::InboundACHTransferReturnIntention },
nil?: true

#inbound_check_adjustment ⇒ Increase::Models::Transaction::Source::InboundCheckAdjustment?

An Inbound Check Adjustment object. This field will be present in the JSON response if and only if ‘category` is equal to `inbound_check_adjustment`. An Inbound Check Adjustment is created when Increase receives an adjustment for a check or return deposited through Check21.

Returns:



388
389
390
 
# File 'lib/increase/models/transaction.rb', line 388

required :inbound_check_adjustment,
-> { Increase::Transaction::Source::InboundCheckAdjustment },
nil?: true

#inbound_check_deposit_return_intention ⇒ Increase::Models::Transaction::Source::InboundCheckDepositReturnIntention?

An Inbound Check Deposit Return Intention object. This field will be present in the JSON response if and only if ‘category` is equal to `inbound_check_deposit_return_intention`. An Inbound Check Deposit Return Intention is created when Increase receives an Inbound Check and the User requests that it be returned.

Returns:



400
401
402
 
# File 'lib/increase/models/transaction.rb', line 400

required :inbound_check_deposit_return_intention,
-> { Increase::Transaction::Source::InboundCheckDepositReturnIntention },
nil?: true

#inbound_real_time_payments_transfer_confirmation ⇒ Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation?

An Inbound Real-Time Payments Transfer Confirmation object. This field will be present in the JSON response if and only if ‘category` is equal to `inbound_real_time_payments_transfer_confirmation`. An Inbound Real-Time Payments Transfer Confirmation is created when a Real-Time Payments transfer is initiated at another bank and received by Increase.

Returns:



412
413
414
 
# File 'lib/increase/models/transaction.rb', line 412

required :inbound_real_time_payments_transfer_confirmation,
-> { Increase::Transaction::Source::InboundRealTimePaymentsTransferConfirmation },
nil?: true

#inbound_wire_reversal ⇒ Increase::Models::Transaction::Source::InboundWireReversal?

An Inbound Wire Reversal object. This field will be present in the JSON response if and only if ‘category` is equal to `inbound_wire_reversal`. An Inbound Wire Reversal represents a reversal of a wire transfer that was initiated via Increase. The other bank is sending the money back. This most often happens when the original destination account details were incorrect.

Returns:



424
 
# File 'lib/increase/models/transaction.rb', line 424

required :inbound_wire_reversal, -> { Increase::Transaction::Source::InboundWireReversal }, nil?: true

#inbound_wire_transfer ⇒ Increase::Models::Transaction::Source::InboundWireTransfer?

An Inbound Wire Transfer Intention object. This field will be present in the JSON response if and only if ‘category` is equal to `inbound_wire_transfer`. An Inbound Wire Transfer Intention is created when a wire transfer is initiated at another bank and received by Increase.

Returns:



433
 
# File 'lib/increase/models/transaction.rb', line 433

required :inbound_wire_transfer, -> { Increase::Transaction::Source::InboundWireTransfer }, nil?: true

#inbound_wire_transfer_reversal ⇒ Increase::Models::Transaction::Source::InboundWireTransferReversal?

An Inbound Wire Transfer Reversal Intention object. This field will be present in the JSON response if and only if ‘category` is equal to `inbound_wire_transfer_reversal`. An Inbound Wire Transfer Reversal Intention is created when Increase has received a wire and the User requests that it be reversed.

Returns:



443
444
445
 
# File 'lib/increase/models/transaction.rb', line 443

required :inbound_wire_transfer_reversal,
-> { Increase::Transaction::Source::InboundWireTransferReversal },
nil?: true

#interest_payment ⇒ Increase::Models::Transaction::Source::InterestPayment?

An Interest Payment object. This field will be present in the JSON response if and only if ‘category` is equal to `interest_payment`. An Interest Payment represents a payment of interest on an account. Interest is usually paid monthly.

Returns:



454
 
# File 'lib/increase/models/transaction.rb', line 454

required :interest_payment, -> { Increase::Transaction::Source::InterestPayment }, nil?: true

#internal_source ⇒ Increase::Models::Transaction::Source::InternalSource?

An Internal Source object. This field will be present in the JSON response if and only if ‘category` is equal to `internal_source`. A transaction between the user and Increase. See the `reason` attribute for more information.

Returns:



462
 
# File 'lib/increase/models/transaction.rb', line 462

required :internal_source, -> { Increase::Transaction::Source::InternalSource }, nil?: true

#other ⇒ Object?

If the category of this Transaction source is equal to ‘other`, this field will contain an empty object, otherwise it will contain null.

Returns:

  • (Object, nil) 


469
 
# File 'lib/increase/models/transaction.rb', line 469

required :other, Increase::Internal::Type::Unknown, nil?: true

#real_time_payments_transfer_acknowledgement ⇒ Increase::Models::Transaction::Source::RealTimePaymentsTransferAcknowledgement?

A Real-Time Payments Transfer Acknowledgement object. This field will be present in the JSON response if and only if ‘category` is equal to `real_time_payments_transfer_acknowledgement`. A Real-Time Payments Transfer Acknowledgement is created when a Real-Time Payments Transfer sent from Increase is acknowledged by the receiving bank.

Returns:



479
480
481
 
# File 'lib/increase/models/transaction.rb', line 479

required :real_time_payments_transfer_acknowledgement,
-> { Increase::Transaction::Source::RealTimePaymentsTransferAcknowledgement },
nil?: true

#sample_funds ⇒ Increase::Models::Transaction::Source::SampleFunds?

A Sample Funds object. This field will be present in the JSON response if and only if ‘category` is equal to `sample_funds`. Sample funds for testing purposes.

Returns:



489
 
# File 'lib/increase/models/transaction.rb', line 489

required :sample_funds, -> { Increase::Transaction::Source::SampleFunds }, nil?: true

#swift_transfer_intention ⇒ Increase::Models::Transaction::Source::SwiftTransferIntention?

A Swift Transfer Intention object. This field will be present in the JSON response if and only if ‘category` is equal to `swift_transfer_intention`. A Swift Transfer initiated via Increase.

Returns:



497
498
499
 
# File 'lib/increase/models/transaction.rb', line 497

required :swift_transfer_intention,
-> { Increase::Transaction::Source::SwiftTransferIntention },
nil?: true

#swift_transfer_return ⇒ Increase::Models::Transaction::Source::SwiftTransferReturn?

A Swift Transfer Return object. This field will be present in the JSON response if and only if ‘category` is equal to `swift_transfer_return`. A Swift Transfer Return is created when a Swift Transfer is returned by the receiving bank.

Returns:



507
 
# File 'lib/increase/models/transaction.rb', line 507

required :swift_transfer_return, -> { Increase::Transaction::Source::SwiftTransferReturn }, nil?: true

#wire_transfer_intention ⇒ Increase::Models::Transaction::Source::WireTransferIntention?

A Wire Transfer Intention object. This field will be present in the JSON response if and only if ‘category` is equal to `wire_transfer_intention`. A Wire Transfer initiated via Increase and sent to a different bank.

Returns:



515
516
517
518
519
 
# File 'lib/increase/models/transaction.rb', line 515

required :wire_transfer_intention,
-> {
  Increase::Transaction::Source::WireTransferIntention
},
nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/transaction.rb', line 720