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, AccountTransferIntention, CardDisputeAcceptance, CardDisputeLoss, CardRefund, CardRevenuePayment, CardSettlement, CashbackPayment, CheckDepositAcceptance, CheckDepositReturn, CheckTransferDeposit, FeePayment, InboundACHTransfer, InboundACHTransferReturnIntention, InboundCheckAdjustment, InboundCheckDepositReturnIntention, InboundRealTimePaymentsTransferConfirmation, InboundRealTimePaymentsTransferDecline, InboundWireReversal, InboundWireTransfer, InboundWireTransferReversal, InterestPayment, InternalSource, OutboundCardPushTransferAcceptance, RealTimePaymentsTransferAcknowledgement, SampleFunds, SwiftTransferIntention, 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, 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 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.

Parameters:

  • transfer_id (String) (defaults to: ) —

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




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

Instance Attribute Details

#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:



163
164
165
 
# File 'lib/increase/models/transaction.rb', line 163

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:



174
175
176
177
178
 
# File 'lib/increase/models/transaction.rb', line 174

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:



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

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:



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

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:



210
211
212
213
214
 
# File 'lib/increase/models/transaction.rb', line 210

required :card_dispute_acceptance,
-> {
  Increase::Transaction::Source::CardDisputeAcceptance
},
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:



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

required :card_dispute_loss, -> { Increase::Transaction::Source::CardDisputeLoss }, 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:



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

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:



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

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:



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

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:



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

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:



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

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:



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

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:



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

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:



298
299
300
301
302
 
# File 'lib/increase/models/transaction.rb', line 298

required :check_transfer_deposit,
-> {
  Increase::Transaction::Source::CheckTransferDeposit
},
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:



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

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:



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

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:



329
330
331
 
# File 'lib/increase/models/transaction.rb', line 329

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:



340
341
342
 
# File 'lib/increase/models/transaction.rb', line 340

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:



352
353
354
 
# File 'lib/increase/models/transaction.rb', line 352

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:



364
365
366
 
# File 'lib/increase/models/transaction.rb', line 364

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

#inbound_real_time_payments_transfer_decline ⇒ Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferDecline?

An Inbound Real-Time Payments Transfer Decline object. This field will be present in the JSON response if and only if ‘category` is equal to `inbound_real_time_payments_transfer_decline`.

Returns:



374
375
376
 
# File 'lib/increase/models/transaction.rb', line 374

required :inbound_real_time_payments_transfer_decline,
-> { Increase::Transaction::Source::InboundRealTimePaymentsTransferDecline },
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:



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

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:



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

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:



405
406
407
 
# File 'lib/increase/models/transaction.rb', line 405

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:



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

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:



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

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) 


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

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

#outbound_card_push_transfer_acceptance ⇒ Increase::Models::Transaction::Source::OutboundCardPushTransferAcceptance?

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

Returns:



441
442
443
 
# File 'lib/increase/models/transaction.rb', line 441

required :outbound_card_push_transfer_acceptance,
-> { Increase::Transaction::Source::OutboundCardPushTransferAcceptance },
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:



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

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:



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

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:



471
472
473
 
# File 'lib/increase/models/transaction.rb', line 471

required :swift_transfer_intention,
-> { Increase::Transaction::Source::SwiftTransferIntention },
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:



481
482
483
484
485
 
# File 'lib/increase/models/transaction.rb', line 481

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 647