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

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

Overview

See Also:

Defined Under Namespace

Modules: ForeignExchangeIndicator, ForeignExchangeReferenceIndicator, InternationalTransactionTypeCode, OriginatingDepositoryFinancialInstitutionIDQualifier, ReceivingDepositoryFinancialInstitutionIDQualifier

Instance Attribute Summary collapse

Class Method 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, 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(destination_country_code: , destination_currency_code: , foreign_exchange_indicator: , foreign_exchange_reference: , foreign_exchange_reference_indicator: , foreign_payment_amount: , foreign_trace_number: , international_transaction_type_code: , originating_currency_code: , originating_depository_financial_institution_branch_country: , originating_depository_financial_institution_id: , originating_depository_financial_institution_id_qualifier: , originating_depository_financial_institution_name: , originator_city: , originator_country: , originator_identification: , originator_name: , originator_postal_code: , originator_state_or_province: , originator_street_address: , payment_related_information: , payment_related_information2: , receiver_city: , receiver_country: , receiver_identification_number: , receiver_postal_code: , receiver_state_or_province: , receiver_street_address: , receiving_company_or_individual_name: , receiving_depository_financial_institution_country: , receiving_depository_financial_institution_id: , receiving_depository_financial_institution_id_qualifier: , receiving_depository_financial_institution_name: ) ⇒ Object

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

If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will contain fields pertaining to the International ACH Transaction.

