@augustusbank/typescript-sdk 0.26.0 → 0.28.0

package/src/resources/counterparties.ts

@@ -15,8 +15,9 @@ export class Counterparties extends APIResource {
    * const counterparty = await client.counterparties.create({
    *   financial_address: {
    *     account_holder_name: 'Acme Sandbox Ltd.',
-   *     iban: 'DE89370400440532013000',
-   *     type: 'iban',
+   *     account_number: '000123456789',
+   *     routing_number: '110000000',
+   *     type: 'aba',
    *   },
    * });
    * ```
@@ -77,21 +78,6 @@ export class Counterparties extends APIResource {
       ...options,
     });
   }
-
-  /**
-   * Blocks payments to and from a counterparty owned by the merchant. Blocking an
-   * already-blocked counterparty succeeds without changing the existing block.
-   *
-   * @example
-   * ```ts
-   * const response = await client.counterparties.block(
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   * );
-   * ```
-   */
-  block(id: string, options?: RequestOptions): APIPromise<CounterpartyBlockResponse> {
-    return this._client.post(path`/v1/counterparties/${id}/block`, options);
-  }
 }
 
 export type CounterpartyListResponsesCursorPage = CursorPage<CounterpartyListResponse>;
@@ -112,6 +98,11 @@ export interface CounterpartyCreateResponse {
    */
   date_of_birth: string | null;
 
+  /**
+   * Email address of the counterparty, or null if not recorded.
+   */
+  email: string | null;
+
   /**
    * Whether the counterparty is a business or an individual.
    */
@@ -121,9 +112,9 @@ export interface CounterpartyCreateResponse {
    * Financial address of the counterparty.
    */
   financial_address:
+    | CounterpartyCreateResponse.AbaFinancialAddress
     | CounterpartyCreateResponse.IbanFinancialAddress
     | CounterpartyCreateResponse.SortCodeFinancialAddress
-    | CounterpartyCreateResponse.AbaFinancialAddress
     | CounterpartyCreateResponse.BicFinancialAddress
     | CounterpartyCreateResponse.CryptoWalletFinancialAddress;
 
@@ -133,6 +124,11 @@ export interface CounterpartyCreateResponse {
    */
   is_self_owned: boolean;
 
+  /**
+   * National tax or identity number of the counterparty, or null if not recorded.
+   */
+  legal_id: string | null;
+
   /**
    * Set of up to 50 key-value string pairs you can attach to store structured
    * information, such as correlating this resource with an object in your own
@@ -145,6 +141,11 @@ export interface CounterpartyCreateResponse {
    */
   name: string | null;
 
+  /**
+   * Phone number of the counterparty, or null if not recorded.
+   */
+  phone: string | null;
+
   /**
    * Physical address of the counterparty, or null if not recorded.
    */
@@ -157,70 +158,80 @@ export interface CounterpartyCreateResponse {
 }
 
 export namespace CounterpartyCreateResponse {
-  export interface IbanFinancialAddress {
+  export interface AbaFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * Bank Identifier Code, or null if not provided.
+     * Bank account number.
      */
-    bic: string | null;
+    account_number: string;
 
     /**
-     * International Bank Account Number.
+     * Whether the account is a checking or a savings account, or null if not provided.
      */
-    iban: string;
+    account_type: 'checking' | 'savings' | null;
 
     /**
-     * Discriminator for IBAN financial address.
+     * ABA routing number (9 digits).
      */
-    type: 'iban';
+    routing_number: string;
+
+    /**
+     * Discriminator for ABA wire financial address.
+     */
+    type: 'aba';
   }
 
-  export interface SortCodeFinancialAddress {
+  export interface IbanFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * UK account number (8 digits).
+     * Whether the account is a checking or a savings account, or null if not provided.
      */
-    account_number: string;
+    account_type: 'checking' | 'savings' | null;
 
     /**
-     * UK sort code (6 digits).
+     * Bank Identifier Code, or null if not provided.
      */
-    sort_code: string;
+    bic: string | null;
 
     /**
-     * Discriminator for UK sort code financial address.
+     * International Bank Account Number.
      */
-    type: 'sort_code';
+    iban: string;
+
+    /**
+     * Discriminator for IBAN financial address.
+     */
+    type: 'iban';
   }
 
-  export interface AbaFinancialAddress {
+  export interface SortCodeFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * Bank account number.
+     * UK account number (8 digits).
      */
     account_number: string;
 
     /**
-     * ABA routing number (9 digits).
+     * UK sort code (6 digits).
      */
-    routing_number: string;
+    sort_code: string;
 
     /**
-     * Discriminator for ABA wire financial address.
+     * Discriminator for UK sort code financial address.
      */
-    type: 'aba';
+    type: 'sort_code';
   }
 
   export interface BicFinancialAddress {
@@ -234,6 +245,11 @@ export namespace CounterpartyCreateResponse {
      */
     account_number: string;
 
+    /**
+     * Whether the account is a checking or a savings account, or null if not provided.
+     */
+    account_type: 'checking' | 'savings' | null;
+
     /**
      * ISO 9362 Bank Identifier Code (8 or 11 characters).
      */
@@ -578,6 +594,11 @@ export interface CounterpartyRetrieveResponse {
    */
   date_of_birth: string | null;
 
+  /**
+   * Email address of the counterparty, or null if not recorded.
+   */
+  email: string | null;
+
   /**
    * Whether the counterparty is a business or an individual.
    */
@@ -587,9 +608,9 @@ export interface CounterpartyRetrieveResponse {
    * Financial address of the counterparty.
    */
   financial_address:
+    | CounterpartyRetrieveResponse.AbaFinancialAddress
     | CounterpartyRetrieveResponse.IbanFinancialAddress
     | CounterpartyRetrieveResponse.SortCodeFinancialAddress
-    | CounterpartyRetrieveResponse.AbaFinancialAddress
     | CounterpartyRetrieveResponse.BicFinancialAddress
     | CounterpartyRetrieveResponse.CryptoWalletFinancialAddress;
 
@@ -599,6 +620,11 @@ export interface CounterpartyRetrieveResponse {
    */
   is_self_owned: boolean;
 
+  /**
+   * National tax or identity number of the counterparty, or null if not recorded.
+   */
+  legal_id: string | null;
+
   /**
    * Set of up to 50 key-value string pairs you can attach to store structured
    * information, such as correlating this resource with an object in your own
@@ -611,6 +637,11 @@ export interface CounterpartyRetrieveResponse {
    */
   name: string | null;
 
+  /**
+   * Phone number of the counterparty, or null if not recorded.
+   */
+  phone: string | null;
+
   /**
    * Physical address of the counterparty, or null if not recorded.
    */
@@ -623,70 +654,80 @@ export interface CounterpartyRetrieveResponse {
 }
 
 export namespace CounterpartyRetrieveResponse {
-  export interface IbanFinancialAddress {
+  export interface AbaFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * Bank Identifier Code, or null if not provided.
+     * Bank account number.
      */
-    bic: string | null;
+    account_number: string;
 
     /**
-     * International Bank Account Number.
+     * Whether the account is a checking or a savings account, or null if not provided.
      */
-    iban: string;
+    account_type: 'checking' | 'savings' | null;
 
     /**
-     * Discriminator for IBAN financial address.
+     * ABA routing number (9 digits).
      */
-    type: 'iban';
+    routing_number: string;
+
+    /**
+     * Discriminator for ABA wire financial address.
+     */
+    type: 'aba';
   }
 
-  export interface SortCodeFinancialAddress {
+  export interface IbanFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * UK account number (8 digits).
+     * Whether the account is a checking or a savings account, or null if not provided.
      */
-    account_number: string;
+    account_type: 'checking' | 'savings' | null;
 
     /**
-     * UK sort code (6 digits).
+     * Bank Identifier Code, or null if not provided.
      */
-    sort_code: string;
+    bic: string | null;
 
     /**
-     * Discriminator for UK sort code financial address.
+     * International Bank Account Number.
      */
-    type: 'sort_code';
+    iban: string;
+
+    /**
+     * Discriminator for IBAN financial address.
+     */
+    type: 'iban';
   }
 
-  export interface AbaFinancialAddress {
+  export interface SortCodeFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * Bank account number.
+     * UK account number (8 digits).
      */
     account_number: string;
 
     /**
-     * ABA routing number (9 digits).
+     * UK sort code (6 digits).
      */
-    routing_number: string;
+    sort_code: string;
 
     /**
-     * Discriminator for ABA wire financial address.
+     * Discriminator for UK sort code financial address.
      */
-    type: 'aba';
+    type: 'sort_code';
   }
 
   export interface BicFinancialAddress {
@@ -700,6 +741,11 @@ export namespace CounterpartyRetrieveResponse {
      */
     account_number: string;
 
+    /**
+     * Whether the account is a checking or a savings account, or null if not provided.
+     */
+    account_type: 'checking' | 'savings' | null;
+
     /**
      * ISO 9362 Bank Identifier Code (8 or 11 characters).
      */
@@ -1044,6 +1090,11 @@ export interface CounterpartyUpdateResponse {
    */
   date_of_birth: string | null;
 
+  /**
+   * Email address of the counterparty, or null if not recorded.
+   */
+  email: string | null;
+
   /**
    * Whether the counterparty is a business or an individual.
    */
@@ -1053,9 +1104,9 @@ export interface CounterpartyUpdateResponse {
    * Financial address of the counterparty.
    */
   financial_address:
+    | CounterpartyUpdateResponse.AbaFinancialAddress
     | CounterpartyUpdateResponse.IbanFinancialAddress
     | CounterpartyUpdateResponse.SortCodeFinancialAddress
-    | CounterpartyUpdateResponse.AbaFinancialAddress
     | CounterpartyUpdateResponse.BicFinancialAddress
     | CounterpartyUpdateResponse.CryptoWalletFinancialAddress;
 
@@ -1065,6 +1116,11 @@ export interface CounterpartyUpdateResponse {
    */
   is_self_owned: boolean;
 
+  /**
+   * National tax or identity number of the counterparty, or null if not recorded.
+   */
+  legal_id: string | null;
+
   /**
    * Set of up to 50 key-value string pairs you can attach to store structured
    * information, such as correlating this resource with an object in your own
@@ -1077,6 +1133,11 @@ export interface CounterpartyUpdateResponse {
    */
   name: string | null;
 
+  /**
+   * Phone number of the counterparty, or null if not recorded.
+   */
+  phone: string | null;
+
   /**
    * Physical address of the counterparty, or null if not recorded.
    */
@@ -1089,70 +1150,80 @@ export interface CounterpartyUpdateResponse {
 }
 
 export namespace CounterpartyUpdateResponse {
-  export interface IbanFinancialAddress {
+  export interface AbaFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * Bank Identifier Code, or null if not provided.
+     * Bank account number.
      */
-    bic: string | null;
+    account_number: string;
 
     /**
-     * International Bank Account Number.
+     * Whether the account is a checking or a savings account, or null if not provided.
      */
-    iban: string;
+    account_type: 'checking' | 'savings' | null;
 
     /**
-     * Discriminator for IBAN financial address.
+     * ABA routing number (9 digits).
      */
-    type: 'iban';
+    routing_number: string;
+
+    /**
+     * Discriminator for ABA wire financial address.
+     */
+    type: 'aba';
   }
 
-  export interface SortCodeFinancialAddress {
+  export interface IbanFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * UK account number (8 digits).
+     * Whether the account is a checking or a savings account, or null if not provided.
      */
-    account_number: string;
+    account_type: 'checking' | 'savings' | null;
 
     /**
-     * UK sort code (6 digits).
+     * Bank Identifier Code, or null if not provided.
      */
-    sort_code: string;
+    bic: string | null;
 
     /**
-     * Discriminator for UK sort code financial address.
+     * International Bank Account Number.
      */
-    type: 'sort_code';
+    iban: string;
+
+    /**
+     * Discriminator for IBAN financial address.
+     */
+    type: 'iban';
   }
 
-  export interface AbaFinancialAddress {
+  export interface SortCodeFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * Bank account number.
+     * UK account number (8 digits).
      */
     account_number: string;
 
     /**
-     * ABA routing number (9 digits).
+     * UK sort code (6 digits).
      */
-    routing_number: string;
+    sort_code: string;
 
     /**
-     * Discriminator for ABA wire financial address.
+     * Discriminator for UK sort code financial address.
      */
-    type: 'aba';
+    type: 'sort_code';
   }
 
   export interface BicFinancialAddress {
@@ -1166,6 +1237,11 @@ export namespace CounterpartyUpdateResponse {
      */
     account_number: string;
 
+    /**
+     * Whether the account is a checking or a savings account, or null if not provided.
+     */
+    account_type: 'checking' | 'savings' | null;
+
     /**
      * ISO 9362 Bank Identifier Code (8 or 11 characters).
      */
@@ -1510,6 +1586,11 @@ export interface CounterpartyListResponse {
    */
   date_of_birth: string | null;
 
+  /**
+   * Email address of the counterparty, or null if not recorded.
+   */
+  email: string | null;
+
   /**
    * Whether the counterparty is a business or an individual.
    */
@@ -1519,9 +1600,9 @@ export interface CounterpartyListResponse {
    * Financial address of the counterparty.
    */
   financial_address:
+    | CounterpartyListResponse.AbaFinancialAddress
     | CounterpartyListResponse.IbanFinancialAddress
     | CounterpartyListResponse.SortCodeFinancialAddress
-    | CounterpartyListResponse.AbaFinancialAddress
     | CounterpartyListResponse.BicFinancialAddress
     | CounterpartyListResponse.CryptoWalletFinancialAddress;
 
@@ -1531,6 +1612,11 @@ export interface CounterpartyListResponse {
    */
   is_self_owned: boolean;
 
+  /**
+   * National tax or identity number of the counterparty, or null if not recorded.
+   */
+  legal_id: string | null;
+
   /**
    * Set of up to 50 key-value string pairs you can attach to store structured
    * information, such as correlating this resource with an object in your own
@@ -1543,6 +1629,11 @@ export interface CounterpartyListResponse {
    */
   name: string | null;
 
+  /**
+   * Phone number of the counterparty, or null if not recorded.
+   */
+  phone: string | null;
+
   /**
    * Physical address of the counterparty, or null if not recorded.
    */
@@ -1555,70 +1646,80 @@ export interface CounterpartyListResponse {
 }
 
 export namespace CounterpartyListResponse {
-  export interface IbanFinancialAddress {
+  export interface AbaFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * Bank Identifier Code, or null if not provided.
+     * Bank account number.
      */
-    bic: string | null;
+    account_number: string;
 
     /**
-     * International Bank Account Number.
+     * Whether the account is a checking or a savings account, or null if not provided.
      */
-    iban: string;
+    account_type: 'checking' | 'savings' | null;
 
     /**
-     * Discriminator for IBAN financial address.
+     * ABA routing number (9 digits).
      */
-    type: 'iban';
+    routing_number: string;
+
+    /**
+     * Discriminator for ABA wire financial address.
+     */
+    type: 'aba';
   }
 
-  export interface SortCodeFinancialAddress {
+  export interface IbanFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * UK account number (8 digits).
+     * Whether the account is a checking or a savings account, or null if not provided.
      */
-    account_number: string;
+    account_type: 'checking' | 'savings' | null;
 
     /**
-     * UK sort code (6 digits).
+     * Bank Identifier Code, or null if not provided.
      */
-    sort_code: string;
+    bic: string | null;
 
     /**
-     * Discriminator for UK sort code financial address.
+     * International Bank Account Number.
      */
-    type: 'sort_code';
+    iban: string;
+
+    /**
+     * Discriminator for IBAN financial address.
+     */
+    type: 'iban';
   }
 
-  export interface AbaFinancialAddress {
+  export interface SortCodeFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * Bank account number.
+     * UK account number (8 digits).
      */
     account_number: string;
 
     /**
-     * ABA routing number (9 digits).
+     * UK sort code (6 digits).
      */
-    routing_number: string;
+    sort_code: string;
 
     /**
-     * Discriminator for ABA wire financial address.
+     * Discriminator for UK sort code financial address.
      */
-    type: 'aba';
+    type: 'sort_code';
   }
 
   export interface BicFinancialAddress {
@@ -1632,6 +1733,11 @@ export namespace CounterpartyListResponse {
      */
     account_number: string;
 
+    /**
+     * Whether the account is a checking or a savings account, or null if not provided.
+     */
+    account_type: 'checking' | 'savings' | null;
+
     /**
      * ISO 9362 Bank Identifier Code (8 or 11 characters).
      */
@@ -1960,112 +2066,72 @@ export namespace CounterpartyListResponse {
   }
 }
 
-export interface CounterpartyBlockResponse {
+export interface CounterpartyCreateParams {
   /**
-   * Unique identifier of the counterparty.
+   * Financial address of the counterparty.
    */
-  id: string;
-
-  /**
-   * Whether payments to or from this counterparty are currently blocked.
-   */
-  blocked: boolean;
+  financial_address:
+    | CounterpartyCreateParams.AbaFinancialAddressRequest
+    | CounterpartyCreateParams.IbanFinancialAddressRequest
+    | CounterpartyCreateParams.SortCodeFinancialAddressRequest
+    | CounterpartyCreateParams.BicFinancialAddressRequest
+    | CounterpartyCreateParams.CryptoWalletFinancialAddress;
 
   /**
-   * Date of birth in YYYY-MM-DD format, or null if not recorded.
+   * Date of birth in YYYY-MM-DD format.
    */
-  date_of_birth: string | null;
+  date_of_birth?: string;
 
   /**
-   * Whether the counterparty is a business or an individual.
+   * Email address of the counterparty. Stored for operational contact only; it is
+   * not sent with payments.
    */
-  entity_type: 'business' | 'individual';
+  email?: string;
 
   /**
-   * Financial address of the counterparty.
+   * Whether the counterparty is a business or an individual. Defaults to business.
    */
-  financial_address:
-    | CounterpartyBlockResponse.IbanFinancialAddress
-    | CounterpartyBlockResponse.SortCodeFinancialAddress
-    | CounterpartyBlockResponse.AbaFinancialAddress
-    | CounterpartyBlockResponse.BicFinancialAddress
-    | CounterpartyBlockResponse.CryptoWalletFinancialAddress;
+  entity_type?: 'business' | 'individual';
 
   /**
    * Whether the counterparty is self-owned. `false` if the counterparty is not owned
    * by you, `true` if it is.
    */
-  is_self_owned: boolean;
+  is_self_owned?: boolean;
+
+  /**
+   * National tax or identity number of the counterparty, as issued in its country:
+   * CPF or CNPJ in Brazil, Cédula or NIT in Colombia, CUIL or CUIT in Argentina, DNI
+   * or RUC in Peru, RUT in Chile. Free text, up to 127 characters.
+   */
+  legal_id?: string;
 
   /**
    * Set of up to 50 key-value string pairs you can attach to store structured
    * information, such as correlating this resource with an object in your own
    * system. Keys may be up to 40 characters and values up to 500 characters.
    */
-  metadata: { [key: string]: string };
+  metadata?: { [key: string]: string } | null;
 
   /**
-   * Name of the counterparty, or null if not recorded.
+   * Name of the counterparty.
    */
-  name: string | null;
+  name?: string;
 
   /**
-   * Physical address of the counterparty, or null if not recorded.
+   * Phone number of the counterparty. Stored for operational contact only; it is not
+   * sent with payments.
    */
-  physical_address: CounterpartyBlockResponse.PhysicalAddress | null;
+  phone?: string;
 
   /**
-   * Resource type discriminator.
+   * Physical address of the counterparty.
    */
-  type: 'counterparty';
+  physical_address?: CounterpartyCreateParams.PhysicalAddress;
 }
 
-export namespace CounterpartyBlockResponse {
-  export interface IbanFinancialAddress {
-    /**
-     * Name of the account holder.
-     */
-    account_holder_name: string;
-
-    /**
-     * Bank Identifier Code, or null if not provided.
-     */
-    bic: string | null;
-
-    /**
-     * International Bank Account Number.
-     */
-    iban: string;
-
-    /**
-     * Discriminator for IBAN financial address.
-     */
-    type: 'iban';
-  }
-
-  export interface SortCodeFinancialAddress {
-    /**
-     * Name of the account holder.
-     */
-    account_holder_name: string;
-
-    /**
-     * UK account number (8 digits).
-     */
-    account_number: string;
-
-    /**
-     * UK sort code (6 digits).
-     */
-    sort_code: string;
-
-    /**
-     * Discriminator for UK sort code financial address.
-     */
-    type: 'sort_code';
-  }
-
-  export interface AbaFinancialAddress {
+export namespace CounterpartyCreateParams {
+  export interface AbaFinancialAddressRequest {
     /**
      * Name of the account holder.
      */
@@ -2085,393 +2151,16 @@ export namespace CounterpartyBlockResponse {
      * Discriminator for ABA wire financial address.
      */
     type: 'aba';
-  }
-
-  export interface BicFinancialAddress {
-    /**
-     * Name of the account holder.
-     */
-    account_holder_name: string;
-
-    /**
-     * Local-format bank account number.
-     */
-    account_number: string;
-
-    /**
-     * ISO 9362 Bank Identifier Code (8 or 11 characters).
-     */
-    bic: string;
-
-    /**
-     * Domestic bank or branch code where the destination country uses one (for example
-     * the BSB in Australia), or null.
-     */
-    local_bank_code: string | null;
 
     /**
-     * Discriminator for BIC + local account financial address.
+     * Whether the account is a checking or a savings account. Optional; omit or send
+     * null if not provided. Some destination countries require it (for example the
+     * Dominican Republic, Honduras and Jamaica) and ACH uses it for the transaction
+     * code. A payment to an account without one is sent as checking.
      */
-    type: 'bic';
+    account_type?: 'checking' | 'savings' | null;
   }
 
-  export interface CryptoWalletFinancialAddress {
-    /**
-     * Wallet address on the specified blockchain.
-     */
-    address: string;
-
-    /**
-     * Blockchain network for the crypto wallet.
-     */
-    blockchain:
-      | 'bitcoin'
-      | 'ethereum'
-      | 'solana'
-      | 'polygon'
-      | 'bitcoin_testnet4'
-      | 'ethereum_sepolia'
-      | 'solana_devnet'
-      | 'polygon_amoy';
-
-    /**
-     * Discriminator for crypto wallet financial address.
-     */
-    type: 'crypto_wallet';
-  }
-
-  /**
-   * Physical address of the counterparty, or null if not recorded.
-   */
-  export interface PhysicalAddress {
-    /**
-     * City or locality.
-     */
-    city: string;
-
-    /**
-     * ISO 3166-1 alpha-2 country code.
-     */
-    country_code:
-      | 'AF'
-      | 'AL'
-      | 'DZ'
-      | 'AS'
-      | 'AD'
-      | 'AO'
-      | 'AI'
-      | 'AQ'
-      | 'AG'
-      | 'AR'
-      | 'AM'
-      | 'AW'
-      | 'AU'
-      | 'AT'
-      | 'AZ'
-      | 'BS'
-      | 'BH'
-      | 'BD'
-      | 'BB'
-      | 'BY'
-      | 'BE'
-      | 'BZ'
-      | 'BJ'
-      | 'BM'
-      | 'BT'
-      | 'BO'
-      | 'BA'
-      | 'BW'
-      | 'BV'
-      | 'BR'
-      | 'IO'
-      | 'BN'
-      | 'BG'
-      | 'BF'
-      | 'BI'
-      | 'KH'
-      | 'CM'
-      | 'CA'
-      | 'CV'
-      | 'KY'
-      | 'CF'
-      | 'TD'
-      | 'CL'
-      | 'CN'
-      | 'CX'
-      | 'CC'
-      | 'CO'
-      | 'KM'
-      | 'CG'
-      | 'CD'
-      | 'CK'
-      | 'CR'
-      | 'CI'
-      | 'HR'
-      | 'CU'
-      | 'CY'
-      | 'CZ'
-      | 'DK'
-      | 'DJ'
-      | 'DM'
-      | 'DO'
-      | 'EC'
-      | 'EG'
-      | 'SV'
-      | 'GQ'
-      | 'ER'
-      | 'EE'
-      | 'ET'
-      | 'FK'
-      | 'FO'
-      | 'FJ'
-      | 'FI'
-      | 'FR'
-      | 'GF'
-      | 'PF'
-      | 'TF'
-      | 'GA'
-      | 'GM'
-      | 'GE'
-      | 'DE'
-      | 'GH'
-      | 'GI'
-      | 'GR'
-      | 'GL'
-      | 'GD'
-      | 'GP'
-      | 'GU'
-      | 'GT'
-      | 'GN'
-      | 'GW'
-      | 'GY'
-      | 'HT'
-      | 'HM'
-      | 'VA'
-      | 'HN'
-      | 'HK'
-      | 'HU'
-      | 'IS'
-      | 'IN'
-      | 'ID'
-      | 'IR'
-      | 'IQ'
-      | 'IE'
-      | 'IL'
-      | 'IT'
-      | 'JM'
-      | 'JP'
-      | 'JO'
-      | 'KZ'
-      | 'KE'
-      | 'KI'
-      | 'KP'
-      | 'KR'
-      | 'KW'
-      | 'KG'
-      | 'LA'
-      | 'LV'
-      | 'LB'
-      | 'LS'
-      | 'LR'
-      | 'LY'
-      | 'LI'
-      | 'LT'
-      | 'LU'
-      | 'MO'
-      | 'MG'
-      | 'MW'
-      | 'MY'
-      | 'MV'
-      | 'ML'
-      | 'MT'
-      | 'MH'
-      | 'MQ'
-      | 'MR'
-      | 'MU'
-      | 'YT'
-      | 'MX'
-      | 'FM'
-      | 'MD'
-      | 'MC'
-      | 'MN'
-      | 'MS'
-      | 'MA'
-      | 'MZ'
-      | 'MM'
-      | 'NA'
-      | 'NR'
-      | 'NP'
-      | 'NL'
-      | 'NC'
-      | 'NZ'
-      | 'NI'
-      | 'NE'
-      | 'NG'
-      | 'NU'
-      | 'NF'
-      | 'MP'
-      | 'MK'
-      | 'NO'
-      | 'OM'
-      | 'PK'
-      | 'PW'
-      | 'PS'
-      | 'PA'
-      | 'PG'
-      | 'PY'
-      | 'PE'
-      | 'PH'
-      | 'PN'
-      | 'PL'
-      | 'PT'
-      | 'PR'
-      | 'QA'
-      | 'RE'
-      | 'RO'
-      | 'RU'
-      | 'RW'
-      | 'SH'
-      | 'KN'
-      | 'LC'
-      | 'PM'
-      | 'VC'
-      | 'WS'
-      | 'SM'
-      | 'ST'
-      | 'SA'
-      | 'SN'
-      | 'SC'
-      | 'SL'
-      | 'SG'
-      | 'SK'
-      | 'SI'
-      | 'SB'
-      | 'SO'
-      | 'ZA'
-      | 'GS'
-      | 'ES'
-      | 'LK'
-      | 'SD'
-      | 'SR'
-      | 'SJ'
-      | 'SZ'
-      | 'SE'
-      | 'CH'
-      | 'SY'
-      | 'TW'
-      | 'TJ'
-      | 'TZ'
-      | 'TH'
-      | 'TL'
-      | 'TG'
-      | 'TK'
-      | 'TO'
-      | 'TT'
-      | 'TN'
-      | 'TR'
-      | 'TM'
-      | 'TC'
-      | 'TV'
-      | 'UG'
-      | 'UA'
-      | 'AE'
-      | 'GB'
-      | 'US'
-      | 'UM'
-      | 'UY'
-      | 'UZ'
-      | 'VU'
-      | 'VE'
-      | 'VN'
-      | 'VG'
-      | 'VI'
-      | 'WF'
-      | 'EH'
-      | 'YE'
-      | 'ZM'
-      | 'ZW'
-      | 'AX'
-      | 'BQ'
-      | 'CW'
-      | 'GG'
-      | 'IM'
-      | 'JE'
-      | 'ME'
-      | 'BL'
-      | 'MF'
-      | 'RS'
-      | 'SX'
-      | 'SS'
-      | 'XK';
-
-    /**
-     * Primary street address, or null if not recorded.
-     */
-    line_1: string | null;
-
-    /**
-     * Secondary street address, or null if not recorded.
-     */
-    line_2: string | null;
-
-    /**
-     * Postal or ZIP code, or null if not recorded.
-     */
-    postal_code: string | null;
-
-    /**
-     * State, province, or region, or null if not recorded.
-     */
-    state: string | null;
-  }
-}
-
-export interface CounterpartyCreateParams {
-  /**
-   * Financial address of the counterparty.
-   */
-  financial_address:
-    | CounterpartyCreateParams.IbanFinancialAddressRequest
-    | CounterpartyCreateParams.SortCodeFinancialAddress
-    | CounterpartyCreateParams.AbaFinancialAddress
-    | CounterpartyCreateParams.BicFinancialAddressRequest
-    | CounterpartyCreateParams.CryptoWalletFinancialAddress;
-
-  /**
-   * Date of birth in YYYY-MM-DD format.
-   */
-  date_of_birth?: string;
-
-  /**
-   * Whether the counterparty is a business or an individual. Defaults to business.
-   */
-  entity_type?: 'business' | 'individual';
-
-  /**
-   * Whether the counterparty is self-owned. `false` if the counterparty is not owned
-   * by you, `true` if it is.
-   */
-  is_self_owned?: boolean;
-
-  /**
-   * Set of up to 50 key-value string pairs you can attach to store structured
-   * information, such as correlating this resource with an object in your own
-   * system. Keys may be up to 40 characters and values up to 500 characters.
-   */
-  metadata?: { [key: string]: string } | null;
-
-  /**
-   * Name of the counterparty.
-   */
-  name?: string;
-
-  /**
-   * Physical address of the counterparty.
-   */
-  physical_address?: CounterpartyCreateParams.PhysicalAddress;
-}
-
-export namespace CounterpartyCreateParams {
   export interface IbanFinancialAddressRequest {
     /**
      * Name of the account holder.
@@ -2488,13 +2177,21 @@ export namespace CounterpartyCreateParams {
      */
     type: 'iban';
 
+    /**
+     * Whether the account is a checking or a savings account. Optional; omit or send
+     * null if not provided. Some destination countries require it (for example the
+     * Dominican Republic, Honduras and Jamaica) and ACH uses it for the transaction
+     * code. A payment to an account without one is sent as checking.
+     */
+    account_type?: 'checking' | 'savings' | null;
+
     /**
      * Bank Identifier Code. Optional; omit or send null if not provided.
      */
     bic?: string | null;
   }
 
-  export interface SortCodeFinancialAddress {
+  export interface SortCodeFinancialAddressRequest {
     /**
      * Name of the account holder.
      */
@@ -2516,28 +2213,6 @@ export namespace CounterpartyCreateParams {
     type: 'sort_code';
   }
 
-  export interface AbaFinancialAddress {
-    /**
-     * Name of the account holder.
-     */
-    account_holder_name: string;
-
-    /**
-     * Bank account number.
-     */
-    account_number: string;
-
-    /**
-     * ABA routing number (9 digits).
-     */
-    routing_number: string;
-
-    /**
-     * Discriminator for ABA wire financial address.
-     */
-    type: 'aba';
-  }
-
   export interface BicFinancialAddressRequest {
     /**
      * Name of the account holder.
@@ -2559,6 +2234,14 @@ export namespace CounterpartyCreateParams {
      */
     type: 'bic';
 
+    /**
+     * Whether the account is a checking or a savings account. Optional; omit or send
+     * null if not provided. Some destination countries require it (for example the
+     * Dominican Republic, Honduras and Jamaica) and ACH uses it for the transaction
+     * code. A payment to an account without one is sent as checking.
+     */
+    account_type?: 'checking' | 'savings' | null;
+
     /**
      * Domestic bank or branch code where the destination country uses one (for example
      * the BSB in Australia). Optional; omit or send null where the country has none.
@@ -2884,6 +2567,11 @@ export interface CounterpartyUpdateParams {
    */
   date_of_birth?: string | null;
 
+  /**
+   * New email address, or null to clear the current email address.
+   */
+  email?: string | null;
+
   /**
    * New entity type. Omit to keep the current entity type.
    */
@@ -2894,11 +2582,21 @@ export interface CounterpartyUpdateParams {
    */
   is_self_owned?: boolean;
 
+  /**
+   * New legal identifier, or null to clear the current legal identifier.
+   */
+  legal_id?: string | null;
+
   /**
    * New name, or null to clear the current name.
    */
   name?: string | null;
 
+  /**
+   * New phone number, or null to clear the current phone number.
+   */
+  phone?: string | null;
+
   /**
    * New physical address, or null to clear the current physical address.
    */
@@ -3200,7 +2898,6 @@ export declare namespace Counterparties {
     type CounterpartyRetrieveResponse as CounterpartyRetrieveResponse,
     type CounterpartyUpdateResponse as CounterpartyUpdateResponse,
     type CounterpartyListResponse as CounterpartyListResponse,
-    type CounterpartyBlockResponse as CounterpartyBlockResponse,
     type CounterpartyListResponsesCursorPage as CounterpartyListResponsesCursorPage,
     type CounterpartyCreateParams as CounterpartyCreateParams,
     type CounterpartyUpdateParams as CounterpartyUpdateParams,