@privy-io/api-types 0.20.0 → 0.22.0

package/src/resources/webhooks.ts

@@ -2,7 +2,9 @@
 
 import { APIResource } from '../core/resource';
 import * as AppsAPI from './apps';
+import * as FiatAPI from './fiat';
 import * as IntentsAPI from './intents';
+import * as SharedAPI from './shared';
 import * as UsersAPI from './users';
 import * as ActionsAPI from './wallets/actions';
 import * as WalletsAPI from './wallets/wallets';
@@ -146,6 +148,135 @@ export interface BridgeTransferRefundMetadata {
   original_transaction_hash?: string;
 }
 
+/**
+ * Details of a fiat deposit that has finished converting and been delivered to the
+ * wallet.
+ */
+export interface DepositCompletedData {
+  created_at: string;
+
+  /**
+   * The crypto asset, chain, delivered amount, and settlement transaction for a
+   * completed deposit.
+   */
+  destination: DepositCompletedDestination;
+
+  /**
+   * The fiat deposit that was received, including amount, currency, and originator.
+   */
+  source: DepositStartedSource;
+}
+
+/**
+ * The crypto asset, chain, delivered amount, and settlement transaction for a
+ * completed deposit.
+ */
+export interface DepositCompletedDestination {
+  /**
+   * The crypto amount delivered to the wallet, after conversion and fees.
+   */
+  amount: string;
+
+  /**
+   * The crypto asset the deposit was converted into (e.g. "usdc").
+   */
+  asset: string;
+
+  /**
+   * The chain the converted crypto was delivered on (e.g. "base").
+   */
+  chain: string;
+
+  /**
+   * The on-chain settlement transaction for the delivered crypto.
+   */
+  transaction_hash: string;
+}
+
+/**
+ * Details of a fiat deposit that failed to convert and was refunded to the sender.
+ */
+export interface DepositFailedData {
+  created_at: string;
+
+  /**
+   * The crypto asset and chain the fiat deposit is being converted into.
+   */
+  destination: DepositStartedDestination;
+
+  reason: string;
+
+  reason_code: string;
+
+  refunded_at: string;
+
+  /**
+   * The fiat deposit that was received, including amount, currency, and originator.
+   */
+  source: DepositStartedSource;
+}
+
+/**
+ * Details of a fiat deposit that has begun processing into a deposit account.
+ */
+export interface DepositStartedData {
+  created_at: string;
+
+  /**
+   * The crypto asset and chain the fiat deposit is being converted into.
+   */
+  destination: DepositStartedDestination;
+
+  /**
+   * The fiat deposit that was received, including amount, currency, and originator.
+   */
+  source: DepositStartedSource;
+}
+
+/**
+ * The crypto asset and chain the fiat deposit is being converted into.
+ */
+export interface DepositStartedDestination {
+  /**
+   * The crypto asset the deposit is converted into (e.g. "usdc").
+   */
+  asset: string;
+
+  /**
+   * The chain the converted crypto is delivered on (e.g. "base").
+   */
+  chain: string;
+}
+
+/**
+ * The fiat deposit that was received, including amount, currency, and originator.
+ */
+export interface DepositStartedSource {
+  /**
+   * The fiat amount deposited.
+   */
+  amount: string;
+
+  /**
+   * Fiat currencies a deposit account can receive deposits in.
+   */
+  currency: FiatDepositCurrency;
+
+  /**
+   * The payment rail the deposit arrived on. Known values include "sepa",
+   * "ach_push", "wire", "fednow", "faster_payments", "pix", "spei", but the provider
+   * may return others.
+   */
+  payment_rail?: string;
+
+  sender_name?: string;
+}
+
+/**
+ * Fiat currencies a deposit account can receive deposits in.
+ */
+export type FiatDepositCurrency = 'usd' | 'eur' | 'gbp' | 'brl' | 'mxn' | 'cop';
+
 /**
  * Payload for the wallet.funds_deposited webhook event.
  */