Parameters:

  • destination_country_code (String) (defaults to: ) —

    The [ISO 3166](en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 countr

  • destination_currency_code (String) (defaults to: ) —

    The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) currency code for the des

  • foreign_exchange_indicator (Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ForeignExchangeIndicator) (defaults to: ) —

    A description of how the foreign exchange rate was calculated.

  • foreign_exchange_reference (String, nil) (defaults to: ) —

    Depending on the ‘foreign_exchange_reference_indicator`, an exchange rate or a r

  • foreign_exchange_reference_indicator (Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ForeignExchangeReferenceIndicator) (defaults to: ) —

    An instruction of how to interpret the ‘foreign_exchange_reference` field for th

  • foreign_payment_amount (Integer) (defaults to: ) —

    The amount in the minor unit of the foreign payment currency. For dollars, for e

  • foreign_trace_number (String, nil) (defaults to: ) —

    A reference number in the foreign banking infrastructure.

  • international_transaction_type_code (Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::InternationalTransactionTypeCode) (defaults to: ) —

    The type of transfer. Set by the originator.

  • originating_currency_code (String) (defaults to: ) —

    The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) currency code for the ori

  • originating_depository_financial_institution_branch_country (String) (defaults to: ) —

    The [ISO 3166](en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 countr

  • originating_depository_financial_institution_id (String) (defaults to: ) —

    An identifier for the originating bank. One of an International Bank Account Num

  • originating_depository_financial_institution_id_qualifier (Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::OriginatingDepositoryFinancialInstitutionIDQualifier) (defaults to: ) —

    An instruction of how to interpret the ‘originating_depository_financial_institu

  • originating_depository_financial_institution_name (String) (defaults to: ) —

    The name of the originating bank. Sometimes this will refer to an American bank

  • originator_city (String) (defaults to: ) —

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

  • originator_country (String) (defaults to: ) —

    A portion of the originator address. The [ISO 3166](en.wikipedia.org/wik

  • originator_identification (String) (defaults to: ) —

    An identifier for the originating company. This is generally stable across multi

  • originator_name (String) (defaults to: ) —

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

  • originator_postal_code (String, nil) (defaults to: ) —

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

  • originator_state_or_province (String, nil) (defaults to: ) —

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

  • originator_street_address (String) (defaults to: ) —

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

  • payment_related_information (String, nil) (defaults to: ) —

    A description field set by the originator.

  • payment_related_information2 (String, nil) (defaults to: ) —

    A description field set by the originator.

  • receiver_city (String) (defaults to: ) —

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

  • receiver_country (String) (defaults to: ) —

    A portion of the receiver address. The [ISO 3166](en.wikipedia.org/wiki/

  • receiver_identification_number (String, nil) (defaults to: ) —

    An identification number the originator uses for the receiver.

  • receiver_postal_code (String, nil) (defaults to: ) —

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

  • receiver_state_or_province (String, nil) (defaults to: ) —

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

  • receiver_street_address (String) (defaults to: ) —

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

  • receiving_company_or_individual_name (String) (defaults to: ) —

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

  • receiving_depository_financial_institution_country (String) (defaults to: ) —

    The [ISO 3166](en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 countr

  • receiving_depository_financial_institution_id (String) (defaults to: ) —

    An identifier for the receiving bank. One of an International Bank Account Numbe

  • receiving_depository_financial_institution_id_qualifier (Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ReceivingDepositoryFinancialInstitutionIDQualifier) (defaults to: ) —

    An instruction of how to interpret the ‘receiving_depository_financial_instituti

  • receiving_depository_financial_institution_name (String) (defaults to: ) —

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




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

Instance Attribute Details

#destination_country_code ⇒ String

The [ISO 3166](en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of the destination country.

Returns:

  • (String) 


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

required :destination_country_code, String

#destination_currency_code ⇒ String

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) currency code for the destination bank account.

Returns:

  • (String) 


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

required :destination_currency_code, String

#foreign_exchange_indicator ⇒ Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ForeignExchangeIndicator

A description of how the foreign exchange rate was calculated.

Returns:



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

required :foreign_exchange_indicator,
enum: -> { Increase::InboundACHTransfer::InternationalAddenda::ForeignExchangeIndicator }

#foreign_exchange_reference ⇒ String?

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

Returns:

  • (String, nil) 


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

required :foreign_exchange_reference, String, nil?: true

#foreign_exchange_reference_indicator ⇒ Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ForeignExchangeReferenceIndicator

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

Returns:



469
470
471
472
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 469

required :foreign_exchange_reference_indicator,
enum: -> {
  Increase::InboundACHTransfer::InternationalAddenda::ForeignExchangeReferenceIndicator
}

#foreign_payment_amount ⇒ Integer

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

Returns:

  • (Integer) 


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

required :foreign_payment_amount, Integer

#foreign_trace_number ⇒ String?

A reference number in the foreign banking infrastructure.

Returns:

  • (String, nil) 


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

required :foreign_trace_number, String, nil?: true

#international_transaction_type_code ⇒ Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::InternationalTransactionTypeCode

The type of transfer. Set by the originator.

Returns:



491
492
493
494
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 491

required :international_transaction_type_code,
enum: -> {
  Increase::InboundACHTransfer::InternationalAddenda::InternationalTransactionTypeCode
}

#originating_currency_code ⇒ String

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) currency code for the originating bank account.

Returns:

  • (String) 


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

required :originating_currency_code, String

#originating_depository_financial_institution_branch_country ⇒ String

The [ISO 3166](en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of the originating branch country.

Returns:

  • (String) 


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

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) 


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

required :originating_depository_financial_institution_id, String

#originating_depository_financial_institution_id_qualifier ⇒ Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::OriginatingDepositoryFinancialInstitutionIDQualifier

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

Returns:



523
524
525
526
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 523

required :originating_depository_financial_institution_id_qualifier,
enum: -> {
  Increase::InboundACHTransfer::InternationalAddenda::OriginatingDepositoryFinancialInstitutionIDQualifier
}

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


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

required :originating_depository_financial_institution_name, String

#originator_city ⇒ String

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

Returns:

  • (String) 


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

required :originator_city, String

#originator_country ⇒ String

A portion of the originator address. The [ISO 3166](en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of the originator country.

Returns:

  • (String) 


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

required :originator_country, String

#originator_identification ⇒ String

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

Returns:

  • (String) 


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

required :originator_identification, String

#originator_name ⇒ String

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

Returns:

  • (String) 


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

required :originator_name, String

#originator_postal_code ⇒ String?

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

Returns:

  • (String, nil) 


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

required :originator_postal_code, String, nil?: true

#originator_state_or_province ⇒ String?

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

Returns:

  • (String, nil) 


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

required :originator_state_or_province, String, nil?: true

#originator_street_address ⇒ String

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

Returns:

  • (String) 


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

required :originator_street_address, String

#payment_related_information ⇒ String?

A description field set by the originator.

Returns:

  • (String, nil) 


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

required :payment_related_information, String, nil?: true

#payment_related_information2 ⇒ String?

A description field set by the originator.

Returns:

  • (String, nil) 


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

required :payment_related_information2, String, nil?: true

#receiver_city ⇒ String

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

Returns:

  • (String) 


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

required :receiver_city, String

#receiver_country ⇒ String

A portion of the receiver address. The [ISO 3166](en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of the receiver country.

Returns:

  • (String) 


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

required :receiver_country, String

#receiver_identification_number ⇒ String?

An identification number the originator uses for the receiver.

Returns:

  • (String, nil) 


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

required :receiver_identification_number, String, nil?: true

#receiver_postal_code ⇒ String?

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

Returns:

  • (String, nil) 


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

required :receiver_postal_code, String, nil?: true

#receiver_state_or_province ⇒ String?

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

Returns:

  • (String, nil) 


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

required :receiver_state_or_province, String, nil?: true

#receiver_street_address ⇒ String

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

Returns:

  • (String) 


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

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) 


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

required :receiving_company_or_individual_name, String

#receiving_depository_financial_institution_country ⇒ String

The [ISO 3166](en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of the receiving bank country.

Returns:

  • (String) 


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

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) 


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

required :receiving_depository_financial_institution_id, String

#receiving_depository_financial_institution_id_qualifier ⇒ Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ReceivingDepositoryFinancialInstitutionIDQualifier

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

Returns:



656
657
658
659
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 656

required :receiving_depository_financial_institution_id_qualifier,
enum: -> {
  Increase::InboundACHTransfer::InternationalAddenda::ReceivingDepositoryFinancialInstitutionIDQualifier
}

#receiving_depository_financial_institution_name ⇒ String

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

Returns:

  • (String) 


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

required :receiving_depository_financial_institution_name, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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