modern_treasury 0.29.0 → 0.29.2

data/lib/modern_treasury/models/legal_entity.rb

@@ -26,6 +26,16 @@ module ModernTreasury
       #   @return [String, nil]
       required :business_description, String, nil?: true
 
+      # @!attribute business_designation
+      #   Legal designation associated with the business.
+      #
+      #   @return [Symbol, ModernTreasury::Models::LegalEntity::BusinessDesignation, nil]
+      required :business_designation,
+               enum: -> {
+                 ModernTreasury::LegalEntity::BusinessDesignation
+               },
+               nil?: true
+
       # @!attribute business_name
       #   The business's legal business name.
       #
@@ -299,7 +309,7 @@ module ModernTreasury
                -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityAssociation] },
                nil?: true
 
-      # @!method initialize(id:, addresses:, bank_settings:, business_description:, business_name:, citizenship_country:, compliance_details:, country_of_incorporation:, created_at:, date_formed:, date_of_birth:, discarded_at:, documents:, doing_business_as_names:, email:, expected_activity_volume:, external_id:, first_name:, identifications:, industry_classifications:, intended_use:, last_name:, legal_entity_type:, legal_structure:, listed_exchange:, live_mode:, metadata:, middle_name:, object:, operating_jurisdictions:, phone_numbers:, politically_exposed_person:, preferred_name:, prefix:, primary_social_media_sites:, regulators:, risk_rating:, service_provider_legal_entity_id:, status:, suffix:, terms_of_use:, third_party_verification:, third_party_verifications:, ticker_symbol:, updated_at:, wealth_and_employment_details:, website:, legal_entity_associations: nil)
+      # @!method initialize(id:, addresses:, bank_settings:, business_description:, business_designation:, business_name:, citizenship_country:, compliance_details:, country_of_incorporation:, created_at:, date_formed:, date_of_birth:, discarded_at:, documents:, doing_business_as_names:, email:, expected_activity_volume:, external_id:, first_name:, identifications:, industry_classifications:, intended_use:, last_name:, legal_entity_type:, legal_structure:, listed_exchange:, live_mode:, metadata:, middle_name:, object:, operating_jurisdictions:, phone_numbers:, politically_exposed_person:, preferred_name:, prefix:, primary_social_media_sites:, regulators:, risk_rating:, service_provider_legal_entity_id:, status:, suffix:, terms_of_use:, third_party_verification:, third_party_verifications:, ticker_symbol:, updated_at:, wealth_and_employment_details:, website:, legal_entity_associations: nil)
       #   Some parameter documentations has been truncated, see
       #   {ModernTreasury::Models::LegalEntity} for more details.
       #
@@ -311,6 +321,8 @@ module ModernTreasury
       #
       #   @param business_description [String, nil] A description of the business.
       #
+      #   @param business_designation [Symbol, ModernTreasury::Models::LegalEntity::BusinessDesignation, nil] Legal designation associated with the business.
+      #
       #   @param business_name [String, nil] The business's legal business name.
       #
       #   @param citizenship_country [String, nil] The country of citizenship for an individual.
@@ -530,6 +542,19 @@ module ModernTreasury
         end
       end
 
+      # Legal designation associated with the business.
+      #
+      # @see ModernTreasury::Models::LegalEntity#business_designation
+      module BusinessDesignation
+        extend ModernTreasury::Internal::Type::Enum
+
+        EXEMPT_FINANCIAL_INSTITUTION = :exempt_financial_institution
+        NON_OPERATING_BUSINESS = :non_operating_business
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       class Identification < ModernTreasury::Internal::Type::BaseModel
         # @!attribute id
         #

data/lib/modern_treasury/models/legal_entity_association.rb

@@ -2,6 +2,7 @@
 
 module ModernTreasury
   module Models
+    # @see ModernTreasury::Resources::LegalEntityAssociations#create
     class LegalEntityAssociation < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #

