Class: Increase::Models::WireDrawdownRequestCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/increase/models/wire_drawdown_request_create_params.rb

Overview

See Also:

Defined Under Namespace

Modules: ChargeBearer Classes: CreditorAddress, DebtorAddress

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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 DebtorAddress for more details.

The debtor’s address.

Parameters:

  • city (String) —

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

  • country (String) —

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

  • line1 (String) —

    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 154

Instance Attribute Details

#account_number_id ⇒ String

The Account Number to which the debtor should send funds.

Returns:

  • (String) 


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


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

required :amount, Integer

#charge_bearer ⇒ Symbol, ...

Determines who bears the cost of the drawdown request. Defaults to ‘shared` if not specified.

Returns:



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

optional :charge_bearer, enum: -> { Increase::WireDrawdownRequestCreateParams::ChargeBearer }

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

The creditor’s address.

Returns:



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


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


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

optional :debtor_account_number, String

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

The debtor’s address.

Returns:



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


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

optional :debtor_external_account_id, String

#debtor_name ⇒ String

The debtor’s name.

Returns:

  • (String) 


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


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

optional :debtor_routing_number, String

#end_to_end_identification ⇒ String?

A free-form reference string set by the sender mirrored back in the subsequent wire transfer.

Returns:

  • (String, nil) 


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

optional :end_to_end_identification, String

#unstructured_remittance_information ⇒ String

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

Returns:

  • (String) 


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

required :unstructured_remittance_information, String