Class: Increase::Models::InboundACHTransfer::InternationalAddenda

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/increase/models/inbound_ach_transfer.rb

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

#[], #inspect, #to_h, #to_s

Instance Attribute Details

#destination_country_code ⇒ String

The ISO 3166, Alpha-2 country code of the destination country.

Returns:

  • (String) 


226
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 226

required :destination_country_code, String

#destination_currency_code ⇒ String

The ISO 4217 currency code for the destination bank account.

Returns:

  • (String) 


231
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 231

required :destination_currency_code, String

#foreign_exchange_indicator ⇒ Symbol

A description of how the foreign exchange rate was calculated.

Returns:

  • (Symbol) 


236
237
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 236

required :foreign_exchange_indicator,
Increase::Enum.new(:fixed_to_variable, :variable_to_fixed, :fixed_to_fixed)

#foreign_exchange_reference ⇒ String

Depending on the foreign_exchange_reference_indicator, an exchange rate or a reference to a well-known rate.

Returns:

  • (String) 


242
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 242

required :foreign_exchange_reference, String

#foreign_exchange_reference_indicator ⇒ Symbol

An instruction of how to interpret the foreign_exchange_reference field for this Transaction.

Returns:

  • (Symbol) 


247
248
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 247

required :foreign_exchange_reference_indicator,
Increase::Enum.new(:foreign_exchange_rate, :foreign_exchange_reference_number, :blank)

#foreign_payment_amount ⇒ Integer

The amount in the minor unit of the foreign payment currency. For dollars, for example, this is cents.

Returns:

  • (Integer) 


253
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 253

required :foreign_payment_amount, Integer

#foreign_trace_number ⇒ String

A reference number in the foreign banking infrastructure.

Returns:

  • (String) 


258
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 258

required :foreign_trace_number, String

#international_transaction_type_code ⇒ Symbol

The type of transfer. Set by the originator.

Returns:

  • (Symbol) 


263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 263

required :international_transaction_type_code,
Increase::Enum.new(
  :annuity,
  :business_or_commercial,
  :deposit,
  :loan,
  :miscellaneous,
  :mortgage,
  :pension,
  :remittance,
  :rent_or_lease,
  :salary_or_payroll,
  :tax,
  :accounts_receivable,
  :back_office_conversion,
  :machine_transfer,
  :point_of_purchase,
  :point_of_sale,
  :represented_check,
  :shared_network_transaction,
  :telphone_initiated,
  :internet_initiated
)

#originating_currency_code ⇒ String

The ISO 4217 currency code for the originating bank account.

Returns:

  • (String) 


290
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 290

required :originating_currency_code, String

#originating_depository_financial_institution_branch_country ⇒ String

The ISO 3166, Alpha-2 country code of the originating branch country.

Returns:

  • (String) 


295
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 295

required :originating_depository_financial_institution_branch_country, String

#originating_depository_financial_institution_id ⇒ String

An identifier for the originating bank. One of an International Bank Account Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a domestic identifier like a US Routing Number.

Returns:

  • (String) 


300
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 300

required :originating_depository_financial_institution_id, String

#originating_depository_financial_institution_id_qualifier ⇒ Symbol

An instruction of how to interpret the originating_depository_financial_institution_id field for this Transaction.

Returns:

  • (Symbol) 


305
306
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 305

required :originating_depository_financial_institution_id_qualifier,
Increase::Enum.new(:national_clearing_system_number, :bic_code, :iban)

#originating_depository_financial_institution_name ⇒ String

The name of the originating bank. Sometimes this will refer to an American bank and obscure the correspondent foreign bank.

Returns:

  • (String) 


311
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 311

required :originating_depository_financial_institution_name, String

#originator_city ⇒ String

A portion of the originator address. This may be incomplete.

Returns:

  • (String) 


316
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 316

required :originator_city, String

#originator_country ⇒ String

A portion of the originator address. The ISO 3166, Alpha-2 country code of the originator country.

Returns:

  • (String) 


321
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 321

required :originator_country, String

#originator_identification ⇒ String

An identifier for the originating company. This is generally stable across multiple ACH transfers.

Returns:

  • (String) 


326
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 326

required :originator_identification, String

#originator_name ⇒ String

Either the name of the originator or an intermediary money transmitter.

Returns:

  • (String) 


331
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 331

required :originator_name, String

#originator_postal_code ⇒ String

A portion of the originator address. This may be incomplete.

Returns:

  • (String) 


336
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 336

required :originator_postal_code, String

#originator_state_or_province ⇒ String

A portion of the originator address. This may be incomplete.

Returns:

  • (String) 


341
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 341

required :originator_state_or_province, String

#originator_street_address ⇒ String

A portion of the originator address. This may be incomplete.

Returns:

  • (String) 


346
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 346

required :originator_street_address, String

#payment_related_information ⇒ String

A description field set by the originator.

Returns:

  • (String) 


351
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 351

required :payment_related_information, String

#payment_related_information2 ⇒ String

A description field set by the originator.

Returns:

  • (String) 


356
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 356

required :payment_related_information2, String

#receiver_city ⇒ String

A portion of the receiver address. This may be incomplete.

Returns:

  • (String) 


361
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 361

required :receiver_city, String

#receiver_country ⇒ String

A portion of the receiver address. The ISO 3166, Alpha-2 country code of the receiver country.

Returns:

  • (String) 


366
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 366

required :receiver_country, String

#receiver_identification_number ⇒ String

An identification number the originator uses for the receiver.

Returns:

  • (String) 


371
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 371

required :receiver_identification_number, String

#receiver_postal_code ⇒ String

A portion of the receiver address. This may be incomplete.

Returns:

  • (String) 


376
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 376

required :receiver_postal_code, String

#receiver_state_or_province ⇒ String

A portion of the receiver address. This may be incomplete.

Returns:

  • (String) 


381
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 381

required :receiver_state_or_province, String

#receiver_street_address ⇒ String

A portion of the receiver address. This may be incomplete.

Returns:

  • (String) 


386
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 386

required :receiver_street_address, String

#receiving_company_or_individual_name ⇒ String

The name of the receiver of the transfer. This is not verified by Increase.

Returns:

  • (String) 


391
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 391

required :receiving_company_or_individual_name, String

#receiving_depository_financial_institution_country ⇒ String

The ISO 3166, Alpha-2 country code of the receiving bank country.

Returns:

  • (String) 


396
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 396

required :receiving_depository_financial_institution_country, String

#receiving_depository_financial_institution_id ⇒ String

An identifier for the receiving bank. One of an International Bank Account Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a domestic identifier like a US Routing Number.

Returns:

  • (String) 


401
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 401

required :receiving_depository_financial_institution_id, String

#receiving_depository_financial_institution_id_qualifier ⇒ Symbol

An instruction of how to interpret the receiving_depository_financial_institution_id field for this Transaction.

Returns:

  • (Symbol) 


406
407
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 406

required :receiving_depository_financial_institution_id_qualifier,
Increase::Enum.new(:national_clearing_system_number, :bic_code, :iban)

#receiving_depository_financial_institution_name ⇒ String

The name of the receiving bank, as set by the sending financial institution.

Returns:

  • (String) 


412
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 412

required :receiving_depository_financial_institution_name, String