Class: Increase::Models::InboundCheckDeposit

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Increase::Models::InboundCheckDeposit

Defined in:

lib/increase/models/inbound_check_deposit.rb,
sig/increase/models/inbound_check_deposit.rbs

Overview

See Also:

• Increase::Resources::InboundCheckDeposits#retrieve

Defined Under Namespace

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

Instance Attribute Summary

• #accepted_at ⇒ Time^?

  If the Inbound Check Deposit was accepted, the ISO 8601 date and time at which this took place.

• #account_id ⇒ String

  The Account the check is being deposited against.

• #account_number_id ⇒ String^?

  The Account Number the check is being deposited against.

• #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.

• #amount ⇒ Integer

  The deposited amount in USD cents.

• #automatically_resolves_at ⇒ Time

  The ISO 8601 date and time at which the Inbound Check Deposit will be automatically resolved if it has not been actioned by then.

• #back_image_file_id ⇒ String^?

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

• #bank_of_first_deposit_routing_number ⇒ String^?

  The American Bankers' Association (ABA) Routing Transit Number (RTN) for the bank depositing this check.

• #check_number ⇒ String^?

  The check number printed on the check being deposited.

• #check_transfer_id ⇒ String^?

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

• #created_at ⇒ Time

  The ISO 8601 date and time at which the deposit was attempted.

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

  The ISO 4217 code for the deposit.

• #declined_at ⇒ Time^?

  If the Inbound Check Deposit was declined, the ISO 8601 date and time at which this took place.

• #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.

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

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

• #front_image_file_id ⇒ String^?

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

• #id ⇒ String

  The deposit's identifier.

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

  Whether the details on the check match the recipient name of the check transfer.

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

  The status of the Inbound Check Deposit.

• #transaction_id ⇒ String^?

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

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

  A constant representing the object's type.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize ⇒ Object constructor
• #to_hash ⇒ {

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 ⇒ Object

# File 'sig/increase/models/inbound_check_deposit.rbs', line 71

def initialize: (

Instance Attribute Details

#accepted_at ⇒ Time^?

If the Inbound Check Deposit was accepted, the ISO 8601 date and time at which this took place.

Parameters:

• value (Time, nil)

Returns:

• (Time, nil)

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

Parameters:

• value (String)

Returns:

• (String)

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

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

Parameters:

• value (::Array[Increase::InboundCheckDeposit::Adjustment])

Returns:

• (Array<Increase::Models::InboundCheckDeposit::Adjustment>)

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

Parameters:

• value (Integer)

Returns:

• (Integer)

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

required :amount, Integer

#automatically_resolves_at ⇒ Time

The ISO 8601 date and time at which the Inbound Check Deposit will be automatically resolved if it has not been actioned by then.

Parameters:

• value (Time)

Returns:

• (Time)

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

required :automatically_resolves_at, Time

#back_image_file_id ⇒ String^?

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

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

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.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

required :bank_of_first_deposit_routing_number, String, nil?: true

#check_number ⇒ String^?

The check number printed on the check being deposited.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

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.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

required :check_transfer_id, String, nil?: true

#created_at ⇒ Time

The ISO 8601 date and time at which the deposit was attempted.

Parameters:

• value (Time)

Returns:

• (Time)

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

required :created_at, Time

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

The ISO 4217 code for the deposit.

Parameters:

• value (Increase::Models::InboundCheckDeposit::currency)

Returns:

• (Symbol, Increase::Models::InboundCheckDeposit::Currency)

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

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

#declined_at ⇒ Time^?

If the Inbound Check Deposit was declined, the ISO 8601 date and time at which this took place.

Parameters:

• value (Time, nil)

Returns:

• (Time, nil)

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

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.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

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.

Parameters:

• value (Increase::InboundCheckDeposit::DepositReturn, nil)

Returns:

• (Increase::Models::InboundCheckDeposit::DepositReturn, nil)

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

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.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

required :front_image_file_id, String, nil?: true

#id ⇒ String

The deposit's identifier.

Parameters:

• value (String)

Returns:

• (String)

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

Parameters:

• value (Increase::Models::InboundCheckDeposit::payee_name_analysis)

Returns:

• (Symbol, Increase::Models::InboundCheckDeposit::PayeeNameAnalysis)

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

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

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

The status of the Inbound Check Deposit.

Parameters:

• value (Increase::Models::InboundCheckDeposit::status)

Returns:

• (Symbol, Increase::Models::InboundCheckDeposit::Status)

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

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.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

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.

Parameters:

• value (Increase::Models::InboundCheckDeposit::type_)

Returns:

• (Symbol, Increase::Models::InboundCheckDeposit::Type)

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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/increase/models/inbound_check_deposit.rbs', line 95

def to_hash: -> {