@privy-io/api-types 0.23.0 → 0.24.0

package/src/resources/cards.ts

@@ -57,13 +57,12 @@ export interface CardIssuingCardResponse {
   id: string;
 
   /**
-   * The asset the card funds from. 'usdc' on EVM and Solana, 'pathusd' on Tempo.
+   * The stablecoin the card settles in.
    */
   asset: string;
 
   /**
-   * USD balance of the card funding wallet on the configured chain, or null when
-   * unavailable.
+   * USD amount the card can spend right now, or null when unavailable.
    */
   balance_formatted: string | null;
 
@@ -94,6 +93,11 @@ export interface CardIssuingCardResponse {
    */
   exp_year: number | null;
 
+  /**
+   * The funding sources the card can spend from, with at most one `selected`.
+   */
+  funding_sources: Array<CardIssuingFundingSource>;
+
   last4: string | null;
 
   provider_id: string;
@@ -141,6 +145,12 @@ export interface CardIssuingConfig {
    * Stripe publishable key for initializing Stripe.js in the browser.
    */
   publishable_key: string;
+
+  /**
+   * Stripe account the publishable key acts on; absent when the key belongs to the
+   * app directly.
+   */
+  stripe_account?: string;
 }
 
 /**
@@ -168,8 +178,7 @@ export interface CardIssuingConfigResponse {
  */
 export interface CardIssuingCreateCardInput {
   /**
-   * The asset to fund the card. Must be 'usdc' on EVM and Solana, or 'pathusd' on
-   * Tempo.
+   * The asset that funds the card on `chain_id`.
    */
   asset: string;
 
@@ -389,6 +398,48 @@ export interface CardIssuingEphemeralKeyResponse {
   data: CardIssuingEphemeralKey;
 }
 
+/**
+ * The funding wallet's shares in an ERC-4626 Earn vault, which the card spends
+ * instead of its `asset` balance.
+ */
+export interface CardIssuingErc4626VaultFundingSource {
+  /**
+   * Earn provider of an ERC-4626 vault a card can spend.
+   */
+  provider: CardIssuingErc4626VaultProvider;
+
+  /**
+   * Whether this is the source the card spends right now.
+   */
+  selected: boolean;
+
+  /**
+   * EVM address: 0x followed by 40 hex characters. Preserves input case.
+   */
+  share_token_address: SharedAPI.EvmAddress;
+
+  /**
+   * EVM address: 0x followed by 40 hex characters. Preserves input case.
+   */
+  spender_address: SharedAPI.EvmAddress;
+
+  type: 'erc4626_vault';
+}
+
+/**
+ * Earn provider of an ERC-4626 vault a card can spend.
+ */
+export type CardIssuingErc4626VaultProvider = 'morpho' | 'aave';
+
+/**
+ * Funds a card can spend, where `selected`, not list position, marks the one it
+ * spends.
+ */
+export type CardIssuingFundingSource =
+  | CardIssuingWalletFundingSource
+  | CardIssuingErc4626VaultFundingSource
+  | CardIssuingTempoEarnVaultFundingSource;
+
 /**
  * Query parameters for listing cards bound to the authenticated Privy user.
  */
@@ -476,6 +527,40 @@ export interface CardIssuingStatementQueryParams {
   environment: SharedAPI.IntegrationEnvironment;
 }
 
+/**
+ * The funding wallet's shares in a Tempo Earn vault, which a card that also lists
+ * its wallet can switch to and back from.
+ */
+export interface CardIssuingTempoEarnVaultFundingSource {
+  /**
+   * EVM address: 0x followed by 40 hex characters. Preserves input case.
+   */
+  asset_address: SharedAPI.EvmAddress;
+
+  /**
+   * Whether the card spends this vault right now; neither it nor the wallet is when
+   * the wallet chose a vault outside the app's Earn vaults.
+   */
+  selected: boolean;
+
+  /**
+   * EVM address: 0x followed by 40 hex characters. Preserves input case.
+   */
+  share_token_address: SharedAPI.EvmAddress;
+
+  /**
+   * EVM address: 0x followed by 40 hex characters. Preserves input case.
+   */
+  spender_address: SharedAPI.EvmAddress;
+
+  type: 'tempo_earn_vault';
+
+  /**
+   * EVM address: 0x followed by 40 hex characters. Preserves input case.
+   */
+  vault_address: SharedAPI.EvmAddress;
+}
+
 /**
  * Card activity
  */
@@ -544,6 +629,18 @@ export interface CardIssuingUpdateCardInput {
   status?: CardIssuingCardStatus;
 }
 
+/**
+ * The funding wallet's `asset` balance.
+ */
+export interface CardIssuingWalletFundingSource {
+  /**
+   * Whether this is the source the card spends right now.
+   */
+  selected: boolean;
+
+  type: 'wallet';
+}
+
 export declare namespace Cards {
   export {
     type CardIssuingBankAgreement as CardIssuingBankAgreement,
@@ -576,6 +673,9 @@ export declare namespace Cards {
     type CardIssuingEphemeralKey as CardIssuingEphemeralKey,
     type CardIssuingEphemeralKeyRequestBody as CardIssuingEphemeralKeyRequestBody,
     type CardIssuingEphemeralKeyResponse as CardIssuingEphemeralKeyResponse,
+    type CardIssuingErc4626VaultFundingSource as CardIssuingErc4626VaultFundingSource,
+    type CardIssuingErc4626VaultProvider as CardIssuingErc4626VaultProvider,
+    type CardIssuingFundingSource as CardIssuingFundingSource,
     type CardIssuingListCardsInput as CardIssuingListCardsInput,
     type CardIssuingListTransactionsInput as CardIssuingListTransactionsInput,
     type CardIssuingMerchant as CardIssuingMerchant,
@@ -583,9 +683,11 @@ export declare namespace Cards {
     type CardIssuingReplaceCardRequestBody as CardIssuingReplaceCardRequestBody,
     type CardIssuingReplacementReason as CardIssuingReplacementReason,
     type CardIssuingStatementQueryParams as CardIssuingStatementQueryParams,
+    type CardIssuingTempoEarnVaultFundingSource as CardIssuingTempoEarnVaultFundingSource,
     type CardIssuingTransactionResponse as CardIssuingTransactionResponse,
     type CardIssuingTransactionStatus as CardIssuingTransactionStatus,
     type CardIssuingTransactionsResponse as CardIssuingTransactionsResponse,
     type CardIssuingUpdateCardInput as CardIssuingUpdateCardInput,
+    type CardIssuingWalletFundingSource as CardIssuingWalletFundingSource,
   };
 }

package/src/resources/client-auth.ts

@@ -96,7 +96,7 @@ export interface BridgeBrlFiatVirtualAccountDepositInstructions {
 /**
  * Supported destination stablecoin assets for fiat-to-crypto transfers.
  */
-export type BridgeDestinationAsset = 'usdb' | 'usdc' | 'usdt' | 'dai' | 'pyusd' | 'eurc';
+export type BridgeDestinationAsset = 'usdb' | 'usdc' | 'usdt' | 'dai' | 'pyusd' | 'eurc' | 'ousd';
 
 /**
  * The deposit instructions for a virtual account.

package/src/resources/fiat.ts

@@ -23,6 +23,12 @@ export interface BridgeCreateExternalFiatAccountRequestBody {
    */
   provider: 'bridge';
 
+  /**
+   * The individual or business that owns the account. Required for `iban`, `gb`, and
+   * `swift` accounts.
+   */
+  account_owner?: ExternalFiatAccountOwner;
+
   /**
    * Physical address associated with an external fiat account.
    */
@@ -55,6 +61,12 @@ export interface BridgeCreateFiatDepositAccountRequestBody {
    */
   source: CreateFiatDepositAccountSource;
 
+  /**
+   * A developer fee as a percentage string from 0 up to (not including) 100, e.g.
+   * "1.5" for 1.5%.
+   */
+  developer_fee_percent?: DeveloperFeePercent;
+
   /**
    * The Privy API environment.
    */
@@ -111,6 +123,12 @@ export interface BridgeFiatDepositAccount {
    */
   destination: FiatDepositAccountDestination;
 
+  /**
+   * A developer fee as a percentage string from 0 up to (not including) 100, e.g.
+   * "1.5" for 1.5%.
+   */
+  developer_fee_percent: DeveloperFeePercent;
+
   /**
    * The Privy API environment.
    */
@@ -183,6 +201,12 @@ export interface CreateExternalFiatAccountRequestBody {
    */
   provider: 'bridge';
 
+  /**
+   * The individual or business that owns the account. Required for `iban`, `gb`, and
+   * `swift` accounts.
+   */
+  account_owner?: ExternalFiatAccountOwner;
+
   /**
    * Physical address associated with an external fiat account.
    */
@@ -215,6 +239,12 @@ export interface CreateFiatDepositAccountRequestBody {
    */
   source: CreateFiatDepositAccountSource;
 
+  /**
+   * A developer fee as a percentage string from 0 up to (not including) 100, e.g.
+   * "1.5" for 1.5%.
+   */
+  developer_fee_percent?: DeveloperFeePercent;
+
   /**
    * The Privy API environment.
    */
@@ -241,8 +271,20 @@ export interface CreatePayoutRequestBody {
    * The source crypto asset, chain, and amount for a payout.
    */
   source: PayoutSource;
+
+  /**
+   * A developer fee as a percentage string from 0 up to (not including) 100, e.g.
+   * "1.5" for 1.5%.
+   */
+  developer_fee_percent?: DeveloperFeePercent;
 }
 
+/**
+ * A developer fee as a percentage string from 0 up to (not including) 100, e.g.
+ * "1.5" for 1.5%.
+ */
+export type DeveloperFeePercent = string;
+
 /**
  * A Bridge external fiat account linked to a user.
  */
@@ -291,6 +333,15 @@ export interface ExternalFiatAccountAddress {
   street_line_2?: string;
 }
 
+/**
+ * A business that owns an external fiat account.
+ */
+export interface ExternalFiatAccountBusinessOwner {
+  business_name: string;
+
+  type: 'business';
+}
+
 /**
  * Bank account details. The `type` field discriminates which shape applies.
  */
@@ -341,6 +392,23 @@ export interface ExternalFiatAccountIbanData {
   type: 'iban';
 }
 
+/**
+ * An individual who owns an external fiat account.
+ */
+export interface ExternalFiatAccountIndividualOwner {
+  first_name: string;
+
+  last_name: string;
+
+  type: 'individual';
+}
+
+/**
+ * The individual or business that owns the account. Required for `iban`, `gb`, and
+ * `swift` accounts.
+ */
+export type ExternalFiatAccountOwner = ExternalFiatAccountIndividualOwner | ExternalFiatAccountBusinessOwner;
+
 /**
  * Brazilian Pix account data for an external fiat account. Provide exactly one of
  * `pix_key` or `br_code`.
@@ -454,6 +522,12 @@ export interface FiatDepositAccount {
    */
   destination: FiatDepositAccountDestination;
 
+  /**
+   * A developer fee as a percentage string from 0 up to (not including) 100, e.g.
+   * "1.5" for 1.5%.
+   */
+  developer_fee_percent: DeveloperFeePercent;
+
   /**
    * The Privy API environment.
    */
@@ -618,6 +692,12 @@ export interface KYBAssociatedPerson {
    */
   residential_address: VerificationAddress;
 
+  /**
+   * When this person (a control person) attested to having verified the business
+   * ownership structure (ISO 8601).
+   */
+  attested_ownership_structure_at?: (string & {}) | (string & {});
+
   /**
    * Supporting documents for this person, such as proof of address.
    */
@@ -628,6 +708,12 @@ export interface KYBAssociatedPerson {
    */
   is_director?: boolean;
 
+  /**
+   * Result of a KYC/AML or OFAC screen you performed and are relying on the provider
+   * to accept, honoured only for developers enrolled in reliance.
+   */
+  kyc_screen?: KyxScreen;
+
   /**
    * Legal middle name.
    */
@@ -638,6 +724,12 @@ export interface KYBAssociatedPerson {
    */
   nationalities?: Array<string>;
 
+  /**
+   * Result of a KYC/AML or OFAC screen you performed and are relying on the provider
+   * to accept, honoured only for developers enrolled in reliance.
+   */
+  ofac_screen?: KyxScreen;
+
   /**
    * Percentage of the business this person owns.
    */
@@ -682,6 +774,21 @@ export interface KYBAssociatedPerson {
    * A postal address used in KYC and KYB data submission.
    */
   transliterated_residential_address?: VerificationAddress;
+
+  /**
+   * When you verified this person against a database source (ISO 8601).
+   */
+  verified_database_at?: (string & {}) | (string & {});
+
+  /**
+   * When you verified the government ID for this person (ISO 8601).
+   */
+  verified_govid_at?: (string & {}) | (string & {});
+
+  /**
+   * When you verified proof of address for this person (ISO 8601).
+   */
+  verified_proof_of_address_at?: (string & {}) | (string & {});
 }
 
 /**
@@ -1064,6 +1171,18 @@ export interface KYBSubmitData {
    */
   is_dao?: boolean;
 
+  /**
+   * Result of a KYC/AML or OFAC screen you performed and are relying on the provider
+   * to accept, honoured only for developers enrolled in reliance.
+   */
+  kyb_screen?: KyxScreen;
+
+  /**
+   * Result of a KYC/AML or OFAC screen you performed and are relying on the provider
+   * to accept, honoured only for developers enrolled in reliance.
+   */
+  ofac_screen?: KyxScreen;
+
   /**
    * Whether the business operates in prohibited jurisdictions.
    */
@@ -1141,6 +1260,22 @@ export interface KYBSubmitData {
    * A postal address used in KYC and KYB data submission.
    */
   transliterated_registered_address?: VerificationAddress;
+
+  /**
+   * When you verified the business against a database source (ISO 8601).
+   */
+  verified_database_at?: (string & {}) | (string & {});
+
+  /**
+   * When you verified the business registration documents (ISO 8601).
+   */
+  verified_govid_at?: (string & {}) | (string & {});
+
+  /**
+   * When you verified the business proof of address (ISO 8601), required for EEA
+   * customers and SEPA rails under reliance.
+   */
+  verified_proof_of_address_at?: (string & {}) | (string & {});
 }
 
 /**
@@ -1290,6 +1425,11 @@ export interface KYCStatusResponse {
    * Terms of Service acceptance status for a KYC or KYB flow.
    */
   tos: KyxTosStatusDetail;
+
+  /**
+   * Stripe Issuing cardholder ID assigned by Bridge for this user.
+   */
+  stripe_cardholder_id?: string;
 }
 
 /**
@@ -1316,6 +1456,12 @@ export interface KYCSubmitData {
    */
   identifying_information?: Array<VerificationDocument>;
 
+  /**
+   * Result of a KYC/AML or OFAC screen you performed and are relying on the provider
+   * to accept, honoured only for developers enrolled in reliance.
+   */
+  kyc_screen?: KyxScreen;
+
   /**
    * Legal last name.
    */
@@ -1337,6 +1483,12 @@ export interface KYCSubmitData {
    */
   nonresident_alien_attestation?: boolean;
 
+  /**
+   * Result of a KYC/AML or OFAC screen you performed and are relying on the provider
+   * to accept, honoured only for developers enrolled in reliance.
+   */
+  ofac_screen?: KyxScreen;
+
   /**
    * Phone number in E.164 format.
    */
@@ -1347,6 +1499,12 @@ export interface KYCSubmitData {
    */
   residential_address?: VerificationAddress;
 
+  /**
+   * Stripe Link shared data ID that supplies name, date of birth, address, and US
+   * SSN (omit those fields); retrieval errors surface in endorsements[].issues.
+   */
+  stripe_link_shared_data_id?: string;
+
   /**
    * Latin-1 transliteration of the first name. Required for non-Latin-1 names.
    */
@@ -1366,6 +1524,24 @@ export interface KYCSubmitData {
    * A postal address used in KYC and KYB data submission.
    */
   transliterated_residential_address?: VerificationAddress;
+
+  /**
+   * When you verified the user against a database source (ISO 8601), which loosens
+   * the identifying-document requirement under reliance.
+   */
+  verified_database_at?: (string & {}) | (string & {});
+
+  /**
+   * When you verified the government ID (ISO 8601), which loosens the
+   * identifying-document requirement under reliance.
+   */
+  verified_govid_at?: (string & {}) | (string & {});
+
+  /**
+   * When you verified proof of address (ISO 8601), required for EEA customers and
+   * SEPA rails under reliance.
+   */
+  verified_proof_of_address_at?: (string & {}) | (string & {});
 }
 
 /**
@@ -1432,6 +1608,11 @@ export type KyxCapabilityStatus = string;
  * An endorsement with its approval status and missing requirements.
  */
 export interface KyxEndorsement {
+  /**
+   * Provider issue codes, or null if none.
+   */
+  issues: Array<string> | null;
+
   /**
    * Missing requirements, or null if complete.
    */
@@ -1473,6 +1654,27 @@ export type KyxProvider = 'bridge';
  */
 export type KyxProviderStatus = string;
 
+/**
+ * Result of a KYC/AML or OFAC screen you performed and are relying on the provider
+ * to accept, honoured only for developers enrolled in reliance.
+ */
+export interface KyxScreen {
+  /**
+   * Outcome of a screen performed under KYC/KYB reliance.
+   */
+  result: KyxScreenResult;
+
+  /**
+   * When the screen was performed (ISO 8601 date or date-time).
+   */
+  screened_at: (string & {}) | (string & {});
+}
+
+/**
+ * Outcome of a screen performed under KYC/KYB reliance.
+ */
+export type KyxScreenResult = 'passed' | 'failed';
+
 /**
  * Request body for initiating Terms of Service acceptance.
  */
@@ -1785,8 +1987,27 @@ export interface PayoutDestination {
    * The ID of a previously registered external fiat account to pay out to.
    */
   fiat_account_id: string;
+
+  /**
+   * A fiat payment rail a payout can settle over. `ach` is a standard ACH credit to
+   * the destination account.
+   */
+  payment_rail?: PayoutPaymentRail;
 }
 
+/**
+ * A fiat payment rail a payout can settle over. `ach` is a standard ACH credit to
+ * the destination account.
+ */
+export type PayoutPaymentRail =
+  | 'ach'
+  | 'ach_same_day'
+  | 'wire'
+  | 'fednow'
+  | 'sepa'
+  | 'faster_payments'
+  | 'pix';
+
 /**
  * The source crypto asset, chain, and amount for a payout.
  */
@@ -1895,11 +2116,15 @@ export declare namespace Fiat {
     type CreateFiatDepositAccountRequestBody as CreateFiatDepositAccountRequestBody,
     type CreateFiatDepositAccountSource as CreateFiatDepositAccountSource,
     type CreatePayoutRequestBody as CreatePayoutRequestBody,
+    type DeveloperFeePercent as DeveloperFeePercent,
     type ExternalFiatAccount as ExternalFiatAccount,
     type ExternalFiatAccountAddress as ExternalFiatAccountAddress,
+    type ExternalFiatAccountBusinessOwner as ExternalFiatAccountBusinessOwner,
     type ExternalFiatAccountData as ExternalFiatAccountData,
     type ExternalFiatAccountGBData as ExternalFiatAccountGBData,
     type ExternalFiatAccountIbanData as ExternalFiatAccountIbanData,
+    type ExternalFiatAccountIndividualOwner as ExternalFiatAccountIndividualOwner,
+    type ExternalFiatAccountOwner as ExternalFiatAccountOwner,
     type ExternalFiatAccountPixData as ExternalFiatAccountPixData,
     type ExternalFiatAccountResponse as ExternalFiatAccountResponse,
     type ExternalFiatAccountSwiftCategory as ExternalFiatAccountSwiftCategory,
@@ -1946,6 +2171,8 @@ export declare namespace Fiat {
     type KyxEnvironment as KyxEnvironment,
     type KyxProvider as KyxProvider,
     type KyxProviderStatus as KyxProviderStatus,
+    type KyxScreen as KyxScreen,
+    type KyxScreenResult as KyxScreenResult,
     type KyxTosRequestBody as KyxTosRequestBody,
     type KyxTosResponse as KyxTosResponse,
     type KyxTosStatus as KyxTosStatus,
@@ -1967,6 +2194,7 @@ export declare namespace Fiat {
     type OrganizationExternalFiatAccount as OrganizationExternalFiatAccount,
     type OrganizationExternalFiatAccountResponse as OrganizationExternalFiatAccountResponse,
     type PayoutDestination as PayoutDestination,
+    type PayoutPaymentRail as PayoutPaymentRail,
     type PayoutSource as PayoutSource,
     type VerificationAddress as VerificationAddress,
     type VerificationDocument as VerificationDocument,