@privy-io/api-types 0.21.0 → 0.23.0

package/src/resources/index.ts

@@ -105,6 +105,7 @@ export {
   type CardIssuingListCardsInput,
   type CardIssuingListTransactionsInput,
   type CardIssuingMerchant,
+  type CardIssuingPinUpdate,
   type CardIssuingReplaceCardRequestBody,
   type CardIssuingReplacementReason,
   type CardIssuingStatementQueryParams,
@@ -342,13 +343,26 @@ export {
   type FiatDepositAccountStatus,
   type FiatDepositInstructions,
   type FiatPaymentRail,
+  type KYBAccountPurpose,
+  type KYBAssociatedPerson,
+  type KYBBusinessDocument,
+  type KYBBusinessType,
+  type KYBDocumentPurpose,
+  type KYBEstimatedAnnualRevenue,
+  type KYBHighRiskActivity,
+  type KYBIndividualDocument,
+  type KYBIndividualDocumentPurpose,
   type KYBLinksRequestBody,
+  type KYBPlaceOfBirth,
+  type KYBPubliclyTradedListing,
+  type KYBRegulatedActivity,
+  type KYBSourceOfFunds,
   type KYBStatusListResponse,
   type KYBStatusResponse,
+  type KYBSubmitData,
+  type KYBSubmitRequestBody,
   type KYBTosRequestBody,
-  type KYCIdentifyingDocument,
   type KYCLinksRequestBody,
-  type KYCResidentialAddress,
   type KYCStatusListResponse,
   type KYCStatusResponse,
   type KYCSubmitData,
@@ -383,6 +397,8 @@ export {
   type OrganizationExternalFiatAccountResponse,
   type PayoutDestination,
   type PayoutSource,
+  type VerificationAddress,
+  type VerificationDocument,
 } from './fiat';
 export {
   Funding,
@@ -663,9 +679,12 @@ export {
 export {
   Shared,
   type BitcoinAddress,
+  type BitcoinCaip2,
+  type Bps,
   type CurrencyAmount,
   type IntegrationEnvironment,
   type EvmAddress,
+  type EvmCaip2,
   type EvmChecksumAddress,
   type HyperliquidTokenAddress,
   type KeyQuorumID,
@@ -676,9 +695,11 @@ export {
   type OwnerInputUser,
   type P256PublicKey,
   type SolanaAddress,
+  type SolanaCaip2,
   type SuccessResponse,
   type TokenIdentifier,
   type TronAddress,
+  type TronCaip2,
   type TronHexAddress,
 } from './shared';
 export {
@@ -817,6 +838,11 @@ export {
   type WalletAutomationExecutionResponse,
   type WalletAutomationExecutionStatus,
   type WalletAutomationListResponse,
+  type WalletAutomationReindexAssetResult,
+  type WalletAutomationReindexAssetStatus,
+  type WalletAutomationReindexCaip2,
+  type WalletAutomationReindexRequestBody,
+  type WalletAutomationReindexResponse,
   type WalletAutomationResponse,
   type WalletAutomationStatus,
   type WalletAutomationSuccessResponse,
@@ -840,6 +866,7 @@ export {
   type AptosSignTransactionRpcResponseData,
   type AptosSignedTransactionBcsHex,
   type AttachWalletAutomationRequestBody,
+  type AttachedWalletAutomation,
   type AuthorizationKeyDashboardResponse,
   type AuthorizationKeyResponse,
   type AuthorizationKeyRole,
@@ -847,7 +874,13 @@ export {
   type CreateCryptoDepositAccountResponse,
   type CreateCryptoDepositAccountWithConfigRequestBody,
   type CreateCryptoDepositAccountWithRouteRequestBody,
+  type CryptoDepositAccountCaip2,
+  type CryptoDepositAccountChain,
+  type CryptoDepositAccountConfigResponse,
+  type CryptoDepositAccountSourceChain,
+  type CryptoDepositAccountSourceCurrency,
   type CryptoDepositAddressRoute,
+  type CryptoDepositAddressStrategy,
   type CryptoDepositAsset,
   type CryptoDepositAssetFilter,
   type CryptoDepositAssetFilterAll,
@@ -856,10 +889,15 @@ export {
   type CurveSigningChainType,
   type CurveType,
   type CustodialWallet,
+  type CustodialWalletChain,
   type CustodialWalletChainType,
   type CustodialWalletCreateInput,
   type CustodialWalletProvider,
   type CustomTokenTransferSource,
+  type DepositAccountCryptoQuoteAmount,
+  type DepositAccountCryptoQuoteAsset,
+  type DepositAccountCryptoQuoteRequestBody,
+  type DepositAccountCryptoQuoteResponse,
   type DetachWalletAutomationRequestBody,
   type DeveloperFee,
   type EncryptedAuthorizationKey,
@@ -914,6 +952,8 @@ export {
   type FirstClassChainType,
   type Gas,
   type GetByWalletAddressRequestBody,
+  type GetCryptoDepositAccountNextOrderResponse,
+  type GetCryptoDepositAccountOrderResponse,
   type HDInitInput,
   type HDPath,
   type HDSubmitInput,
@@ -922,6 +962,7 @@ export {
   type HpkeImportConfig,
   type Hex,
   type IntentBinding,
+  type ListCryptoDepositAccountsResponse,
   type NamedTokenTransferSource,
   type NearRpcRequestBody,
   type NearRpcResponse,
@@ -1039,10 +1080,19 @@ export {
   type TransactionChainNameInput,
   type TransactionDetail,
   type TransactionTokenAddressInput,
+  type TransferCustodyOptions,
+  type TransferInitiation,
+  type TransferInitiationAttestations,
+  type TransferInitiationChannel,
+  type TransferInitiationSubchannel,
   type TransferQuoteRequestBody,
   type TransferQuoteResponse,
   type TransferReceivedTransactionDetail,
   type TransferRequestBody,
+  type TransferScaAttestation,
+  type TransferScaAuthFactor,
+  type TransferScaAuthFactorCategory,
+  type TransferScaOutcome,
   type TransferSentTransactionDetail,
   type TronContract,
   type TronRawDataForSend,
@@ -1171,9 +1221,9 @@ export {
   type TransactionProviderErrorWebhookPayload,
   type TransactionReplacedWebhookPayload,
   type TransactionStillPendingWebhookPayload,
-  type UsageCrossChainFeeRecordedWebhookPayload,
   type UsageGasSponsorshipRecordedWebhookPayload,
   type UsageSourceType,
+  type UsageSwapProviderFeeRecordedWebhookPayload,
   type UserAuthenticatedWebhookPayload,
   type UserCreatedWebhookPayload,
   type UserDeletedWebhookPayload,
@@ -1218,6 +1268,7 @@ export {
   type WalletArchivedWebhookPayload,
   type WalletAutomationSubmittedWebhookPayload,
   type WalletFundsAsset,
+  type WalletFundsBtknAsset,
   type WalletFundsErc20Asset,
   type WalletFundsNativeTokenAsset,
   type WalletFundsSacAsset,

package/src/resources/shared.ts

@@ -9,6 +9,17 @@ export class Shared extends APIResource {}
  */
 export type BitcoinAddress = string;
 
+/**
+ * Bitcoin CAIP-2 chain identifier (e.g.
+ * "bip122:000000000019d6689c085ae165831e93").
+ */
+export type BitcoinCaip2 = 'bip122:mainnet' | (string & {});
+
+/**
+ * Value in basis points: integer from 0 to 10000 (0% to 100%).
+ */
+export type Bps = number;
+
 /**
  * A monetary value with its currency denomination.
  */
@@ -34,6 +45,12 @@ export type IntegrationEnvironment = 'sandbox' | 'production';
  */
 export type EvmAddress = string;
 
+/**
+ * EVM CAIP-2 chain identifier (e.g. "eip155:4217" for Tempo, "eip155:1" for
+ * Ethereum).
+ */
+export type EvmCaip2 = string;
+
 /**
  * EVM address normalized to EIP-55 checksum case.
  */
@@ -95,6 +112,11 @@ export type P256PublicKey = string;
  */
 export type SolanaAddress = string;
 
+/**
+ * Solana CAIP-2 chain identifier (e.g. "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp").
+ */
+export type SolanaCaip2 = string;
+
 /**
  * A simple success response.
  */
@@ -114,6 +136,11 @@ export type TokenIdentifier = string;
  */
 export type TronAddress = string;
 
+/**
+ * Tron CAIP-2 chain identifier. Supported values: "tron:mainnet", "tron:nile".
+ */
+export type TronCaip2 = 'tron:mainnet' | 'tron:nile';
+
 /**
  * Tron address in hex format: 41-prefixed, 42 hex characters (21 bytes), no 0x
  * prefix.
@@ -123,9 +150,12 @@ export type TronHexAddress = string;
 export declare namespace Shared {
   export {
     type BitcoinAddress as BitcoinAddress,
+    type BitcoinCaip2 as BitcoinCaip2,
+    type Bps as Bps,
     type CurrencyAmount as CurrencyAmount,
     type IntegrationEnvironment as IntegrationEnvironment,
     type EvmAddress as EvmAddress,
+    type EvmCaip2 as EvmCaip2,
     type EvmChecksumAddress as EvmChecksumAddress,
     type HyperliquidTokenAddress as HyperliquidTokenAddress,
     type KeyQuorumID as KeyQuorumID,
@@ -136,9 +166,11 @@ export declare namespace Shared {
     type OwnerInputUser as OwnerInputUser,
     type P256PublicKey as P256PublicKey,
     type SolanaAddress as SolanaAddress,
+    type SolanaCaip2 as SolanaCaip2,
     type SuccessResponse as SuccessResponse,
     type TokenIdentifier as TokenIdentifier,
     type TronAddress as TronAddress,
+    type TronCaip2 as TronCaip2,
     type TronHexAddress as TronHexAddress,
   };
 }

package/src/resources/swaps.ts

@@ -22,7 +22,8 @@ export interface SwapDestination {
 
   /**
    * Address to receive the output tokens. Defaults to the swapping wallet address.
-   * Required when swapping between different chain types (e.g. EVM to Solana).
+   * Required when swapping between chains with different address types (e.g. EVM to
+   * Solana) and for same-asset transfers.
    */
   destination_address?: string;
 }

package/src/resources/wallet-automations.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
+import * as SharedAPI from './shared';
 
 export class WalletAutomations extends APIResource {}
 
@@ -77,7 +78,10 @@ export interface AutomationAssetFilterInputInclude {
 }
 
 /**
- * An asset identified by contract address, scoped to a chain via CAIP-2.
+ * An asset identified by contract address on a specific chain (CAIP-2). Either
+ * field may be "_": asset_address: "_" matches any asset on the chain; caip2: "\*"
+ * matches the asset on any chain (in this case asset_address holds the asset
+ * symbol id, e.g. "usdc" or "eth", not a contract address).
  */
 export interface AutomationAssetSpec {
   asset_address: string;
@@ -88,7 +92,10 @@ export interface AutomationAssetSpec {
 /**
  * An asset spec accepting either raw identifiers (asset_address, caip2) or
  * human-readable aliases (asset, chain). Exactly one of asset_address or asset
- * must be provided; at most one of caip2 or chain may be provided.
+ * must be provided; at most one of caip2 or chain may be provided. Use "_" for
+ * asset_address or asset to match any asset on a given chain (chain is then
+ * required). Omitting chain/caip2 (or passing "_" for either) matches the
+ * specified asset on any chain.
  */
 export interface AutomationAssetSpecInput extends AutomationAssetSpec {
   asset?: string;
@@ -276,6 +283,11 @@ export interface UpdateAutomationRequestBody {
   enabled?: boolean;
 
   name?: string | null;
+
+  /**
+   * A unique identifier for a key quorum.
+   */
+  owner_id?: SharedAPI.KeyQuorumID | null;
 }
 
 /**
@@ -288,7 +300,7 @@ export interface WalletAutomationExecutionListResponse {
 }
 
 /**
- * A record of a single automation execution triggered by a deposit.
+ * A record of a single automation execution created by a deposit.
  */
 export interface WalletAutomationExecutionResponse {
   id: string;
@@ -308,6 +320,8 @@ export interface WalletAutomationExecutionResponse {
    */
   status: WalletAutomationExecutionStatus;
 
+  submitted_at: string | null;
+
   trigger_asset_address: string;
 
   trigger_block_number: string;
@@ -316,8 +330,6 @@ export interface WalletAutomationExecutionResponse {
 
   trigger_tx_hash: string;
 
-  triggered_at: string | null;
-
   updated_at: string;
 
   wallet_action_id: string | null;
@@ -328,7 +340,7 @@ export interface WalletAutomationExecutionResponse {
 /**
  * Execution lifecycle status.
  */
-export type WalletAutomationExecutionStatus = 'pending' | 'triggered' | 'completed' | 'failed' | 'skipped';
+export type WalletAutomationExecutionStatus = 'pending' | 'submitted' | 'completed' | 'failed' | 'skipped';
 
 /**
  * Paginated list of wallet automations.
@@ -339,6 +351,103 @@ export interface WalletAutomationListResponse {
   next_cursor: string | null;
 }
 
+/**
+ * The outcome of checking one asset on the requested chain during a reindex.
+ */
+export interface WalletAutomationReindexAssetResult {
+  /**
+   * Asset contract address; the native asset uses `native`.
+   */
+  asset_address: string;
+
+  /**
+   * An EVM, Solana, or Tron CAIP-2 chain identifier supported by wallet automation
+   * reindex.
+   */
+  caip2: WalletAutomationReindexCaip2;
+
+  /**
+   * ID of the in-flight execution blocking a re-trigger. Populated only when
+   * `status` is `skipped_existing_execution`; `null` otherwise.
+   */
+  existing_execution_id: string | null;
+
+  /**
+   * On-chain balance in base units. Populated when `status` is `submitted` or
+   * `skipped_zero_balance`; `null` otherwise. For example, 1 OUSD is `1000000`.
+   */
+  raw_balance: string | null;
+
+  /**
+   * Outcome of checking a single asset during a wallet automation reindex. One of
+   * `submitted`, `skipped_zero_balance`, `skipped_no_match`,
+   * `skipped_existing_execution`, or `failed`. `submitted` confirms that an
+   * execution was enqueued.
+   */
+  status: WalletAutomationReindexAssetStatus;
+}
+
+/**
+ * Outcome of checking a single asset during a wallet automation reindex. One of
+ * `submitted`, `skipped_zero_balance`, `skipped_no_match`,
+ * `skipped_existing_execution`, or `failed`. `submitted` confirms that an
+ * execution was enqueued.
+ */
+export type WalletAutomationReindexAssetStatus = string;
+
+/**
+ * An EVM, Solana, or Tron CAIP-2 chain identifier supported by wallet automation
+ * reindex.
+ */
+export type WalletAutomationReindexCaip2 = SharedAPI.EvmCaip2 | SharedAPI.TronCaip2;
+
+/**
+ * Request body for re-checking a wallet against its wallet automations. Identify
+ * the wallet by wallet_id or deposit_address (at least one is required). If both
+ * are provided, wallet_id takes precedence and deposit_address must match that
+ * wallet's address. Specify exactly one of caip2 or chain, and the asset_address
+ * to check. Useful for recovering a deposit that was missed or failed to trigger
+ * its automation.
+ */
+export interface WalletAutomationReindexRequestBody {
+  /**
+   * Asset contract address to check; the native asset uses `native`.
+   */
+  asset_address: string;
+
+  /**
+   * An EVM, Solana, or Tron CAIP-2 chain identifier supported by wallet automation
+   * reindex.
+   */
+  caip2?: WalletAutomationReindexCaip2;
+
+  /**
+   * Human-readable chain name to check. Specify exactly one of `caip2` or `chain`.
+   */
+  chain?: string;
+
+  /**
+   * On-chain deposit address of the wallet to reindex. Must match the resolved
+   * wallet's address if `wallet_id` is also provided.
+   */
+  deposit_address?: string;
+
+  /**
+   * Privy wallet ID to reindex. Takes precedence over `deposit_address` when both
+   * are supplied.
+   */
+  wallet_id?: string;
+}
+
+/**
+ * Result of re-checking a wallet against its wallet automations.
+ */
+export interface WalletAutomationReindexResponse {
+  results: Array<WalletAutomationReindexAssetResult>;
+
+  wallet_id: string;
+}
+
 /**
  * A wallet automation.
  */
@@ -410,6 +519,11 @@ export declare namespace WalletAutomations {
     type WalletAutomationExecutionResponse as WalletAutomationExecutionResponse,
     type WalletAutomationExecutionStatus as WalletAutomationExecutionStatus,
     type WalletAutomationListResponse as WalletAutomationListResponse,
+    type WalletAutomationReindexAssetResult as WalletAutomationReindexAssetResult,
+    type WalletAutomationReindexAssetStatus as WalletAutomationReindexAssetStatus,
+    type WalletAutomationReindexCaip2 as WalletAutomationReindexCaip2,
+    type WalletAutomationReindexRequestBody as WalletAutomationReindexRequestBody,
+    type WalletAutomationReindexResponse as WalletAutomationReindexResponse,
     type WalletAutomationResponse as WalletAutomationResponse,
     type WalletAutomationStatus as WalletAutomationStatus,
     type WalletAutomationSuccessResponse as WalletAutomationSuccessResponse,

package/src/resources/wallets/actions.ts

@@ -91,6 +91,14 @@ export interface CustodianTransactionWalletActionStep {
    */
   status: CustodianTransactionWalletActionStepStatus;
 
+  /**
+   * Identifier of the transaction the custodian last reported on the destination
+   * chain. Set on a settled transfer, and also on a failed one when the custodian
+   * had already broadcast a payout that was later returned. Null until the custodian
+   * reports one.
+   */
+  transaction_hash: string | null;
+
   type: 'custodian_transaction';
 
   /**
@@ -143,6 +151,11 @@ export interface EvmTransactionWalletActionStep {
    * confirmed.
    */
   finalized?: boolean;
+
+  /**
+   * Amount charged in USD for gas sponsorship on this step.
+   */
+  gas_credits_charged_usd?: string;
 }
 
 /**
@@ -617,6 +630,31 @@ export interface EarnIncetiveClaimRewardEntry {
   token_decimals?: number;
 }
 
+/**
+ * An APY allocation within a vault position.
+ */
+export interface EarnPositionApyAllocation {
+  /**
+   * Net APY in basis points, rounded to the nearest integer.
+   */
+  apy_bps: number;
+
+  /**
+   * Allocated assets in the smallest unit of the underlying asset.
+   */
+  assets_in_vault: string;
+
+  /**
+   * Whether an APY allocation earns the base or boosted rate.
+   */
+  type: EarnPositionApyType;
+}
+
+/**
+ * Whether an APY allocation earns the base or boosted rate.
+ */
+export type EarnPositionApyType = 'boost' | 'base';
+
 /**
  * Response for an earn withdraw action.
  */
@@ -784,6 +822,17 @@ export interface EthereumEarnPositionResponse {
    * Total amount withdrawn from the vault, in smallest unit.
    */
   total_withdrawn: string;
+
+  /**
+   * Vault APY allocations by origin, returned together with apy_bps when available.
+   */
+  apy_allocation?: Array<EarnPositionApyAllocation>;
+
+  /**
+   * Wallet-specific net APY in basis points, rounded to the nearest integer.
+   * Returned together with apy_allocation when available.
+   */
+  apy_bps?: number;
 }
 
 /**
@@ -1102,9 +1151,8 @@ export interface SwapActionResponse {
   wallet_id: string;
 
   /**
-   * Recipient address on the destination chain. Present for cross-chain swaps. May
-   * differ from the source wallet address when swapping between chain types (e.g.
-   * EVM to Solana).
+   * Recipient address for the swap. Present for newly created swaps; may be absent
+   * for older swap actions.
    */
   destination_address?: string;
 
@@ -1519,6 +1567,8 @@ export declare namespace Actions {
     type EarnIncentiveRewardsQuery as EarnIncentiveRewardsQuery,
     type EarnIncentiveRewardsResponse as EarnIncentiveRewardsResponse,
     type EarnIncetiveClaimRewardEntry as EarnIncetiveClaimRewardEntry,
+    type EarnPositionApyAllocation as EarnPositionApyAllocation,
+    type EarnPositionApyType as EarnPositionApyType,
     type EarnWithdrawActionResponse as EarnWithdrawActionResponse,
     type EarnWithdrawRequestBody as EarnWithdrawRequestBody,
     type EthereumEarnPositionQuery as EthereumEarnPositionQuery,

package/src/resources/wallets/balance.ts

@@ -111,6 +111,14 @@ export interface BalanceGetParams {
     | 'tron'
     | 'zksync_era'
     | 'robinhood'
+    | 'unichain'
+    | 'worldchain'
+    | 'ink'
+    | 'soneium'
+    | 'megaeth'
+    | 'hyperevm'
+    | 'hypercore'
+    | 'arc'
     | 'tempo_testnet'
     | 'hoodi'
     | 'sepolia'
@@ -125,6 +133,7 @@ export interface BalanceGetParams {
     | 'solana_testnet'
     | 'tron_nile'
     | 'robinhood_testnet'
+    | 'ink_sepolia'
     | string
     | Array<WalletsAPI.WalletAssetChainNameInput>;
 

package/src/resources/wallets/index.ts

@@ -20,6 +20,8 @@ export {
   type EarnIncentiveRewardsQuery,
   type EarnIncentiveRewardsResponse,
   type EarnIncetiveClaimRewardEntry,
+  type EarnPositionApyAllocation,
+  type EarnPositionApyType,
   type EarnWithdrawActionResponse,
   type EarnWithdrawRequestBody,
   type EthereumEarnPositionQuery,
@@ -69,6 +71,7 @@ export {
   type AptosSignTransactionRpcResponseData,
   type AptosSignedTransactionBcsHex,
   type AttachWalletAutomationRequestBody,
+  type AttachedWalletAutomation,
   type AuthorizationKeyDashboardResponse,
   type AuthorizationKeyResponse,
   type AuthorizationKeyRole,
@@ -76,7 +79,13 @@ export {
   type CreateCryptoDepositAccountResponse,
   type CreateCryptoDepositAccountWithConfigRequestBody,
   type CreateCryptoDepositAccountWithRouteRequestBody,
+  type CryptoDepositAccountCaip2,
+  type CryptoDepositAccountChain,
+  type CryptoDepositAccountConfigResponse,
+  type CryptoDepositAccountSourceChain,
+  type CryptoDepositAccountSourceCurrency,
   type CryptoDepositAddressRoute,
+  type CryptoDepositAddressStrategy,
   type CryptoDepositAsset,
   type CryptoDepositAssetFilter,
   type CryptoDepositAssetFilterAll,
@@ -85,10 +94,15 @@ export {
   type CurveSigningChainType,
   type CurveType,
   type CustodialWallet,
+  type CustodialWalletChain,
   type CustodialWalletChainType,
   type CustodialWalletCreateInput,
   type CustodialWalletProvider,
   type CustomTokenTransferSource,
+  type DepositAccountCryptoQuoteAmount,
+  type DepositAccountCryptoQuoteAsset,
+  type DepositAccountCryptoQuoteRequestBody,
+  type DepositAccountCryptoQuoteResponse,
   type DetachWalletAutomationRequestBody,
   type DeveloperFee,
   type EncryptedAuthorizationKey,
@@ -143,6 +157,8 @@ export {
   type FirstClassChainType,
   type Gas,
   type GetByWalletAddressRequestBody,
+  type GetCryptoDepositAccountNextOrderResponse,
+  type GetCryptoDepositAccountOrderResponse,
   type HDInitInput,
   type HDPath,
   type HDSubmitInput,
@@ -151,6 +167,7 @@ export {
   type HpkeImportConfig,
   type Hex,
   type IntentBinding,
+  type ListCryptoDepositAccountsResponse,
   type NamedTokenTransferSource,
   type NearRpcRequestBody,
   type NearRpcResponse,
@@ -268,10 +285,19 @@ export {
   type TransactionChainNameInput,
   type TransactionDetail,
   type TransactionTokenAddressInput,
+  type TransferCustodyOptions,
+  type TransferInitiation,
+  type TransferInitiationAttestations,
+  type TransferInitiationChannel,
+  type TransferInitiationSubchannel,
   type TransferQuoteRequestBody,
   type TransferQuoteResponse,
   type TransferReceivedTransactionDetail,
   type TransferRequestBody,
+  type TransferScaAttestation,
+  type TransferScaAuthFactor,
+  type TransferScaAuthFactorCategory,
+  type TransferScaOutcome,
   type TransferSentTransactionDetail,
   type TronContract,
   type TronRawDataForSend,