Class: Increase::Models::CheckDeposit

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/increase/models/check_deposit.rb

Defined Under Namespace

Classes: DepositAcceptance, DepositRejection, DepositReturn, DepositSubmission

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

#[], #inspect, #to_h, #to_s

Instance Attribute Details

#account_id ⇒ String

The Account the check was deposited into.

Returns:

  • (String) 


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

required :account_id, String

#amount ⇒ Integer

The deposited amount in the minor unit of the destination account currency. For dollars, for example, this is cents.

Returns:

  • (Integer) 


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

required :amount, Integer

#back_image_file_id ⇒ String

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

Returns:

  • (String) 


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

required :back_image_file_id, String

#created_at ⇒ String

The ISO 8601 date and time at which the transfer was created.

Returns:

  • (String) 


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

required :created_at, String

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

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

Returns:



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

required :deposit_acceptance, -> { Increase::Models::CheckDeposit::DepositAcceptance }

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

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

Returns:



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

required :deposit_rejection, -> { Increase::Models::CheckDeposit::DepositRejection }

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

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

Returns:



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

required :deposit_return, -> { Increase::Models::CheckDeposit::DepositReturn }

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



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

required :deposit_submission, -> { Increase::Models::CheckDeposit::DepositSubmission }

#description ⇒ String

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

Returns:

  • (String) 


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

required :description, String

#front_image_file_id ⇒ String

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

Returns:

  • (String) 


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

required :front_image_file_id, String

#id ⇒ String

The deposit's identifier.

Returns:

  • (String) 


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

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.

Returns:

  • (String) 


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

required :idempotency_key, String

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


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

required :inbound_mail_item_id, String

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


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

required :lockbox_id, String

#status ⇒ Symbol

The status of the Check Deposit.

Returns:

  • (Symbol) 


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

required :status, Increase::Enum.new(:pending, :submitted, :rejected, :returned)

#transaction_id ⇒ String

The ID for the Transaction created by the deposit.

Returns:

  • (String) 


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

required :transaction_id, String

#type ⇒ Symbol

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

Returns:

  • (Symbol) 


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

required :type, Increase::Enum.new(:check_deposit)