data/lib/modern_treasury/models/legal_entity_association_create_params.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::LegalEntityAssociations#create
+    class LegalEntityAssociationCreateParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      # @!attribute child_legal_entity_id
+      #   The ID of the child legal entity.
+      #
+      #   @return [String]
+      required :child_legal_entity_id, String
+
+      # @!attribute parent_legal_entity_id
+      #   The ID of the parent legal entity. This must be a business legal entity.
+      #
+      #   @return [String]
+      required :parent_legal_entity_id, String
+
+      # @!attribute relationship_types
+      #
+      #   @return [Array<Symbol, ModernTreasury::Models::LegalEntityAssociationCreateParams::RelationshipType>]
+      required :relationship_types,
+               -> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::LegalEntityAssociationCreateParams::RelationshipType] }
+
+      # @!attribute ownership_percentage
+      #   The child entity's ownership percentage iff they are a beneficial owner.
+      #
+      #   @return [Integer, nil]
+      optional :ownership_percentage, Integer, nil?: true
+
+      # @!attribute title
+      #   The job title of the child entity at the parent entity.
+      #
+      #   @return [String, nil]
+      optional :title, String, nil?: true
+
+      # @!method initialize(child_legal_entity_id:, parent_legal_entity_id:, relationship_types:, ownership_percentage: nil, title: nil, request_options: {})
+      #   @param child_legal_entity_id [String] The ID of the child legal entity.
+      #
+      #   @param parent_legal_entity_id [String] The ID of the parent legal entity. This must be a business legal entity.
+      #
+      #   @param relationship_types [Array<Symbol, ModernTreasury::Models::LegalEntityAssociationCreateParams::RelationshipType>]
+      #
+      #   @param ownership_percentage [Integer, nil] The child entity's ownership percentage iff they are a beneficial owner.
+      #
+      #   @param title [String, nil] The job title of the child entity at the parent entity.
+      #
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+
+      # A list of relationship types for how the child entity relates to parent entity.
+      module RelationshipType
+        extend ModernTreasury::Internal::Type::Enum
+
+        AUTHORIZED_SIGNER = :authorized_signer
+        BENEFICIAL_OWNER = :beneficial_owner
+        CONTROL_PERSON = :control_person
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/legal_entity_association_delete_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::LegalEntityAssociations#delete
+    class LegalEntityAssociationDeleteParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/modern_treasury/models/legal_entity_create_params.rb

@@ -31,6 +31,14 @@ module ModernTreasury
       #   @return [String, nil]
       optional :business_description, String, nil?: true
 
+      # @!attribute business_designation
+      #   Legal designation associated with the business.
+      #
+      #   @return [Symbol, ModernTreasury::Models::LegalEntityCreateParams::BusinessDesignation, nil]
+      optional :business_designation,
+               enum: -> { ModernTreasury::LegalEntityCreateParams::BusinessDesignation },
+               nil?: true
+
       # @!attribute business_name
       #   The business's legal business name.
       #
@@ -283,7 +291,7 @@ module ModernTreasury
       #   @return [String, nil]
       optional :website, String, nil?: true
 
-      # @!method initialize(legal_entity_type:, addresses: nil, bank_settings: nil, business_description: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, connection_id: nil, country_of_incorporation: nil, date_formed: nil, date_of_birth: nil, documents: nil, doing_business_as_names: nil, email: nil, expected_activity_volume: nil, external_id: nil, first_name: nil, identifications: nil, industry_classifications: nil, intended_use: nil, last_name: nil, legal_entity_associations: nil, legal_structure: nil, listed_exchange: nil, metadata: nil, middle_name: nil, operating_jurisdictions: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, primary_social_media_sites: nil, regulators: nil, risk_rating: nil, service_provider_legal_entity_id: nil, suffix: nil, terms_of_use: nil, third_party_verification: nil, third_party_verifications: nil, ticker_symbol: nil, wealth_and_employment_details: nil, website: nil, request_options: {})
+      # @!method initialize(legal_entity_type:, addresses: nil, bank_settings: nil, business_description: nil, business_designation: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, connection_id: nil, country_of_incorporation: nil, date_formed: nil, date_of_birth: nil, documents: nil, doing_business_as_names: nil, email: nil, expected_activity_volume: nil, external_id: nil, first_name: nil, identifications: nil, industry_classifications: nil, intended_use: nil, last_name: nil, legal_entity_associations: nil, legal_structure: nil, listed_exchange: nil, metadata: nil, middle_name: nil, operating_jurisdictions: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, primary_social_media_sites: nil, regulators: nil, risk_rating: nil, service_provider_legal_entity_id: nil, suffix: nil, terms_of_use: nil, third_party_verification: nil, third_party_verifications: nil, ticker_symbol: nil, wealth_and_employment_details: nil, website: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ModernTreasury::Models::LegalEntityCreateParams} for more details.
       #
