@augustusbank/typescript-sdk 0.29.0 → 0.31.0

package/resources/webhooks.d.mts

@@ -81,10 +81,10 @@ export declare namespace PayoutInitiatedWebhookEvent {
          */
         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: Payload.TrackingReference | null;
         /**
          * Transaction hash for crypto payouts, or null when not known. Only blockchain
          * rails support this field.
@@ -118,6 +118,20 @@ export declare namespace PayoutInitiatedWebhookEvent {
              */
             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.
+         */
+        interface TrackingReference {
+            /**
+             * Tracking reference type: UETR, IMAD, or ACH trace number.
+             */
+            type: 'uetr' | 'imad' | 'trace_number';
+            /**
+             * Rail-provided tracking identifier.
+             */
+            value: string;
+        }
     }
 }
 export interface PayoutSubmittedWebhookEvent {
@@ -196,10 +210,10 @@ export declare namespace PayoutSubmittedWebhookEvent {
          */
         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: Payload.TrackingReference | null;
         /**
          * Transaction hash for crypto payouts, or null when not known. Only blockchain
          * rails support this field.
@@ -233,6 +247,20 @@ export declare namespace PayoutSubmittedWebhookEvent {
              */
             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.
+         */
+        interface TrackingReference {
+            /**
+             * Tracking reference type: UETR, IMAD, or ACH trace number.
+             */
+            type: 'uetr' | 'imad' | 'trace_number';
+            /**
+             * Rail-provided tracking identifier.
+             */
+            value: string;
+        }
     }
 }
 export interface PayoutSentWebhookEvent {
@@ -311,10 +339,10 @@ export declare namespace PayoutSentWebhookEvent {
          */
         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: Payload.TrackingReference | null;
         /**
          * Transaction hash for crypto payouts, or null when not known. Only blockchain
          * rails support this field.
@@ -348,6 +376,20 @@ export declare namespace PayoutSentWebhookEvent {
              */
             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.
+         */
+        interface TrackingReference {
+            /**
+             * Tracking reference type: UETR, IMAD, or ACH trace number.
+             */
+            type: 'uetr' | 'imad' | 'trace_number';
+            /**
+             * Rail-provided tracking identifier.
+             */
+            value: string;
+        }
     }
 }
 export interface PayoutFailedWebhookEvent {
@@ -426,10 +468,10 @@ export declare namespace PayoutFailedWebhookEvent {
          */
         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: Payload.TrackingReference | null;
         /**
          * Transaction hash for crypto payouts, or null when not known. Only blockchain
          * rails support this field.
@@ -463,6 +505,20 @@ export declare namespace PayoutFailedWebhookEvent {
              */
             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.
+         */
+        interface TrackingReference {
+            /**
+             * Tracking reference type: UETR, IMAD, or ACH trace number.
+             */
+            type: 'uetr' | 'imad' | 'trace_number';
+            /**
+             * Rail-provided tracking identifier.
+             */
+            value: string;
+        }
     }
 }
 export interface PayoutReturnedWebhookEvent {
@@ -541,10 +597,10 @@ export declare namespace PayoutReturnedWebhookEvent {
          */
         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: Payload.TrackingReference | null;
         /**
          * Transaction hash for crypto payouts, or null when not known. Only blockchain
          * rails support this field.
@@ -578,6 +634,20 @@ export declare namespace PayoutReturnedWebhookEvent {
              */
             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.
+         */
+        interface TrackingReference {
+            /**
+             * Tracking reference type: UETR, IMAD, or ACH trace number.
+             */
+            type: 'uetr' | 'imad' | 'trace_number';
+            /**
+             * Rail-provided tracking identifier.
+             */
+            value: string;
+        }
     }
 }
 export interface ReturnInitiatedWebhookEvent {
@@ -1149,10 +1219,10 @@ export declare namespace DepositSettledWebhookEvent {
          */
         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: Payload.TrackingReference | null;
         /**
          * Transaction hash for crypto deposits, or null when not known. Only blockchain
          * rails support this field.
@@ -1168,6 +1238,22 @@ export declare namespace DepositSettledWebhookEvent {
          */
         unstructured_remittance_information: string | null;
     }
+    namespace Payload {
+        /**
+         * Rail network tracking identifier with its type: UETR for SWIFT, IMAD for
+         * Fedwire, or the 15-digit trace number for ACH. Null when unavailable.
+         */
+        interface TrackingReference {
+            /**
+             * Tracking reference type: UETR, IMAD, or ACH trace number.
+             */
+            type: 'uetr' | 'imad' | 'trace_number';
+            /**
+             * Rail-provided tracking identifier.
+             */
+            value: string;
+        }
+    }
 }
 export interface ConversionCreatedWebhookEvent {
     /**
@@ -2910,7 +2996,7 @@ export declare namespace AccountHolderClosedWebhookEvent {
         }
     }
 }
-export interface CounterpartyCreatedWebhookEvent {
+export interface CounterpartyPendingWebhookEvent {
     /**
      * Unique identifier for the event. Stable across retries.
      */
@@ -2926,13 +3012,13 @@ export interface CounterpartyCreatedWebhookEvent {
     /**
      * Full resource snapshot at the time of the event.
      */
-    payload: CounterpartyCreatedWebhookEvent.Payload;
+    payload: CounterpartyPendingWebhookEvent.Payload;
     /**
      * Event type in resource.action format.
      */
-    type: 'counterparty.created';
+    type: 'counterparty.pending';
 }
-export declare namespace CounterpartyCreatedWebhookEvent {
+export declare namespace CounterpartyPendingWebhookEvent {
     /**
      * Full resource snapshot at the time of the event.
      */
@@ -2990,6 +3076,10 @@ export declare namespace CounterpartyCreatedWebhookEvent {
          * Physical address of the counterparty, or null if not recorded.
          */
         physical_address: Payload.PhysicalAddress | null;
+        /**
+         * Counterparty lifecycle status. Blocking is separate.
+         */
+        status: 'pending' | 'active' | 'rejected';
         /**
          * Resource type discriminator.
          */
@@ -3130,7 +3220,7 @@ export declare namespace CounterpartyCreatedWebhookEvent {
         }
     }
 }
-export interface CounterpartyVerifiedWebhookEvent {
+export interface CounterpartyActiveWebhookEvent {
     /**
      * Unique identifier for the event. Stable across retries.
      */
@@ -3146,13 +3236,13 @@ export interface CounterpartyVerifiedWebhookEvent {
     /**
      * Full resource snapshot at the time of the event.
      */
-    payload: CounterpartyVerifiedWebhookEvent.Payload;
+    payload: CounterpartyActiveWebhookEvent.Payload;
     /**
      * Event type in resource.action format.
      */
-    type: 'counterparty.verified';
+    type: 'counterparty.active';
 }
-export declare namespace CounterpartyVerifiedWebhookEvent {
+export declare namespace CounterpartyActiveWebhookEvent {
     /**
      * Full resource snapshot at the time of the event.
      */
@@ -3210,6 +3300,10 @@ export declare namespace CounterpartyVerifiedWebhookEvent {
          * Physical address of the counterparty, or null if not recorded.
          */
         physical_address: Payload.PhysicalAddress | null;
+        /**
+         * Counterparty lifecycle status. Blocking is separate.
+         */
+        status: 'pending' | 'active' | 'rejected';
         /**
          * Resource type discriminator.
          */
@@ -3430,6 +3524,10 @@ export declare namespace CounterpartyRejectedWebhookEvent {
          * Physical address of the counterparty, or null if not recorded.
          */
         physical_address: Payload.PhysicalAddress | null;
+        /**
+         * Counterparty lifecycle status. Blocking is separate.
+         */
+        status: 'pending' | 'active' | 'rejected';
         /**
          * Resource type discriminator.
          */
@@ -3650,6 +3748,10 @@ export declare namespace CounterpartyBlockedWebhookEvent {
          * Physical address of the counterparty, or null if not recorded.
          */
         physical_address: Payload.PhysicalAddress | null;
+        /**
+         * Counterparty lifecycle status. Blocking is separate.
+         */
+        status: 'pending' | 'active' | 'rejected';
         /**
          * Resource type discriminator.
          */
@@ -3870,6 +3972,10 @@ export declare namespace CounterpartyUnblockedWebhookEvent {
          * Physical address of the counterparty, or null if not recorded.
          */
         physical_address: Payload.PhysicalAddress | null;
+        /**
+         * Counterparty lifecycle status. Blocking is separate.
+         */
+        status: 'pending' | 'active' | 'rejected';
         /**
          * Resource type discriminator.
          */
@@ -4090,6 +4196,10 @@ export declare namespace CounterpartyUpdatedWebhookEvent {
          * Physical address of the counterparty, or null if not recorded.
          */
         physical_address: Payload.PhysicalAddress | null;
+        /**
+         * Counterparty lifecycle status. Blocking is separate.
+         */
+        status: 'pending' | 'active' | 'rejected';
         /**
          * Resource type discriminator.
          */
@@ -4280,8 +4390,8 @@ export declare namespace PingTestWebhookEvent {
         type: 'ping';
     }
 }
-export type UnwrapWebhookEvent = PayoutInitiatedWebhookEvent | PayoutSubmittedWebhookEvent | PayoutSentWebhookEvent | PayoutFailedWebhookEvent | PayoutReturnedWebhookEvent | ReturnInitiatedWebhookEvent | ReturnSubmittedWebhookEvent | ReturnSentWebhookEvent | ReturnFailedWebhookEvent | ReturnReturnedWebhookEvent | DepositSettledWebhookEvent | ConversionCreatedWebhookEvent | ConversionCompletedWebhookEvent | ConversionFailedWebhookEvent | AccountHolderActiveWebhookEvent | AccountHolderClosedWebhookEvent | CounterpartyCreatedWebhookEvent | CounterpartyVerifiedWebhookEvent | CounterpartyRejectedWebhookEvent | CounterpartyBlockedWebhookEvent | CounterpartyUnblockedWebhookEvent | CounterpartyUpdatedWebhookEvent | PingTestWebhookEvent;
+export type UnwrapWebhookEvent = PayoutInitiatedWebhookEvent | PayoutSubmittedWebhookEvent | PayoutSentWebhookEvent | PayoutFailedWebhookEvent | PayoutReturnedWebhookEvent | ReturnInitiatedWebhookEvent | ReturnSubmittedWebhookEvent | ReturnSentWebhookEvent | ReturnFailedWebhookEvent | ReturnReturnedWebhookEvent | DepositSettledWebhookEvent | ConversionCreatedWebhookEvent | ConversionCompletedWebhookEvent | ConversionFailedWebhookEvent | AccountHolderActiveWebhookEvent | AccountHolderClosedWebhookEvent | CounterpartyPendingWebhookEvent | CounterpartyActiveWebhookEvent | CounterpartyRejectedWebhookEvent | CounterpartyBlockedWebhookEvent | CounterpartyUnblockedWebhookEvent | CounterpartyUpdatedWebhookEvent | PingTestWebhookEvent;
 export declare namespace Webhooks {
-    export { type PayoutInitiatedWebhookEvent as PayoutInitiatedWebhookEvent, type PayoutSubmittedWebhookEvent as PayoutSubmittedWebhookEvent, type PayoutSentWebhookEvent as PayoutSentWebhookEvent, type PayoutFailedWebhookEvent as PayoutFailedWebhookEvent, type PayoutReturnedWebhookEvent as PayoutReturnedWebhookEvent, type ReturnInitiatedWebhookEvent as ReturnInitiatedWebhookEvent, type ReturnSubmittedWebhookEvent as ReturnSubmittedWebhookEvent, type ReturnSentWebhookEvent as ReturnSentWebhookEvent, type ReturnFailedWebhookEvent as ReturnFailedWebhookEvent, type ReturnReturnedWebhookEvent as ReturnReturnedWebhookEvent, type DepositSettledWebhookEvent as DepositSettledWebhookEvent, type ConversionCreatedWebhookEvent as ConversionCreatedWebhookEvent, type ConversionCompletedWebhookEvent as ConversionCompletedWebhookEvent, type ConversionFailedWebhookEvent as ConversionFailedWebhookEvent, type AccountHolderActiveWebhookEvent as AccountHolderActiveWebhookEvent, type AccountHolderClosedWebhookEvent as AccountHolderClosedWebhookEvent, type CounterpartyCreatedWebhookEvent as CounterpartyCreatedWebhookEvent, type CounterpartyVerifiedWebhookEvent as CounterpartyVerifiedWebhookEvent, type CounterpartyRejectedWebhookEvent as CounterpartyRejectedWebhookEvent, type CounterpartyBlockedWebhookEvent as CounterpartyBlockedWebhookEvent, type CounterpartyUnblockedWebhookEvent as CounterpartyUnblockedWebhookEvent, type CounterpartyUpdatedWebhookEvent as CounterpartyUpdatedWebhookEvent, type PingTestWebhookEvent as PingTestWebhookEvent, type UnwrapWebhookEvent as UnwrapWebhookEvent, };
+    export { type PayoutInitiatedWebhookEvent as PayoutInitiatedWebhookEvent, type PayoutSubmittedWebhookEvent as PayoutSubmittedWebhookEvent, type PayoutSentWebhookEvent as PayoutSentWebhookEvent, type PayoutFailedWebhookEvent as PayoutFailedWebhookEvent, type PayoutReturnedWebhookEvent as PayoutReturnedWebhookEvent, type ReturnInitiatedWebhookEvent as ReturnInitiatedWebhookEvent, type ReturnSubmittedWebhookEvent as ReturnSubmittedWebhookEvent, type ReturnSentWebhookEvent as ReturnSentWebhookEvent, type ReturnFailedWebhookEvent as ReturnFailedWebhookEvent, type ReturnReturnedWebhookEvent as ReturnReturnedWebhookEvent, type DepositSettledWebhookEvent as DepositSettledWebhookEvent, type ConversionCreatedWebhookEvent as ConversionCreatedWebhookEvent, type ConversionCompletedWebhookEvent as ConversionCompletedWebhookEvent, type ConversionFailedWebhookEvent as ConversionFailedWebhookEvent, type AccountHolderActiveWebhookEvent as AccountHolderActiveWebhookEvent, type AccountHolderClosedWebhookEvent as AccountHolderClosedWebhookEvent, type CounterpartyPendingWebhookEvent as CounterpartyPendingWebhookEvent, type CounterpartyActiveWebhookEvent as CounterpartyActiveWebhookEvent, type CounterpartyRejectedWebhookEvent as CounterpartyRejectedWebhookEvent, type CounterpartyBlockedWebhookEvent as CounterpartyBlockedWebhookEvent, type CounterpartyUnblockedWebhookEvent as CounterpartyUnblockedWebhookEvent, type CounterpartyUpdatedWebhookEvent as CounterpartyUpdatedWebhookEvent, type PingTestWebhookEvent as PingTestWebhookEvent, type UnwrapWebhookEvent as UnwrapWebhookEvent, };
 }
 //# sourceMappingURL=webhooks.d.mts.map