Class: Increase::Models::CheckDeposit

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

Overview

See Also:

Defined Under Namespace

Modules: Status, Type Classes: DepositAcceptance, DepositRejection, DepositReturn, DepositSubmission, InboundFundsHold

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(back_file_id: , front_file_id: , submitted_at: ) ⇒ Object

Some parameter documentations has been truncated, see DepositSubmission for more details.

After the check is parsed, it is submitted to the Check21 network for processing. This will contain details of the submission.

Parameters:

  • back_file_id (String) (defaults to: ) —

    The ID for the File containing the check back image that was submitted to the Ch

  • front_file_id (String) (defaults to: ) —

    The ID for the File containing the check front image that was submitted to the C

  • submitted_at (Time) (defaults to: ) —

    When the check deposit was submitted to the Check21 network for processing. Duri




# File 'lib/increase/models/check_deposit.rb', line 126

Instance Attribute Details

#account_id ⇒ String

The Account the check was deposited into.

Returns:

  • (String) 


17
 
# File 'lib/increase/models/check_deposit.rb', line 17

required :account_id, String

#amount ⇒ Integer

The deposited amount in USD cents.

Returns:

  • (Integer) 


23
 
# File 'lib/increase/models/check_deposit.rb', line 23

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) 


29
 
# File 'lib/increase/models/check_deposit.rb', line 29

required :back_image_file_id, String, nil?: true

#created_at ⇒ Time

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

Returns:

  • (Time) 


36
 
# File 'lib/increase/models/check_deposit.rb', line 36

required :created_at, Time

#deposit_acceptance ⇒ Increase::Models::CheckDeposit::DepositAcceptance?

Once your deposit is successfully parsed and accepted by Increase, this will contain details of the parsed check.

Returns:



43
 
# File 'lib/increase/models/check_deposit.rb', line 43

required :deposit_acceptance, -> { Increase::CheckDeposit::DepositAcceptance }, nil?: true

#deposit_rejection ⇒ Increase::Models::CheckDeposit::DepositRejection?

If your deposit is rejected by Increase, this will contain details as to why it was rejected.

Returns:



50
 
# File 'lib/increase/models/check_deposit.rb', line 50

required :deposit_rejection, -> { Increase::CheckDeposit::DepositRejection }, nil?: true

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

If your deposit is returned, this will contain details as to why it was returned.

Returns:



57
 
# File 'lib/increase/models/check_deposit.rb', line 57

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

#deposit_submission ⇒ Increase::Models::CheckDeposit::DepositSubmission?

After the check is parsed, it is submitted to the Check21 network for processing. This will contain details of the submission.

Returns:



64
 
# File 'lib/increase/models/check_deposit.rb', line 64

required :deposit_submission, -> { Increase::CheckDeposit::DepositSubmission }, nil?: true

#description ⇒ String?

The description of the Check Deposit, for display purposes only.

Returns:

  • (String, nil) 


70
 
# File 'lib/increase/models/check_deposit.rb', line 70

required :description, String, nil?: true

#front_image_file_id ⇒ String

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

Returns:

  • (String) 


76
 
# File 'lib/increase/models/check_deposit.rb', line 76

required :front_image_file_id, String

#id ⇒ String

The deposit’s identifier.

Returns:

  • (String) 


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

required :id, String

#idempotency_key ⇒ String?

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](increase.com/documentation/idempotency-keys).

Returns:

  • (String, nil) 


84
 
# File 'lib/increase/models/check_deposit.rb', line 84

required :idempotency_key, String, nil?: true

#inbound_funds_hold ⇒ Increase::Models::CheckDeposit::InboundFundsHold?

Increase will sometimes hold the funds for Check Deposits. If funds are held, this sub-object will contain details of the hold.

Returns:



91
 
# File 'lib/increase/models/check_deposit.rb', line 91

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

#inbound_mail_item_id ⇒ String?

If the Check Deposit was the result of an Inbound Mail Item, this will contain the identifier of the Inbound Mail Item.

Returns:

  • (String, nil) 


98
 
# File 'lib/increase/models/check_deposit.rb', line 98

required :inbound_mail_item_id, String, nil?: true

#lockbox_id ⇒ String?

If the Check Deposit was the result of an Inbound Mail Item, this will contain the identifier of the Lockbox that received it.

Returns:

  • (String, nil) 


105
 
# File 'lib/increase/models/check_deposit.rb', line 105

required :lockbox_id, String, nil?: true

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

The status of the Check Deposit.

Returns:



111
 
# File 'lib/increase/models/check_deposit.rb', line 111

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

#transaction_id ⇒ String?

The ID for the Transaction created by the deposit.

Returns:

  • (String, nil) 


117
 
# File 'lib/increase/models/check_deposit.rb', line 117

required :transaction_id, String, nil?: true

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

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

Returns:



124
 
# File 'lib/increase/models/check_deposit.rb', line 124

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/check_deposit.rb', line 249