@augustusbank/typescript-sdk 0.22.0 → 0.22.2

package/resources/webhooks.d.ts

@@ -5,7 +5,7 @@ export declare class Webhooks extends APIResource {
         key?: string;
     }): UnwrapWebhookEvent;
 }
-export interface PayoutCreatedWebhookEvent {
+export interface PayoutInitiatedWebhookEvent {
     /**
      * Unique identifier for the event. Stable across retries.
      */
@@ -21,13 +21,13 @@ export interface PayoutCreatedWebhookEvent {
     /**
      * Full resource snapshot at the time of the event.
      */
-    payload: PayoutCreatedWebhookEvent.Payload;
+    payload: PayoutInitiatedWebhookEvent.Payload;
     /**
      * Event type in resource.action format.
      */
-    type: 'payout.created';
+    type: 'payout.initiated';
 }
-export declare namespace PayoutCreatedWebhookEvent {
+export declare namespace PayoutInitiatedWebhookEvent {
     /**
      * Full resource snapshot at the time of the event.
      */
@@ -79,9 +79,10 @@ export declare namespace PayoutCreatedWebhookEvent {
          */
         status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
         /**
-         * Identifier used to track the payout through the payment network where supported.
+         * Reference used to track the payment across the payment network, such as the UETR
+         * for SWIFT payments.
          */
-        tracking_id: string | null;
+        tracking_reference: string | null;
         /**
          * Transaction hash for crypto payouts, or null when not known. Only blockchain
          * rails support this field.
@@ -117,7 +118,7 @@ export declare namespace PayoutCreatedWebhookEvent {
         }
     }
 }
-export interface PayoutInitiatedWebhookEvent {
+export interface PayoutSubmittedWebhookEvent {
     /**
      * Unique identifier for the event. Stable across retries.
      */
@@ -133,13 +134,13 @@ export interface PayoutInitiatedWebhookEvent {
     /**
      * Full resource snapshot at the time of the event.
      */
-    payload: PayoutInitiatedWebhookEvent.Payload;
+    payload: PayoutSubmittedWebhookEvent.Payload;
     /**
      * Event type in resource.action format.
      */
-    type: 'payout.initiated';
+    type: 'payout.submitted';
 }
-export declare namespace PayoutInitiatedWebhookEvent {
+export declare namespace PayoutSubmittedWebhookEvent {
     /**
      * Full resource snapshot at the time of the event.
      */
@@ -191,9 +192,10 @@ export declare namespace PayoutInitiatedWebhookEvent {
          */
         status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
         /**
-         * Identifier used to track the payout through the payment network where supported.
+         * Reference used to track the payment across the payment network, such as the UETR
+         * for SWIFT payments.
          */
-        tracking_id: string | null;
+        tracking_reference: string | null;
         /**
          * Transaction hash for crypto payouts, or null when not known. Only blockchain
          * rails support this field.
@@ -229,7 +231,7 @@ export declare namespace PayoutInitiatedWebhookEvent {
         }
     }
 }
-export interface PayoutPaidWebhookEvent {
+export interface PayoutSentWebhookEvent {
     /**
      * Unique identifier for the event. Stable across retries.
      */
@@ -245,13 +247,13 @@ export interface PayoutPaidWebhookEvent {
     /**
      * Full resource snapshot at the time of the event.
      */
-    payload: PayoutPaidWebhookEvent.Payload;
+    payload: PayoutSentWebhookEvent.Payload;
     /**
      * Event type in resource.action format.
      */
-    type: 'payout.paid';
+    type: 'payout.sent';
 }
-export declare namespace PayoutPaidWebhookEvent {
+export declare namespace PayoutSentWebhookEvent {
     /**
      * Full resource snapshot at the time of the event.
      */
@@ -303,9 +305,10 @@ export declare namespace PayoutPaidWebhookEvent {
          */
         status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
         /**
-         * Identifier used to track the payout through the payment network where supported.
+         * Reference used to track the payment across the payment network, such as the UETR
+         * for SWIFT payments.
          */
-        tracking_id: string | null;
+        tracking_reference: string | null;
         /**
          * Transaction hash for crypto payouts, or null when not known. Only blockchain
          * rails support this field.
@@ -415,9 +418,123 @@ export declare namespace PayoutFailedWebhookEvent {
          */
         status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
         /**
-         * Identifier used to track the payout through the payment network where supported.
+         * Reference used to track the payment across the payment network, such as the UETR
+         * for SWIFT payments.
          */
-        tracking_id: string | null;
+        tracking_reference: string | null;
+        /**
+         * Transaction hash for crypto payouts, or null when not known. Only blockchain
+         * rails support this field.
+         */
+        tx_hash: string | null;
+        /**
+         * Resource type discriminator.
+         */
+        type: 'payout';
+        /**
+         * Unstructured remittance information attached to the transfer. Not all rails
+         * support this field.
+         */
+        unstructured_remittance_information: string | null;
+    }
+    namespace Payload {
+        /**
+         * Failure details when status is failed, otherwise null.
+         */
+        interface Failure {
+            /**
+             * Failure code.
+             */
+            code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_routing_number' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
+            /**
+             * Human-readable description of the failure.
+             */
+            message: string;
+            /**
+             * Whether the payout can be retried.
+             */
+            retry: boolean;
+        }
+    }
+}
+export interface PayoutReturnedWebhookEvent {
+    /**
+     * Unique identifier for the event. Stable across retries.
+     */
+    id: string;
+    /**
+     * API version the payload was rendered at. Stable across retries and redeliveries.
+     */
+    api_version: string;
+    /**
+     * ISO 8601 UTC timestamp when the event was created.
+     */
+    date: string;
+    /**
+     * Full resource snapshot at the time of the event.
+     */
+    payload: PayoutReturnedWebhookEvent.Payload;
+    /**
+     * Event type in resource.action format.
+     */
+    type: 'payout.returned';
+}
+export declare namespace PayoutReturnedWebhookEvent {
+    /**
+     * Full resource snapshot at the time of the event.
+     */
+    interface Payload {
+        /**
+         * Unique identifier of the payout.
+         */
+        id: string;
+        /**
+         * ID of the account that was debited.
+         */
+        account_id: string;
+        /**
+         * Amount as a string decimal (e.g. "100.50").
+         */
+        amount: string;
+        /**
+         * ID of the counterparty that receives the money.
+         */
+        counterparty_id: string;
+        /**
+         * Currency code (ISO 4217 or crypto).
+         */
+        currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+        /**
+         * Failure details when status is failed, otherwise null.
+         */
+        failure: Payload.Failure | null;
+        /**
+         * ISO 8601 UTC timestamp when the payout was initiated.
+         */
+        initiated_at: string;
+        /**
+         * Key-value pairs stored with the payout.
+         */
+        metadata: {
+            [key: string]: string;
+        };
+        /**
+         * Payment scheme or blockchain used for the payout, or null when unknown.
+         */
+        rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
+        /**
+         * ISO 8601 UTC timestamp when the payout was sent.
+         */
+        sent_at: string | null;
+        /**
+         * Current status of the payout.
+         */
+        status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
+        /**
+         * Reference used to track the payment across the payment network, such as the UETR
+         * for SWIFT payments.
+         */
+        tracking_reference: string | null;
         /**
          * Transaction hash for crypto payouts, or null when not known. Only blockchain
          * rails support this field.
@@ -546,7 +663,100 @@ export declare namespace ReturnInitiatedWebhookEvent {
         }
     }
 }
-export interface ReturnPaidWebhookEvent {
+export interface ReturnSubmittedWebhookEvent {
+    /**
+     * Unique identifier for the event. Stable across retries.
+     */
+    id: string;
+    /**
+     * API version the payload was rendered at. Stable across retries and redeliveries.
+     */
+    api_version: string;
+    /**
+     * ISO 8601 UTC timestamp when the event was created.
+     */
+    date: string;
+    /**
+     * Full resource snapshot at the time of the event.
+     */
+    payload: ReturnSubmittedWebhookEvent.Payload;
+    /**
+     * Event type in resource.action format.
+     */
+    type: 'return.submitted';
+}
+export declare namespace ReturnSubmittedWebhookEvent {
+    /**
+     * Full resource snapshot at the time of the event.
+     */
+    interface Payload {
+        /**
+         * Unique identifier of the return.
+         */
+        id: string;
+        /**
+         * Amount as a string decimal (e.g. "100.50").
+         */
+        amount: string;
+        /**
+         * Currency code (ISO 4217 or crypto).
+         */
+        currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+        /**
+         * ID of the parent deposit.
+         */
+        deposit_id: string;
+        /**
+         * Failure details when status is failed, otherwise null.
+         */
+        failure: Payload.Failure | null;
+        /**
+         * ISO 8601 UTC timestamp when the return was initiated.
+         */
+        initiated_at: string;
+        /**
+         * Payment scheme or blockchain used for the return, or null when unknown.
+         */
+        rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
+        /**
+         * ISO 8601 UTC timestamp when the return was sent.
+         */
+        sent_at: string | null;
+        /**
+         * Current status of the return.
+         */
+        status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
+        /**
+         * Transaction hash for crypto returns, or null when not known. Only blockchain
+         * rails support this field.
+         */
+        tx_hash: string | null;
+        /**
+         * Resource type discriminator.
+         */
+        type: 'return';
+    }
+    namespace Payload {
+        /**
+         * Failure details when status is failed, otherwise null.
+         */
+        interface Failure {
+            /**
+             * Failure code.
+             */
+            code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_routing_number' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
+            /**
+             * Human-readable description of the failure.
+             */
+            message: string;
+            /**
+             * Whether the return can be retried.
+             */
+            retry: boolean;
+        }
+    }
+}
+export interface ReturnSentWebhookEvent {
     /**
      * Unique identifier for the event. Stable across retries.
      */
@@ -562,13 +772,13 @@ export interface ReturnPaidWebhookEvent {
     /**
      * Full resource snapshot at the time of the event.
      */
-    payload: ReturnPaidWebhookEvent.Payload;
+    payload: ReturnSentWebhookEvent.Payload;
     /**
      * Event type in resource.action format.
      */
-    type: 'return.paid';
+    type: 'return.sent';
 }
-export declare namespace ReturnPaidWebhookEvent {
+export declare namespace ReturnSentWebhookEvent {
     /**
      * Full resource snapshot at the time of the event.
      */
@@ -825,7 +1035,7 @@ export declare namespace ReturnReturnedWebhookEvent {
         }
     }
 }
-export interface DepositReceivedWebhookEvent {
+export interface DepositSettledWebhookEvent {
     /**
      * Unique identifier for the event. Stable across retries.
      */
@@ -841,13 +1051,13 @@ export interface DepositReceivedWebhookEvent {
     /**
      * Full resource snapshot at the time of the event.
      */
-    payload: DepositReceivedWebhookEvent.Payload;
+    payload: DepositSettledWebhookEvent.Payload;
     /**
      * Event type in resource.action format.
      */
-    type: 'deposit.received';
+    type: 'deposit.settled';
 }
-export declare namespace DepositReceivedWebhookEvent {
+export declare namespace DepositSettledWebhookEvent {
     /**
      * Full resource snapshot at the time of the event.
      */
@@ -888,6 +1098,11 @@ export declare namespace DepositReceivedWebhookEvent {
          * Current status of the deposit.
          */
         status: 'settled';
+        /**
+         * Reference used to track the payment across the payment network, such as the UETR
+         * for SWIFT payments.
+         */
+        tracking_reference: string | null;
         /**
          * Transaction hash for crypto deposits, or null when not known. Only blockchain
          * rails support this field.
@@ -2673,8 +2888,8 @@ export declare namespace PingTestWebhookEvent {
         type: 'ping';
     }
 }
-export type UnwrapWebhookEvent = PayoutCreatedWebhookEvent | PayoutInitiatedWebhookEvent | PayoutPaidWebhookEvent | PayoutFailedWebhookEvent | ReturnInitiatedWebhookEvent | ReturnPaidWebhookEvent | ReturnFailedWebhookEvent | ReturnReturnedWebhookEvent | DepositReceivedWebhookEvent | ConversionCreatedWebhookEvent | ConversionCompletedWebhookEvent | ConversionFailedWebhookEvent | AccountHolderActiveWebhookEvent | AccountHolderClosedWebhookEvent | PingTestWebhookEvent;
+export type UnwrapWebhookEvent = PayoutInitiatedWebhookEvent | PayoutSubmittedWebhookEvent | PayoutSentWebhookEvent | PayoutFailedWebhookEvent | PayoutReturnedWebhookEvent | ReturnInitiatedWebhookEvent | ReturnSubmittedWebhookEvent | ReturnSentWebhookEvent | ReturnFailedWebhookEvent | ReturnReturnedWebhookEvent | DepositSettledWebhookEvent | ConversionCreatedWebhookEvent | ConversionCompletedWebhookEvent | ConversionFailedWebhookEvent | AccountHolderActiveWebhookEvent | AccountHolderClosedWebhookEvent | PingTestWebhookEvent;
 export declare namespace Webhooks {
-    export { type PayoutCreatedWebhookEvent as PayoutCreatedWebhookEvent, type PayoutInitiatedWebhookEvent as PayoutInitiatedWebhookEvent, type PayoutPaidWebhookEvent as PayoutPaidWebhookEvent, type PayoutFailedWebhookEvent as PayoutFailedWebhookEvent, type ReturnInitiatedWebhookEvent as ReturnInitiatedWebhookEvent, type ReturnPaidWebhookEvent as ReturnPaidWebhookEvent, type ReturnFailedWebhookEvent as ReturnFailedWebhookEvent, type ReturnReturnedWebhookEvent as ReturnReturnedWebhookEvent, type DepositReceivedWebhookEvent as DepositReceivedWebhookEvent, type ConversionCreatedWebhookEvent as ConversionCreatedWebhookEvent, type ConversionCompletedWebhookEvent as ConversionCompletedWebhookEvent, type ConversionFailedWebhookEvent as ConversionFailedWebhookEvent, type AccountHolderActiveWebhookEvent as AccountHolderActiveWebhookEvent, type AccountHolderClosedWebhookEvent as AccountHolderClosedWebhookEvent, 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 PingTestWebhookEvent as PingTestWebhookEvent, type UnwrapWebhookEvent as UnwrapWebhookEvent, };
 }
 //# sourceMappingURL=webhooks.d.ts.map