@augustusbank/typescript-sdk 0.29.0 → 0.31.0

package/src/client.ts

@@ -143,12 +143,12 @@ import {
   ConversionCompletedWebhookEvent,
   ConversionCreatedWebhookEvent,
   ConversionFailedWebhookEvent,
+  CounterpartyActiveWebhookEvent,
   CounterpartyBlockedWebhookEvent,
-  CounterpartyCreatedWebhookEvent,
+  CounterpartyPendingWebhookEvent,
   CounterpartyRejectedWebhookEvent,
   CounterpartyUnblockedWebhookEvent,
   CounterpartyUpdatedWebhookEvent,
-  CounterpartyVerifiedWebhookEvent,
   DepositSettledWebhookEvent,
   PayoutFailedWebhookEvent,
   PayoutInitiatedWebhookEvent,
@@ -1018,8 +1018,8 @@ export declare namespace Augustus {
     type ConversionFailedWebhookEvent as ConversionFailedWebhookEvent,
     type AccountHolderActiveWebhookEvent as AccountHolderActiveWebhookEvent,
     type AccountHolderClosedWebhookEvent as AccountHolderClosedWebhookEvent,
-    type CounterpartyCreatedWebhookEvent as CounterpartyCreatedWebhookEvent,
-    type CounterpartyVerifiedWebhookEvent as CounterpartyVerifiedWebhookEvent,
+    type CounterpartyPendingWebhookEvent as CounterpartyPendingWebhookEvent,
+    type CounterpartyActiveWebhookEvent as CounterpartyActiveWebhookEvent,
     type CounterpartyRejectedWebhookEvent as CounterpartyRejectedWebhookEvent,
     type CounterpartyBlockedWebhookEvent as CounterpartyBlockedWebhookEvent,
     type CounterpartyUnblockedWebhookEvent as CounterpartyUnblockedWebhookEvent,

package/src/resources/counterparties.ts

@@ -151,6 +151,11 @@ export interface CounterpartyCreateResponse {
    */
   physical_address: CounterpartyCreateResponse.PhysicalAddress | null;
 
+  /**
+   * Counterparty lifecycle status. Blocking is separate.
+   */
+  status: 'pending' | 'active' | 'rejected';
+
   /**
    * Resource type discriminator.
    */
@@ -647,6 +652,11 @@ export interface CounterpartyRetrieveResponse {
    */
   physical_address: CounterpartyRetrieveResponse.PhysicalAddress | null;
 
+  /**
+   * Counterparty lifecycle status. Blocking is separate.
+   */
+  status: 'pending' | 'active' | 'rejected';
+
   /**
    * Resource type discriminator.
    */
@@ -1143,6 +1153,11 @@ export interface CounterpartyUpdateResponse {
    */
   physical_address: CounterpartyUpdateResponse.PhysicalAddress | null;
 
+  /**
+   * Counterparty lifecycle status. Blocking is separate.
+   */
+  status: 'pending' | 'active' | 'rejected';
+
   /**
    * Resource type discriminator.
    */
@@ -1639,6 +1654,11 @@ export interface CounterpartyListResponse {
    */
   physical_address: CounterpartyListResponse.PhysicalAddress | null;
 
+  /**
+   * Counterparty lifecycle status. Blocking is separate.
+   */
+  status: 'pending' | 'active' | 'rejected';
+
   /**
    * Resource type discriminator.
    */

package/src/resources/deposits.ts

@@ -91,10 +91,10 @@ export interface DepositRetrieveResponse {
   status: 'settled';
 
   /**
-   * Reference used to track the payment across the payment network, such as the UETR
-   * for SWIFT payments.
+   * Rail network tracking identifier with its type: UETR for SWIFT, IMAD for
+   * Fedwire, or the 15-digit trace number for ACH. Null when unavailable.
    */
-  tracking_reference: string | null;
+  tracking_reference: DepositRetrieveResponse.TrackingReference | null;
 
   /**
    * Transaction hash for crypto deposits, or null when not known. Only blockchain
@@ -114,6 +114,24 @@ export interface DepositRetrieveResponse {
   unstructured_remittance_information: string | null;
 }
 
+export namespace DepositRetrieveResponse {
+  /**
+   * Rail network tracking identifier with its type: UETR for SWIFT, IMAD for
+   * Fedwire, or the 15-digit trace number for ACH. Null when unavailable.
+   */
+  export interface TrackingReference {
+    /**
+     * Tracking reference type: UETR, IMAD, or ACH trace number.
+     */
+    type: 'uetr' | 'imad' | 'trace_number';
+
+    /**
+     * Rail-provided tracking identifier.
+     */
+    value: string;
+  }
+}
+
 export interface DepositListResponse {
   /**
    * Unique identifier of the deposit.
@@ -178,10 +196,10 @@ export interface DepositListResponse {
   status: 'settled';
 
   /**
-   * Reference used to track the payment across the payment network, such as the UETR
-   * for SWIFT payments.
+   * Rail network tracking identifier with its type: UETR for SWIFT, IMAD for
+   * Fedwire, or the 15-digit trace number for ACH. Null when unavailable.
    */
-  tracking_reference: string | null;
+  tracking_reference: DepositListResponse.TrackingReference | null;
 
   /**
    * Transaction hash for crypto deposits, or null when not known. Only blockchain
@@ -201,7 +219,52 @@ export interface DepositListResponse {
   unstructured_remittance_information: string | null;
 }
 
+export namespace DepositListResponse {
+  /**
+   * Rail network tracking identifier with its type: UETR for SWIFT, IMAD for
+   * Fedwire, or the 15-digit trace number for ACH. Null when unavailable.
+   */
+  export interface TrackingReference {
+    /**
+     * Tracking reference type: UETR, IMAD, or ACH trace number.
+     */
+    type: 'uetr' | 'imad' | 'trace_number';
+
+    /**
+     * Rail-provided tracking identifier.
+     */
+    value: string;
+  }
+}
+
 export interface DepositListParams extends CursorPageParams {
+  /**
+   * Filter to these currency codes. Use a separate `currencies` query parameter for
+   * each value (e.g. `?currencies=EUR&currencies=USD`).
+   */
+  currencies?: Array<'EUR' | 'GBP' | 'USD' | 'USDC'>;
+
+  /**
+   * Filter by deposit rail.
+   */
+  rail?:
+    | 'sepa'
+    | 'sepa_instant'
+    | 'faster_payments'
+    | 'swift'
+    | 'internal'
+    | 'target'
+    | 'ach'
+    | 'fedwire'
+    | 'bitcoin'
+    | 'bitcoin_testnet4'
+    | 'ethereum'
+    | 'ethereum_sepolia'
+    | 'solana'
+    | 'solana_devnet'
+    | 'polygon'
+    | 'polygon_amoy';
+
   settled_at?: DepositListParams.SettledAt;
 }
 

package/src/resources/events.ts

@@ -71,8 +71,8 @@ export interface EventRetrieveResponse {
     | 'conversion.failed'
     | 'account_holder.active'
     | 'account_holder.closed'
-    | 'counterparty.created'
-    | 'counterparty.verified'
+    | 'counterparty.pending'
+    | 'counterparty.active'
     | 'counterparty.rejected'
     | 'counterparty.blocked'
     | 'counterparty.unblocked'
@@ -128,8 +128,8 @@ export interface EventListResponse {
     | 'conversion.failed'
     | 'account_holder.active'
     | 'account_holder.closed'
-    | 'counterparty.created'
-    | 'counterparty.verified'
+    | 'counterparty.pending'
+    | 'counterparty.active'
     | 'counterparty.rejected'
     | 'counterparty.blocked'
     | 'counterparty.unblocked'
@@ -165,8 +165,8 @@ export interface EventListParams extends CursorPageParams {
     | 'conversion.failed'
     | 'account_holder.active'
     | 'account_holder.closed'
-    | 'counterparty.created'
-    | 'counterparty.verified'
+    | 'counterparty.pending'
+    | 'counterparty.active'
     | 'counterparty.rejected'
     | 'counterparty.blocked'
     | 'counterparty.unblocked'

package/src/resources/index.ts

@@ -138,8 +138,8 @@ export {
   type ConversionFailedWebhookEvent,
   type AccountHolderActiveWebhookEvent,
   type AccountHolderClosedWebhookEvent,
-  type CounterpartyCreatedWebhookEvent,
-  type CounterpartyVerifiedWebhookEvent,
+  type CounterpartyPendingWebhookEvent,
+  type CounterpartyActiveWebhookEvent,
   type CounterpartyRejectedWebhookEvent,
   type CounterpartyBlockedWebhookEvent,
   type CounterpartyUnblockedWebhookEvent,

package/src/resources/payouts.ts

@@ -135,10 +135,10 @@ export interface PayoutCreateResponse {
   status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
 
   /**
-   * Reference used to track the payment across the payment network, such as the UETR
-   * for SWIFT payments.
+   * Rail network tracking identifier with its type: UETR for SWIFT, IMAD for
+   * Fedwire, or the 15-digit trace number for ACH. Null when unavailable.
    */
-  tracking_reference: string | null;
+  tracking_reference: PayoutCreateResponse.TrackingReference | null;
 
   /**
    * Transaction hash for crypto payouts, or null when not known. Only blockchain
@@ -193,6 +193,22 @@ export namespace PayoutCreateResponse {
      */
     retry: boolean;
   }
+
+  /**
+   * Rail network tracking identifier with its type: UETR for SWIFT, IMAD for
+   * Fedwire, or the 15-digit trace number for ACH. Null when unavailable.
+   */
+  export interface TrackingReference {
+    /**
+     * Tracking reference type: UETR, IMAD, or ACH trace number.
+     */
+    type: 'uetr' | 'imad' | 'trace_number';
+
+    /**
+     * Rail-provided tracking identifier.
+     */
+    value: string;
+  }
 }
 
 export interface PayoutRetrieveResponse {
@@ -271,10 +287,10 @@ export interface PayoutRetrieveResponse {
   status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
 
   /**
-   * Reference used to track the payment across the payment network, such as the UETR
-   * for SWIFT payments.
+   * Rail network tracking identifier with its type: UETR for SWIFT, IMAD for
+   * Fedwire, or the 15-digit trace number for ACH. Null when unavailable.
    */
-  tracking_reference: string | null;
+  tracking_reference: PayoutRetrieveResponse.TrackingReference | null;
 
   /**
    * Transaction hash for crypto payouts, or null when not known. Only blockchain
@@ -329,6 +345,22 @@ export namespace PayoutRetrieveResponse {
      */
     retry: boolean;
   }
+
+  /**
+   * Rail network tracking identifier with its type: UETR for SWIFT, IMAD for
+   * Fedwire, or the 15-digit trace number for ACH. Null when unavailable.
+   */
+  export interface TrackingReference {
+    /**
+     * Tracking reference type: UETR, IMAD, or ACH trace number.
+     */
+    type: 'uetr' | 'imad' | 'trace_number';
+
+    /**
+     * Rail-provided tracking identifier.
+     */
+    value: string;
+  }
 }
 
 export interface PayoutListResponse {
@@ -407,10 +439,10 @@ export interface PayoutListResponse {
   status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
 
   /**
-   * Reference used to track the payment across the payment network, such as the UETR
-   * for SWIFT payments.
+   * Rail network tracking identifier with its type: UETR for SWIFT, IMAD for
+   * Fedwire, or the 15-digit trace number for ACH. Null when unavailable.
    */
-  tracking_reference: string | null;
+  tracking_reference: PayoutListResponse.TrackingReference | null;
 
   /**
    * Transaction hash for crypto payouts, or null when not known. Only blockchain
@@ -465,6 +497,22 @@ export namespace PayoutListResponse {
      */
     retry: boolean;
   }
+
+  /**
+   * Rail network tracking identifier with its type: UETR for SWIFT, IMAD for
+   * Fedwire, or the 15-digit trace number for ACH. Null when unavailable.
+   */
+  export interface TrackingReference {
+    /**
+     * Tracking reference type: UETR, IMAD, or ACH trace number.
+     */
+    type: 'uetr' | 'imad' | 'trace_number';
+
+    /**
+     * Rail-provided tracking identifier.
+     */
+    value: string;
+  }
 }
 
 export interface PayoutCreateParams {
@@ -529,6 +577,27 @@ export interface PayoutListParams extends CursorPageParams {
    */
   currencies?: Array<'EUR' | 'GBP' | 'USD' | 'USDC'>;
 
+  /**
+   * Filter by payout rail.
+   */
+  rail?:
+    | 'sepa'
+    | 'sepa_instant'
+    | 'faster_payments'
+    | 'swift'
+    | 'internal'
+    | 'target'
+    | 'ach'
+    | 'fedwire'
+    | 'bitcoin'
+    | 'bitcoin_testnet4'
+    | 'ethereum'
+    | 'ethereum_sepolia'
+    | 'solana'
+    | 'solana_devnet'
+    | 'polygon'
+    | 'polygon_amoy';
+
   /**
    * Filter by payout status.
    */

package/src/resources/simulations/account-programs.ts

@@ -184,9 +184,9 @@ export interface AccountProgramCreateParams {
   label: string;
 
   /**
-   * Account program type.
+   * Account program type. Simulation supports FBO programs only.
    */
-  type: 'fbo_program' | 'fbo_sponsored' | 'operating' | 'crypto';
+  type: 'fbo_program' | 'fbo_sponsored';
 }
 
 export interface AccountProgramCloseParams {

package/src/resources/webhook-subscriptions.ts

@@ -149,8 +149,8 @@ export interface WebhookSubscriptionCreateResponse {
     | 'conversion.failed'
     | 'account_holder.active'
     | 'account_holder.closed'
-    | 'counterparty.created'
-    | 'counterparty.verified'
+    | 'counterparty.pending'
+    | 'counterparty.active'
     | 'counterparty.rejected'
     | 'counterparty.blocked'
     | 'counterparty.unblocked'
@@ -211,8 +211,8 @@ export interface WebhookSubscriptionRetrieveResponse {
     | 'conversion.failed'
     | 'account_holder.active'
     | 'account_holder.closed'
-    | 'counterparty.created'
-    | 'counterparty.verified'
+    | 'counterparty.pending'
+    | 'counterparty.active'
     | 'counterparty.rejected'
     | 'counterparty.blocked'
     | 'counterparty.unblocked'
@@ -273,8 +273,8 @@ export interface WebhookSubscriptionUpdateResponse {
     | 'conversion.failed'
     | 'account_holder.active'
     | 'account_holder.closed'
-    | 'counterparty.created'
-    | 'counterparty.verified'
+    | 'counterparty.pending'
+    | 'counterparty.active'
     | 'counterparty.rejected'
     | 'counterparty.blocked'
     | 'counterparty.unblocked'
@@ -335,8 +335,8 @@ export interface WebhookSubscriptionListResponse {
     | 'conversion.failed'
     | 'account_holder.active'
     | 'account_holder.closed'
-    | 'counterparty.created'
-    | 'counterparty.verified'
+    | 'counterparty.pending'
+    | 'counterparty.active'
     | 'counterparty.rejected'
     | 'counterparty.blocked'
     | 'counterparty.unblocked'
@@ -397,8 +397,8 @@ export interface WebhookSubscriptionDeleteResponse {
     | 'conversion.failed'
     | 'account_holder.active'
     | 'account_holder.closed'
-    | 'counterparty.created'
-    | 'counterparty.verified'
+    | 'counterparty.pending'
+    | 'counterparty.active'
     | 'counterparty.rejected'
     | 'counterparty.blocked'
     | 'counterparty.unblocked'
@@ -471,8 +471,8 @@ export interface WebhookSubscriptionSendTestEventResponse {
     | 'conversion.failed'
     | 'account_holder.active'
     | 'account_holder.closed'
-    | 'counterparty.created'
-    | 'counterparty.verified'
+    | 'counterparty.pending'
+    | 'counterparty.active'
     | 'counterparty.rejected'
     | 'counterparty.blocked'
     | 'counterparty.unblocked'
@@ -506,8 +506,8 @@ export interface WebhookSubscriptionCreateParams {
     | 'conversion.failed'
     | 'account_holder.active'
     | 'account_holder.closed'
-    | 'counterparty.created'
-    | 'counterparty.verified'
+    | 'counterparty.pending'
+    | 'counterparty.active'
     | 'counterparty.rejected'
     | 'counterparty.blocked'
     | 'counterparty.unblocked'
@@ -550,8 +550,8 @@ export interface WebhookSubscriptionUpdateParams {
     | 'conversion.failed'
     | 'account_holder.active'
     | 'account_holder.closed'
-    | 'counterparty.created'
-    | 'counterparty.verified'
+    | 'counterparty.pending'
+    | 'counterparty.active'
     | 'counterparty.rejected'
     | 'counterparty.blocked'
     | 'counterparty.unblocked'