@augustusbank/typescript-sdk 0.33.0 → 0.34.0

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/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.
@@ -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.

package/src/resources/webhooks.ts

@@ -93,9 +93,7 @@ export namespace PayoutInitiatedWebhookEvent {
     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'
@@ -426,12 +424,6 @@ export namespace PayoutInitiatedWebhookEvent {
       | 'DEPD'
       | 'RETL'
       | 'DEBT'
-      | 'CAP'
-      | 'GDS'
-      | 'SRV'
-      | 'CAC'
-      | 'FTF'
-      | (string & {})
       | null;
 
     /**
@@ -619,9 +611,7 @@ export namespace PayoutSubmittedWebhookEvent {
     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'
@@ -952,12 +942,6 @@ export namespace PayoutSubmittedWebhookEvent {
       | 'DEPD'
       | 'RETL'
       | 'DEBT'
-      | 'CAP'
-      | 'GDS'
-      | 'SRV'
-      | 'CAC'
-      | 'FTF'
-      | (string & {})
       | null;
 
     /**
@@ -1145,9 +1129,7 @@ export namespace PayoutSentWebhookEvent {
     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'
@@ -1478,12 +1460,6 @@ export namespace PayoutSentWebhookEvent {
       | 'DEPD'
       | 'RETL'
       | 'DEBT'
-      | 'CAP'
-      | 'GDS'
-      | 'SRV'
-      | 'CAC'
-      | 'FTF'
-      | (string & {})
       | null;
 
     /**
@@ -1671,9 +1647,7 @@ export namespace PayoutFailedWebhookEvent {
     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'
@@ -2004,12 +1978,6 @@ export namespace PayoutFailedWebhookEvent {
       | 'DEPD'
       | 'RETL'
       | 'DEBT'
-      | 'CAP'
-      | 'GDS'
-      | 'SRV'
-      | 'CAC'
-      | 'FTF'
-      | (string & {})
       | null;
 
     /**
@@ -2197,9 +2165,7 @@ export namespace PayoutReturnedWebhookEvent {
     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'
@@ -2530,12 +2496,6 @@ export namespace PayoutReturnedWebhookEvent {
       | 'DEPD'
       | 'RETL'
       | 'DEBT'
-      | 'CAP'
-      | 'GDS'
-      | 'SRV'
-      | 'CAC'
-      | 'FTF'
-      | (string & {})
       | null;
 
     /**
@@ -14945,13 +14905,21 @@ export namespace PayoutTrackingEventCreatedWebhookEvent {
     fee: Payload.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: Payload.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: Payload.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;
 
@@ -15060,18 +15028,62 @@ export namespace PayoutTrackingEventCreatedWebhookEvent {
     }
 
     /**
-     * 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 {
         /**
@@ -15080,7 +15092,8 @@ export namespace PayoutTrackingEventCreatedWebhookEvent {
         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;
       }
@@ -15106,7 +15119,8 @@ export namespace PayoutTrackingEventCreatedWebhookEvent {
      */
     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/version.ts

@@ -1 +1 @@
-export const VERSION = '0.33.0'; // x-release-please-version
+export const VERSION = '0.34.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.33.0";
+export declare const VERSION = "0.34.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.33.0";
+export declare const VERSION = "0.34.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.33.0'; // x-release-please-version
+exports.VERSION = '0.34.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.33.0'; // x-release-please-version
+export const VERSION = '0.34.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map