@augustusbank/typescript-sdk 0.33.0 → 0.35.0

package/src/resources/account-holders.ts

@@ -1421,11 +1421,14 @@ export namespace AccountHolderCreateResponse {
 
     /**
      * Business registration number: type "ein" (Employer Identification Number, format
-     * ##-#######) or "ssn" (Social Security Number, format ###-##-####).
+     * ##-#######), "ssn" (Social Security Number, format ###-##-####), or "other" (any
+     * other registration number, 1-32 characters, non-US businesses only, with a
+     * required `description` of what the number is).
      */
     registration_number:
       | V1BusinessBeneficiaryDataResponse.V1EinIdentification
-      | V1BusinessBeneficiaryDataResponse.V1SsnIdentification;
+      | V1BusinessBeneficiaryDataResponse.V1SsnIdentification
+      | V1BusinessBeneficiaryDataResponse.V1OtherRegistrationNumber;
 
     /**
      * State or subdivision where the business is incorporated.
@@ -4012,6 +4015,21 @@ export namespace AccountHolderCreateResponse {
 
       value: string;
     }
+
+    export interface V1OtherRegistrationNumber {
+      /**
+       * A short explanation of what this number is and which authority issued it.
+       */
+      description: string;
+
+      type: 'other';
+
+      /**
+       * The registration number, 1-32 characters. Any characters are allowed, but at
+       * least one must be a letter or digit.
+       */
+      value: string;
+    }
   }
 }
 
@@ -5329,11 +5347,14 @@ export namespace AccountHolderRetrieveResponse {
 
     /**
      * Business registration number: type "ein" (Employer Identification Number, format
-     * ##-#######) or "ssn" (Social Security Number, format ###-##-####).
+     * ##-#######), "ssn" (Social Security Number, format ###-##-####), or "other" (any
+     * other registration number, 1-32 characters, non-US businesses only, with a
+     * required `description` of what the number is).
      */
     registration_number:
       | V1BusinessBeneficiaryDataResponse.V1EinIdentification
-      | V1BusinessBeneficiaryDataResponse.V1SsnIdentification;
+      | V1BusinessBeneficiaryDataResponse.V1SsnIdentification
+      | V1BusinessBeneficiaryDataResponse.V1OtherRegistrationNumber;
 
     /**
      * State or subdivision where the business is incorporated.
@@ -7920,6 +7941,21 @@ export namespace AccountHolderRetrieveResponse {
 
       value: string;
     }
+
+    export interface V1OtherRegistrationNumber {
+      /**
+       * A short explanation of what this number is and which authority issued it.
+       */
+      description: string;
+
+      type: 'other';
+
+      /**
+       * The registration number, 1-32 characters. Any characters are allowed, but at
+       * least one must be a letter or digit.
+       */
+      value: string;
+    }
   }
 }
 
@@ -9237,11 +9273,14 @@ export namespace AccountHolderUpdateResponse {
 
     /**
      * Business registration number: type "ein" (Employer Identification Number, format
-     * ##-#######) or "ssn" (Social Security Number, format ###-##-####).
+     * ##-#######), "ssn" (Social Security Number, format ###-##-####), or "other" (any
+     * other registration number, 1-32 characters, non-US businesses only, with a
+     * required `description` of what the number is).
      */
     registration_number:
       | V1BusinessBeneficiaryDataResponse.V1EinIdentification
-      | V1BusinessBeneficiaryDataResponse.V1SsnIdentification;
+      | V1BusinessBeneficiaryDataResponse.V1SsnIdentification
+      | V1BusinessBeneficiaryDataResponse.V1OtherRegistrationNumber;
 
     /**
      * State or subdivision where the business is incorporated.
@@ -11828,6 +11867,21 @@ export namespace AccountHolderUpdateResponse {
 
       value: string;
     }
+
+    export interface V1OtherRegistrationNumber {
+      /**
+       * A short explanation of what this number is and which authority issued it.
+       */
+      description: string;
+
+      type: 'other';
+
+      /**
+       * The registration number, 1-32 characters. Any characters are allowed, but at
+       * least one must be a letter or digit.
+       */
+      value: string;
+    }
   }
 }
 
