@privy-io/api-types 0.22.0 → 0.24.0

package/src/resources/wallets/wallets.ts

@@ -45,6 +45,7 @@ import {
   SvmWalletActionStepStatus,
   SwapActionResponse,
   TempoVaultDetails,
+  TempoZoneSettlementWalletActionStep,
   TransferActionResponse,
   TvmTransactionWalletActionStep,
   TvmWalletActionStepStatus,
@@ -649,6 +650,12 @@ export interface CreateCryptoDepositAccountWithConfigRequestBody {
   deposit_config_id: string;
 
   type: 'deposit_config';
+
+  /**
+   * How deposit source wallets are chosen. Omission uses `dedicated`. Destination
+   * reuse applies only to the destination's own chain type.
+   */
+  deposit_address_strategy?: CryptoDepositAddressStrategy;
 }
 
 /**
@@ -668,6 +675,12 @@ export interface CreateCryptoDepositAccountWithRouteRequestBody {
   source: CryptoDepositAssetFilter;
 
   type: 'inline_route';
+
+  /**
+   * How deposit source wallets are chosen. Omission uses `dedicated`. Destination
+   * reuse applies only to the destination's own chain type.
+   */
+  deposit_address_strategy?: CryptoDepositAddressStrategy;
 }
 
 /**
@@ -714,6 +727,37 @@ export interface CryptoDepositAccountConfigResponse {
   currencies: Array<CryptoDepositAccountSourceCurrency>;
 }
 
+/**
+ * Source tokens matching a crypto deposit-account search.
+ */
+export interface CryptoDepositAccountConfigSearchResponse {
+  chains: { [key: string]: CryptoDepositAccountChain };
+
+  currencies: Array<CryptoDepositAccountSearchCurrency>;
+}
+
+/**
+ * A source token matched by crypto deposit-account search.
+ */
+export interface CryptoDepositAccountSearchCurrency {
+  chains: Array<CryptoDepositAccountSourceChain>;
+
+  name: string;
+
+  symbol: string;
+
+  /**
+   * Whether this token is verified as the canonical token for its symbol, since
+   * unverified tokens may be lookalikes.
+   */
+  verified: boolean;
+
+  /**
+   * URL of the token logo, omitted when none is known.
+   */
+  logo_uri?: string;
+}
+
 /**
  * A token contract on one source chain in the crypto deposit-account catalog.
  */
@@ -773,6 +817,12 @@ export interface CryptoDepositAddressRoute {
   wallet_id: string;
 }
 