@@ -800,6 +931,53 @@ export interface MfaEnabledWebhookPayload {
   user_id: string;
 }
 
+/**
+ * Full KYB state snapshot in a KYB update event.
+ */
+export interface OrganizationKYBUpdatedData {
+  /**
+   * Capability statuses for the customer.
+   */
+  capabilities: FiatAPI.KyxCapabilities;
+
+  endorsements: Array<FiatAPI.KyxEndorsement>;
+
+  /**
+   * KYB verification status in a KYB update event.
+   */
+  kyb: OrganizationKYBUpdatedKYBData;
+
+  /**
+   * KYC/KYB status for the user.
+   */
+  status: FiatAPI.KyxProviderStatus;
+
+  /**
+   * Terms of service status in a KYB update event.
+   */
+  tos: OrganizationKYBUpdatedTosData;
+}
+
+/**
+ * KYB verification status in a KYB update event.
+ */
+export interface OrganizationKYBUpdatedKYBData {
+  /**
+   * Status of KYC/KYB verification. Passthrough from the provider.
+   */
+  status: FiatAPI.KyxVerificationStatus;
+}
+
+/**
+ * Terms of service status in a KYB update event.
+ */
+export interface OrganizationKYBUpdatedTosData {
+  /**
+   * Status of Terms of Service acceptance. Passthrough from the provider.
+   */
+  status: FiatAPI.KyxTosStatus;
+}
+
 /**
  * Payload for the wallet.private_key_export webhook event.
  */
@@ -1127,6 +1305,67 @@ export interface TransactionStillPendingWebhookPayload {
   reference_id?: string | null;
 }
 
+/**
+ * Payload for the usage.cross_chain_fee.recorded webhook event (Privy fee on a
+ * cross-chain transfer or swap).
+ */
+export interface UsageCrossChainFeeRecordedWebhookPayload {
+  amount_usd: string;
+
+  /**
+   * An opaque, stable identifier for this charge. Use it to deduplicate webhook
+   * deliveries.
+   */
+  event_id: string;
+
+  recorded_at: number;
+
+  source_id: string;
+
+  /**
+   * The type of operation that incurred a usage charge.
+   */
+  source_type: UsageSourceType;
+
+  /**
+   * The type of webhook event.
+   */
+  type: 'usage.cross_chain_fee.recorded';
+}
+
+/**
+ * Payload for the usage.gas_sponsorship.recorded webhook event (sponsored network
+ * gas).
+ */
+export interface UsageGasSponsorshipRecordedWebhookPayload {
+  amount_usd: string;
+
+  /**
+   * An opaque, stable identifier for this charge. Use it to deduplicate webhook
+   * deliveries.
+   */
+  event_id: string;
+
+  recorded_at: number;
+
+  source_id: string;
+
+  /**
+   * The type of operation that incurred a usage charge.
+   */
+  source_type: UsageSourceType;
+
+  /**
+   * The type of webhook event.
+   */
+  type: 'usage.gas_sponsorship.recorded';
+}
+
+/**
+ * The type of operation that incurred a usage charge.
+ */
+export type UsageSourceType = 'wallet-action-transfer' | 'wallet-action-swap' | 'rpc';
+
 /**
  * Payload for the user.authenticated webhook event.
  */
@@ -1162,6 +1401,68 @@ export interface UserCreatedWebhookPayload {
   user: UsersAPI.User;
 }
 