@@ -13145,11 +13199,14 @@ export namespace AccountHolderListResponse {
 
     /**
      * Business registration number: type "ein" (Employer Identification Number, format
-     * ##-#######) or "ssn" (Social Security Number, format ###-##-####).
+     * ##-#######), "ssn" (Social Security Number, format ###-##-####), or "other" (any
+     * other registration number, 1-32 characters, non-US businesses only, with a
+     * required `description` of what the number is).
      */
     registration_number:
       | V1BusinessBeneficiaryDataResponse.V1EinIdentification
-      | V1BusinessBeneficiaryDataResponse.V1SsnIdentification;
+      | V1BusinessBeneficiaryDataResponse.V1SsnIdentification
+      | V1BusinessBeneficiaryDataResponse.V1OtherRegistrationNumber;
 
     /**
      * State or subdivision where the business is incorporated.
@@ -15736,6 +15793,21 @@ export namespace AccountHolderListResponse {
 
       value: string;
     }
+
+    export interface V1OtherRegistrationNumber {
+      /**
+       * A short explanation of what this number is and which authority issued it.
+       */
+      description: string;
+
+      type: 'other';
+
+      /**
+       * The registration number, 1-32 characters. Any characters are allowed, but at
+       * least one must be a letter or digit.
+       */
+      value: string;
+    }
   }
 }
 
@@ -17028,11 +17100,14 @@ export namespace AccountHolderCreateParams {
 
     /**
      * Business registration number: type "ein" (Employer Identification Number, format
-     * ##-#######) or "ssn" (Social Security Number, format ###-##-####).
+     * ##-#######), "ssn" (Social Security Number, format ###-##-####), or "other" (any
+     * other registration number, 1-32 characters, non-US businesses only, with a
+     * required `description` of what the number is).
      */
     registration_number:
       | V1BusinessBeneficiaryData.V1EinIdentification
-      | V1BusinessBeneficiaryData.V1SsnIdentification;
+      | V1BusinessBeneficiaryData.V1SsnIdentification
+      | V1BusinessBeneficiaryData.V1OtherRegistrationNumber;
 
     /**
      * State or subdivision where the business is incorporated.
@@ -19626,6 +19701,21 @@ export namespace AccountHolderCreateParams {
 
       value: string;
     }
+
+    export interface V1OtherRegistrationNumber {
+      /**
+       * A short explanation of what this number is and which authority issued it.
+       */
+      description: string;
+
+      type: 'other';
+
+      /**
+       * The registration number, 1-32 characters. Any characters are allowed, but at
+       * least one must be a letter or digit.
+       */
+      value: string;
+    }
   }
 }
 
@@ -20901,11 +20991,14 @@ export namespace AccountHolderUpdateParams {
 
     /**
      * Business registration number: type "ein" (Employer Identification Number, format
-     * ##-#######) or "ssn" (Social Security Number, format ###-##-####).
+     * ##-#######), "ssn" (Social Security Number, format ###-##-####), or "other" (any
+     * other registration number, 1-32 characters, non-US businesses only, with a
+     * required `description` of what the number is).
      */
     registration_number:
       | V1BusinessBeneficiaryData.V1EinIdentification
-      | V1BusinessBeneficiaryData.V1SsnIdentification;
+      | V1BusinessBeneficiaryData.V1SsnIdentification
+      | V1BusinessBeneficiaryData.V1OtherRegistrationNumber;
 
     /**
      * State or subdivision where the business is incorporated.
@@ -23499,6 +23592,21 @@ export namespace AccountHolderUpdateParams {
 
       value: string;
     }
+
+    export interface V1OtherRegistrationNumber {
+      /**
+       * A short explanation of what this number is and which authority issued it.
+       */
+      description: string;
+
+      type: 'other';
+
+      /**
+       * The registration number, 1-32 characters. Any characters are allowed, but at
+       * least one must be a letter or digit.
+       */
+      value: string;
+    }
   }
 }
 

package/src/resources/accounts.ts