@@ -295,6 +303,8 @@ module ModernTreasury
       #
       #   @param business_description [String, nil] A description of the business.
       #
+      #   @param business_designation [Symbol, ModernTreasury::Models::LegalEntityCreateParams::BusinessDesignation, nil] Legal designation associated with the business.
+      #
       #   @param business_name [String, nil] The business's legal business name.
       #
       #   @param citizenship_country [String, nil] The country of citizenship for an individual.
@@ -384,6 +394,17 @@ module ModernTreasury
         #   @return [Array<Symbol>]
       end
 
+      # Legal designation associated with the business.
+      module BusinessDesignation
+        extend ModernTreasury::Internal::Type::Enum
+
+        EXEMPT_FINANCIAL_INSTITUTION = :exempt_financial_institution
+        NON_OPERATING_BUSINESS = :non_operating_business
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       class Document < ModernTreasury::Internal::Type::BaseModel
         # @!attribute document_type
         #   A category given to the document, can be `null`.

data/lib/modern_treasury/models/legal_entity_update_params.rb

@@ -30,6 +30,14 @@ module ModernTreasury
       #   @return [String, nil]
       optional :business_description, String, nil?: true
 
+      # @!attribute business_designation
+      #   Legal designation associated with the business.
+      #
+      #   @return [Symbol, ModernTreasury::Models::LegalEntityUpdateParams::BusinessDesignation, nil]
+      optional :business_designation,
+               enum: -> { ModernTreasury::LegalEntityUpdateParams::BusinessDesignation },
+               nil?: true
+
       # @!attribute business_name
       #   The business's legal business name.
       #
@@ -248,7 +256,7 @@ module ModernTreasury
       #   @return [String, nil]
       optional :website, String, nil?: true
 
-      # @!method initialize(id:, addresses: nil, bank_settings: nil, business_description: nil, business_name: nil, citizenship_country: nil, country_of_incorporation: nil, date_formed: nil, date_of_birth: nil, doing_business_as_names: nil, email: nil, expected_activity_volume: nil, external_id: nil, first_name: nil, identifications: nil, industry_classifications: nil, intended_use: nil, last_name: nil, legal_structure: nil, listed_exchange: nil, metadata: nil, middle_name: nil, operating_jurisdictions: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, primary_social_media_sites: nil, regulators: nil, risk_rating: nil, service_provider_legal_entity_id: nil, suffix: nil, terms_of_use: nil, third_party_verification: nil, third_party_verifications: nil, ticker_symbol: nil, wealth_and_employment_details: nil, website: nil, request_options: {})
+      # @!method initialize(id:, addresses: nil, bank_settings: nil, business_description: nil, business_designation: nil, business_name: nil, citizenship_country: nil, country_of_incorporation: nil, date_formed: nil, date_of_birth: nil, doing_business_as_names: nil, email: nil, expected_activity_volume: nil, external_id: nil, first_name: nil, identifications: nil, industry_classifications: nil, intended_use: nil, last_name: nil, legal_structure: nil, listed_exchange: nil, metadata: nil, middle_name: nil, operating_jurisdictions: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, primary_social_media_sites: nil, regulators: nil, risk_rating: nil, service_provider_legal_entity_id: nil, suffix: nil, terms_of_use: nil, third_party_verification: nil, third_party_verifications: nil, ticker_symbol: nil, wealth_and_employment_details: nil, website: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ModernTreasury::Models::LegalEntityUpdateParams} for more details.
       #
@@ -260,6 +268,8 @@ module ModernTreasury
       #
       #   @param business_description [String, nil] A description of the business.
       #
+      #   @param business_designation [Symbol, ModernTreasury::Models::LegalEntityUpdateParams::BusinessDesignation, nil] Legal designation associated with the business.
+      #
       #   @param business_name [String, nil] The business's legal business name.
       #
       #   @param citizenship_country [String, nil] The country of citizenship for an individual.
@@ -330,6 +340,17 @@ module ModernTreasury
       #
       #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
 