+/**
+ * How deposit source wallets are chosen. Omission uses `dedicated`. Destination
+ * reuse applies only to the destination's own chain type.
+ */
+export type CryptoDepositAddressStrategy = 'dedicated' | 'prefer_destination' | 'require_destination';
+
 /**
  * An asset on a chain. Uses a human-readable alias (usdc, tempo) when one is on
  * file, otherwise the raw asset address and CAIP-2.
@@ -898,6 +948,11 @@ export type CustodialWalletChainType = 'ethereum' | 'solana';
  * The input for creating a custodial wallet.
  */
 export interface CustodialWalletCreateInput {
+  /**
+   * The chain of the custodial wallet.
+   */
+  chain: CustodialWalletChain;
+
   /**
    * The provider of the custodial wallet.
    */
@@ -914,16 +969,6 @@ export interface CustodialWalletCreateInput {
    */
   additional_signers?: AdditionalSignerInput;
 
-  /**
-   * The chain of the custodial wallet.
-   */
-  chain?: CustodialWalletChain;
-
-  /**
-   * @deprecated The chain type of the custodial wallet (deprecated).
-   */
-  chain_type?: CustodialWalletChainType;
-
   /**
    * The owner of the resource, specified as a Privy user ID, a P-256 public key, or
    * null to remove the current owner.
@@ -968,6 +1013,84 @@ export interface CustomTokenTransferSource {
   amount?: string;
 }
 
+/**
+ * A positive decimal amount in the source token’s standard unit, not its smallest
+ * on-chain unit.
+ */
+export type DepositAccountCryptoQuoteAmount = string;
+
+/**
+ * An asset and chain for an indicative crypto deposit-account quote.
+ */
+export interface DepositAccountCryptoQuoteAsset {
+  /**
+   * Named asset ID (e.g. "usdc", "eth") or chain-specific token contract or mint
+   * address
+   */
+  asset: string;
+
+  /**
+   * Friendly chain name or CAIP-2 identifier (e.g. "base", "eip155:8453")
+   */
+  chain: string;
+}
+
+/**
+ * Request body for an indicative crypto deposit-account route quote.
+ */
+export interface DepositAccountCryptoQuoteRequestBody {
+  /**
+   * An asset and chain for an indicative crypto deposit-account quote.
+   */
+  destination: DepositAccountCryptoQuoteAsset;
+
+  /**
+   * An asset and chain for an indicative crypto deposit-account quote.
+   */
+  source: DepositAccountCryptoQuoteAsset;
+
+  /**
+   * A positive decimal amount in the source token’s standard unit, not its smallest
+   * on-chain unit.
+   */
+  input_amount?: DepositAccountCryptoQuoteAmount;
+
+  /**
+   * Value in basis points: integer from 0 to 10000 (0% to 100%).
+   */
+  slippage_bps?: SharedAPI.Bps;
+}
+
+/**
+ * An indicative crypto deposit-account quote. Amounts are in token standard units.
+ */
+export interface DepositAccountCryptoQuoteResponse {
+  created_at: string;
+
+  /**
+   * Estimated output amount as a decimal string in the destination token's standard
+   * unit. Not in the smallest on-chain unit.
+   */
+  estimated_output_amount: string;
+
+  /**
+   * Quoted input amount as a decimal string in the source token's standard unit
+   * (e.g. "0.02" for 0.02 ETH). Not in the smallest on-chain unit.
+   */
+  input_amount: string;
+}
+
+/**
+ * Derives the new wallet from an existing HD root wallet so both share one seed
+ * phrase.
+ */
+export interface DerivationInput {
+  /**
+   * ID of the HD root wallet to derive the new wallet from.
+   */
+  wallet_id: string;
+}
+
 /**
  * Request body for detaching automations from a wallet (wallet ID comes from the
  * URL).
@@ -3589,6 +3712,7 @@ export type TransactionChainNameInput =
   | 'solana'
   | 'sepolia'
   | 'arc'
+  | 'monad'
   | (string & {});
 
 /**
@@ -3602,6 +3726,78 @@ export type TransactionDetail = TransferSentTransactionDetail | TransferReceived
  */
 export type TransactionTokenAddressInput = string;
 
+/**
+ * Options for a transfer from a custodial wallet.
+ */
+export interface TransferCustodyOptions {
+  /**
+   * Payment initiation context for transfers sourced from wallets that require
+   * initiation data. Captures how the payment was initiated (channel and subchannel)
+   * and whether Strong Customer Authentication was applied or which SCA exemption
+   * was used.
+   */
+  initiation: TransferInitiation;
+}
+
+/**
+ * Payment initiation context for transfers sourced from wallets that require
+ * initiation data. Captures how the payment was initiated (channel and subchannel)
+ * and whether Strong Customer Authentication was applied or which SCA exemption
+ * was used.
+ */
+export interface TransferInitiation {
+  /**
+   * Payment initiation attestations for a transfer.
+   */
+  attestations: TransferInitiationAttestations;
+
+  /**
+   * How the payment was initiated. Use `p2p_mobile_payment` for peer-to-peer
+   * transfers initiated on a mobile device; `other_mobile_payment` for non-P2P
+   * mobile-initiated payments (e.g. a merchant payment via a mobile app); `other`
+   * for payments not relying on a mobile device.
+   */
+  channel: TransferInitiationChannel;
+
+  /**
+   * Whether the payment was made remotely or in person. Use `remote` for payments
+   * initiated from a distance (mobile app, online banking, or e-commerce checkout);
+   * `non_remote` for payments made in person (physical card, payment terminal, or
+   * contactless tap).
+   */
+  subchannel: TransferInitiationSubchannel;
+}
+
+/**
+ * Payment initiation attestations for a transfer.
+ */
+export interface TransferInitiationAttestations {
+  /**
+   * Strong Customer Authentication attestation for a transfer.
+   */
+  sca: TransferScaAttestation;
+}
+
+/**
+ * How the payment was initiated. Use `p2p_mobile_payment` for peer-to-peer
+ * transfers initiated on a mobile device; `other_mobile_payment` for non-P2P
+ * mobile-initiated payments (e.g. a merchant payment via a mobile app); `other`
+ * for payments not relying on a mobile device.
+ */
+export type TransferInitiationChannel =
+  | 'p2p_mobile_payment'
+  | 'other_mobile_payment'
+  | 'other'
+  | (string & {});
+
+/**
+ * Whether the payment was made remotely or in person. Use `remote` for payments
+ * initiated from a distance (mobile app, online banking, or e-commerce checkout);
+ * `non_remote` for payments made in person (physical card, payment terminal, or
+ * contactless tap).
+ */
+export type TransferInitiationSubchannel = 'remote' | 'non_remote' | (string & {});
+
 /**
  * Request body for requesting a quote for a cross-asset or cross-chain (DADC)
  * transfer.
@@ -3705,6 +3901,7 @@ export interface TransferReceivedTransactionDetail {
     | 'avax'
     | 'pol'
     | 'bnb'
+    | 'mon'
     | 'usdt'
     | 'eurc'
     | 'usdb'
@@ -3764,6 +3961,11 @@ export interface TransferRequestBody {
    */
   amount_type?: AmountType;
 
+  /**
+   * Options for a transfer from a custodial wallet.
+   */
+  custody_options?: TransferCustodyOptions;
+
   /**
    * Total fees assessed on a transfer, in BPS
    */
@@ -3787,6 +3989,112 @@ export interface TransferRequestBody {
   slippage_bps?: number;
 }
 
+/**
+ * Strong Customer Authentication attestation for a transfer.
+ */
+export interface TransferScaAttestation {
+  /**
+   * Whether Strong Customer Authentication (SCA) was applied or which regulatory
+   * exemption or non-applicability reason covers this payment. Use `sca_used` when
+   * the user authenticated with SCA. Otherwise, choose the value that applies:
+   * `payment_to_self` — payer and payee are the same person (remote only);
+   * `trusted_beneficiaries` — payee is on the user's pre-approved list;
+   * `recurring_transaction` — amount and payee match a previously SCA-authorized
+   * recurring series; `contactless_low_value` — contactless card payment below the
+   * low-value threshold (non-remote only); `unattended_terminal_for_transport` —
+   * automated terminal for transport fares or parking (non-remote only); `low_value`
+   * — remote payment below the low-value threshold (remote only);
+   * `secure_corporate_payment` — dedicated corporate payment process with controls
+   * equivalent to SCA (remote only); `transaction_risk_analysis` — PSP has performed
+   * real-time risk analysis and the transaction falls within permitted thresholds
+   * (remote only); `merchant_initiated_transaction` — payment triggered by the
+   * merchant without the payer present, on a pre-authorized mandate (remote only);
+   * `not_applicable` — this flow requires initiation context but SCA and SCA
+   * exemptions do not apply; `other` — another recognized exemption not listed
+   * above.
+   */
+  outcome: TransferScaOutcome;
+
+  /**
+   * Authentication factor metadata. Optional when `outcome` is `sca_used`; if
+   * provided, it must contain at least two entries from different `category` values
+   * (e.g. one `possession` factor and one `knowledge` factor). Omit this field for
+   * any other outcome.
+   */
+  auth_factors?: Array<TransferScaAuthFactor>;
+}
+
+/**
+ * Authentication factor metadata for a transfer.
+ */
+export interface TransferScaAuthFactor {
+  /**
+   * The ISO 8601 timestamp when this factor was authenticated.
+   */
+  authenticated_at: string;
+
+  /**
+   * The type of authentication factor used. Known values are: `knowledge` (something
+   * only the user knows, e.g. a PIN or password), `possession` (something only the
+   * user has, e.g. a phone receiving an OTP or a hardware token), and `inherence`
+   * (something the user is, e.g. a fingerprint or face scan). When `outcome` is
+   * `sca_used`, the two factors in `auth_factors` must belong to two different
+   * categories.
+   */
+  category: TransferScaAuthFactorCategory;
+
+  /**
+   * Your internal identifier for this authentication event (e.g. a session ID,
+   * transaction ID, or audit log reference). Used for reconciliation.
+   */
+  reference: string;
+}
+
+/**
+ * The type of authentication factor used. Known values are: `knowledge` (something
+ * only the user knows, e.g. a PIN or password), `possession` (something only the
+ * user has, e.g. a phone receiving an OTP or a hardware token), and `inherence`
+ * (something the user is, e.g. a fingerprint or face scan). When `outcome` is
+ * `sca_used`, the two factors in `auth_factors` must belong to two different
+ * categories.
+ */
+export type TransferScaAuthFactorCategory = 'knowledge' | 'possession' | 'inherence' | (string & {});
+
+/**
+ * Whether Strong Customer Authentication (SCA) was applied or which regulatory
+ * exemption or non-applicability reason covers this payment. Use `sca_used` when
+ * the user authenticated with SCA. Otherwise, choose the value that applies:
+ * `payment_to_self` — payer and payee are the same person (remote only);
+ * `trusted_beneficiaries` — payee is on the user's pre-approved list;
+ * `recurring_transaction` — amount and payee match a previously SCA-authorized
+ * recurring series; `contactless_low_value` — contactless card payment below the
+ * low-value threshold (non-remote only); `unattended_terminal_for_transport` —
+ * automated terminal for transport fares or parking (non-remote only); `low_value`
+ * — remote payment below the low-value threshold (remote only);
+ * `secure_corporate_payment` — dedicated corporate payment process with controls
+ * equivalent to SCA (remote only); `transaction_risk_analysis` — PSP has performed
+ * real-time risk analysis and the transaction falls within permitted thresholds
+ * (remote only); `merchant_initiated_transaction` — payment triggered by the
+ * merchant without the payer present, on a pre-authorized mandate (remote only);
+ * `not_applicable` — this flow requires initiation context but SCA and SCA
+ * exemptions do not apply; `other` — another recognized exemption not listed
+ * above.
+ */
+export type TransferScaOutcome =
+  | 'sca_used'
+  | 'payment_to_self'
+  | 'trusted_beneficiaries'
+  | 'recurring_transaction'
+  | 'contactless_low_value'
+  | 'unattended_terminal_for_transport'
+  | 'low_value'
+  | 'secure_corporate_payment'
+  | 'transaction_risk_analysis'
+  | 'merchant_initiated_transaction'
+  | 'not_applicable'
+  | 'other'
+  | (string & {});
+
 /**
  * Details for a sent transfer transaction.
  */
@@ -3798,6 +4106,7 @@ export interface TransferSentTransactionDetail {
     | 'avax'
     | 'pol'
     | 'bnb'
+    | 'mon'
     | 'usdt'
     | 'eurc'
     | 'usdb'
@@ -4375,6 +4684,12 @@ export interface Wallet {
    */
   external_id?: string;
 
+  /**
+   * ID of the HD root wallet this wallet was derived from, or null if it was not
+   * derived from another wallet.
+   */
+  parent_wallet_id?: string | null;
+
   /**
    * The compressed, raw public key for the wallet along the chain cryptographic
    * curve.
@@ -4441,6 +4756,7 @@ export type WalletAsset =
   | 'avax'
   | 'pol'
   | 'bnb'
+  | 'mon'
   | 'usdt'
   | 'eurc'
   | 'usdb'
@@ -4474,6 +4790,7 @@ export type WalletAssetChainNameInput =
   | 'hyperevm'
   | 'hypercore'
   | 'arc'
+  | 'monad'
   | 'tempo_testnet'
   | 'hoodi'
   | 'sepolia'
@@ -4703,6 +5020,12 @@ export interface WalletBatchItemInput {
    */
   additional_signers?: AdditionalSignerInput;
 
+  /**
+   * Derives the new wallet from an existing HD root wallet so both share one seed
+   * phrase.
+   */
+  derivation?: DerivationInput;
+
   /**
    * A human-readable label for the wallet.
    */
@@ -4870,6 +5193,7 @@ export type WalletEthereumAsset =
   | 'avax'
   | 'pol'
   | 'bnb'
+  | 'mon'
   | 'usdt'
   | 'eurc'
   | 'usdb'
@@ -5155,6 +5479,12 @@ export interface WalletCreateParams {
    */
   additional_signers?: AdditionalSignerInput;
 
+  /**
+   * Body param: Derives the new wallet from an existing HD root wallet so both share
+   * one seed phrase.
+   */
+  derivation?: DerivationInput;
+
   /**
    * Body param: A human-readable label for the wallet.
    */
@@ -6621,9 +6951,12 @@ export declare namespace Wallets {
     type CryptoDepositAccountCaip2 as CryptoDepositAccountCaip2,
     type CryptoDepositAccountChain as CryptoDepositAccountChain,
     type CryptoDepositAccountConfigResponse as CryptoDepositAccountConfigResponse,
+    type CryptoDepositAccountConfigSearchResponse as CryptoDepositAccountConfigSearchResponse,
+    type CryptoDepositAccountSearchCurrency as CryptoDepositAccountSearchCurrency,
     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,
@@ -6637,6 +6970,11 @@ export declare namespace Wallets {
     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 DerivationInput as DerivationInput,
     type DetachWalletAutomationRequestBody as DetachWalletAutomationRequestBody,
     type DeveloperFee as DeveloperFee,
     type EncryptedAuthorizationKey as EncryptedAuthorizationKey,
@@ -6819,10 +7157,19 @@ export declare namespace Wallets {
     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,
@@ -6957,6 +7304,7 @@ export declare namespace Wallets {
     type TvmTransactionWalletActionStep as TvmTransactionWalletActionStep,
     type TvmWalletActionStepStatus as TvmWalletActionStepStatus,
     type TempoVaultDetails as TempoVaultDetails,
+    type TempoZoneSettlementWalletActionStep as TempoZoneSettlementWalletActionStep,
     type TransferActionResponse as TransferActionResponse,
     type VedaVaultDetails as VedaVaultDetails,
     type WalletActionInclude as WalletActionInclude,