@@ -161,7 +161,8 @@ export interface AccountCreateResponse {
   >;
 
   /**
-   * Human-readable label for the account.
+   * Human-readable label for the account. For FBO accounts the label is set to the
+   * account holder’s name.
    */
   label: string;
 
@@ -361,7 +362,8 @@ export interface AccountRetrieveResponse {
   >;
 
   /**
-   * Human-readable label for the account.
+   * Human-readable label for the account. For FBO accounts the label is set to the
+   * account holder’s name.
    */
   label: string;
 
@@ -561,7 +563,8 @@ export interface AccountListResponse {
   >;
 
   /**
-   * Human-readable label for the account.
+   * Human-readable label for the account. For FBO accounts the label is set to the
+   * account holder’s name.
    */
   label: string;
 
@@ -761,7 +764,8 @@ export interface AccountCloseResponse {
   >;
 
   /**
-   * Human-readable label for the account.
+   * Human-readable label for the account. For FBO accounts the label is set to the
+   * account holder’s name.
    */
   label: string;
 
@@ -961,7 +965,8 @@ export interface AccountFreezeResponse {
   >;
 
   /**
-   * Human-readable label for the account.
+   * Human-readable label for the account. For FBO accounts the label is set to the
+   * account holder’s name.
    */
   label: string;
 
@@ -1199,7 +1204,8 @@ export interface AccountUnfreezeResponse {
   >;
 
   /**
-   * Human-readable label for the account.
+   * Human-readable label for the account. For FBO accounts the label is set to the
+   * account holder’s name.
    */
   label: string;
 

package/src/resources/conversions.ts

@@ -97,7 +97,7 @@ export interface ConversionCreateResponse {
   /**
    * Current status of the conversion.
    */
-  status: 'pending' | 'completed' | 'failed';
+  status: 'initiated' | 'pending' | 'completed' | 'failed';
 
   /**
    * ID of the target account, or null.
@@ -156,7 +156,7 @@ export interface ConversionRetrieveResponse {
   /**
    * Current status of the conversion.
    */
-  status: 'pending' | 'completed' | 'failed';
+  status: 'initiated' | 'pending' | 'completed' | 'failed';
 
   /**
    * ID of the target account, or null.
@@ -215,7 +215,7 @@ export interface ConversionListResponse {
   /**
    * Current status of the conversion.
    */
-  status: 'pending' | 'completed' | 'failed';
+  status: 'initiated' | 'pending' | 'completed' | 'failed';
 
   /**
    * ID of the target account, or null.
@@ -271,7 +271,7 @@ export interface ConversionListParams extends CursorPageParams {
   /**
    * Filter by conversion status.
    */
-  status?: 'pending' | 'completed' | 'failed';
+  status?: 'initiated' | 'pending' | 'completed' | 'failed';
 
   /**
    * Filter by target currency code.

package/src/resources/payout-tracking-events.ts

@@ -54,13 +54,21 @@ export interface PayoutTrackingEventRetrieveResponse {
   fee: PayoutTrackingEventRetrieveResponse.Fee | null;
 
   /**
-   * Institution that acted on or reported this step. Null when unknown.
+   * Institution that sent the payout in this step. Null when unknown or not reported
+   * by the source.
+   */
+  from_institution: PayoutTrackingEventRetrieveResponse.FromInstitution | null;
+
+  /**
+   * Institution holding the payout after this step: the bank that received it, or
+   * the bank that reported this status. Null when unknown.
    */
   institution: PayoutTrackingEventRetrieveResponse.Institution | null;
 
   /**
-   * Whether Augustus considers delivery finished. A later event, such as returned,
-   * can still follow.
+   * Whether Augustus considers delivery finished. A credit reported by a bank that
+   * passes the payout on is a forwarded step and is not terminal. A later event,
+   * such as returned, can still follow.
    */
   is_terminal: boolean;
 
@@ -169,18 +177,62 @@ export namespace PayoutTrackingEventRetrieveResponse {
   }
 
   /**
-   * Institution that acted on or reported this step. Null when unknown.
+   * Institution that sent the payout in this step. Null when unknown or not reported
+   * by the source.
+   */
+  export interface FromInstitution {
+    /**
+     * Identifier of the institution, typed by scheme. Null when only its name is
+     * known.
+     */
+    identifier: FromInstitution.Identifier | null;
+
+    /**
+     * Name of the institution. Null when unknown.
+     */
+    name: string | null;
+  }
+
+  export namespace FromInstitution {
+    /**
+     * Identifier of the institution, typed by scheme. Null when only its name is
+     * known.
+     */
+    export interface Identifier {
+      /**
+       * Identifier scheme. Only bic today.
+       */
+      type: 'bic';
+
+      /**
+       * ISO 9362 Bank Identifier Code, always 11 characters. An 8-character BIC is
+       * padded with the XXX head office branch code.
+       */
+      value: string;
+    }
+  }
+
+  /**
+   * Institution holding the payout after this step: the bank that received it, or
+   * the bank that reported this status. Null when unknown.
    */
   export interface Institution {
     /**
-     * Identifier of the institution, typed by scheme.
+     * Identifier of the institution, typed by scheme. Null when only its name is
+     * known.
+     */
+    identifier: Institution.Identifier | null;
+
+    /**
+     * Name of the institution. Null when unknown.
      */
-    identifier: Institution.Identifier;
+    name: string | null;
   }
 
   export namespace Institution {
     /**
-     * Identifier of the institution, typed by scheme.
+     * Identifier of the institution, typed by scheme. Null when only its name is
+     * known.
      */
     export interface Identifier {
       /**
@@ -189,7 +241,8 @@ export namespace PayoutTrackingEventRetrieveResponse {
       type: 'bic';
 
       /**
-       * ISO 9362 Bank Identifier Code (8 or 11 characters).
+       * ISO 9362 Bank Identifier Code, always 11 characters. An 8-character BIC is
+       * padded with the XXX head office branch code.
        */
       value: string;
     }
@@ -215,7 +268,8 @@ export namespace PayoutTrackingEventRetrieveResponse {
    */
   export interface StatusReason {
     /**
-     * Normalized reason code assigned by Augustus. New codes may be added.
+     * Normalized reason code assigned by Augustus. Current codes: `CREDIT_PENDING`
+     * (the beneficiary bank reported the credit as pending). New codes may be added.
      */
     code: string;
 
@@ -249,13 +303,21 @@ export interface PayoutTrackingEventListResponse {
   fee: PayoutTrackingEventListResponse.Fee | null;
 
   /**
-   * Institution that acted on or reported this step. Null when unknown.
+   * Institution that sent the payout in this step. Null when unknown or not reported
+   * by the source.
+   */
+  from_institution: PayoutTrackingEventListResponse.FromInstitution | null;
+
+  /**
+   * Institution holding the payout after this step: the bank that received it, or
+   * the bank that reported this status. Null when unknown.
    */
   institution: PayoutTrackingEventListResponse.Institution | null;
 
   /**
-   * Whether Augustus considers delivery finished. A later event, such as returned,
-   * can still follow.
+   * Whether Augustus considers delivery finished. A credit reported by a bank that
+   * passes the payout on is a forwarded step and is not terminal. A later event,
+   * such as returned, can still follow.
    */
   is_terminal: boolean;
 
@@ -364,18 +426,62 @@ export namespace PayoutTrackingEventListResponse {
   }
 
   /**
-   * Institution that acted on or reported this step. Null when unknown.
+   * Institution that sent the payout in this step. Null when unknown or not reported
+   * by the source.
+   */
+  export interface FromInstitution {
+    /**
+     * Identifier of the institution, typed by scheme. Null when only its name is
+     * known.
+     */
+    identifier: FromInstitution.Identifier | null;
+
+    /**
+     * Name of the institution. Null when unknown.
+     */
+    name: string | null;
+  }
+
+  export namespace FromInstitution {
+    /**
+     * Identifier of the institution, typed by scheme. Null when only its name is
+     * known.
+     */
+    export interface Identifier {
+      /**
+       * Identifier scheme. Only bic today.
+       */
+      type: 'bic';
+
+      /**
+       * ISO 9362 Bank Identifier Code, always 11 characters. An 8-character BIC is
+       * padded with the XXX head office branch code.
+       */
+      value: string;
+    }
+  }
+
+  /**
+   * Institution holding the payout after this step: the bank that received it, or
+   * the bank that reported this status. Null when unknown.
    */
   export interface Institution {
     /**
-     * Identifier of the institution, typed by scheme.
+     * Identifier of the institution, typed by scheme. Null when only its name is
+     * known.
+     */
+    identifier: Institution.Identifier | null;
+
+    /**
+     * Name of the institution. Null when unknown.
      */
-    identifier: Institution.Identifier;
+    name: string | null;
   }
 
   export namespace Institution {
     /**
-     * Identifier of the institution, typed by scheme.
+     * Identifier of the institution, typed by scheme. Null when only its name is
+     * known.
      */
     export interface Identifier {
       /**
@@ -384,7 +490,8 @@ export namespace PayoutTrackingEventListResponse {
       type: 'bic';
 
       /**
-       * ISO 9362 Bank Identifier Code (8 or 11 characters).
+       * ISO 9362 Bank Identifier Code, always 11 characters. An 8-character BIC is
+       * padded with the XXX head office branch code.
        */
       value: string;
     }
@@ -410,7 +517,8 @@ export namespace PayoutTrackingEventListResponse {
    */
   export interface StatusReason {
     /**
-     * Normalized reason code assigned by Augustus. New codes may be added.
+     * Normalized reason code assigned by Augustus. Current codes: `CREDIT_PENDING`
+     * (the beneficiary bank reported the credit as pending). New codes may be added.
      */
     code: string;
 

package/src/resources/payouts.ts

@@ -103,9 +103,7 @@ export interface PayoutCreateResponse {
   metadata: { [key: string]: string };
 
   /**
-   * Purpose of the payout. Use an ISO 20022 external purpose code unless the
-   * beneficiary bank country requires a national code. Only supported on fedwire and
-   * swift payouts.
+   * ISO 20022 external purpose code. Only supported on fedwire and swift payouts.
    */
   purpose_code:
     | 'BKDF'
@@ -436,12 +434,6 @@ export interface PayoutCreateResponse {
     | 'DEPD'
     | 'RETL'
     | 'DEBT'
-    | 'CAP'
-    | 'GDS'
-    | 'SRV'
-    | 'CAC'
-    | 'FTF'
-    | (string & {})
     | null;
 
   /**
@@ -597,9 +589,7 @@ export interface PayoutRetrieveResponse {
   metadata: { [key: string]: string };
 
   /**
-   * Purpose of the payout. Use an ISO 20022 external purpose code unless the
-   * beneficiary bank country requires a national code. Only supported on fedwire and
-   * swift payouts.
+   * ISO 20022 external purpose code. Only supported on fedwire and swift payouts.
    */
   purpose_code:
     | 'BKDF'
@@ -930,12 +920,6 @@ export interface PayoutRetrieveResponse {
     | 'DEPD'
     | 'RETL'
     | 'DEBT'
-    | 'CAP'
-    | 'GDS'
-    | 'SRV'
-    | 'CAC'
-    | 'FTF'
-    | (string & {})
     | null;
 
   /**
@@ -1091,9 +1075,7 @@ export interface PayoutListResponse {
   metadata: { [key: string]: string };
 
   /**
-   * Purpose of the payout. Use an ISO 20022 external purpose code unless the
-   * beneficiary bank country requires a national code. Only supported on fedwire and
-   * swift payouts.
+   * ISO 20022 external purpose code. Only supported on fedwire and swift payouts.
    */
   purpose_code:
     | 'BKDF'
@@ -1424,12 +1406,6 @@ export interface PayoutListResponse {
     | 'DEPD'
     | 'RETL'
     | 'DEBT'
-    | 'CAP'
-    | 'GDS'
-    | 'SRV'
-    | 'CAC'
-    | 'FTF'
-    | (string & {})
     | null;
 
   /**
@@ -1570,9 +1546,7 @@ export interface PayoutCreateParams {
   metadata?: { [key: string]: string } | null;
 
   /**
-   * Purpose of the payout. Use an ISO 20022 external purpose code unless the
-   * beneficiary bank country requires a national code. Only supported on fedwire and
-   * swift payouts.
+   * ISO 20022 external purpose code. Only supported on fedwire and swift payouts.
    */
   purpose_code?:
     | 'BKDF'
@@ -1903,12 +1877,6 @@ export interface PayoutCreateParams {
     | 'DEPD'
     | 'RETL'
     | 'DEBT'
-    | 'CAP'
-    | 'GDS'
-    | 'SRV'
-    | 'CAC'
-    | 'FTF'
-    | (string & {})
     | null;
 
   /**

package/src/resources/transactions.ts

@@ -106,12 +106,6 @@ export interface TransactionRetrieveResponse {
    */
   status: 'booked';
 
-  /**
-   * Network tracking identifier: UETR for SWIFT, IMAD for Fedwire, or the trace
-   * number for ACH. Null when unavailable.
-   */
-  tracking_reference: string | null;
-
   /**
    * Transaction hash for crypto transactions, or null when not known. Only
    * blockchain rails support this field.
@@ -585,7 +579,7 @@ export namespace TransactionRetrieveResponse {
     /**
      * Type of the resource that originated this transaction.
      */
-    type: 'deposit' | 'payout' | 'return';
+    type: 'deposit' | 'payout' | 'return' | 'conversion';
   }
 }
 
@@ -665,12 +659,6 @@ export interface TransactionListResponse {
    */
   status: 'booked';
 
-  /**
-   * Network tracking identifier: UETR for SWIFT, IMAD for Fedwire, or the trace
-   * number for ACH. Null when unavailable.
-   */
-  tracking_reference: string | null;
-
   /**
    * Transaction hash for crypto transactions, or null when not known. Only
    * blockchain rails support this field.
@@ -1144,7 +1132,7 @@ export namespace TransactionListResponse {
     /**
      * Type of the resource that originated this transaction.
      */
-    type: 'deposit' | 'payout' | 'return';
+    type: 'deposit' | 'payout' | 'return' | 'conversion';
   }
 }