@augustusbank/typescript-sdk 0.27.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',
    *   },
    * });
    * ```
@@ -97,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.
    */
@@ -106,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;
 
@@ -118,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
@@ -130,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.
    */
@@ -142,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 {
@@ -219,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).
      */
@@ -563,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.
    */
@@ -572,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;
 
@@ -584,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
@@ -596,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.
    */
@@ -608,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 {
@@ -685,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).
      */
@@ -1029,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.
    */
@@ -1038,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;
 
@@ -1050,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
@@ -1062,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.
    */
@@ -1074,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 {
@@ -1151,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).
      */
@@ -1495,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.
    */
@@ -1504,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;
 
@@ -1516,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
@@ -1528,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.
    */
@@ -1540,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 {
@@ -1617,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).
      */
@@ -1950,9 +2071,9 @@ export interface CounterpartyCreateParams {
    * Financial address of the counterparty.
    */
   financial_address:
+    | CounterpartyCreateParams.AbaFinancialAddressRequest
     | CounterpartyCreateParams.IbanFinancialAddressRequest
     | CounterpartyCreateParams.SortCodeFinancialAddressRequest
-    | CounterpartyCreateParams.AbaFinancialAddressRequest
     | CounterpartyCreateParams.BicFinancialAddressRequest
     | CounterpartyCreateParams.CryptoWalletFinancialAddress;
 
@@ -1961,6 +2082,12 @@ export interface CounterpartyCreateParams {
    */
   date_of_birth?: string;
 
+  /**
+   * Email address of the counterparty. Stored for operational contact only; it is
+   * not sent with payments.
+   */
+  email?: string;
+
   /**
    * Whether the counterparty is a business or an individual. Defaults to business.
    */
@@ -1972,6 +2099,13 @@ export interface CounterpartyCreateParams {
    */
   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
@@ -1984,6 +2118,12 @@ export interface CounterpartyCreateParams {
    */
   name?: string;
 
+  /**
+   * Phone number of the counterparty. Stored for operational contact only; it is not
+   * sent with payments.
+   */
+  phone?: string;
+
   /**
    * Physical address of the counterparty.
    */
@@ -1991,70 +2131,86 @@ export interface CounterpartyCreateParams {
 }
 
 export namespace CounterpartyCreateParams {
-  export interface IbanFinancialAddressRequest {
+  export interface AbaFinancialAddressRequest {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * International Bank Account Number.
+     * Bank account number.
      */
-    iban: string;
+    account_number: string;
 
     /**
-     * Discriminator for IBAN financial address.
+     * ABA routing number (9 digits).
      */
-    type: 'iban';
+    routing_number: string;
 
     /**
-     * Bank Identifier Code. Optional; omit or send null if not provided.
+     * Discriminator for ABA wire financial address.
      */
-    bic?: string | null;
+    type: 'aba';
+
+    /**
+     * 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;
   }
 
-  export interface SortCodeFinancialAddressRequest {
+  export interface IbanFinancialAddressRequest {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * UK account number (8 digits).
+     * International Bank Account Number.
      */
-    account_number: string;
+    iban: string;
 
     /**
-     * UK sort code (6 digits).
+     * Discriminator for IBAN financial address.
      */
-    sort_code: string;
+    type: 'iban';
 
     /**
-     * Discriminator for UK sort code 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: 'sort_code';
+    account_type?: 'checking' | 'savings' | null;
+
+    /**
+     * Bank Identifier Code. Optional; omit or send null if not provided.
+     */
+    bic?: string | null;
   }
 
-  export interface AbaFinancialAddressRequest {
+  export interface SortCodeFinancialAddressRequest {
     /**
      * 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 BicFinancialAddressRequest {
@@ -2078,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.
@@ -2403,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.
    */
@@ -2413,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.
    */