Class: Increase::Models::InboundCheckDeposit

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

Overview

See Also:

Defined Under Namespace

Modules: Currency, PayeeNameAnalysis, Status, Type Classes: Adjustment, DepositReturn

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from Increase::Internal::Type::BaseModel

Instance Attribute Details

#accepted_at ⇒ Time?

If the Inbound Check Deposit was accepted, the [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time at which this took place.

Returns:

  • (Time, nil) 


19
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 19

required :accepted_at, Time, nil?: true

#account_id ⇒ String

The Account the check is being deposited against.

Returns:

  • (String) 


25
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 25

required :account_id, String

#account_number_id ⇒ String?

The Account Number the check is being deposited against.

Returns:

  • (String, nil) 


31
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 31

required :account_number_id, String, nil?: true

#adjustments ⇒ Array<Increase::Models::InboundCheckDeposit::Adjustment>

If the deposit or the return was adjusted by the sending institution, this will contain details of the adjustments.

Returns:



38
39
40
41
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 38

required :adjustments,
-> {
  Increase::Internal::Type::ArrayOf[Increase::InboundCheckDeposit::Adjustment]
}

#amount ⇒ Integer

The deposited amount in USD cents.

Returns:

  • (Integer) 


47
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 47

required :amount, Integer

#back_image_file_id ⇒ String?

The ID for the File containing the image of the back of the check.

Returns:

  • (String, nil) 


53
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 53

required :back_image_file_id, String, nil?: true

#bank_of_first_deposit_routing_number ⇒ String?

The American Bankers’ Association (ABA) Routing Transit Number (RTN) for the bank depositing this check. In some rare cases, this is not transmitted via Check21 and the value will be null.

Returns:

  • (String, nil) 


61
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 61

required :bank_of_first_deposit_routing_number, String, nil?: true

#check_number ⇒ String?

The check number printed on the check being deposited.

Returns:

  • (String, nil) 


67
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 67

required :check_number, String, nil?: true

#check_transfer_id ⇒ String?

If this deposit is for an existing Check Transfer, the identifier of that Check Transfer.

Returns:

  • (String, nil) 


74
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 74

required :check_transfer_id, String, nil?: true

#created_at ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time at which the deposit was attempted.

Returns:

  • (Time) 


81
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 81

required :created_at, Time

#currency ⇒ Symbol, Increase::Models::InboundCheckDeposit::Currency

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the deposit.

Returns:



87
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 87

required :currency, enum: -> { Increase::InboundCheckDeposit::Currency }

#declined_at ⇒ Time?

If the Inbound Check Deposit was declined, the [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time at which this took place.

Returns:

  • (Time, nil) 


95
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 95

required :declined_at, Time, nil?: true

#declined_transaction_id ⇒ String?

If the deposit attempt has been rejected, the identifier of the Declined Transaction object created as a result of the failed deposit.

Returns:

  • (String, nil) 


102
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 102

required :declined_transaction_id, String, nil?: true

#deposit_return ⇒ Increase::Models::InboundCheckDeposit::DepositReturn?

If you requested a return of this deposit, this will contain details of the return.

Returns:



109
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 109

required :deposit_return, -> { Increase::InboundCheckDeposit::DepositReturn }, nil?: true

#front_image_file_id ⇒ String?

The ID for the File containing the image of the front of the check.

Returns:

  • (String, nil) 


115
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 115

required :front_image_file_id, String, nil?: true

#id ⇒ String

The deposit’s identifier.

Returns:

  • (String) 


11
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 11

required :id, String

#payee_name_analysis ⇒ Symbol, Increase::Models::InboundCheckDeposit::PayeeNameAnalysis

Whether the details on the check match the recipient name of the check transfer. This is an optional feature, contact sales to enable.

Returns:



122
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 122

required :payee_name_analysis, enum: -> { Increase::InboundCheckDeposit::PayeeNameAnalysis }

#status ⇒ Symbol, Increase::Models::InboundCheckDeposit::Status

The status of the Inbound Check Deposit.

Returns:



128
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 128

required :status, enum: -> { Increase::InboundCheckDeposit::Status }

#transaction_id ⇒ String?

If the deposit attempt has been accepted, the identifier of the Transaction object created as a result of the successful deposit.

Returns:

  • (String, nil) 


135
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 135

required :transaction_id, String, nil?: true

#type ⇒ Symbol, Increase::Models::InboundCheckDeposit::Type

A constant representing the object’s type. For this resource it will always be ‘inbound_check_deposit`.

Returns:



142
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 142

required :type, enum: -> { Increase::InboundCheckDeposit::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/inbound_check_deposit.rb', line 243