Class: Increase::Models::WireDrawdownRequestCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/increase/models/wire_drawdown_request_create_params.rb

Overview

See Also:

• Resources::WireDrawdownRequests#create

Defined Under Namespace

Classes: CreditorAddress, DebtorAddress

Instance Attribute Summary

• #account_number_id ⇒ String

  The Account Number to which the debtor should send funds.

• #amount ⇒ Integer

  The amount requested from the debtor, in USD cents.

• #creditor_address ⇒ Increase::Models::WireDrawdownRequestCreateParams::CreditorAddress

  The creditor’s address.

• #creditor_name ⇒ String

  The creditor’s name.

• #debtor_account_number ⇒ String^?

  The debtor’s account number.

• #debtor_address ⇒ Increase::Models::WireDrawdownRequestCreateParams::DebtorAddress

  The debtor’s address.

• #debtor_external_account_id ⇒ String^?

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

• #debtor_name ⇒ String

  The debtor’s name.

• #debtor_routing_number ⇒ String^?

  The debtor’s routing number.

• #unstructured_remittance_information ⇒ String

  Remittance information the debtor will see as part of the request.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

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

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

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

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

The creditor’s address.

Parameters:

• city (String) (defaults to: ) —

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

• country (String) (defaults to: ) —

  The two-letter [ISO 3166-1 alpha-2](en.wikipedia.org/wiki/ISO_3166-1_alp

• line1 (String) (defaults to: ) —

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

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

  The second line of the address. This might be the floor or room number.

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

  The ZIP code of the address.

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

  The address state.

# File 'lib/increase/models/wire_drawdown_request_create_params.rb', line 136

Instance Attribute Details

#account_number_id ⇒ String

The Account Number to which the debtor should send funds.

Returns:

• (String)

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

required :account_number_id, String

#amount ⇒ Integer

The amount requested from the debtor, in USD cents.

Returns:

• (Integer)

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

required :amount, Integer

#creditor_address ⇒ Increase::Models::WireDrawdownRequestCreateParams::CreditorAddress

The creditor’s address.

Returns:

• (Increase::Models::WireDrawdownRequestCreateParams::CreditorAddress)

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

required :creditor_address, -> { Increase::WireDrawdownRequestCreateParams::CreditorAddress }

#creditor_name ⇒ String

The creditor’s name.

Returns:

• (String)

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

required :creditor_name, String

#debtor_account_number ⇒ String^?

The debtor’s account number.

Returns:

• (String, nil)

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

optional :debtor_account_number, String

#debtor_address ⇒ Increase::Models::WireDrawdownRequestCreateParams::DebtorAddress

The debtor’s address.

Returns:

• (Increase::Models::WireDrawdownRequestCreateParams::DebtorAddress)

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

required :debtor_address, -> { Increase::WireDrawdownRequestCreateParams::DebtorAddress }

#debtor_external_account_id ⇒ String^?

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

Returns:

• (String, nil)

# File 'lib/increase/models/wire_drawdown_request_create_params.rb', line 63

optional :debtor_external_account_id, String

#debtor_name ⇒ String

The debtor’s name.

Returns:

• (String)

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

required :debtor_name, String

#debtor_routing_number ⇒ String^?

The debtor’s routing number.

Returns:

• (String, nil)

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

optional :debtor_routing_number, String

#unstructured_remittance_information ⇒ String

Remittance information the debtor will see as part of the request.

Returns:

• (String)

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

required :unstructured_remittance_information, String