Class: Increase::Models::FednowTransferCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/increase/models/fednow_transfer_create_params.rb

Overview

See Also:

• Resources::FednowTransfers#create

Defined Under Namespace

Classes: CreditorAddress, DebtorAddress

Instance Attribute Summary

• #account_id ⇒ String

  The identifier for the account that will send the transfer.

• #account_number ⇒ String^?

  The creditor’s account number.

• #amount ⇒ Integer

  The amount, in minor units, to send to the creditor.

• #creditor_address ⇒ Increase::Models::FednowTransferCreateParams::CreditorAddress^?

  The creditor’s address.

• #creditor_name ⇒ String

  The creditor’s name.

• #debtor_address ⇒ Increase::Models::FednowTransferCreateParams::DebtorAddress^?

  The debtor’s address.

• #debtor_name ⇒ String

  The debtor’s name.

• #external_account_id ⇒ String^?

  The ID of an External Account to initiate a transfer to.

• #require_approval ⇒ Boolean^?

  Whether the transfer requires explicit approval via the dashboard or API.

• #routing_number ⇒ String^?

  The creditor’s bank account routing number.

• #source_account_number_id ⇒ String

  The Account Number to include in the transfer as the debtor’s account number.

• #unstructured_remittance_information ⇒ String

  Unstructured remittance information to include in the transfer.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(city: , postal_code: , state: , line1: nil) ⇒ Object constructor

  The creditor’s address.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(city: , postal_code: , state: , line1: nil) ⇒ Object

The creditor’s address.

Parameters:

• city (String) (defaults to: ) —

  The city, district, town, or village of the address.

• postal_code (String) (defaults to: ) —

  The postal code component of the address.

• state (String) (defaults to: ) —

  The US state component of the address.

• line1 (String) (defaults to: nil) —

  The first line of the address. This is usually the street number and street.

# File 'lib/increase/models/fednow_transfer_create_params.rb', line 138

Instance Attribute Details

#account_id ⇒ String

The identifier for the account that will send the transfer.

Returns:

• (String)

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

required :account_id, String

#account_number ⇒ String^?

The creditor’s account number.

Returns:

• (String, nil)

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

optional :account_number, String

#amount ⇒ Integer

The amount, in minor units, to send to the creditor.

Returns:

• (Integer)

# File 'lib/increase/models/fednow_transfer_create_params.rb', line 20

required :amount, Integer

#creditor_address ⇒ Increase::Models::FednowTransferCreateParams::CreditorAddress^?

The creditor’s address.

Returns:

• (Increase::Models::FednowTransferCreateParams::CreditorAddress, nil)

# File 'lib/increase/models/fednow_transfer_create_params.rb', line 56

optional :creditor_address, -> { Increase::FednowTransferCreateParams::CreditorAddress }

#creditor_name ⇒ String

The creditor’s name.

Returns:

• (String)

# File 'lib/increase/models/fednow_transfer_create_params.rb', line 26

required :creditor_name, String

#debtor_address ⇒ Increase::Models::FednowTransferCreateParams::DebtorAddress^?

The debtor’s address.

Returns:

• (Increase::Models::FednowTransferCreateParams::DebtorAddress, nil)

# File 'lib/increase/models/fednow_transfer_create_params.rb', line 62

optional :debtor_address, -> { Increase::FednowTransferCreateParams::DebtorAddress }

#debtor_name ⇒ String

The debtor’s name.

Returns:

• (String)

# File 'lib/increase/models/fednow_transfer_create_params.rb', line 32

required :debtor_name, String

#external_account_id ⇒ String^?

The ID of an External Account to initiate a transfer to. If this parameter is provided, ‘account_number` and `routing_number` must be absent.

Returns:

• (String, nil)

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

optional :external_account_id, String

#require_approval ⇒ Boolean^?

Whether the transfer requires explicit approval via the dashboard or API.

Returns:

• (Boolean, nil)

# File 'lib/increase/models/fednow_transfer_create_params.rb', line 75

optional :require_approval, Increase::Internal::Type::Boolean

#routing_number ⇒ String^?

The creditor’s bank account routing number.

Returns:

• (String, nil)

# File 'lib/increase/models/fednow_transfer_create_params.rb', line 81

optional :routing_number, String

#source_account_number_id ⇒ String

The Account Number to include in the transfer as the debtor’s account number.

Returns:

• (String)

# File 'lib/increase/models/fednow_transfer_create_params.rb', line 38

required :source_account_number_id, String

#unstructured_remittance_information ⇒ String

Unstructured remittance information to include in the transfer.

Returns:

• (String)

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

required :unstructured_remittance_information, String