Class: Increase::Models::PendingTransaction::Source

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

Overview

See Also:

Defined Under Namespace

Modules: Category Classes: ACHTransferInstruction, AccountTransferInstruction, CardAuthorization, CardPushTransferInstruction, CheckDepositInstruction, CheckTransferInstruction, FednowTransferInstruction, InboundFundsHold, InboundWireTransferReversal, RealTimePaymentsTransferInstruction, SwiftTransferInstruction, WireTransferInstruction

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 Instruction object. This field will be present in the JSON response if and only if ‘category` is equal to `swift_transfer_instruction`.

Parameters:

  • transfer_id (String) (defaults to: ) —

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




# File 'lib/increase/models/pending_transaction.rb', line 344

Instance Attribute Details

#account_transfer_instruction ⇒ Increase::Models::PendingTransaction::Source::AccountTransferInstruction?

An Account Transfer Instruction object. This field will be present in the JSON response if and only if ‘category` is equal to `account_transfer_instruction`.

Returns:



206
207
208
 
# File 'lib/increase/models/pending_transaction.rb', line 206

required :account_transfer_instruction,
-> { Increase::PendingTransaction::Source::AccountTransferInstruction },
nil?: true

#ach_transfer_instruction ⇒ Increase::Models::PendingTransaction::Source::ACHTransferInstruction?

An ACH Transfer Instruction object. This field will be present in the JSON response if and only if ‘category` is equal to `ach_transfer_instruction`.

Returns:



215
216
217
 
# File 'lib/increase/models/pending_transaction.rb', line 215

required :ach_transfer_instruction,
-> { Increase::PendingTransaction::Source::ACHTransferInstruction },
nil?: true

#card_authorization ⇒ Increase::Models::PendingTransaction::Source::CardAuthorization?

A Card Authorization object. This field will be present in the JSON response if and only if ‘category` is equal to `card_authorization`. Card Authorizations are temporary holds placed on a customers funds with the intent to later clear a transaction.

Returns:



226
227
228
229
230
 
# File 'lib/increase/models/pending_transaction.rb', line 226

required :card_authorization,
-> {
  Increase::PendingTransaction::Source::CardAuthorization
},
nil?: true

#card_push_transfer_instruction ⇒ Increase::Models::PendingTransaction::Source::CardPushTransferInstruction?

A Card Push Transfer Instruction object. This field will be present in the JSON response if and only if ‘category` is equal to `card_push_transfer_instruction`.

Returns:



237
238
239
 
# File 'lib/increase/models/pending_transaction.rb', line 237

required :card_push_transfer_instruction,
-> { Increase::PendingTransaction::Source::CardPushTransferInstruction },
nil?: true

#category ⇒ Symbol, Increase::Models::PendingTransaction::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:



246
 
# File 'lib/increase/models/pending_transaction.rb', line 246

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

#check_deposit_instruction ⇒ Increase::Models::PendingTransaction::Source::CheckDepositInstruction?

A Check Deposit Instruction object. This field will be present in the JSON response if and only if ‘category` is equal to `check_deposit_instruction`.

Returns:



253
254
255
 
# File 'lib/increase/models/pending_transaction.rb', line 253

required :check_deposit_instruction,
-> { Increase::PendingTransaction::Source::CheckDepositInstruction },
nil?: true

#check_transfer_instruction ⇒ Increase::Models::PendingTransaction::Source::CheckTransferInstruction?

A Check Transfer Instruction object. This field will be present in the JSON response if and only if ‘category` is equal to `check_transfer_instruction`.

Returns:



262
263
264
 
# File 'lib/increase/models/pending_transaction.rb', line 262

required :check_transfer_instruction,
-> { Increase::PendingTransaction::Source::CheckTransferInstruction },
nil?: true

#fednow_transfer_instruction ⇒ Increase::Models::PendingTransaction::Source::FednowTransferInstruction?

A FedNow Transfer Instruction object. This field will be present in the JSON response if and only if ‘category` is equal to `fednow_transfer_instruction`.

Returns:



271
272
273
 
# File 'lib/increase/models/pending_transaction.rb', line 271

required :fednow_transfer_instruction,
-> { Increase::PendingTransaction::Source::FednowTransferInstruction },
nil?: true

#inbound_funds_hold ⇒ Increase::Models::PendingTransaction::Source::InboundFundsHold?

An Inbound Funds Hold object. This field will be present in the JSON response if and only if ‘category` is equal to `inbound_funds_hold`. We hold funds for certain transaction types to account for return windows where funds might still be clawed back by the sending institution.

Returns:



282
283
284
285
286
 
# File 'lib/increase/models/pending_transaction.rb', line 282

required :inbound_funds_hold,
-> {
  Increase::PendingTransaction::Source::InboundFundsHold
},
nil?: true

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

An Inbound Wire Transfer Reversal 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 is created when Increase has received a wire and the User requests that it be reversed.

Returns:



295
296
297
 
# File 'lib/increase/models/pending_transaction.rb', line 295

required :inbound_wire_transfer_reversal,
-> { Increase::PendingTransaction::Source::InboundWireTransferReversal },
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) 


304
 
# File 'lib/increase/models/pending_transaction.rb', line 304

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

#real_time_payments_transfer_instruction ⇒ Increase::Models::PendingTransaction::Source::RealTimePaymentsTransferInstruction?

A Real-Time Payments Transfer Instruction object. This field will be present in the JSON response if and only if ‘category` is equal to `real_time_payments_transfer_instruction`.

Returns:



312
313
314
 
# File 'lib/increase/models/pending_transaction.rb', line 312

required :real_time_payments_transfer_instruction,
-> { Increase::PendingTransaction::Source::RealTimePaymentsTransferInstruction },
nil?: true

#swift_transfer_instruction ⇒ Increase::Models::PendingTransaction::Source::SwiftTransferInstruction?

A Swift Transfer Instruction object. This field will be present in the JSON response if and only if ‘category` is equal to `swift_transfer_instruction`.

Returns:



321
322
323
 
# File 'lib/increase/models/pending_transaction.rb', line 321

required :swift_transfer_instruction,
-> { Increase::PendingTransaction::Source::SwiftTransferInstruction },
nil?: true

#user_initiated_hold ⇒ Hash{Symbol=>Object}?

An User Initiated Hold object. This field will be present in the JSON response if and only if ‘category` is equal to `user_initiated_hold`. Created when a user initiates a hold on funds in their account.

Returns:

  • (Hash{Symbol=>Object}, nil) 


331
332
333
 
# File 'lib/increase/models/pending_transaction.rb', line 331

required :user_initiated_hold,
Increase::Internal::Type::HashOf[Increase::Internal::Type::Unknown],
nil?: true

#wire_transfer_instruction ⇒ Increase::Models::PendingTransaction::Source::WireTransferInstruction?

A Wire Transfer Instruction object. This field will be present in the JSON response if and only if ‘category` is equal to `wire_transfer_instruction`.

Returns:



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

required :wire_transfer_instruction,
-> { Increase::PendingTransaction::Source::WireTransferInstruction },
nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/pending_transaction.rb', line 444