+      # Legal designation associated with the business.
+      module BusinessDesignation
+        extend ModernTreasury::Internal::Type::Enum
+
+        EXEMPT_FINANCIAL_INSTITUTION = :exempt_financial_institution
+        NON_OPERATING_BUSINESS = :non_operating_business
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # The business's legal structure.
       module LegalStructure
         extend ModernTreasury::Internal::Type::Enum

data/lib/modern_treasury/models/legal_entity_update_status_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::LegalEntities#update_status
+    class LegalEntityUpdateStatusParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute status
+      #   The target status for the legal entity. One of `active`, `suspended`, or
+      #   `denied`. Valid transitions depend on the current status.
+      #
+      #   @return [Symbol, ModernTreasury::Models::LegalEntityUpdateStatusParams::Status]
+      required :status, enum: -> { ModernTreasury::LegalEntityUpdateStatusParams::Status }
+
+      # @!method initialize(id:, status:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::LegalEntityUpdateStatusParams} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param status [Symbol, ModernTreasury::Models::LegalEntityUpdateStatusParams::Status] The target status for the legal entity. One of `active`, `suspended`, or `denied
+      #
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+
+      # The target status for the legal entity. One of `active`, `suspended`, or
+      # `denied`. Valid transitions depend on the current status.
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
+        ACTIVE = :active
+        SUSPENDED = :suspended
+        DENIED = :denied
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/payment_order.rb

@@ -183,6 +183,20 @@ module ModernTreasury
       #   @return [String]
       required :originating_account_id, String
 
+      # @!attribute originating_account_type
+      #
+      #   @return [Symbol, ModernTreasury::Models::PaymentOrder::OriginatingAccountType]
+      required :originating_account_type, enum: -> { ModernTreasury::PaymentOrder::OriginatingAccountType }
+
+      # @!attribute originating_party_address
+      #   If present, this address will override the default originating party address
+      #   used on the payment order. This works across all payment types.
+      #
+      #   @return [ModernTreasury::Models::PaymentOrder::OriginatingPartyAddress, nil]
+      required :originating_party_address,
+               -> { ModernTreasury::PaymentOrder::OriginatingPartyAddress },
+               nil?: true
+
       # @!attribute originating_party_name
       #   If present, this will replace your default company name on receiver's bank
       #   statement. This field can only be used for ACH payments currently. For ACH, only
@@ -362,7 +376,7 @@ module ModernTreasury
       #   @return [String, nil]
       required :vendor_failure_reason, String, nil?: true
 
-      # @!method initialize(id:, accounting:, accounting_category_id:, accounting_ledger_class_id:, amount:, batch_id:, charge_bearer:, counterparty_id:, created_at:, currency:, current_hold:, current_return:, description:, direction:, effective_date:, expires_at:, external_id:, foreign_exchange_contract:, foreign_exchange_indicator:, foreign_exchange_rate:, ledger_transaction_id:, live_mode:, metadata:, nsf_protected:, object:, originating_account_id:, originating_party_name:, priority:, process_after:, purpose:, receiving_account_id:, receiving_account_type:, reconciliation_status:, reference_numbers:, remittance_information:, send_remittance_advice:, statement_descriptor:, status:, subtype:, transaction_ids:, type:, ultimate_originating_account:, ultimate_originating_account_id:, ultimate_originating_account_type:, ultimate_originating_party_identifier:, ultimate_originating_party_name:, ultimate_receiving_party_identifier:, ultimate_receiving_party_name:, updated_at:, vendor_attributes:, vendor_failure_reason:)
+      # @!method initialize(id:, accounting:, accounting_category_id:, accounting_ledger_class_id:, amount:, batch_id:, charge_bearer:, counterparty_id:, created_at:, currency:, current_hold:, current_return:, description:, direction:, effective_date:, expires_at:, external_id:, foreign_exchange_contract:, foreign_exchange_indicator:, foreign_exchange_rate:, ledger_transaction_id:, live_mode:, metadata:, nsf_protected:, object:, originating_account_id:, originating_account_type:, originating_party_address:, originating_party_name:, priority:, process_after:, purpose:, receiving_account_id:, receiving_account_type:, reconciliation_status:, reference_numbers:, remittance_information:, send_remittance_advice:, statement_descriptor:, status:, subtype:, transaction_ids:, type:, ultimate_originating_account:, ultimate_originating_account_id:, ultimate_originating_account_type:, ultimate_originating_party_identifier:, ultimate_originating_party_name:, ultimate_receiving_party_identifier:, ultimate_receiving_party_name:, updated_at:, vendor_attributes:, vendor_failure_reason:)
       #   Some parameter documentations has been truncated, see
       #   {ModernTreasury::Models::PaymentOrder} for more details.
       #
