Class: Increase::Models::CheckDeposit::DepositAcceptance

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

Overview

See Also:

Defined Under Namespace

Modules: Currency

Instance Attribute 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(account_number: , amount: , auxiliary_on_us: , check_deposit_id: , currency: , routing_number: , serial_number: ) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::CheckDeposit::DepositAcceptance for more details.

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

Parameters:

  • account_number (String) (defaults to: ) —

    The account number printed on the check. This is an account at the bank that iss

  • amount (Integer) (defaults to: ) —

    The amount to be deposited in the minor unit of the transaction’s currency. For

  • auxiliary_on_us (String, nil) (defaults to: ) —

    An additional line of metadata printed on the check. This typically includes the

  • check_deposit_id (String) (defaults to: ) —

    The ID of the Check Deposit that was accepted.

  • currency (Symbol, Increase::Models::CheckDeposit::DepositAcceptance::Currency) (defaults to: ) —

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

  • routing_number (String) (defaults to: ) —

    The routing number printed on the check. This is a routing number for the bank t

  • serial_number (String, nil) (defaults to: ) —

    The check serial number, if present, for consumer checks. For business checks, t




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

Instance Attribute Details

#account_number ⇒ String

The account number printed on the check. This is an account at the bank that issued the check.

Returns:

  • (String) 


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

required :account_number, String

#amount ⇒ Integer

The amount to be deposited in the minor unit of the transaction’s currency. For dollars, for example, this is cents.

Returns:

  • (Integer) 


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

required :amount, Integer

#auxiliary_on_us ⇒ String?

An additional line of metadata printed on the check. This typically includes the check number for business checks.

Returns:

  • (String, nil) 


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

required :auxiliary_on_us, String, nil?: true

#check_deposit_id ⇒ String

The ID of the Check Deposit that was accepted.

Returns:

  • (String) 


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

required :check_deposit_id, String

#currency ⇒ Symbol, Increase::Models::CheckDeposit::DepositAcceptance::Currency

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the transaction’s currency.

Returns:



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

required :currency, enum: -> { Increase::CheckDeposit::DepositAcceptance::Currency }

#routing_number ⇒ String

The routing number printed on the check. This is a routing number for the bank that issued the check.

Returns:

  • (String) 


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

required :routing_number, String

#serial_number ⇒ String?

The check serial number, if present, for consumer checks. For business checks, the serial number is usually in the ‘auxiliary_on_us` field.

Returns:

  • (String, nil) 


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

required :serial_number, String, nil?: true