@augustusbank/typescript-sdk 0.20.0 → 0.22.0

package/resources/counterparties.d.mts

@@ -0,0 +1,1042 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Counterparties extends APIResource {
+    /**
+     * Creates a counterparty owned by the merchant.
+     */
+    create(body: CounterpartyCreateParams, options?: RequestOptions): APIPromise<CounterpartyCreateResponse>;
+    /**
+     * Retrieves a counterparty owned by the merchant.
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<CounterpartyRetrieveResponse>;
+    /**
+     * Updates the mutable details of a counterparty owned by the merchant.
+     */
+    update(id: string, body: CounterpartyUpdateParams, options?: RequestOptions): APIPromise<CounterpartyUpdateResponse>;
+    /**
+     * Lists counterparties owned by the merchant with cursor-based pagination.
+     */
+    list(query?: CounterpartyListParams | null | undefined, options?: RequestOptions): PagePromise<CounterpartyListResponsesCursorPage, CounterpartyListResponse>;
+    /**
+     * Blocks payments to and from a counterparty owned by the merchant. Blocking an
+     * already-blocked counterparty succeeds without changing the existing block.
+     */
+    block(id: string, options?: RequestOptions): APIPromise<CounterpartyBlockResponse>;
+}
+export type CounterpartyListResponsesCursorPage = CursorPage<CounterpartyListResponse>;
+export interface CounterpartyCreateResponse {
+    /**
+     * Unique identifier of the counterparty.
+     */
+    id: string;
+    /**
+     * Whether payments to or from this counterparty are currently blocked.
+     */
+    blocked: boolean;
+    /**
+     * Date of birth in YYYY-MM-DD format, or null if not recorded.
+     */
+    date_of_birth: string | null;
+    /**
+     * Whether the counterparty is a business or an individual.
+     */
+    entity_type: 'business' | 'individual';
+    /**
+     * Financial address of the counterparty.
+     */
+    financial_address: CounterpartyCreateResponse.IbanFinancialAddress | CounterpartyCreateResponse.SortCodeFinancialAddress | CounterpartyCreateResponse.AbaFinancialAddress | CounterpartyCreateResponse.BicFinancialAddress | CounterpartyCreateResponse.CryptoWalletFinancialAddress;
+    /**
+     * Whether the counterparty is self-owned. `false` if the counterparty is not owned
+     * by you, `true` if it is.
+     */
+    is_self_owned: boolean;
+    /**
+     * Name of the counterparty, or null if not recorded.
+     */
+    name: string | null;
+    /**
+     * Physical address of the counterparty, or null if not recorded.
+     */
+    physical_address: CounterpartyCreateResponse.PhysicalAddress | null;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'counterparty';
+}
+export declare namespace CounterpartyCreateResponse {
+    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';
+    }
+    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';
+    }
+    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';
+    }
+    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.
+         */
+        type: 'bic';
+    }
+    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.
+     */
+    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 CounterpartyRetrieveResponse {
+    /**
+     * Unique identifier of the counterparty.
+     */
+    id: string;
+    /**
+     * Whether payments to or from this counterparty are currently blocked.
+     */
+    blocked: boolean;
+    /**
+     * Date of birth in YYYY-MM-DD format, or null if not recorded.
+     */
+    date_of_birth: string | null;
+    /**
+     * Whether the counterparty is a business or an individual.
+     */
+    entity_type: 'business' | 'individual';
+    /**
+     * Financial address of the counterparty.
+     */
+    financial_address: CounterpartyRetrieveResponse.IbanFinancialAddress | CounterpartyRetrieveResponse.SortCodeFinancialAddress | CounterpartyRetrieveResponse.AbaFinancialAddress | CounterpartyRetrieveResponse.BicFinancialAddress | CounterpartyRetrieveResponse.CryptoWalletFinancialAddress;
+    /**
+     * Whether the counterparty is self-owned. `false` if the counterparty is not owned
+     * by you, `true` if it is.
+     */
+    is_self_owned: boolean;
+    /**
+     * Name of the counterparty, or null if not recorded.
+     */
+    name: string | null;
+    /**
+     * Physical address of the counterparty, or null if not recorded.
+     */
+    physical_address: CounterpartyRetrieveResponse.PhysicalAddress | null;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'counterparty';
+}
+export declare namespace CounterpartyRetrieveResponse {
+    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';
+    }
+    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';
+    }
+    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';
+    }
+    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.
+         */
+        type: 'bic';
+    }
+    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.
+     */
+    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 CounterpartyUpdateResponse {
+    /**
+     * Unique identifier of the counterparty.
+     */
+    id: string;
+    /**
+     * Whether payments to or from this counterparty are currently blocked.
+     */
+    blocked: boolean;
+    /**
+     * Date of birth in YYYY-MM-DD format, or null if not recorded.
+     */
+    date_of_birth: string | null;
+    /**
+     * Whether the counterparty is a business or an individual.
+     */
+    entity_type: 'business' | 'individual';
+    /**
+     * Financial address of the counterparty.
+     */
+    financial_address: CounterpartyUpdateResponse.IbanFinancialAddress | CounterpartyUpdateResponse.SortCodeFinancialAddress | CounterpartyUpdateResponse.AbaFinancialAddress | CounterpartyUpdateResponse.BicFinancialAddress | CounterpartyUpdateResponse.CryptoWalletFinancialAddress;
+    /**
+     * Whether the counterparty is self-owned. `false` if the counterparty is not owned
+     * by you, `true` if it is.
+     */
+    is_self_owned: boolean;
+    /**
+     * Name of the counterparty, or null if not recorded.
+     */
+    name: string | null;
+    /**
+     * Physical address of the counterparty, or null if not recorded.
+     */
+    physical_address: CounterpartyUpdateResponse.PhysicalAddress | null;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'counterparty';
+}
+export declare namespace CounterpartyUpdateResponse {
+    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';
+    }
+    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';
+    }
+    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';
+    }
+    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.
+         */
+        type: 'bic';
+    }
+    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.
+     */
+    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 CounterpartyListResponse {
+    /**
+     * Unique identifier of the counterparty.
+     */
+    id: string;
+    /**
+     * Whether payments to or from this counterparty are currently blocked.
+     */
+    blocked: boolean;
+    /**
+     * Date of birth in YYYY-MM-DD format, or null if not recorded.
+     */
+    date_of_birth: string | null;
+    /**
+     * Whether the counterparty is a business or an individual.
+     */
+    entity_type: 'business' | 'individual';
+    /**
+     * Financial address of the counterparty.
+     */
+    financial_address: CounterpartyListResponse.IbanFinancialAddress | CounterpartyListResponse.SortCodeFinancialAddress | CounterpartyListResponse.AbaFinancialAddress | CounterpartyListResponse.BicFinancialAddress | CounterpartyListResponse.CryptoWalletFinancialAddress;
+    /**
+     * Whether the counterparty is self-owned. `false` if the counterparty is not owned
+     * by you, `true` if it is.
+     */
+    is_self_owned: boolean;
+    /**
+     * Name of the counterparty, or null if not recorded.
+     */
+    name: string | null;
+    /**
+     * Physical address of the counterparty, or null if not recorded.
+     */
+    physical_address: CounterpartyListResponse.PhysicalAddress | null;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'counterparty';
+}
+export declare namespace CounterpartyListResponse {
+    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';
+    }
+    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';
+    }
+    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';
+    }
+    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.
+         */
+        type: 'bic';
+    }
+    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.
+     */
+    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 CounterpartyBlockResponse {
+    /**
+     * Unique identifier of the counterparty.
+     */
+    id: string;
+    /**
+     * Whether payments to or from this counterparty are currently blocked.
+     */
+    blocked: boolean;
+    /**
+     * Date of birth in YYYY-MM-DD format, or null if not recorded.
+     */
+    date_of_birth: string | null;
+    /**
+     * Whether the counterparty is a business or an individual.
+     */
+    entity_type: 'business' | 'individual';
+    /**
+     * Financial address of the counterparty.
+     */
+    financial_address: CounterpartyBlockResponse.IbanFinancialAddress | CounterpartyBlockResponse.SortCodeFinancialAddress | CounterpartyBlockResponse.AbaFinancialAddress | CounterpartyBlockResponse.BicFinancialAddress | CounterpartyBlockResponse.CryptoWalletFinancialAddress;
+    /**
+     * Whether the counterparty is self-owned. `false` if the counterparty is not owned
+     * by you, `true` if it is.
+     */
+    is_self_owned: boolean;
+    /**
+     * Name of the counterparty, or null if not recorded.
+     */
+    name: string | null;
+    /**
+     * Physical address of the counterparty, or null if not recorded.
+     */
+    physical_address: CounterpartyBlockResponse.PhysicalAddress | null;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'counterparty';
+}
+export declare namespace CounterpartyBlockResponse {
+    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';
+    }
+    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';
+    }
+    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';
+    }
+    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.
+         */
+        type: 'bic';
+    }
+    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.
+     */
+    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;
+    /**
+     * Name of the counterparty.
+     */
+    name?: string;
+    /**
+     * Physical address of the counterparty.
+     */
+    physical_address?: CounterpartyCreateParams.PhysicalAddress;
+}
+export declare namespace CounterpartyCreateParams {
+    interface IbanFinancialAddressRequest {
+        /**
+         * Name of the account holder.
+         */
+        account_holder_name: string;
+        /**
+         * International Bank Account Number.
+         */
+        iban: string;
+        /**
+         * Discriminator for IBAN financial address.
+         */
+        type: 'iban';
+        /**
+         * Bank Identifier Code. Optional; omit or send null if not provided.
+         */
+        bic?: string | null;
+    }
+    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';
+    }
+    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';
+    }
+    interface BicFinancialAddressRequest {
+        /**
+         * Name of the account holder.
+         */
+        account_holder_name: string;
+        /**
+         * Local-format bank account number (1-34 alphanumeric characters).
+         */
+        account_number: string;
+        /**
+         * ISO 9362 Bank Identifier Code (8 or 11 characters).
+         */
+        bic: string;
+        /**
+         * Discriminator for BIC + local account financial address.
+         */
+        type: 'bic';
+        /**
+         * 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.
+         */
+        local_bank_code?: string | null;
+    }
+    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.
+     */
+    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 CounterpartyUpdateParams {
+    /**
+     * New date of birth in YYYY-MM-DD format, or null to clear the current date of
+     * birth.
+     */
+    date_of_birth?: string | null;
+    /**
+     * New entity type. Omit to keep the current entity type.
+     */
+    entity_type?: 'business' | 'individual';
+    /**
+     * New ownership status. Omit to keep the current ownership status.
+     */
+    is_self_owned?: boolean;
+    /**
+     * New name, or null to clear the current name.
+     */
+    name?: string | null;
+    /**
+     * New physical address, or null to clear the current physical address.
+     */
+    physical_address?: CounterpartyUpdateParams.PhysicalAddress | null;
+}
+export declare namespace CounterpartyUpdateParams {
+    /**
+     * New physical address, or null to clear the current physical address.
+     */
+    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 CounterpartyListParams extends CursorPageParams {
+}
+export declare namespace Counterparties {
+    export { type CounterpartyCreateResponse as CounterpartyCreateResponse, 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, type CounterpartyListParams as CounterpartyListParams, };
+}
+//# sourceMappingURL=counterparties.d.mts.map