@@ -418,6 +432,10 @@ module ModernTreasury
       #
       #   @param originating_account_id [String] The ID of one of your organization's internal accounts.
       #
+      #   @param originating_account_type [Symbol, ModernTreasury::Models::PaymentOrder::OriginatingAccountType]
+      #
+      #   @param originating_party_address [ModernTreasury::Models::PaymentOrder::OriginatingPartyAddress, nil] If present, this address will override the default originating party address use
+      #
       #   @param originating_party_name [String, nil] If present, this will replace your default company name on receiver's bank state
       #
       #   @param priority [Symbol, ModernTreasury::Models::PaymentOrder::Priority] Either `normal` or `high`. For ACH and EFT payments, `high` represents a same-da
@@ -688,6 +706,76 @@ module ModernTreasury
         #   @return [Array<Symbol>]
       end
 
+      # @see ModernTreasury::Models::PaymentOrder#originating_account_type
+      module OriginatingAccountType
+        extend ModernTreasury::Internal::Type::Enum
+
+        INTERNAL_ACCOUNT = :internal_account
+        VIRTUAL_ACCOUNT = :virtual_account
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see ModernTreasury::Models::PaymentOrder#originating_party_address
+      class OriginatingPartyAddress < ModernTreasury::Internal::Type::BaseModel
+        # @!attribute country
+        #   Country code conforms to [ISO 3166-1 alpha-2]
+        #
+        #   @return [String, nil]
+        optional :country, String, nil?: true
+
+        # @!attribute line1
+        #
+        #   @return [String, nil]
+        optional :line1, String, nil?: true
+
+        # @!attribute line2
+        #
+        #   @return [String, nil]
+        optional :line2, String, nil?: true
+
+        # @!attribute locality
+        #   Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        #   Francisco).
+        #
+        #   @return [String, nil]
+        optional :locality, String, nil?: true
+
+        # @!attribute postal_code
+        #   The postal code of the address.
+        #
+        #   @return [String, nil]
+        optional :postal_code, String, nil?: true
+
+        # @!attribute region
+        #   Region or State. This field is free-form; for US states, we recommend a
+        #   two-letter code (e.g. CA). Full state names are also accepted.
+        #
+        #   @return [String, nil]
+        optional :region, String, nil?: true
+
+        # @!method initialize(country: nil, line1: nil, line2: nil, locality: nil, postal_code: nil, region: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::Models::PaymentOrder::OriginatingPartyAddress} for more
+        #   details.
+        #
+        #   If present, this address will override the default originating party address
+        #   used on the payment order. This works across all payment types.
+        #
+        #   @param country [String, nil] Country code conforms to [ISO 3166-1 alpha-2]
+        #
+        #   @param line1 [String, nil]
+        #
+        #   @param line2 [String, nil]
+        #
+        #   @param locality [String, nil] Locality or City. Use the full city name rather than an abbreviation (e.g. San F
+        #
+        #   @param postal_code [String, nil] The postal code of the address.
+        #
+        #   @param region [String, nil] Region or State. This field is free-form; for US states, we recommend a two-lett
+      end
+
       # Either `normal` or `high`. For ACH and EFT payments, `high` represents a
       # same-day ACH or EFT transfer, respectively. For check payments, `high` can mean
       # an overnight check rather than standard mail.
@@ -822,7 +910,6 @@ module ModernTreasury
           CROSS_RIVER_TRANSACTION_ID = :cross_river_transaction_id
           CURRENCYCLOUD_CONVERSION_ID = :currencycloud_conversion_id
           CURRENCYCLOUD_PAYMENT_ID = :currencycloud_payment_id
-          DC_BANK_TRANSACTION_ID = :dc_bank_transaction_id
           EFT_TRACE_NUMBER = :eft_trace_number
           EVOLVE_CORE_BATCH = :evolve_core_batch
           EVOLVE_CORE_FILE_KEY = :evolve_core_file_key
