@privy-io/api-types 0.21.0 → 0.23.0

package/src/client.ts

@@ -123,6 +123,7 @@ import {
   CardIssuingListCardsInput,
   CardIssuingListTransactionsInput,
   CardIssuingMerchant,
+  CardIssuingPinUpdate,
   CardIssuingReplaceCardRequestBody,
   CardIssuingReplacementReason,
   CardIssuingStatementQueryParams,
@@ -361,13 +362,26 @@ import {
   FiatDepositAccountStatus,
   FiatDepositInstructions,
   FiatPaymentRail,
+  KYBAccountPurpose,
+  KYBAssociatedPerson,
+  KYBBusinessDocument,
+  KYBBusinessType,
+  KYBDocumentPurpose,
+  KYBEstimatedAnnualRevenue,
+  KYBHighRiskActivity,
+  KYBIndividualDocument,
+  KYBIndividualDocumentPurpose,
   KYBLinksRequestBody,
+  KYBPlaceOfBirth,
+  KYBPubliclyTradedListing,
+  KYBRegulatedActivity,
+  KYBSourceOfFunds,
   KYBStatusListResponse,
   KYBStatusResponse,
+  KYBSubmitData,
+  KYBSubmitRequestBody,
   KYBTosRequestBody,
-  KYCIdentifyingDocument,
   KYCLinksRequestBody,
-  KYCResidentialAddress,
   KYCStatusListResponse,
   KYCStatusResponse,
   KYCSubmitData,
@@ -402,6 +416,8 @@ import {
   OrganizationExternalFiatAccountResponse,
   PayoutDestination,
   PayoutSource,
+  VerificationAddress,
+  VerificationDocument,
 } from './resources/fiat';
 import {
   CoinbaseBlockchain,
@@ -681,8 +697,11 @@ import {
 } from './resources/policies';
 import {
   BitcoinAddress,
+  BitcoinCaip2,
+  Bps,
   CurrencyAmount,
   EvmAddress,
+  EvmCaip2,
   EvmChecksumAddress,
   HyperliquidTokenAddress,
   IntegrationEnvironment,
@@ -695,9 +714,11 @@ import {
   P256PublicKey,
   Shared,
   SolanaAddress,
+  SolanaCaip2,
   SuccessResponse,
   TokenIdentifier,
   TronAddress,
+  TronCaip2,
   TronHexAddress,
 } from './resources/shared';
 import {
@@ -835,6 +856,11 @@ import {
   WalletAutomationExecutionResponse,
   WalletAutomationExecutionStatus,
   WalletAutomationListResponse,
+  WalletAutomationReindexAssetResult,
+  WalletAutomationReindexAssetStatus,
+  WalletAutomationReindexCaip2,
+  WalletAutomationReindexRequestBody,
+  WalletAutomationReindexResponse,
   WalletAutomationResponse,
   WalletAutomationStatus,
   WalletAutomationSuccessResponse,
@@ -887,9 +913,9 @@ import {
   TransactionProviderErrorWebhookPayload,
   TransactionReplacedWebhookPayload,
   TransactionStillPendingWebhookPayload,
-  UsageCrossChainFeeRecordedWebhookPayload,
   UsageGasSponsorshipRecordedWebhookPayload,
   UsageSourceType,
+  UsageSwapProviderFeeRecordedWebhookPayload,
   UserAuthenticatedWebhookPayload,
   UserCreatedWebhookPayload,
   UserDeletedWebhookPayload,
@@ -934,6 +960,7 @@ import {
   WalletArchivedWebhookPayload,
   WalletAutomationSubmittedWebhookPayload,
   WalletFundsAsset,
+  WalletFundsBtknAsset,
   WalletFundsErc20Asset,
   WalletFundsNativeTokenAsset,
   WalletFundsSacAsset,
@@ -991,6 +1018,7 @@ import {
   AptosSignTransactionRpcResponseData,
   AptosSignedTransactionBcsHex,
   AttachWalletAutomationRequestBody,
+  AttachedWalletAutomation,
   AuthorizationKeyDashboardResponse,
   AuthorizationKeyResponse,
   AuthorizationKeyRole,
@@ -998,7 +1026,13 @@ import {
   CreateCryptoDepositAccountResponse,
   CreateCryptoDepositAccountWithConfigRequestBody,
   CreateCryptoDepositAccountWithRouteRequestBody,
+  CryptoDepositAccountCaip2,
+  CryptoDepositAccountChain,
+  CryptoDepositAccountConfigResponse,
+  CryptoDepositAccountSourceChain,
+  CryptoDepositAccountSourceCurrency,
   CryptoDepositAddressRoute,
+  CryptoDepositAddressStrategy,
   CryptoDepositAsset,
   CryptoDepositAssetFilter,
   CryptoDepositAssetFilterAll,
@@ -1007,10 +1041,15 @@ import {
   CurveSigningChainType,
   CurveType,
   CustodialWallet,
+  CustodialWalletChain,
   CustodialWalletChainType,
   CustodialWalletCreateInput,
   CustodialWalletProvider,
   CustomTokenTransferSource,
+  DepositAccountCryptoQuoteAmount,
+  DepositAccountCryptoQuoteAsset,
+  DepositAccountCryptoQuoteRequestBody,
+  DepositAccountCryptoQuoteResponse,
   DetachWalletAutomationRequestBody,
   DeveloperFee,
   EncryptedAuthorizationKey,
@@ -1065,6 +1104,8 @@ import {
   FirstClassChainType,
   Gas,
   GetByWalletAddressRequestBody,
+  GetCryptoDepositAccountNextOrderResponse,
+  GetCryptoDepositAccountOrderResponse,
   HDInitInput,
   HDPath,
   HDSubmitInput,
@@ -1073,6 +1114,7 @@ import {
   HpkeEncryption,
   HpkeImportConfig,
   IntentBinding,
+  ListCryptoDepositAccountsResponse,
   NamedTokenTransferSource,
   NearRpcRequestBody,
   NearRpcResponse,
@@ -1190,10 +1232,19 @@ import {
   TransactionChainNameInput,
   TransactionDetail,
   TransactionTokenAddressInput,
+  TransferCustodyOptions,
+  TransferInitiation,
+  TransferInitiationAttestations,
+  TransferInitiationChannel,
+  TransferInitiationSubchannel,
   TransferQuoteRequestBody,
   TransferQuoteResponse,
   TransferReceivedTransactionDetail,
   TransferRequestBody,
+  TransferScaAttestation,
+  TransferScaAuthFactor,
+  TransferScaAuthFactorCategory,
+  TransferScaOutcome,
   TransferSentTransactionDetail,
   TronContract,
   TronRawDataForSend,
@@ -2158,6 +2209,7 @@ export declare namespace Privy {
     type AptosSignTransactionRpcResponseData as AptosSignTransactionRpcResponseData,
     type AptosSignedTransactionBcsHex as AptosSignedTransactionBcsHex,
     type AttachWalletAutomationRequestBody as AttachWalletAutomationRequestBody,
+    type AttachedWalletAutomation as AttachedWalletAutomation,
     type AuthorizationKeyDashboardResponse as AuthorizationKeyDashboardResponse,
     type AuthorizationKeyResponse as AuthorizationKeyResponse,
     type AuthorizationKeyRole as AuthorizationKeyRole,
@@ -2165,7 +2217,13 @@ export declare namespace Privy {
     type CreateCryptoDepositAccountResponse as CreateCryptoDepositAccountResponse,
     type CreateCryptoDepositAccountWithConfigRequestBody as CreateCryptoDepositAccountWithConfigRequestBody,
     type CreateCryptoDepositAccountWithRouteRequestBody as CreateCryptoDepositAccountWithRouteRequestBody,
+    type CryptoDepositAccountCaip2 as CryptoDepositAccountCaip2,
+    type CryptoDepositAccountChain as CryptoDepositAccountChain,
+    type CryptoDepositAccountConfigResponse as CryptoDepositAccountConfigResponse,
+    type CryptoDepositAccountSourceChain as CryptoDepositAccountSourceChain,
+    type CryptoDepositAccountSourceCurrency as CryptoDepositAccountSourceCurrency,
     type CryptoDepositAddressRoute as CryptoDepositAddressRoute,
+    type CryptoDepositAddressStrategy as CryptoDepositAddressStrategy,
     type CryptoDepositAsset as CryptoDepositAsset,
     type CryptoDepositAssetFilter as CryptoDepositAssetFilter,
     type CryptoDepositAssetFilterAll as CryptoDepositAssetFilterAll,
@@ -2174,10 +2232,15 @@ export declare namespace Privy {
     type CurveSigningChainType as CurveSigningChainType,
     type CurveType as CurveType,
     type CustodialWallet as CustodialWallet,
+    type CustodialWalletChain as CustodialWalletChain,
     type CustodialWalletChainType as CustodialWalletChainType,
     type CustodialWalletCreateInput as CustodialWalletCreateInput,
     type CustodialWalletProvider as CustodialWalletProvider,
     type CustomTokenTransferSource as CustomTokenTransferSource,
+    type DepositAccountCryptoQuoteAmount as DepositAccountCryptoQuoteAmount,
+    type DepositAccountCryptoQuoteAsset as DepositAccountCryptoQuoteAsset,
+    type DepositAccountCryptoQuoteRequestBody as DepositAccountCryptoQuoteRequestBody,
+    type DepositAccountCryptoQuoteResponse as DepositAccountCryptoQuoteResponse,
     type DetachWalletAutomationRequestBody as DetachWalletAutomationRequestBody,
     type DeveloperFee as DeveloperFee,
     type EncryptedAuthorizationKey as EncryptedAuthorizationKey,
@@ -2232,6 +2295,8 @@ export declare namespace Privy {
     type FirstClassChainType as FirstClassChainType,
     type Gas as Gas,
     type GetByWalletAddressRequestBody as GetByWalletAddressRequestBody,
+    type GetCryptoDepositAccountNextOrderResponse as GetCryptoDepositAccountNextOrderResponse,
+    type GetCryptoDepositAccountOrderResponse as GetCryptoDepositAccountOrderResponse,
     type HDInitInput as HDInitInput,
     type HDPath as HDPath,
     type HDSubmitInput as HDSubmitInput,
@@ -2240,6 +2305,7 @@ export declare namespace Privy {
     type HpkeImportConfig as HpkeImportConfig,
     type Hex as Hex,
     type IntentBinding as IntentBinding,
+    type ListCryptoDepositAccountsResponse as ListCryptoDepositAccountsResponse,
     type NamedTokenTransferSource as NamedTokenTransferSource,
     type NearRpcRequestBody as NearRpcRequestBody,
     type NearRpcResponse as NearRpcResponse,
@@ -2357,10 +2423,19 @@ export declare namespace Privy {
     type TransactionChainNameInput as TransactionChainNameInput,
     type TransactionDetail as TransactionDetail,
     type TransactionTokenAddressInput as TransactionTokenAddressInput,
+    type TransferCustodyOptions as TransferCustodyOptions,
+    type TransferInitiation as TransferInitiation,
+    type TransferInitiationAttestations as TransferInitiationAttestations,
+    type TransferInitiationChannel as TransferInitiationChannel,
+    type TransferInitiationSubchannel as TransferInitiationSubchannel,
     type TransferQuoteRequestBody as TransferQuoteRequestBody,
     type TransferQuoteResponse as TransferQuoteResponse,
     type TransferReceivedTransactionDetail as TransferReceivedTransactionDetail,
     type TransferRequestBody as TransferRequestBody,
+    type TransferScaAttestation as TransferScaAttestation,
+    type TransferScaAuthFactor as TransferScaAuthFactor,
+    type TransferScaAuthFactorCategory as TransferScaAuthFactorCategory,
+    type TransferScaOutcome as TransferScaOutcome,
     type TransferSentTransactionDetail as TransferSentTransactionDetail,
     type TronContract as TronContract,
     type TronRawDataForSend as TronRawDataForSend,
@@ -2512,6 +2587,7 @@ export declare namespace Privy {
     type CardIssuingListCardsInput as CardIssuingListCardsInput,
     type CardIssuingListTransactionsInput as CardIssuingListTransactionsInput,
     type CardIssuingMerchant as CardIssuingMerchant,
+    type CardIssuingPinUpdate as CardIssuingPinUpdate,
     type CardIssuingReplaceCardRequestBody as CardIssuingReplaceCardRequestBody,
     type CardIssuingReplacementReason as CardIssuingReplacementReason,
     type CardIssuingStatementQueryParams as CardIssuingStatementQueryParams,
@@ -2949,13 +3025,26 @@ export declare namespace Privy {
     type FiatDepositAccountStatus as FiatDepositAccountStatus,
     type FiatDepositInstructions as FiatDepositInstructions,
     type FiatPaymentRail as FiatPaymentRail,
+    type KYBAccountPurpose as KYBAccountPurpose,
+    type KYBAssociatedPerson as KYBAssociatedPerson,
+    type KYBBusinessDocument as KYBBusinessDocument,
+    type KYBBusinessType as KYBBusinessType,
+    type KYBDocumentPurpose as KYBDocumentPurpose,
+    type KYBEstimatedAnnualRevenue as KYBEstimatedAnnualRevenue,
+    type KYBHighRiskActivity as KYBHighRiskActivity,
+    type KYBIndividualDocument as KYBIndividualDocument,
+    type KYBIndividualDocumentPurpose as KYBIndividualDocumentPurpose,
     type KYBLinksRequestBody as KYBLinksRequestBody,
+    type KYBPlaceOfBirth as KYBPlaceOfBirth,
+    type KYBPubliclyTradedListing as KYBPubliclyTradedListing,
+    type KYBRegulatedActivity as KYBRegulatedActivity,
+    type KYBSourceOfFunds as KYBSourceOfFunds,
     type KYBStatusListResponse as KYBStatusListResponse,
     type KYBStatusResponse as KYBStatusResponse,
+    type KYBSubmitData as KYBSubmitData,
+    type KYBSubmitRequestBody as KYBSubmitRequestBody,
     type KYBTosRequestBody as KYBTosRequestBody,
-    type KYCIdentifyingDocument as KYCIdentifyingDocument,
     type KYCLinksRequestBody as KYCLinksRequestBody,
-    type KYCResidentialAddress as KYCResidentialAddress,
     type KYCStatusListResponse as KYCStatusListResponse,
     type KYCStatusResponse as KYCStatusResponse,
     type KYCSubmitData as KYCSubmitData,
@@ -2990,6 +3079,8 @@ export declare namespace Privy {
     type OrganizationExternalFiatAccountResponse as OrganizationExternalFiatAccountResponse,
     type PayoutDestination as PayoutDestination,
     type PayoutSource as PayoutSource,
+    type VerificationAddress as VerificationAddress,
+    type VerificationDocument as VerificationDocument,
   };
 
   export {
@@ -3060,6 +3151,11 @@ export declare namespace Privy {
     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,
@@ -3101,9 +3197,12 @@ export declare namespace Privy {
   export {
     Shared as Shared,
     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,
@@ -3114,9 +3213,11 @@ export declare namespace Privy {
     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,
   };
 
@@ -3168,9 +3269,9 @@ export declare namespace Privy {
     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 UsageSwapProviderFeeRecordedWebhookPayload as UsageSwapProviderFeeRecordedWebhookPayload,
     type UserAuthenticatedWebhookPayload as UserAuthenticatedWebhookPayload,
     type UserCreatedWebhookPayload as UserCreatedWebhookPayload,
     type UserDeletedWebhookPayload as UserDeletedWebhookPayload,
@@ -3215,6 +3316,7 @@ export declare namespace Privy {
     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,

package/src/resources/accounts.ts

@@ -80,11 +80,6 @@ export interface AccountWallet {
    * The wallet chain types that offer first class support.
    */
   chain_type: WalletsAPI.FirstClassChainType;
-
-  /**
-   * Information about the custodian managing this wallet.
-   */
-  custody?: WalletsAPI.WalletCustodian;
 }
 
 /**
@@ -95,11 +90,6 @@ export interface AccountWalletConfigurationItem {
    * The wallet chain types that offer first class support.
    */
   chain_type: WalletsAPI.FirstClassChainType;
-
-  /**
-   * Information about the custodian managing this wallet.
-   */
-  custody?: WalletsAPI.WalletCustodian;
 }
 
 /**

package/src/resources/cards.ts

@@ -57,7 +57,7 @@ export interface CardIssuingCardResponse {
   id: string;
 
   /**
-   * The asset the card funds from. 'usdc' on EVM and Solana, 'path_usd' on Tempo.
+   * The asset the card funds from. 'usdc' on EVM and Solana, 'pathusd' on Tempo.
    */
   asset: string;
 
@@ -132,6 +132,11 @@ export interface CardIssuingCardsResponse {
  * Browser-safe configuration for rendering Stripe Issuing card details.
  */
 export interface CardIssuingConfig {
+  /**
+   * Logo for the in-app card face. Null when none is set.
+   */
+  card_logo_url: string | null;
+
   /**
    * Stripe publishable key for initializing Stripe.js in the browser.
    */
@@ -163,7 +168,7 @@ export interface CardIssuingConfigResponse {
  */
 export interface CardIssuingCreateCardInput {
   /**
-   * The asset to fund the card. Must be 'usdc' on EVM and Solana, or 'path_usd' on
+   * The asset to fund the card. Must be 'usdc' on EVM and Solana, or 'pathusd' on
    * Tempo.
    */
   asset: string;
@@ -431,6 +436,16 @@ export interface CardIssuingMerchant {
   name: string | null;
 }
 
+/**
+ * Encrypted PIN to set on the card.
+ */
+export interface CardIssuingPinUpdate {
+  /**
+   * The PIN, encrypted with the Stripe Issuing key.
+   */
+  encrypted_number: string;
+}
+
 /**
  * Input for replacing a lost, stolen, or expired card.
  */
@@ -504,7 +519,7 @@ export interface CardIssuingTransactionsResponse {
 }
 
 /**
- * Input for updating the status of a card.
+ * Input for updating a card.
  */
 export interface CardIssuingUpdateCardInput {
   /**
@@ -513,15 +528,20 @@ export interface CardIssuingUpdateCardInput {
   environment: SharedAPI.IntegrationEnvironment;
 
   /**
-   * Lifecycle status of a card. Active unfreezes the card, inactive freezes it, and
-   * canceled closes it.
+   * Why a lost or stolen card is being canceled.
    */
-  status: CardIssuingCardStatus;
+  cancellation_reason?: CardIssuingCancellationReason;
 
   /**
-   * Why a lost or stolen card is being canceled.
+   * Encrypted PIN to set on the card.
    */
-  cancellation_reason?: CardIssuingCancellationReason;
+  pin?: CardIssuingPinUpdate;
+
+  /**
+   * Lifecycle status of a card. Active unfreezes the card, inactive freezes it, and
+   * canceled closes it.
+   */
+  status?: CardIssuingCardStatus;
 }
 
 export declare namespace Cards {
@@ -559,6 +579,7 @@ export declare namespace Cards {
     type CardIssuingListCardsInput as CardIssuingListCardsInput,
     type CardIssuingListTransactionsInput as CardIssuingListTransactionsInput,
     type CardIssuingMerchant as CardIssuingMerchant,
+    type CardIssuingPinUpdate as CardIssuingPinUpdate,
     type CardIssuingReplaceCardRequestBody as CardIssuingReplaceCardRequestBody,
     type CardIssuingReplacementReason as CardIssuingReplacementReason,
     type CardIssuingStatementQueryParams as CardIssuingStatementQueryParams,