@augustusbank/typescript-sdk 0.22.0 → 0.22.2

package/src/resources/payouts.ts

@@ -15,10 +15,8 @@ export class Payouts extends APIResource {
    * const payout = await client.payouts.create({
    *   account_id: '550e8400-e29b-41d4-a716-44665544000b',
    *   amount: '100.50',
-   *   destination: {
-   *     counterparty_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *     type: 'counterparty',
-   *   },
+   *   counterparty_id: '550e8400-e29b-41d4-a716-446655440000',
+   *   currency: 'EUR',
    * });
    * ```
    */
@@ -135,9 +133,10 @@ export interface PayoutCreateResponse {
   status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
 
   /**
-   * Identifier used to track the payout through the payment network where supported.
+   * Reference used to track the payment across the payment network, such as the UETR
+   * for SWIFT payments.
    */
-  tracking_id: string | null;
+  tracking_reference: string | null;
 
   /**
    * Transaction hash for crypto payouts, or null when not known. Only blockchain
@@ -268,9 +267,10 @@ export interface PayoutRetrieveResponse {
   status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
 
   /**
-   * Identifier used to track the payout through the payment network where supported.
+   * Reference used to track the payment across the payment network, such as the UETR
+   * for SWIFT payments.
    */
-  tracking_id: string | null;
+  tracking_reference: string | null;
 
   /**
    * Transaction hash for crypto payouts, or null when not known. Only blockchain
@@ -401,9 +401,10 @@ export interface PayoutListResponse {
   status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
 
   /**
-   * Identifier used to track the payout through the payment network where supported.
+   * Reference used to track the payment across the payment network, such as the UETR
+   * for SWIFT payments.
    */
-  tracking_id: string | null;
+  tracking_reference: string | null;
 
   /**
    * Transaction hash for crypto payouts, or null when not known. Only blockchain
@@ -472,24 +473,38 @@ export interface PayoutCreateParams {
   amount: string;
 
   /**
-   * Where and how to send the payout: a saved counterparty or an inline financial
-   * address. Currency and rail are bundled with the destination so only valid
-   * combinations are accepted.
+   * ID of the saved counterparty that receives the money.
    */
-  destination:
-    | PayoutCreateParams.SavedCounterpartyDestination
-    | PayoutCreateParams.IbanEurDestination
-    | PayoutCreateParams.IbanUsdDestination
-    | PayoutCreateParams.SortCodeDestination
-    | PayoutCreateParams.AbaDestination
-    | PayoutCreateParams.BicDestination
-    | PayoutCreateParams.CryptoWalletDestination;
+  counterparty_id: string;
+
+  /**
+   * Currency code (ISO 4217 or crypto).
+   */
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
   /**
    * Key-value pairs stored with the payout.
    */
   metadata?: { [key: string]: string } | null;
 
+  /**
+   * Settlement rail the counterparty is reachable on. Selected automatically when
+   * omitted. Validated against the counterparty financial address at runtime.
+   */
+  rail?:
+    | 'sepa'
+    | 'sepa_instant'
+    | 'faster_payments'
+    | 'swift'
+    | 'ach'
+    | 'fedwire'
+    | 'ethereum'
+    | 'ethereum_sepolia'
+    | 'solana'
+    | 'solana_devnet'
+    | 'polygon'
+    | 'polygon_amoy';
+
   /**
    * Unstructured remittance information attached to the transfer. This appears on
    * the counterparty's bank statement. Not supported by blockchain rails.
@@ -497,1978 +512,6 @@ export interface PayoutCreateParams {
   unstructured_remittance_information?: string | null;
 }
 
-export namespace PayoutCreateParams {
-  export interface SavedCounterpartyDestination {
-    /**
-     * ID of the saved counterparty to pay.
-     */
-    counterparty_id: string;
-
-    /**
-     * Discriminator for paying a saved counterparty.
-     */
-    type: 'counterparty';
-
-    /**
-     * Settlement rail the counterparty is reachable on. Selected automatically when
-     * omitted.
-     */
-    rail?: 'sepa' | 'sepa_instant' | 'faster_payments' | 'ach' | 'fedwire' | 'swift';
-  }
-
-  export interface IbanEurDestination {
-    /**
-     * Name of the account holder.
-     */
-    account_holder_name: string;
-
-    /**
-     * Currency of the payout. Settles in EUR.
-     */
-    currency: 'EUR';
-
-    /**
-     * 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;
-
-    /**
-     * Physical address of the counterparty. Only used when creating a new counterparty
-     * inline.
-     */
-    physical_address?: IbanEurDestination.PhysicalAddress | null;
-
-    /**
-     * When omitted, Augustus sends via SEPA Instant where available and falls back to
-     * SEPA Credit Transfer.
-     */
-    rail?: 'sepa' | 'sepa_instant';
-  }
-
-  export namespace IbanEurDestination {
-    /**
-     * Physical address of the counterparty. Only used when creating a new counterparty
-     * inline.
-     */
-    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.
-       */
-      line_1: string;
-
-      /**
-       * Postal or ZIP code.
-       */
-      postal_code: string;
-
-      /**
-       * Secondary street address, or null if not recorded.
-       */
-      line_2?: string | null;
-
-      /**
-       * State, province, or region, or null if not recorded.
-       */
-      state?: string | null;
-    }
-  }
-
-  export interface IbanUsdDestination {
-    /**
-     * Name of the account holder.
-     */
-    account_holder_name: string;
-
-    /**
-     * Currency of the payout. Settles in USD over SWIFT.
-     */
-    currency: 'USD';
-
-    /**
-     * 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;
-
-    /**
-     * Physical address of the counterparty. Only used when creating a new counterparty
-     * inline.
-     */
-    physical_address?: IbanUsdDestination.PhysicalAddress | null;
-
-    /**
-     * Settles over SWIFT. Defaults to `swift` when omitted.
-     */
-    rail?: 'swift';
-  }
-
-  export namespace IbanUsdDestination {
-    /**
-     * Physical address of the counterparty. Only used when creating a new counterparty
-     * inline.
-     */
-    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.
-       */
-      line_1: string;
-
-      /**
-       * Postal or ZIP code.
-       */
-      postal_code: string;
-
-      /**
-       * Secondary street address, or null if not recorded.
-       */
-      line_2?: string | null;
-
-      /**
-       * State, province, or region, or null if not recorded.
-       */
-      state?: string | null;
-    }
-  }
-
-  export interface SortCodeDestination {
-    /**
-     * Name of the account holder.
-     */
-    account_holder_name: string;
-
-    /**
-     * UK account number (8 digits).
-     */
-    account_number: string;
-
-    /**
-     * Currency of the payout. Sort code destinations settle in GBP.
-     */
-    currency: 'GBP';
-
-    /**
-     * UK sort code (6 digits).
-     */
-    sort_code: string;
-
-    /**
-     * Discriminator for UK sort code financial address.
-     */
-    type: 'sort_code';
-
-    /**
-     * Physical address of the counterparty. Only used when creating a new counterparty
-     * inline.
-     */
-    physical_address?: SortCodeDestination.PhysicalAddress | null;
-
-    /**
-     * Selected automatically for this destination when omitted.
-     */
-    rail?: 'faster_payments';
-  }
-
-  export namespace SortCodeDestination {
-    /**
-     * Physical address of the counterparty. Only used when creating a new counterparty
-     * inline.
-     */
-    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.
-       */
-      line_1: string;
-
-      /**
-       * Postal or ZIP code.
-       */
-      postal_code: string;
-
-      /**
-       * Secondary street address, or null if not recorded.
-       */
-      line_2?: string | null;
-
-      /**
-       * State, province, or region, or null if not recorded.
-       */
-      state?: string | null;
-    }
-  }
-
-  export interface AbaDestination {
-    /**
-     * Name of the account holder.
-     */
-    account_holder_name: string;
-
-    /**
-     * Bank account number.
-     */
-    account_number: string;
-
-    /**
-     * Currency of the payout. ABA destinations settle in USD.
-     */
-    currency: 'USD';
-
-    /**
-     * ABA accounts are reachable on more than one rail, so the rail must be specified.
-     */
-    rail: 'ach' | 'fedwire';
-
-    /**
-     * ABA routing number (9 digits).
-     */
-    routing_number: string;
-
-    /**
-     * Discriminator for ABA wire financial address.
-     */
-    type: 'aba';
-
-    /**
-     * Physical address of the counterparty. Only used when creating a new counterparty
-     * inline.
-     */
-    physical_address?: AbaDestination.PhysicalAddress | null;
-  }
-
-  export namespace AbaDestination {
-    /**
-     * Physical address of the counterparty. Only used when creating a new counterparty
-     * inline.
-     */
-    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.
-       */
-      line_1: string;
-
-      /**
-       * Postal or ZIP code.
-       */
-      postal_code: string;
-
-      /**
-       * Secondary street address, or null if not recorded.
-       */
-      line_2?: string | null;
-
-      /**
-       * State, province, or region, or null if not recorded.
-       */
-      state?: string | null;
-    }
-  }
-
-  export interface BicDestination {
-    /**
-     * 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;
-
-    /**
-     * Currency of the payout. Settles in USD over SWIFT.
-     */
-    currency: 'USD';
-
-    /**
-     * Physical address of the counterparty. Required for SWIFT destinations.
-     */
-    physical_address: BicDestination.PhysicalAddress;
-
-    /**
-     * 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;
-
-    /**
-     * Settles over SWIFT. Defaults to `swift` when omitted.
-     */
-    rail?: 'swift';
-  }
-
-  export namespace BicDestination {
-    /**
-     * Physical address of the counterparty. Required for SWIFT destinations.
-     */
-    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.
-       */
-      line_1: string;
-
-      /**
-       * Postal or ZIP code.
-       */
-      postal_code: string;
-
-      /**
-       * Secondary street address, or null if not recorded.
-       */
-      line_2?: string | null;
-
-      /**
-       * State, province, or region, or null if not recorded.
-       */
-      state?: string | null;
-    }
-  }
-
-  export interface CryptoWalletDestination {
-    /**
-     * Wallet address on the specified blockchain.
-     */
-    address: string;
-
-    /**
-     * Blockchain network of the destination wallet.
-     */
-    blockchain: 'ethereum' | 'solana' | 'polygon' | 'ethereum_sepolia' | 'solana_devnet' | 'polygon_amoy';
-
-    /**
-     * Currency debited from the source account. The wallet always settles USDC
-     * on-chain; a non-USDC currency triggers auto-conversion.
-     */
-    currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
-
-    /**
-     * Discriminator for a crypto wallet destination.
-     */
-    type: 'crypto_wallet';
-
-    /**
-     * Physical address of the counterparty. Only used when creating a new counterparty
-     * inline.
-     */
-    physical_address?: CryptoWalletDestination.PhysicalAddress | null;
-  }
-
-  export namespace CryptoWalletDestination {
-    /**
-     * Physical address of the counterparty. Only used when creating a new counterparty
-     * inline.
-     */
-    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.
-       */
-      line_1: string;
-
-      /**
-       * Postal or ZIP code.
-       */
-      postal_code: string;
-
-      /**
-       * Secondary street address, or null if not recorded.
-       */
-      line_2?: string | null;
-
-      /**
-       * State, province, or region, or null if not recorded.
-       */
-      state?: string | null;
-    }
-  }
-}
-
 export interface PayoutListParams extends CursorPageParams {
   created_at?: PayoutListParams.CreatedAt;