@@ -883,6 +970,7 @@ module ModernTreasury
           WESTERN_ALLIANCE_PAYMENT_ID = :western_alliance_payment_id
           WESTERN_ALLIANCE_TRANSACTION_ID = :western_alliance_transaction_id
           WESTERN_ALLIANCE_WIRE_CONFIRMATION_NUMBER = :western_alliance_wire_confirmation_number
+          WISE_TRANSFER_ID = :wise_transfer_id
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/modern_treasury/models/payment_order_create_async_params.rb

@@ -166,6 +166,15 @@ module ModernTreasury
       #   @return [Boolean, nil]
       optional :nsf_protected, ModernTreasury::Internal::Type::Boolean
 
+      # @!attribute originating_party_address
+      #   If present, this address will override the default originating party address
+      #   used on the payment order. This works across all payment types.
+      #
+      #   @return [ModernTreasury::Models::PaymentOrderCreateAsyncParams::OriginatingPartyAddress, nil]
+      optional :originating_party_address,
+               -> { ModernTreasury::PaymentOrderCreateAsyncParams::OriginatingPartyAddress },
+               nil?: true
+
       # @!attribute originating_party_name
       #   If present, this will replace your default company name on receiver's bank
       #   statement. This field can only be used for ACH payments currently. For ACH, only
@@ -315,7 +324,7 @@ module ModernTreasury
       optional :vendor_attributes,
                ModernTreasury::Internal::Type::HashOf[ModernTreasury::Internal::Type::Unknown]
 
-      # @!method initialize(amount:, direction:, originating_account_id:, type:, accounting: nil, accounting_category_id: nil, accounting_ledger_class_id: nil, charge_bearer: nil, currency: nil, description: nil, effective_date: nil, expires_at: nil, external_id: nil, fallback_type: nil, foreign_exchange_contract: nil, foreign_exchange_indicator: nil, ledger_transaction: nil, ledger_transaction_id: nil, line_items: nil, metadata: nil, nsf_protected: nil, originating_party_name: nil, priority: nil, process_after: nil, purpose: nil, receiving_account: nil, receiving_account_id: nil, reconciliation_status: nil, remittance_information: nil, send_remittance_advice: nil, statement_descriptor: nil, subtype: nil, transaction_monitoring_enabled: nil, ultimate_originating_account_id: nil, ultimate_originating_party_address: nil, ultimate_originating_party_identifier: nil, ultimate_originating_party_name: nil, ultimate_receiving_party_identifier: nil, ultimate_receiving_party_name: nil, vendor_attributes: nil, request_options: {})
+      # @!method initialize(amount:, direction:, originating_account_id:, type:, accounting: nil, accounting_category_id: nil, accounting_ledger_class_id: nil, charge_bearer: nil, currency: nil, description: nil, effective_date: nil, expires_at: nil, external_id: nil, fallback_type: nil, foreign_exchange_contract: nil, foreign_exchange_indicator: nil, ledger_transaction: nil, ledger_transaction_id: nil, line_items: nil, metadata: nil, nsf_protected: nil, originating_party_address: nil, originating_party_name: nil, priority: nil, process_after: nil, purpose: nil, receiving_account: nil, receiving_account_id: nil, reconciliation_status: nil, remittance_information: nil, send_remittance_advice: nil, statement_descriptor: nil, subtype: nil, transaction_monitoring_enabled: nil, ultimate_originating_account_id: nil, ultimate_originating_party_address: nil, ultimate_originating_party_identifier: nil, ultimate_originating_party_name: nil, ultimate_receiving_party_identifier: nil, ultimate_receiving_party_name: nil, vendor_attributes: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ModernTreasury::Models::PaymentOrderCreateAsyncParams} for more details.
       #
@@ -361,6 +370,8 @@ module ModernTreasury
       #
       #   @param nsf_protected [Boolean] A boolean to determine if NSF Protection is enabled for this payment order. Note
       #
+      #   @param originating_party_address [ModernTreasury::Models::PaymentOrderCreateAsyncParams::OriginatingPartyAddress, nil] If present, this address will override the default originating party address use
+      #
       #   @param originating_party_name [String, nil] If present, this will replace your default company name on receiver's bank state
       #
       #   @param priority [Symbol, ModernTreasury::Models::PaymentOrderCreateAsyncParams::Priority] Either `normal` or `high`. For ACH and EFT payments, `high` represents a same-da
