Class: Increase::Models::InboundCheckDeposit

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

Defined Under Namespace

Classes: DepositReturn

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

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

Instance Attribute Details

#accepted_at ⇒ String

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

Returns:

  • (String) 


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

required :accepted_at, String

#account_id ⇒ String

The Account the check is being deposited against.

Returns:

  • (String) 


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

required :account_id, String

#account_number_id ⇒ String

The Account Number the check is being deposited against.

Returns:

  • (String) 


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

required :account_number_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) 


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

required :amount, Integer

#back_image_file_id ⇒ String

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

Returns:

  • (String) 


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

required :back_image_file_id, String

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


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

required :bank_of_first_deposit_routing_number, String

#check_number ⇒ String

The check number printed on the check being deposited.

Returns:

  • (String) 


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

required :check_number, String

#check_transfer_id ⇒ String

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

Returns:

  • (String) 


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

required :check_transfer_id, String

#created_at ⇒ String

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

Returns:

  • (String) 


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

required :created_at, String

#currency ⇒ Symbol

The ISO 4217 code for the deposit.

Returns:

  • (Symbol) 


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

required :currency, Increase::Enum.new(:CAD, :CHF, :EUR, :GBP, :JPY, :USD)

#declined_at ⇒ String

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

Returns:

  • (String) 


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

required :declined_at, String

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


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

required :declined_transaction_id, String

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

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

Returns:



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

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

#front_image_file_id ⇒ String

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

Returns:

  • (String) 


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

required :front_image_file_id, String

#id ⇒ String

The deposit's identifier.

Returns:

  • (String) 


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

required :id, String

#status ⇒ Symbol

The status of the Inbound Check Deposit.

Returns:

  • (Symbol) 


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

required :status, Increase::Enum.new(:pending, :accepted, :declined, :returned)

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


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

required :transaction_id, String

#type ⇒ Symbol

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

Returns:

  • (Symbol) 


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

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