+/**
+ * Payload for the user.deleted webhook event.
+ */
+export interface UserDeletedWebhookPayload {
+  /**
+   * The type of webhook event.
+   */
+  type: 'user.deleted';
+
+  /**
+   * A Privy user object.
+   */
+  user: UsersAPI.User;
+}
+
+/**
+ * Full KYC state snapshot in a KYC update event.
+ */
+export interface UserKYCUpdatedData {
+  /**
+   * Capability statuses for the customer.
+   */
+  capabilities: FiatAPI.KyxCapabilities;
+
+  endorsements: Array<FiatAPI.KyxEndorsement>;
+
+  /**
+   * KYC verification status in a KYC update event.
+   */
+  kyc: UserKYCUpdatedKYCData;
+
+  /**
+   * KYC/KYB status for the user.
+   */
+  status: FiatAPI.KyxProviderStatus;
+
+  /**
+   * Terms of service status in a KYC update event.
+   */
+  tos: UserKYCUpdatedTosData;
+}
+
+/**
+ * KYC verification status in a KYC update event.
+ */
+export interface UserKYCUpdatedKYCData {
+  /**
+   * Status of KYC/KYB verification. Passthrough from the provider.
+   */
+  status: FiatAPI.KyxVerificationStatus;
+}
+
+/**
+ * Terms of service status in a KYC update event.
+ */
+export interface UserKYCUpdatedTosData {
+  /**
+   * Status of Terms of Service acceptance. Passthrough from the provider.
+   */
+  status: FiatAPI.KyxTosStatus;
+}
+
 /**
  * Payload for the user.linked_account webhook event.
  */