@@ -527,6 +538,64 @@ module ModernTreasury
         #   @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
       end
 
+      class OriginatingPartyAddress < ModernTreasury::Internal::Type::BaseModel
+        # @!attribute country
+        #   Country code conforms to [ISO 3166-1 alpha-2]
+        #
+        #   @return [String, nil]
+        optional :country, String, nil?: true
+
+        # @!attribute line1
+        #
+        #   @return [String, nil]
+        optional :line1, String, nil?: true
+
+        # @!attribute line2
+        #
+        #   @return [String, nil]
+        optional :line2, String, nil?: true
+
+        # @!attribute locality
+        #   Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        #   Francisco).
+        #
+        #   @return [String, nil]
+        optional :locality, String, nil?: true
+
+        # @!attribute postal_code
+        #   The postal code of the address.
+        #
+        #   @return [String, nil]
+        optional :postal_code, String, nil?: true
+
+        # @!attribute region
+        #   Region or State. This field is free-form; for US states, we recommend a
+        #   two-letter code (e.g. CA). Full state names are also accepted.
+        #
+        #   @return [String, nil]
+        optional :region, String, nil?: true
+
+        # @!method initialize(country: nil, line1: nil, line2: nil, locality: nil, postal_code: nil, region: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::Models::PaymentOrderCreateAsyncParams::OriginatingPartyAddress}
+        #   for more details.
+        #
+        #   If present, this address will override the default originating party address
+        #   used on the payment order. This works across all payment types.
+        #
+        #   @param country [String, nil] Country code conforms to [ISO 3166-1 alpha-2]
+        #
+        #   @param line1 [String, nil]
+        #
+        #   @param line2 [String, nil]
+        #
+        #   @param locality [String, nil] Locality or City. Use the full city name rather than an abbreviation (e.g. San F
+        #
+        #   @param postal_code [String, nil] The postal code of the address.
+        #
+        #   @param region [String, nil] Region or State. This field is free-form; for US states, we recommend a two-lett
+      end
+
       # Either `normal` or `high`. For ACH and EFT payments, `high` represents a
       # same-day ACH or EFT transfer, respectively. For check payments, `high` can mean
       # an overnight check rather than standard mail.

data/lib/modern_treasury/models/payment_order_create_params.rb

@@ -172,6 +172,15 @@ module ModernTreasury
       #   @return [Boolean, nil]
       optional :nsf_protected, ModernTreasury::Internal::Type::Boolean
 
+      # @!attribute originating_party_address
+      #   If present, this address will override the default originating party address
+      #   used on the payment order. This works across all payment types.
+      #
+      #   @return [ModernTreasury::Models::PaymentOrderCreateParams::OriginatingPartyAddress, nil]
+      optional :originating_party_address,
+               -> { ModernTreasury::PaymentOrderCreateParams::OriginatingPartyAddress },
+               nil?: true
+
       # @!attribute originating_party_name
       #   If present, this will replace your default company name on receiver's bank
       #   statement. This field can only be used for ACH payments currently. For ACH, only
@@ -321,7 +330,7 @@ module ModernTreasury
       optional :vendor_attributes,
                ModernTreasury::Internal::Type::HashOf[ModernTreasury::Internal::Type::Unknown]
 
