@augustusbank/typescript-sdk 0.22.0 → 0.22.1

package/src/resources/webhooks.ts

@@ -18,7 +18,7 @@ export class Webhooks extends APIResource {
   }
 }
 
-export interface PayoutCreatedWebhookEvent {
+export interface PayoutInitiatedWebhookEvent {
   /**
    * Unique identifier for the event. Stable across retries.
    */
@@ -37,15 +37,15 @@ 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 namespace PayoutCreatedWebhookEvent {
+export namespace PayoutInitiatedWebhookEvent {
   /**
    * Full resource snapshot at the time of the event.
    */
@@ -123,9 +123,10 @@ export 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
@@ -183,7 +184,7 @@ export namespace PayoutCreatedWebhookEvent {
   }
 }
 
-export interface PayoutInitiatedWebhookEvent {
+export interface PayoutSubmittedWebhookEvent {
   /**
    * Unique identifier for the event. Stable across retries.
    */
@@ -202,15 +203,15 @@ 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 namespace PayoutInitiatedWebhookEvent {
+export namespace PayoutSubmittedWebhookEvent {
   /**
    * Full resource snapshot at the time of the event.
    */
@@ -288,9 +289,10 @@ export 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
@@ -348,7 +350,7 @@ export namespace PayoutInitiatedWebhookEvent {
   }
 }
 
-export interface PayoutPaidWebhookEvent {
+export interface PayoutSentWebhookEvent {
   /**
    * Unique identifier for the event. Stable across retries.
    */
@@ -367,15 +369,15 @@ 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 namespace PayoutPaidWebhookEvent {
+export namespace PayoutSentWebhookEvent {
   /**
    * Full resource snapshot at the time of the event.
    */
@@ -453,9 +455,10 @@ export 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
@@ -618,9 +621,176 @@ export 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_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;
+  }
+
+  export namespace Payload {
+    /**
+     * Failure details when status is failed, otherwise null.
+     */
+    export 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 namespace PayoutReturnedWebhookEvent {
+  /**
+   * Full resource snapshot at the time of the event.
+   */
+  export 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_id: string | null;
+    tracking_reference: string | null;
 
     /**
      * Transaction hash for crypto payouts, or null when not known. Only blockchain
@@ -822,7 +992,7 @@ export namespace ReturnInitiatedWebhookEvent {
   }
 }
 
-export interface ReturnPaidWebhookEvent {
+export interface ReturnSubmittedWebhookEvent {
   /**
    * Unique identifier for the event. Stable across retries.
    */
@@ -841,15 +1011,159 @@ export interface ReturnPaidWebhookEvent {
   /**
    * Full resource snapshot at the time of the event.
    */
-  payload: ReturnPaidWebhookEvent.Payload;
+  payload: ReturnSubmittedWebhookEvent.Payload;
 
   /**
    * Event type in resource.action format.
    */
-  type: 'return.paid';
+  type: 'return.submitted';
 }
 
-export namespace ReturnPaidWebhookEvent {
+export namespace ReturnSubmittedWebhookEvent {
+  /**
+   * Full resource snapshot at the time of the event.
+   */
+  export 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';
+  }
+
+  export namespace Payload {
+    /**
+     * Failure details when status is failed, otherwise null.
+     */
+    export 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.
+   */
+  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: ReturnSentWebhookEvent.Payload;
+
+  /**
+   * Event type in resource.action format.
+   */
+  type: 'return.sent';
+}
+
+export namespace ReturnSentWebhookEvent {
   /**
    * Full resource snapshot at the time of the event.
    */
@@ -1254,7 +1568,7 @@ export namespace ReturnReturnedWebhookEvent {
   }
 }
 
-export interface DepositReceivedWebhookEvent {
+export interface DepositSettledWebhookEvent {
   /**
    * Unique identifier for the event. Stable across retries.
    */
@@ -1273,15 +1587,15 @@ 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 namespace DepositReceivedWebhookEvent {
+export namespace DepositSettledWebhookEvent {
   /**
    * Full resource snapshot at the time of the event.
    */
@@ -1348,6 +1662,12 @@ export namespace DepositReceivedWebhookEvent {
      */
     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.
@@ -9561,15 +9881,17 @@ export namespace PingTestWebhookEvent {
 }
 
 export type UnwrapWebhookEvent =
-  | PayoutCreatedWebhookEvent
   | PayoutInitiatedWebhookEvent
-  | PayoutPaidWebhookEvent
+  | PayoutSubmittedWebhookEvent
+  | PayoutSentWebhookEvent
   | PayoutFailedWebhookEvent
+  | PayoutReturnedWebhookEvent
   | ReturnInitiatedWebhookEvent
-  | ReturnPaidWebhookEvent
+  | ReturnSubmittedWebhookEvent
+  | ReturnSentWebhookEvent
   | ReturnFailedWebhookEvent
   | ReturnReturnedWebhookEvent
-  | DepositReceivedWebhookEvent
+  | DepositSettledWebhookEvent
   | ConversionCreatedWebhookEvent
   | ConversionCompletedWebhookEvent
   | ConversionFailedWebhookEvent
@@ -9579,15 +9901,17 @@ export type UnwrapWebhookEvent =
 
 export declare namespace Webhooks {
   export {
-    type PayoutCreatedWebhookEvent as PayoutCreatedWebhookEvent,
     type PayoutInitiatedWebhookEvent as PayoutInitiatedWebhookEvent,
-    type PayoutPaidWebhookEvent as PayoutPaidWebhookEvent,
+    type PayoutSubmittedWebhookEvent as PayoutSubmittedWebhookEvent,
+    type PayoutSentWebhookEvent as PayoutSentWebhookEvent,
     type PayoutFailedWebhookEvent as PayoutFailedWebhookEvent,
+    type PayoutReturnedWebhookEvent as PayoutReturnedWebhookEvent,
     type ReturnInitiatedWebhookEvent as ReturnInitiatedWebhookEvent,
-    type ReturnPaidWebhookEvent as ReturnPaidWebhookEvent,
+    type ReturnSubmittedWebhookEvent as ReturnSubmittedWebhookEvent,
+    type ReturnSentWebhookEvent as ReturnSentWebhookEvent,
     type ReturnFailedWebhookEvent as ReturnFailedWebhookEvent,
     type ReturnReturnedWebhookEvent as ReturnReturnedWebhookEvent,
-    type DepositReceivedWebhookEvent as DepositReceivedWebhookEvent,
+    type DepositSettledWebhookEvent as DepositSettledWebhookEvent,
     type ConversionCreatedWebhookEvent as ConversionCreatedWebhookEvent,
     type ConversionCompletedWebhookEvent as ConversionCompletedWebhookEvent,
     type ConversionFailedWebhookEvent as ConversionFailedWebhookEvent,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.22.0'; // x-release-please-version
+export const VERSION = '0.22.1'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.22.0";
+export declare const VERSION = "0.22.1";
 //# 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.22.0'; // x-release-please-version
+exports.VERSION = '0.22.1'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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