Class: Increase::Models::WireDrawdownRequestCreateParams::CreditorAddress

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

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_id: , amount: , creditor_address: , creditor_name: , debtor_address: , debtor_name: , unstructured_remittance_information: , debtor_account_number: nil, debtor_external_account_id: nil, debtor_routing_number: nil, request_options: {}) ⇒ Object

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

Parameters:

  • account_number_id (String) (defaults to: ) —

    The Account Number to which the debtor should send funds.

  • amount (Integer) (defaults to: ) —

    The amount requested from the debtor, in USD cents.

  • creditor_address (Increase::Models::WireDrawdownRequestCreateParams::CreditorAddress) (defaults to: ) —

    The creditor’s address.

  • creditor_name (String) (defaults to: ) —

    The creditor’s name.

  • debtor_address (Increase::Models::WireDrawdownRequestCreateParams::DebtorAddress) (defaults to: ) —

    The debtor’s address.

  • debtor_name (String) (defaults to: ) —

    The debtor’s name.

  • unstructured_remittance_information (String) (defaults to: ) —

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

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

    The debtor’s account number.

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

    The ID of an External Account to initiate a transfer to. If this parameter is pr

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

    The debtor’s routing number.

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 


97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/increase/models/wire_drawdown_request_create_params.rb', line 97

class CreditorAddress < Increase::Internal::Type::BaseModel
  # @!attribute city
  #   The city, district, town, or village of the address.
  #
  #   @return [String]
  required :city, String

  # @!attribute country
  #   The two-letter
  #   [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for
  #   the country of the address.
  #
  #   @return [String]
  required :country, String

  # @!attribute line1
  #   The first line of the address. This is usually the street number and street.
  #
  #   @return [String]
  required :line1, String

  # @!attribute line2
  #   The second line of the address. This might be the floor or room number.
  #
  #   @return [String, nil]
  optional :line2, String

  # @!attribute postal_code
  #   The ZIP code of the address.
  #
  #   @return [String, nil]
  optional :postal_code, String

  # @!attribute state
  #   The address state.
  #
  #   @return [String, nil]
  optional :state, String

  # @!method initialize(city:, country:, line1:, line2: nil, postal_code: nil, state: nil)
  #   Some parameter documentations has been truncated, see
  #   {Increase::Models::WireDrawdownRequestCreateParams::CreditorAddress} for more
  #   details.
  #
  #   The creditor's address.
  #
  #   @param city [String] The city, district, town, or village of the address.
  #
  #   @param country [String] The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alp
  #
  #   @param line1 [String] The first line of the address. This is usually the street number and street.
  #
  #   @param line2 [String] The second line of the address. This might be the floor or room number.
  #
  #   @param postal_code [String] The ZIP code of the address.
  #
  #   @param state [String] The address state.
end

Instance Attribute Details

#city ⇒ String

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

Returns:

  • (String) 


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

required :city, String

#country ⇒ String

The two-letter [ISO 3166-1 alpha-2](en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country of the address.

Returns:

  • (String) 


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

required :country, String

#line1 ⇒ String

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

Returns:

  • (String) 


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

required :line1, String

#line2 ⇒ String?

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

Returns:

  • (String, nil) 


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

optional :line2, String

#postal_code ⇒ String?

The ZIP code of the address.

Returns:

  • (String, nil) 


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

optional :postal_code, String

#state ⇒ String?

The address state.

Returns:

  • (String, nil) 


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

optional :state, String