-      # @!method initialize(amount:, direction:, originating_account_id:, type:, accounting: nil, accounting_category_id: nil, accounting_ledger_class_id: nil, charge_bearer: nil, currency: nil, description: nil, documents: nil, effective_date: nil, expires_at: nil, external_id: nil, fallback_type: nil, foreign_exchange_contract: nil, foreign_exchange_indicator: nil, ledger_transaction: nil, ledger_transaction_id: nil, line_items: nil, metadata: nil, nsf_protected: nil, originating_party_name: nil, priority: nil, process_after: nil, purpose: nil, receiving_account: nil, receiving_account_id: nil, reconciliation_status: nil, remittance_information: nil, send_remittance_advice: nil, statement_descriptor: nil, subtype: nil, transaction_monitoring_enabled: nil, ultimate_originating_account_id: nil, ultimate_originating_party_address: nil, ultimate_originating_party_identifier: nil, ultimate_originating_party_name: nil, ultimate_receiving_party_identifier: nil, ultimate_receiving_party_name: nil, vendor_attributes: nil, request_options: {})
+      # @!method initialize(amount:, direction:, originating_account_id:, type:, accounting: nil, accounting_category_id: nil, accounting_ledger_class_id: nil, charge_bearer: nil, currency: nil, description: nil, documents: nil, effective_date: nil, expires_at: nil, external_id: nil, fallback_type: nil, foreign_exchange_contract: nil, foreign_exchange_indicator: nil, ledger_transaction: nil, ledger_transaction_id: nil, line_items: nil, metadata: nil, nsf_protected: nil, originating_party_address: nil, originating_party_name: nil, priority: nil, process_after: nil, purpose: nil, receiving_account: nil, receiving_account_id: nil, reconciliation_status: nil, remittance_information: nil, send_remittance_advice: nil, statement_descriptor: nil, subtype: nil, transaction_monitoring_enabled: nil, ultimate_originating_account_id: nil, ultimate_originating_party_address: nil, ultimate_originating_party_identifier: nil, ultimate_originating_party_name: nil, ultimate_receiving_party_identifier: nil, ultimate_receiving_party_name: nil, vendor_attributes: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ModernTreasury::Models::PaymentOrderCreateParams} for more details.
       #
@@ -369,6 +378,8 @@ module ModernTreasury
       #
       #   @param nsf_protected [Boolean] A boolean to determine if NSF Protection is enabled for this payment order. Note
       #
+      #   @param originating_party_address [ModernTreasury::Models::PaymentOrderCreateParams::OriginatingPartyAddress, nil] If present, this address will override the default originating party address use
+      #
       #   @param originating_party_name [String, nil] If present, this will replace your default company name on receiver's bank state
       #
       #   @param priority [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::Priority] Either `normal` or `high`. For ACH and EFT payments, `high` represents a same-da
@@ -514,6 +525,7 @@ module ModernTreasury
           LEGAL_ENTITY = :legal_entity
           ORGANIZATION = :organization
           PAYMENT_ORDER = :payment_order
+          RETURN = :return
           TRANSACTION = :transaction
 
           # @!method self.values
@@ -587,6 +599,64 @@ module ModernTreasury
         #   @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
       end
 
+      class OriginatingPartyAddress < ModernTreasury::Internal::Type::BaseModel
+        # @!attribute country
+        #   Country code conforms to [ISO 3166-1 alpha-2]
+        #
+        #   @return [String, nil]
+        optional :country, String, nil?: true
+
+        # @!attribute line1
+        #
+        #   @return [String, nil]
+        optional :line1, String, nil?: true
+
+        # @!attribute line2
+        #
+        #   @return [String, nil]
+        optional :line2, String, nil?: true
+
+        # @!attribute locality
+        #   Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        #   Francisco).
+        #
+        #   @return [String, nil]
+        optional :locality, String, nil?: true
+
+        # @!attribute postal_code
+        #   The postal code of the address.
+        #
+        #   @return [String, nil]
+        optional :postal_code, String, nil?: true
+
+        # @!attribute region
+        #   Region or State. This field is free-form; for US states, we recommend a
+        #   two-letter code (e.g. CA). Full state names are also accepted.
+        #
+        #   @return [String, nil]
+        optional :region, String, nil?: true
+
+        # @!method initialize(country: nil, line1: nil, line2: nil, locality: nil, postal_code: nil, region: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::Models::PaymentOrderCreateParams::OriginatingPartyAddress} for
+        #   more details.
+        #
+        #   If present, this address will override the default originating party address
+        #   used on the payment order. This works across all payment types.
+        #
+        #   @param country [String, nil] Country code conforms to [ISO 3166-1 alpha-2]
+        #
+        #   @param line1 [String, nil]
+        #
+        #   @param line2 [String, nil]
+        #
+        #   @param locality [String, nil] Locality or City. Use the full city name rather than an abbreviation (e.g. San F
+        #
+        #   @param postal_code [String, nil] The postal code of the address.
+        #
+        #   @param region [String, nil] Region or State. This field is free-form; for US states, we recommend a two-lett
+      end
+
       # Either `normal` or `high`. For ACH and EFT payments, `high` represents a
       # same-day ACH or EFT transfer, respectively. For check payments, `high` can mean
       # an overnight check rather than standard mail.