modern-treasury 3.3.0 → 4.4.2

package/src/resources/payment-orders/payment-orders.ts

@@ -154,6 +154,12 @@ export interface PaymentOrder {
    */
   amount: number;
 
+  /**
+   * The ID of the batch in which the payment order is included. Only populated after
+   * the payment order begins processing.
+   */
+  batch_id: string | null;
+
   /**
    * The party that will pay the fees for the payment order. See
    * https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
@@ -522,6 +528,7 @@ export namespace PaymentOrder {
       | 'ach_trace_number'
       | 'bankprov_payment_activity_date'
       | 'bankprov_payment_id'
+      | 'blockchain_transaction_hash'
       | 'bnk_dev_prenotification_id'
       | 'bnk_dev_transfer_id'
       | 'bny_mellon_transaction_reference_number'
@@ -534,9 +541,11 @@ export namespace PaymentOrder {
       | 'column_fx_quote_id'
       | 'column_reversal_pair_transfer_id'
       | 'column_transfer_id'
+      | 'cross_river_card_trace_number'
       | 'cross_river_core_transaction_id'
       | 'cross_river_fed_batch_id'
       | 'cross_river_payment_id'
+      | 'cross_river_retrieval_reference_id'
       | 'cross_river_service_message'
       | 'cross_river_transaction_id'
       | 'currencycloud_conversion_id'
@@ -571,9 +580,13 @@ export namespace PaymentOrder {
       | 'jpmc_payment_returned_datetime'
       | 'jpmc_transaction_reference_number'
       | 'lob_check_id'
-      | 'mt_fof_transfer_id'
+      | 'mt_flow_ach_noc_id'
+      | 'mt_flow_transfer_id'
       | 'other'
       | 'partial_swift_mir'
+      | 'paxos_group_id'
+      | 'paxos_orchestration_id'
+      | 'paxos_transfer_id'
       | 'pnc_clearing_reference'
       | 'pnc_instruction_id'
       | 'pnc_multipayment_id'
@@ -588,8 +601,6 @@ export namespace PaymentOrder {
       | 'silvergate_payment_id'
       | 'svb_end_to_end_id'
       | 'svb_payment_id'
-      | 'svb_transaction_cleared_for_sanctions_review'
-      | 'svb_transaction_held_for_sanctions_review'
       | 'swift_mir'
       | 'swift_uetr'
       | 'umb_product_partner_account_number'
@@ -623,7 +634,6 @@ export type PaymentOrderSubtype =
   | 'CIE'
   | 'CTX'
   | 'IAT'
-  | 'POS'
   | 'PPD'
   | 'TEL'
   | 'WEB'
@@ -769,6 +779,11 @@ export interface PaymentOrderCreateParams {
    */
   expires_at?: string | null;
 
+  /**
+   * An optional user-defined 180 character unique identifier.
+   */
+  external_id?: string | null;
+
   /**
    * A payment type to fallback to if the original type is not valid for the
    * receiving account. Currently, this only supports falling back from RTP to ACH
@@ -904,8 +919,8 @@ export interface PaymentOrderCreateParams {
   subtype?: PaymentOrderSubtype | null;
 
   /**
-   * A flag that determines whether a payment order should go through transaction
-   * monitoring.
+   * @deprecated A flag that determines whether a payment order should go through
+   * transaction monitoring.
    */
   transaction_monitoring_enabled?: boolean;
 
@@ -950,29 +965,30 @@ export namespace PaymentOrderCreateParams {
   }
 
   export interface Document {
+    file: Uploadable;
+
+    /**
+     * A category given to the document, can be `null`.
+     */
+    document_type?: string;
+
     /**
      * The unique identifier for the associated object.
      */
-    documentable_id: string;
+    documentable_id?: string;
 
-    documentable_type:
+    documentable_type?:
+      | 'connections'
       | 'counterparties'
       | 'expected_payments'
       | 'external_accounts'
       | 'identifications'
       | 'incoming_payment_details'
       | 'internal_accounts'
+      | 'legal_entities'
       | 'organizations'
       | 'payment_orders'
-      | 'transactions'
-      | 'connections';
-
-    file: Uploadable;
-
-    /**
-     * A category given to the document, can be `null`.
-     */
-    document_type?: string;
+      | 'transactions';
   }
 
   export interface LineItem {
@@ -1074,6 +1090,7 @@ export namespace PaymentOrderCreateParams {
       account_number_type?:
         | 'au_number'
         | 'base_address'
+        | 'card_token'
         | 'clabe'
         | 'ethereum_address'
         | 'hk_number'
@@ -1221,6 +1238,11 @@ export interface PaymentOrderUpdateParams {
    */
   expires_at?: string | null;
 
+  /**
+   * An optional user-defined 180 character unique identifier.
+   */
+  external_id?: string | null;
+
   /**
    * A payment type to fallback to if the original type is not valid for the
    * receiving account. Currently, this only supports falling back from RTP to ACH
@@ -1518,6 +1540,7 @@ export namespace PaymentOrderUpdateParams {
       account_number_type?:
         | 'au_number'
         | 'base_address'
+        | 'card_token'
         | 'clabe'
         | 'ethereum_address'
         | 'hk_number'
@@ -1788,6 +1811,11 @@ export interface PaymentOrderCreateAsyncParams {
    */
   expires_at?: string | null;
 
+  /**
+   * An optional user-defined 180 character unique identifier.
+   */
+  external_id?: string | null;
+
   /**
    * A payment type to fallback to if the original type is not valid for the
    * receiving account. Currently, this only supports falling back from RTP to ACH
@@ -1923,8 +1951,8 @@ export interface PaymentOrderCreateAsyncParams {
   subtype?: PaymentOrderSubtype | null;
 
   /**
-   * A flag that determines whether a payment order should go through transaction
-   * monitoring.
+   * @deprecated A flag that determines whether a payment order should go through
+   * transaction monitoring.
    */
   transaction_monitoring_enabled?: boolean;
 
@@ -2067,6 +2095,7 @@ export namespace PaymentOrderCreateAsyncParams {
       account_number_type?:
         | 'au_number'
         | 'base_address'
+        | 'card_token'
         | 'clabe'
         | 'ethereum_address'
         | 'hk_number'

package/src/resources/payment-orders/reversals.ts

@@ -77,6 +77,11 @@ export interface Reversal {
 
   created_at: string;
 
+  /**
+   * The ID of the relevant Internal Account.
+   */
+  internal_account_id: string | null;
+
   /**
    * The ID of the ledger transaction linked to the reversal.
    */

package/src/resources/payment-references.ts

@@ -58,6 +58,7 @@ export interface PaymentReference {
     | 'ach_trace_number'
     | 'bankprov_payment_activity_date'
     | 'bankprov_payment_id'
+    | 'blockchain_transaction_hash'
     | 'bnk_dev_prenotification_id'
     | 'bnk_dev_transfer_id'
     | 'bny_mellon_transaction_reference_number'
@@ -70,9 +71,11 @@ export interface PaymentReference {
     | 'column_fx_quote_id'
     | 'column_reversal_pair_transfer_id'
     | 'column_transfer_id'
+    | 'cross_river_card_trace_number'
     | 'cross_river_core_transaction_id'
     | 'cross_river_fed_batch_id'
     | 'cross_river_payment_id'
+    | 'cross_river_retrieval_reference_id'
     | 'cross_river_service_message'
     | 'cross_river_transaction_id'
     | 'currencycloud_conversion_id'
@@ -107,9 +110,13 @@ export interface PaymentReference {
     | 'jpmc_payment_returned_datetime'
     | 'jpmc_transaction_reference_number'
     | 'lob_check_id'
-    | 'mt_fof_transfer_id'
+    | 'mt_flow_ach_noc_id'
+    | 'mt_flow_transfer_id'
     | 'other'
     | 'partial_swift_mir'
+    | 'paxos_group_id'
+    | 'paxos_orchestration_id'
+    | 'paxos_transfer_id'
     | 'pnc_clearing_reference'
     | 'pnc_instruction_id'
     | 'pnc_multipayment_id'
@@ -124,8 +131,6 @@ export interface PaymentReference {
     | 'silvergate_payment_id'
     | 'svb_end_to_end_id'
     | 'svb_payment_id'
-    | 'svb_transaction_cleared_for_sanctions_review'
-    | 'svb_transaction_held_for_sanctions_review'
     | 'swift_mir'
     | 'swift_uetr'
     | 'umb_product_partner_account_number'

package/src/resources/returns.ts

@@ -229,7 +229,7 @@ export interface ReturnObject {
   /**
    * The current status of the return.
    */
-  status: 'completed' | 'failed' | 'pending' | 'processing' | 'returned' | 'sent';
+  status: 'cancelled' | 'completed' | 'failed' | 'pending' | 'processing' | 'returned' | 'sent';
 
   /**
    * The ID of the relevant Transaction or `null`.
@@ -258,7 +258,8 @@ export interface ReturnObject {
     | 'interac'
     | 'manual'
     | 'sepa'
-    | 'wire';
+    | 'wire'
+    | 'zengin';
 
   updated_at: string;
 
@@ -344,6 +345,7 @@ export namespace ReturnObject {
       | 'ach_trace_number'
       | 'bankprov_payment_activity_date'
       | 'bankprov_payment_id'
+      | 'blockchain_transaction_hash'
       | 'bnk_dev_prenotification_id'
       | 'bnk_dev_transfer_id'
       | 'bny_mellon_transaction_reference_number'
@@ -356,9 +358,11 @@ export namespace ReturnObject {
       | 'column_fx_quote_id'
       | 'column_reversal_pair_transfer_id'
       | 'column_transfer_id'
+      | 'cross_river_card_trace_number'
       | 'cross_river_core_transaction_id'
       | 'cross_river_fed_batch_id'
       | 'cross_river_payment_id'
+      | 'cross_river_retrieval_reference_id'
       | 'cross_river_service_message'
       | 'cross_river_transaction_id'
       | 'currencycloud_conversion_id'
@@ -393,9 +397,13 @@ export namespace ReturnObject {
       | 'jpmc_payment_returned_datetime'
       | 'jpmc_transaction_reference_number'
       | 'lob_check_id'
-      | 'mt_fof_transfer_id'
+      | 'mt_flow_ach_noc_id'
+      | 'mt_flow_transfer_id'
       | 'other'
       | 'partial_swift_mir'
+      | 'paxos_group_id'
+      | 'paxos_orchestration_id'
+      | 'paxos_transfer_id'
       | 'pnc_clearing_reference'
       | 'pnc_instruction_id'
       | 'pnc_multipayment_id'
@@ -410,8 +418,6 @@ export namespace ReturnObject {
       | 'silvergate_payment_id'
       | 'svb_end_to_end_id'
       | 'svb_payment_id'
-      | 'svb_transaction_cleared_for_sanctions_review'
-      | 'svb_transaction_held_for_sanctions_review'
       | 'swift_mir'
       | 'swift_uetr'
       | 'umb_product_partner_account_number'

package/src/resources/routing-details.ts

@@ -166,7 +166,7 @@ export interface RoutingDetail {
 
 export interface RoutingDetailCreateParams {
   /**
-   * Path param:
+   * Path param
    */
   accounts_type: 'external_accounts';
 
@@ -258,7 +258,7 @@ export interface RoutingDetailRetrieveParams {
 
 export interface RoutingDetailListParams extends PageParams {
   /**
-   * Path param:
+   * Path param
    */
   accounts_type: Shared.AccountsType;
 }

package/src/resources/shared.ts

@@ -82,6 +82,11 @@ export interface ChildLegalEntityCreate {
 
   bank_settings?: ChildLegalEntityCreate.BankSettings | null;
 
+  /**
+   * A description of the business.
+   */
+  business_description?: string | null;
+
   /**
    * The business's legal business name.
    */
@@ -92,7 +97,20 @@ export interface ChildLegalEntityCreate {
    */
   citizenship_country?: string | null;
 
-  compliance_details?: LegalEntityComplianceDetail | null;
+  /**
+   * The connection ID for the connection the legal entity is associated with.
+   * Defaults to the id of the connection designated with an is_default value of true
+   * or the id of an existing operational connection if only one is available. Pass
+   * in a value of null to prevent the connection from being associated with the
+   * legal entity.
+   */
+  connection_id?: string | null;
+
+  /**
+   * The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
+   * alpha-3 formats.
+   */
+  country_of_incorporation?: string | null;
 
   /**
    * A business's formation date (YYYY-MM-DD).
@@ -111,6 +129,16 @@ export interface ChildLegalEntityCreate {
    */
   email?: string | null;
 
+  /**
+   * Monthly expected transaction volume in USD.
+   */
+  expected_activity_volume?: number | null;
+
+  /**
+   * An optional user-defined 180 character unique identifier.
+   */
+  external_id?: string | null;
+
   /**
    * An individual's first name.
    */
@@ -126,11 +154,21 @@ export interface ChildLegalEntityCreate {
    */
   industry_classifications?: Array<LegalEntityIndustryClassification>;
 
+  /**
+   * A description of the intended use of the legal entity.
+   */
+  intended_use?: string | null;
+
   /**
    * An individual's last name.
    */
   last_name?: string | null;
 
+  /**
+   * The legal entity associations and its child legal entities.
+   */
+  legal_entity_associations?: Array<LegalEntityAssociationInlineCreate> | null;
+
   /**
    * The type of legal entity.
    */
@@ -148,6 +186,11 @@ export interface ChildLegalEntityCreate {
     | 'trust'
     | null;
 
+  /**
+   * ISO 10383 market identifier code.
+   */
+  listed_exchange?: string | null;
+
   /**
    * Additional data represented as key-value pairs. Both the key and value must be
    * strings.
@@ -159,6 +202,12 @@ export interface ChildLegalEntityCreate {
    */
   middle_name?: string | null;
 
+  /**
+   * A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
+   * codes).
+   */
+  operating_jurisdictions?: Array<string>;
+
   phone_numbers?: Array<ChildLegalEntityCreate.PhoneNumber>;
 
   /**
@@ -176,16 +225,42 @@ export interface ChildLegalEntityCreate {
    */
   prefix?: string | null;
 
+  /**
+   * A list of primary social media URLs for the business.
+   */
+  primary_social_media_sites?: Array<string>;
+
+  /**
+   * Array of regulatory bodies overseeing this institution.
+   */
+  regulators?: Array<ChildLegalEntityCreate.Regulator> | null;
+
   /**
    * The risk rating of the legal entity. One of low, medium, high.
    */
   risk_rating?: 'low' | 'medium' | 'high' | null;
 
+  /**
+   * The activation status of the legal entity. One of pending, active, suspended, or
+   * closed.
+   */
+  status?: 'active' | 'closed' | 'pending' | 'suspended' | null;
+
   /**
    * An individual's suffix.
    */
   suffix?: string | null;
 
+  /**
+   * Information describing a third-party verification run by an external vendor.
+   */
+  third_party_verification?: ChildLegalEntityCreate.ThirdPartyVerification | null;
+
+  /**
+   * Stock ticker symbol for publicly traded companies.
+   */
+  ticker_symbol?: string | null;
+
   wealth_and_employment_details?: ChildLegalEntityCreate.WealthAndEmploymentDetails | null;
 
   /**
@@ -244,11 +319,44 @@ export namespace ChildLegalEntityCreate {
     phone_number?: string;
   }
 
+  export interface Regulator {
+    /**
+     * The country code where the regulator operates in the ISO 3166-1 alpha-2 format
+     * (e.g., "US", "CA", "GB").
+     */
+    jurisdiction: string;
+
+    /**
+     * Full name of the regulatory body.
+     */
+    name: string;
+
+    /**
+     * Registration or identification number with the regulator.
+     */
+    registration_number: string;
+  }
+
+  /**
+   * Information describing a third-party verification run by an external vendor.
+   */
+  export interface ThirdPartyVerification {
+    /**
+     * The vendor that performed the verification, e.g. `persona`.
+     */
+    vendor: 'persona';
+
+    /**
+     * The identification of the third party verification in `vendor`'s system.
+     */
+    vendor_verification_id: string;
+  }
+
   export interface WealthAndEmploymentDetails {
     id: string;
 
     /**
-     * The annual income of the individual.
+     * The annual income of the individual in USD.
      */
     annual_income: number | null;
 
@@ -372,17 +480,24 @@ export namespace ChildLegalEntityCreate {
       | 'alimony'
       | 'annuity'
       | 'business_owner'
+      | 'business_revenue'
+      | 'debt_financing'
       | 'general_employee'
       | 'government_benefits'
       | 'homemaker'
       | 'inheritance_gift'
+      | 'intercompany_loan'
       | 'investment'
+      | 'investor_funding'
       | 'legal_settlement'
       | 'lottery'
       | 'real_estate'
+      | 'retained_earnings_or_savings'
       | 'retired'
       | 'retirement'
       | 'salary'
+      | 'sale_of_business_assets'
+      | 'sale_of_real_estate'
       | 'self_employed'
       | 'senior_executive'
       | 'trust_income'
@@ -754,6 +869,11 @@ export interface LedgerAccountCreateRequest {
    */
   description?: string | null;
 
+  /**
+   * An optional user-defined 180 character unique identifier.
+   */
+  external_id?: string | null;
+
   /**
    * The array of ledger account category ids that this ledger account should be a
    * child of.
@@ -845,6 +965,12 @@ export interface LedgerEntryCreateRequest {
    */
   available_balance_amount?: { [key: string]: number } | null;
 
+  /**
+   * The timestamp (ISO8601 format) at which the ledger transaction happened for
+   * reporting purposes.
+   */
+  effective_at?: string;
+
   /**
    * Lock version of the ledger account. This can be passed when creating a ledger
    * transaction to only succeed if no ledger transactions have posted since the
@@ -965,52 +1091,28 @@ export interface LegalEntityAddressCreateRequest {
   line2?: string | null;
 }
 
-export interface LegalEntityComplianceDetail {
-  id: string;
-
-  created_at: string;
-
-  discarded_at: string | null;
-
-  /**
-   * The issuer of the compliance token.
-   */
-  issuer: string;
-
-  /**
-   * This field will be true if this object exists in the live environment or false
-   * if it exists in the test environment.
-   */
-  live_mode: boolean;
-
-  object: string;
+export interface LegalEntityAssociationInlineCreate {
+  relationship_types: Array<'authorized_signer' | 'beneficial_owner' | 'control_person'>;
 
   /**
-   * The timestamp when the compliance token expires.
+   * The child legal entity.
    */
-  token_expires_at: string | null;
+  child_legal_entity?: ChildLegalEntityCreate;
 
   /**
-   * The timestamp when the compliance token was issued.
+   * The ID of the child legal entity.
    */
-  token_issued_at: string | null;
-
-  /**
-   * The URL to the compliance token. (ex. provider portal URL)
-   */
-  token_url: string | null;
-
-  updated_at: string;
+  child_legal_entity_id?: string;
 
   /**
-   * Whether entity corresponding to the compliance token has been validated.
+   * The child entity's ownership percentage iff they are a beneficial owner.
    */
-  validated: boolean;
+  ownership_percentage?: number | null;
 
   /**
-   * The timestamp when the entity was validated.
+   * The job title of the child entity at the parent entity.
    */
-  validated_at: string | null;
+  title?: string | null;
 }
 
 export interface LegalEntityIndustryClassification {

package/src/resources/transactions/transactions.ts

@@ -261,8 +261,9 @@ export interface Transaction {
     | 'hifi'
     | 'iso20022'
     | 'jpmc'
-    | 'mt_fof'
+    | 'modern_treasury'
     | 'mx'
+    | 'paxos'
     | 'paypal'
     | 'pnc'
     | 'signet'

package/src/resources/virtual-accounts.ts

@@ -203,6 +203,7 @@ export namespace VirtualAccountCreateParams {
     account_number_type?:
       | 'au_number'
       | 'base_address'
+      | 'card_token'
       | 'clabe'
       | 'ethereum_address'
       | 'hk_number'

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '3.3.0'; // x-release-please-version
+export const VERSION = '4.4.2'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "3.3.0";
+export declare const VERSION = "4.4.2";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "3.3.0";
+export declare const VERSION = "4.4.2";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '3.3.0'; // x-release-please-version
+exports.VERSION = '4.4.2'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '3.3.0'; // x-release-please-version
+export const VERSION = '4.4.2'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map