@@ -1384,6 +1685,11 @@ export interface WalletActionEarnDepositCreatedWebhookPayload {
    * present when the token is known in the asset registry.
    */
   decimals?: number;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -1478,6 +1784,11 @@ export interface WalletActionEarnDepositFailedWebhookPayload {
    * present when the token is known in the asset registry.
    */
   decimals?: number;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -1571,6 +1882,11 @@ export interface WalletActionEarnDepositRejectedWebhookPayload {
    * present when the token is known in the asset registry.
    */
   decimals?: number;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -1664,6 +1980,11 @@ export interface WalletActionEarnDepositSucceededWebhookPayload {
    * present when the token is known in the asset registry.
    */
   decimals?: number;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -1742,6 +2063,11 @@ export interface WalletActionEarnFeeCollectCreatedWebhookPayload {
    * present when the token is known in the asset registry.
    */
   decimals?: number;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -1836,6 +2162,11 @@ export interface WalletActionEarnFeeCollectFailedWebhookPayload {
    * present when the token is known in the asset registry.
    */
   decimals?: number;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -1929,6 +2260,11 @@ export interface WalletActionEarnFeeCollectRejectedWebhookPayload {
    * present when the token is known in the asset registry.
    */
   decimals?: number;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -2017,6 +2353,11 @@ export interface WalletActionEarnFeeCollectSucceededWebhookPayload {
    * present when the token is known in the asset registry.
    */
   decimals?: number;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -2062,6 +2403,11 @@ export interface WalletActionEarnIncentiveClaimCreatedWebhookPayload {
    * The ID of the wallet involved in the action.
    */
   wallet_id: string;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -2123,6 +2469,11 @@ export interface WalletActionEarnIncentiveClaimFailedWebhookPayload {
    * The ID of the wallet involved in the action.
    */
   wallet_id: string;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -2183,6 +2534,11 @@ export interface WalletActionEarnIncentiveClaimRejectedWebhookPayload {
    * The ID of the wallet involved in the action.
    */
   wallet_id: string;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -2238,6 +2594,11 @@ export interface WalletActionEarnIncentiveClaimSucceededWebhookPayload {
    * The ID of the wallet involved in the action.
    */
   wallet_id: string;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -2316,6 +2677,11 @@ export interface WalletActionEarnWithdrawCreatedWebhookPayload {
    * present when the token is known in the asset registry.
    */
   decimals?: number;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -2410,6 +2776,11 @@ export interface WalletActionEarnWithdrawFailedWebhookPayload {
    * present when the token is known in the asset registry.
    */
   decimals?: number;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -2503,6 +2874,11 @@ export interface WalletActionEarnWithdrawRejectedWebhookPayload {
    * present when the token is known in the asset registry.
    */
   decimals?: number;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -2596,22 +2972,388 @@ export interface WalletActionEarnWithdrawSucceededWebhookPayload {
    * present when the token is known in the asset registry.
    */
   decimals?: number;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
 }
 
 /**
- * Payload for the wallet_action.swap.created webhook event.
+ * Payload for the wallet_action.payout.created webhook event.
  */
-export interface WalletActionSwapCreatedWebhookPayload {
+export interface WalletActionPayoutCreatedWebhookPayload {
   /**
    * Type of wallet action
    */
   action_type: ActionsAPI.WalletActionType;
 
-  /**
-   * Chain identifier.
-   */
-  caip2: string;
-
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
+  /**
+   * The fiat currency the payout settles in (e.g. "usd").
+   */
+  destination_currency: string;
+
+  /**
+   * The registered external fiat account the payout settles to.
+   */
+  destination_fiat_account_id: string;
+
+  /**
+   * The fiat payment rail the payout settles over (e.g. "ach", "sepa", "wire").
+   */
+  destination_payment_rail: string;
+
+  /**
+   * The Privy API environment.
+   */
+  environment: SharedAPI.IntegrationEnvironment;
+
+  /**
+   * Supported fiat orchestration providers.
+   */
+  provider: SharedAPI.OrchestrationProvider;
+
+  /**
+   * Decimal amount offramped, in the asset's standard units (e.g. "100.00").
+   */
+  source_amount: string;
+
+  /**
+   * Source crypto asset sent on-chain (e.g. "usdc").
+   */
+  source_asset: string;
+
+  /**
+   * Source chain the crypto was sent from (e.g. "base").
+   */
+  source_chain: string;
+
+  /**
+   * The status of the wallet action.
+   */
+  status: 'pending';
+
+  /**
+   * The type of webhook event.
+   */
+  type: 'wallet_action.payout.created';
+
+  /**
+   * The ID of the wallet action.
+   */
+  wallet_action_id: string;
+
+  /**
+   * The ID of the wallet involved in the action.
+   */
+  wallet_id: string;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
+}
+
+/**
+ * Payload for the wallet_action.payout.failed webhook event.
+ */
+export interface WalletActionPayoutFailedWebhookPayload {
+  /**
+   * Type of wallet action
+   */
+  action_type: ActionsAPI.WalletActionType;
+
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
+  /**
+   * The fiat currency the payout settles in (e.g. "usd").
+   */
+  destination_currency: string;
+
+  /**
+   * The registered external fiat account the payout settles to.
+   */
+  destination_fiat_account_id: string;
+
+  /**
+   * The fiat payment rail the payout settles over (e.g. "ach", "sepa", "wire").
+   */
+  destination_payment_rail: string;
+
+  /**
+   * The Privy API environment.
+   */
+  environment: SharedAPI.IntegrationEnvironment;
+
+  /**
+   * ISO 8601 timestamp of when the wallet action failed.
+   */
+  failed_at: string;
+
+  /**
+   * A description of why a wallet action (or a step within a wallet action) failed.
+   */
+  failure_reason: ActionsAPI.FailureReason;
+
+  /**
+   * Supported fiat orchestration providers.
+   */
+  provider: SharedAPI.OrchestrationProvider;
+
+  /**
+   * Decimal amount offramped, in the asset's standard units (e.g. "100.00").
+   */
+  source_amount: string;
+
+  /**
+   * Source crypto asset sent on-chain (e.g. "usdc").
+   */
+  source_asset: string;
+
+  /**
+   * Source chain the crypto was sent from (e.g. "base").
+   */
+  source_chain: string;
+
+  /**
+   * The status of the wallet action.
+   */
+  status: 'failed';
+
+  /**
+   * The steps of the wallet action. Completed steps will have transaction hashes;
+   * the failing step will have a failure_reason.
+   */
+  steps: Array<ActionsAPI.WalletActionStep>;
+
+  /**
+   * The type of webhook event.
+   */
+  type: 'wallet_action.payout.failed';
+
+  /**
+   * The ID of the wallet action.
+   */
+  wallet_action_id: string;
+
+  /**
+   * The ID of the wallet involved in the action.
+   */
+  wallet_id: string;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
+}
+
+/**
+ * Payload for the wallet_action.payout.rejected webhook event.
+ */
+export interface WalletActionPayoutRejectedWebhookPayload {
+  /**
+   * Type of wallet action
+   */
+  action_type: ActionsAPI.WalletActionType;
+
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
+  /**
+   * The fiat currency the payout settles in (e.g. "usd").
+   */
+  destination_currency: string;
+
+  /**
+   * The registered external fiat account the payout settles to.
+   */
+  destination_fiat_account_id: string;
+
+  /**
+   * The fiat payment rail the payout settles over (e.g. "ach", "sepa", "wire").
+   */
+  destination_payment_rail: string;
+
+  /**
+   * The Privy API environment.
+   */
+  environment: SharedAPI.IntegrationEnvironment;
+
+  /**
+   * A description of why a wallet action (or a step within a wallet action) failed.
+   */
+  failure_reason: ActionsAPI.FailureReason;
+
+  /**
+   * Supported fiat orchestration providers.
+   */
+  provider: SharedAPI.OrchestrationProvider;
+
+  /**
+   * ISO 8601 timestamp of when the wallet action was rejected.
+   */
+  rejected_at: string;
+
+  /**
+   * Decimal amount offramped, in the asset's standard units (e.g. "100.00").
+   */
+  source_amount: string;
+
+  /**
+   * Source crypto asset sent on-chain (e.g. "usdc").
+   */
+  source_asset: string;
+
+  /**
+   * Source chain the crypto was sent from (e.g. "base").
+   */
+  source_chain: string;
+
+  /**
+   * The status of the wallet action.
+   */
+  status: 'rejected';
+
+  /**
+   * The steps of the wallet action at the time of rejection.
+   */
+  steps: Array<ActionsAPI.WalletActionStep>;
+
+  /**
+   * The type of webhook event.
+   */
+  type: 'wallet_action.payout.rejected';
+
+  /**
+   * The ID of the wallet action.
+   */
+  wallet_action_id: string;
+
+  /**
+   * The ID of the wallet involved in the action.
+   */
+  wallet_id: string;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
+}
+
+/**
+ * Payload for the wallet_action.payout.succeeded webhook event.
+ */
+export interface WalletActionPayoutSucceededWebhookPayload {
+  /**
+   * Type of wallet action
+   */
+  action_type: ActionsAPI.WalletActionType;
+
+  /**
+   * ISO 8601 timestamp of when the wallet action completed successfully.
+   */
+  completed_at: string;
+
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
+  /**
+   * The fiat currency the payout settles in (e.g. "usd").
+   */
+  destination_currency: string;
+
+  /**
+   * The registered external fiat account the payout settles to.
+   */
+  destination_fiat_account_id: string;
+
+  /**
+   * The fiat payment rail the payout settles over (e.g. "ach", "sepa", "wire").
+   */
+  destination_payment_rail: string;
+
+  /**
+   * The Privy API environment.
+   */
+  environment: SharedAPI.IntegrationEnvironment;
+
+  /**
+   * Supported fiat orchestration providers.
+   */
+  provider: SharedAPI.OrchestrationProvider;
+
+  /**
+   * Decimal amount offramped, in the asset's standard units (e.g. "100.00").
+   */
+  source_amount: string;
+
+  /**
+   * Source crypto asset sent on-chain (e.g. "usdc").
+   */
+  source_asset: string;
+
+  /**
+   * Source chain the crypto was sent from (e.g. "base").
+   */
+  source_chain: string;
+
+  /**
+   * The status of the wallet action.
+   */
+  status: 'succeeded';
+
+  /**
+   * The steps of the wallet action, including transaction hashes.
+   */
+  steps: Array<ActionsAPI.WalletActionStep>;
+
+  /**
+   * The type of webhook event.
+   */
+  type: 'wallet_action.payout.succeeded';
+
+  /**
+   * The ID of the wallet action.
+   */
+  wallet_action_id: string;
+
+  /**
+   * The ID of the wallet involved in the action.
+   */
+  wallet_id: string;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
+}
+
+/**
+ * Payload for the wallet_action.swap.created webhook event.
+ */
+export interface WalletActionSwapCreatedWebhookPayload {
+  /**
+   * Type of wallet action
+   */
+  action_type: ActionsAPI.WalletActionType;
+
+  /**
+   * Chain identifier.
+   */
+  caip2: string;
+
   /**
    * ISO 8601 timestamp of when the wallet action was created.
    */
@@ -2651,6 +3393,11 @@ export interface WalletActionSwapCreatedWebhookPayload {
    * The ID of the wallet involved in the action.
    */
   wallet_id: string;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -2722,6 +3469,11 @@ export interface WalletActionSwapFailedWebhookPayload {
    * The ID of the wallet involved in the action.
    */
   wallet_id: string;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -2792,6 +3544,11 @@ export interface WalletActionSwapRejectedWebhookPayload {
    * The ID of the wallet involved in the action.
    */
   wallet_id: string;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -2863,6 +3620,11 @@ export interface WalletActionSwapSucceededWebhookPayload {
    * The ID of the wallet involved in the action.
    */
   wallet_id: string;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -2909,6 +3671,11 @@ export interface WalletActionTransferCreatedWebhookPayload {
    */
   wallet_id: string;
 
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
+
   /**
    * Decimal amount sent on the source chain (e.g. "1.5"). Omitted for exact_output
    * cross-chain transfers until the source amount is determined.
@@ -2994,6 +3761,11 @@ export interface WalletActionTransferFailedWebhookPayload {
    */
   wallet_id: string;
 
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
+
   /**
    * Decimal amount sent on the source chain (e.g. "1.5"). Omitted for exact_output
    * cross-chain transfers until the source amount is determined.
@@ -3078,6 +3850,11 @@ export interface WalletActionTransferRejectedWebhookPayload {
    */
   wallet_id: string;
 
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
+
   /**
    * Decimal amount sent on the source chain (e.g. "1.5"). Omitted for exact_output
    * cross-chain transfers until the source amount is determined.
@@ -3157,6 +3934,11 @@ export interface WalletActionTransferSucceededWebhookPayload {
    */
   wallet_id: string;
 
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
+
   /**
    * Decimal amount sent on the source chain (e.g. "1.5"). Omitted for exact_output
    * cross-chain transfers until the source amount is determined.
@@ -3212,6 +3994,52 @@ export interface WalletArchivedWebhookPayload {
   wallet_id: string;
 }
 
+/**
+ * Payload for the wallet_automation.submitted webhook event.
+ */
+export interface WalletAutomationSubmittedWebhookPayload {
+  /**
+   * The ID of the wallet action created to fulfill the automation.
+   */
+  action_id: string;
+
+  /**
+   * The ID of the automation that fired.
+   */
+  automation_id: string;
+
+  /**
+   * ISO 8601 timestamp of when the automation was submitted.
+   */
+  created_at: string;
+
+  /**
+   * Contract address of the triggering deposit's asset, or 'native-token' for the
+   * native asset.
+   */
+  trigger_asset_address: string;
+
+  /**
+   * CAIP-2 chain identifier of the triggering deposit (e.g., 'eip155:8453').
+   */
+  trigger_caip2: string;
+
+  /**
+   * The ID of the automation execution that fired.
+   */
+  trigger_id: string;
+
+  /**
+   * The type of webhook event.
+   */
+  type: 'wallet_automation.submitted';
+
+  /**
+   * The ID of the wallet the automation fired for.
+   */
+  wallet_id: string;
+}
+
 /**
  * An asset involved in a wallet transfer.
  */
@@ -3220,7 +4048,17 @@ export type WalletFundsAsset =
   | WalletFundsErc20Asset
   | WalletFundsSplAsset
   | WalletFundsSacAsset
-  | WalletFundsTrc20Asset;
+  | WalletFundsTrc20Asset
+  | WalletFundsBtknAsset;
+
+/**
+ * A token issued on Spark, identified by its BTKN identifier.
+ */
+export interface WalletFundsBtknAsset {
+  identifier: string;
+
+  type: 'btkn';
+}
 
 /**
  * An ERC-20 token asset.
@@ -3363,6 +4201,7 @@ export interface WalletRestoredWebhookPayload {
  */
 export type WebhookPayload =
   | UserCreatedWebhookPayload
+  | UserDeletedWebhookPayload
   | UserAuthenticatedWebhookPayload
   | UserLinkedAccountWebhookPayload
   | UserUnlinkedAccountWebhookPayload
@@ -3390,6 +4229,8 @@ export type WebhookPayload =
   | YieldWithdrawConfirmedWebhookPayload
   | YieldClaimConfirmedWebhookPayload
   | UserOperationCompletedWebhookPayload
+  | UsageGasSponsorshipRecordedWebhookPayload
+  | UsageCrossChainFeeRecordedWebhookPayload
   | IntentCreatedWebhookPayload
   | IntentAuthorizedWebhookPayload
   | IntentRejectedWebhookPayload
@@ -3418,7 +4259,12 @@ export type WebhookPayload =
   | WalletActionEarnFeeCollectCreatedWebhookPayload
   | WalletActionEarnFeeCollectSucceededWebhookPayload
   | WalletActionEarnFeeCollectRejectedWebhookPayload
-  | WalletActionEarnFeeCollectFailedWebhookPayload;
+  | WalletActionEarnFeeCollectFailedWebhookPayload
+  | WalletActionPayoutCreatedWebhookPayload
+  | WalletActionPayoutSucceededWebhookPayload
+  | WalletActionPayoutRejectedWebhookPayload
+  | WalletActionPayoutFailedWebhookPayload
+  | WalletAutomationSubmittedWebhookPayload;
 
 /**
  * Payload for the yield.claim.confirmed webhook event.
@@ -3506,6 +4352,13 @@ export declare namespace Webhooks {
     type BridgeRefundMetadata as BridgeRefundMetadata,
     type BridgeStaticMemoDepositMetadata as BridgeStaticMemoDepositMetadata,
     type BridgeTransferRefundMetadata as BridgeTransferRefundMetadata,
+    type DepositCompletedData as DepositCompletedData,
+    type DepositCompletedDestination as DepositCompletedDestination,
+    type DepositFailedData as DepositFailedData,
+    type DepositStartedData as DepositStartedData,
+    type DepositStartedDestination as DepositStartedDestination,
+    type DepositStartedSource as DepositStartedSource,
+    type FiatDepositCurrency as FiatDepositCurrency,
     type FundsDepositedWebhookPayload as FundsDepositedWebhookPayload,
     type FundsWithdrawnWebhookPayload as FundsWithdrawnWebhookPayload,
     type IntentAuthorizedWebhookPayload as IntentAuthorizedWebhookPayload,
@@ -3524,6 +4377,9 @@ export declare namespace Webhooks {
     type KrakenEmbedUserVerifiedWebhookPayload as KrakenEmbedUserVerifiedWebhookPayload,
     type MfaDisabledWebhookPayload as MfaDisabledWebhookPayload,
     type MfaEnabledWebhookPayload as MfaEnabledWebhookPayload,
+    type OrganizationKYBUpdatedData as OrganizationKYBUpdatedData,
+    type OrganizationKYBUpdatedKYBData as OrganizationKYBUpdatedKYBData,
+    type OrganizationKYBUpdatedTosData as OrganizationKYBUpdatedTosData,
     type PrivateKeyExportWebhookPayload as PrivateKeyExportWebhookPayload,
     type SeedPhraseExportWebhookPayload as SeedPhraseExportWebhookPayload,
     type TransactionBroadcastedWebhookPayload as TransactionBroadcastedWebhookPayload,
@@ -3533,8 +4389,15 @@ export declare namespace Webhooks {
     type TransactionProviderErrorWebhookPayload as TransactionProviderErrorWebhookPayload,
     type TransactionReplacedWebhookPayload as TransactionReplacedWebhookPayload,
     type TransactionStillPendingWebhookPayload as TransactionStillPendingWebhookPayload,
+    type UsageCrossChainFeeRecordedWebhookPayload as UsageCrossChainFeeRecordedWebhookPayload,
+    type UsageGasSponsorshipRecordedWebhookPayload as UsageGasSponsorshipRecordedWebhookPayload,
+    type UsageSourceType as UsageSourceType,
     type UserAuthenticatedWebhookPayload as UserAuthenticatedWebhookPayload,
     type UserCreatedWebhookPayload as UserCreatedWebhookPayload,
+    type UserDeletedWebhookPayload as UserDeletedWebhookPayload,
+    type UserKYCUpdatedData as UserKYCUpdatedData,
+    type UserKYCUpdatedKYCData as UserKYCUpdatedKYCData,
+    type UserKYCUpdatedTosData as UserKYCUpdatedTosData,
     type UserLinkedAccountWebhookPayload as UserLinkedAccountWebhookPayload,
     type UserOperationCompletedWebhookPayload as UserOperationCompletedWebhookPayload,
     type UserReference as UserReference,
@@ -3558,6 +4421,10 @@ export declare namespace Webhooks {
     type WalletActionEarnWithdrawFailedWebhookPayload as WalletActionEarnWithdrawFailedWebhookPayload,
     type WalletActionEarnWithdrawRejectedWebhookPayload as WalletActionEarnWithdrawRejectedWebhookPayload,
     type WalletActionEarnWithdrawSucceededWebhookPayload as WalletActionEarnWithdrawSucceededWebhookPayload,
+    type WalletActionPayoutCreatedWebhookPayload as WalletActionPayoutCreatedWebhookPayload,
+    type WalletActionPayoutFailedWebhookPayload as WalletActionPayoutFailedWebhookPayload,
+    type WalletActionPayoutRejectedWebhookPayload as WalletActionPayoutRejectedWebhookPayload,
+    type WalletActionPayoutSucceededWebhookPayload as WalletActionPayoutSucceededWebhookPayload,
     type WalletActionSwapCreatedWebhookPayload as WalletActionSwapCreatedWebhookPayload,
     type WalletActionSwapFailedWebhookPayload as WalletActionSwapFailedWebhookPayload,
     type WalletActionSwapRejectedWebhookPayload as WalletActionSwapRejectedWebhookPayload,
@@ -3567,7 +4434,9 @@ export declare namespace Webhooks {
     type WalletActionTransferRejectedWebhookPayload as WalletActionTransferRejectedWebhookPayload,
     type WalletActionTransferSucceededWebhookPayload as WalletActionTransferSucceededWebhookPayload,
     type WalletArchivedWebhookPayload as WalletArchivedWebhookPayload,
+    type WalletAutomationSubmittedWebhookPayload as WalletAutomationSubmittedWebhookPayload,
     type WalletFundsAsset as WalletFundsAsset,
+    type WalletFundsBtknAsset as WalletFundsBtknAsset,
     type WalletFundsErc20Asset as WalletFundsErc20Asset,
     type WalletFundsNativeTokenAsset as WalletFundsNativeTokenAsset,
     type WalletFundsSacAsset as WalletFundsSacAsset,