@unifold/core 0.1.67 → 0.1.68-beta.0

package/dist/index.d.mts

@@ -340,6 +340,11 @@ interface OnrampQuotesResponse {
  * @param publishableKey - Optional publishable key, defaults to configured key
  */
 declare function getOnrampQuotes(request: OnrampQuotesRequest, publishableKey?: string): Promise<OnrampQuotesResponse>;
+/**
+ * Payment method for an onramp session. Defaults to `card` server-side.
+ * `sepa` routes the session through SEPA bank transfer (Swapped-only today).
+ */
+type OnrampSessionPaymentMethod = "card" | "sepa";
 interface OnrampSessionRequest {
     service_provider: string;
     country_code: string;
@@ -352,6 +357,7 @@ interface OnrampSessionRequest {
     redirect_url?: string;
     external_id?: string;
     email?: string;
+    payment_method?: OnrampSessionPaymentMethod;
 }
 interface OnrampSessionResponse {
     url: string;
@@ -363,6 +369,51 @@ interface OnrampSessionResponse {
  * @param publishableKey - Optional publishable key, defaults to configured key
  */
 declare function createOnrampSession(request: OnrampSessionRequest, publishableKey?: string): Promise<OnrampSessionResponse>;
+/**
+ * A bank-transfer onramp provider returned by `getBankTransferProviders()`.
+ * Mirrors the shape of `IntegrationExchangeInfo` so SDK consumers can render
+ * exchanges + bank-transfer with the same UI primitives.
+ */
+interface BankTransferProvider {
+    service_provider: string;
+    service_provider_display_name: string;
+    description: string;
+    icon_url: string;
+    icon_urls: IconUrl[];
+    /**
+     * True when the provider is configured AND the rail supports the caller's
+     * country. Use this to decide whether the row is clickable.
+     */
+    enabled: boolean;
+    /**
+     * Payment methods this provider supports. Forward one of these as
+     * `payment_method` when calling `/onramps/sessions`. Stored as an array so
+     * a single provider can light up multiple rails (e.g. SEPA + ACH) without
+     * forking the row.
+     */
+    payment_methods: OnrampSessionPaymentMethod[];
+    /** All fiat currencies the rail accepts (e.g. ['eur', 'gbp']). */
+    supported_currencies: string[];
+    /**
+     * Preferred fiat for the caller's country, picked from `supported_currencies`.
+     * Forward as `source_currency` to `/onramps/sessions` — avoids the SDK
+     * re-implementing the country → fiat mapping.
+     */
+    source_currency: string;
+}
+interface BankTransferProvidersResponse {
+    data: BankTransferProvider[];
+}
+interface GetBankTransferProvidersOptions {
+    /** ISO 3166-1 alpha-2 country code. Drives the `enabled` flag per provider. */
+    countryCode?: string;
+}
+/**
+ * Get supported bank-transfer onramp providers (SEPA via Swapped today).
+ * Each provider's `enabled` flag reflects project config + native integration
+ * availability + the caller-supplied country.
+ */
+declare function getBankTransferProviders(publishableKey?: string, options?: GetBankTransferProvidersOptions): Promise<BankTransferProvidersResponse>;
 /**
  * Generate a URL for the sessions/start endpoint that redirects to the onramp provider.
  * This is useful for avoiding popup blockers by opening the URL directly via anchor tag.
@@ -484,10 +535,20 @@ interface ProjectConfigResponse {
     deposit_tracker?: {
         enabled: boolean;
     };
+    bank_transfer?: BankTransferConfig;
     hypercore_sponsorship?: {
         enabled: boolean;
     };
 }
+/**
+ * Bank-transfer project-level toggle returned by `/projects/config`.
+ *
+ * Only reflects the dashboard preference — the actual rails available for
+ * a given country live under `getBankTransferProviders()`.
+ */
+interface BankTransferConfig {
+    enabled: boolean;
+}
 /**
  * Get project configuration
  * @param publishableKey - Optional publishable key, defaults to configured key
@@ -1296,12 +1357,51 @@ declare enum DepositEventType {
 declare enum WithdrawEventType {
     DIRECT_EXECUTION_SUCCEEDED = "direct_execution.succeeded"
 }
+/** Event types emitted by the checkout flow. */
+declare enum CheckoutEventType {
+    PAYMENT_INTENT_SUCCEEDED = "payment_intent.succeeded"
+}
 /** Funding method used by a deposit flow. */
 type DepositMethod = "transfer" | "card" | "cashapp" | "pay_with_exchange" | "exchange_connect" | "wallet_connect";
+/** Funding method used by a checkout flow. */
+type CheckoutMethod = "transfer" | "wallet_connect";
 /** `data.object` payload for {@link DepositEventType.ONRAMP_SESSION_CREATED} */
 interface OnrampSessionCreatedData {
     externalId: string;
 }
+/**
+ * Callback-facing payment intent object.
+ * Mirrors the field-naming conventions used by {@link DirectExecution}
+ * (camelCase, `BaseUnit` / `Usd` amount suffixes, `failureReason`, no currency
+ * code or decimals — derive those from `*TokenAddress` if needed).
+ */
+interface CheckoutPaymentIntent {
+    id: string;
+    status: "succeeded";
+    recipientAddress: string;
+    destinationChainType: string;
+    destinationChainId: string;
+    destinationTokenAddress: string;
+    destinationAmountBaseUnit: string;
+    destinationAmountUsd: string;
+    destinationAmountReceivedBaseUnit: string;
+    destinationAmountReceivedUsd: string;
+    sourceChainType: string | null;
+    sourceChainId: string | null;
+    sourceTokenAddress: string | null;
+    sourceAmountBaseUnit: string | null;
+    sourceAmountUsd: string | null;
+    sourceAmountReceivedBaseUnit: string | null;
+    sourceAmountReceivedUsd: string | null;
+    /** Atomic payout (pool → recipient) hash. Locked-quote only; null until broadcast. */
+    transactionHash: string | null;
+    failureReason: string | null;
+}
+/**
+ * `data.object` payload for {@link CheckoutEventType.PAYMENT_INTENT_SUCCEEDED}.
+ * @deprecated Use {@link CheckoutPaymentIntent} — kept as an alias for back-compat.
+ */
+type CheckoutPaymentIntentData = CheckoutPaymentIntent;
 /**
  * Callback-facing direct execution object.
  * Intentionally separate from legacy `DirectExecutionResponse` naming.
@@ -1334,6 +1434,10 @@ interface DepositEventDataMap {
 interface WithdrawEventDataMap {
     [WithdrawEventType.DIRECT_EXECUTION_SUCCEEDED]: DirectExecution;
 }
+/** Map from event type to its `data.object` shape */
+interface CheckoutEventDataMap {
+    [CheckoutEventType.PAYMENT_INTENT_SUCCEEDED]: CheckoutPaymentIntent;
+}
 /**
  * Event envelope emitted by the deposit flow, inspired by the server-side
  * webhook payload shape: top-level metadata (`id`, `type`, `created`) with
@@ -1370,6 +1474,18 @@ type WithdrawEvent = {
         };
     };
 }[WithdrawEventType];
+/** Event envelope emitted by the checkout flow. */
+type CheckoutEvent = {
+    [K in CheckoutEventType]: {
+        id: string;
+        type: K;
+        created: number;
+        method?: CheckoutMethod;
+        data: {
+            object: CheckoutEventDataMap[K];
+        };
+    };
+}[CheckoutEventType];
 /** Convenience type for a fully-typed `onramp_session.created` event */
 type OnrampSessionCreatedEvent = Extract<DepositEvent, {
     type: DepositEventType.ONRAMP_SESSION_CREATED;
@@ -1385,6 +1501,10 @@ type DirectExecutionSucceededEvent = Extract<DepositEvent, {
 type WithdrawDirectExecutionSucceededEvent = Extract<WithdrawEvent, {
     type: WithdrawEventType.DIRECT_EXECUTION_SUCCEEDED;
 }>;
+/** Convenience type for a fully-typed `payment_intent.succeeded` checkout event */
+type CheckoutPaymentIntentSucceededEvent = Extract<CheckoutEvent, {
+    type: CheckoutEventType.PAYMENT_INTENT_SUCCEEDED;
+}>;
 
 /**
  * User IP information interface
@@ -1508,4 +1628,4 @@ declare const i18n: {
 };
 type I18nStrings = typeof i18n;
 
-export { ActionType, type AddressBalanceResponse, type AddressBalancesResponse, type AddressValidationFailureCode, type AddressValidationMetadata, type AuthenticateOAuthResult, type AutoSwapRequest, type AutoSwapResponse, type BlockedCountrySubdivision, type BuildHypercoreTransactionRequest, type BuildHypercoreTransactionResponse, type BuildSolanaTransactionRequest, type BuildSolanaTransactionResponse, type CashAppLimits, type CashAppSessionRequest, type CashAppSessionResponse, type CashAppSessionStatusResponse, type ChainType, type ConfirmIntegrationTransferResult, type CreateDepositAddressRequest, type CreateExchangeSessionRequest, type CreateExchangeSessionResponse, type CreateIntegrationTransferParams, type CreateIntegrationTransferResult, type DefaultTokenChain, type DefaultTokenMetadata, type DefaultTokenResponse, type DepositAddressResponse, type DepositEvent, DepositEventType, type DepositMethod, type DepositQuote, type DepositQuoteRequest, type DestinationToken, type DestinationTokenChain, type DirectExecution, type DirectExecutionResponse, type DirectExecutionSucceededEvent, type EvmContractCall, type ExchangeProviderInfo, type ExchangeProvidersResponse, type ExchangeSessionStartParams, type ExchangeWalletAddress, ExecutionStatus, type ExternalWalletChainType, type ExternalWalletInfo, type ExternalWalletsResponse, type FeaturedToken, type FeaturedWallet, type FiatCurrenciesResponse, type FiatCurrency, type GetExchangesQuery, type HypercoreActivationRequest, type HypercoreActivationResponse, type I18nStrings, type IconUrl, IneligibilityReason, type IntegrationAccount, type IntegrationExchangeInfo, type IntegrationExchangesResponse, type IntegrationFeeAmount, type IntegrationHoldingsResponse, IntegrationProvider, type IpAddressResponse, type LockedQuoteLimits, type LockedQuotePreview, type LockedQuotePreviewRequest, type OnrampQuote, type OnrampQuotesRequest, type OnrampQuotesResponse, type OnrampSessionCreatedData, type OnrampSessionCreatedEvent, type OnrampSessionRequest, type OnrampSessionResponse, type PaymentIntent, type PaymentIntentDepositAddress, type PaymentIntentExecutionsResponse, type PaymentIntentStatus, type PaymentIntentType, type PaymentNetwork, type PollExecutionsRequest, type PollExecutionsResponse, type ProductType, type ProjectConfigResponse, type QueryExecutionsRequest, type QueryExecutionsResponse, type RefreshIntegrationTokenResult, SOLANA_USDC_ADDRESS, type SendHypercoreTransactionRequest, type SendHypercoreTransactionResponse, type SendSolanaTransactionRequest, type SendSolanaTransactionResponse, type SourceToken, type SourceTokenNetwork, type StartIntegrationOAuthResult, type SupportedChain, type SupportedDepositTokensResponse, type SupportedDestinationTokensResponse, type SupportedSourceTokensQuery, type SupportedSourceTokensResponse, type SupportedToken, type TokenBalance, type TokenChain, type TokenChainIconUrl, type TokenChainsResponse, type TokenIconUrl, type TokenInfo, type TokenMetadata, type TransferDefaultTokenParams, type TransferDefaultTokenResult, type UserIpInfo, type VerifyAddressRequest, type VerifyAddressResponse, type Wallet, type WalletMobileDeepLinkDepositAddress, type WalletMobileDeepLinkResponse, type WalletMobileDeepLinkWallet, type WithdrawDirectExecutionSucceededEvent, type WithdrawEvent, WithdrawEventType, authenticateIntegrationOAuth, buildHypercoreTransaction, buildSolanaTransaction, checkHypercoreActivation, confirmIntegrationTransfer, createCashAppSession, createDepositAddress, createExchangeSession, createIntegrationTransfer, createOnrampSession, formatStablecoinAmount, generateKSUID, generatePrefixedKSUID, getAddressBalance, getAddressBalances, getApiBaseUrl, getCashAppLimits, getCashAppSessionStatus, getChainName, getDefaultOnrampToken, getDepositAddress, getDepositQuote, getExchangeSessionStartUrl, getExchanges, getExternalWallets, getFiatCurrencies, getIconUrl, getIconUrlWithCdn, getIntegrationExchanges, getIntegrationHoldings, getIntegrationTransferDefaultToken, getIpAddress, getOnrampQuotes, getOnrampSessionStartUrl, getPreferredIconUrl, getProjectConfig, getSupportedDepositTokens, getSupportedDestinationTokens, getTokenChains, getTokenMetadata, getWalletByChainType, getWalletMobileDeepLink, i18n, listPaymentIntentExecutions, pollDirectExecutions, queryExecutions, refreshIntegrationToken, retrievePaymentIntent, revokeIntegrationToken, sendHypercoreTransaction, sendSolanaTransaction, setApiConfig, startIntegrationOAuth, useUserIp, verifyRecipientAddress };
+export { ActionType, type AddressBalanceResponse, type AddressBalancesResponse, type AddressValidationFailureCode, type AddressValidationMetadata, type AuthenticateOAuthResult, type AutoSwapRequest, type AutoSwapResponse, type BankTransferConfig, type BankTransferProvider, type BankTransferProvidersResponse, type BlockedCountrySubdivision, type BuildHypercoreTransactionRequest, type BuildHypercoreTransactionResponse, type BuildSolanaTransactionRequest, type BuildSolanaTransactionResponse, type CashAppLimits, type CashAppSessionRequest, type CashAppSessionResponse, type CashAppSessionStatusResponse, type ChainType, type CheckoutEvent, CheckoutEventType, type CheckoutMethod, type CheckoutPaymentIntent, type CheckoutPaymentIntentData, type CheckoutPaymentIntentSucceededEvent, type ConfirmIntegrationTransferResult, type CreateDepositAddressRequest, type CreateExchangeSessionRequest, type CreateExchangeSessionResponse, type CreateIntegrationTransferParams, type CreateIntegrationTransferResult, type DefaultTokenChain, type DefaultTokenMetadata, type DefaultTokenResponse, type DepositAddressResponse, type DepositEvent, DepositEventType, type DepositMethod, type DepositQuote, type DepositQuoteRequest, type DestinationToken, type DestinationTokenChain, type DirectExecution, type DirectExecutionResponse, type DirectExecutionSucceededEvent, type EvmContractCall, type ExchangeProviderInfo, type ExchangeProvidersResponse, type ExchangeSessionStartParams, type ExchangeWalletAddress, ExecutionStatus, type ExternalWalletChainType, type ExternalWalletInfo, type ExternalWalletsResponse, type FeaturedToken, type FeaturedWallet, type FiatCurrenciesResponse, type FiatCurrency, type GetBankTransferProvidersOptions, type GetExchangesQuery, type HypercoreActivationRequest, type HypercoreActivationResponse, type I18nStrings, type IconUrl, IneligibilityReason, type IntegrationAccount, type IntegrationExchangeInfo, type IntegrationExchangesResponse, type IntegrationFeeAmount, type IntegrationHoldingsResponse, IntegrationProvider, type IpAddressResponse, type LockedQuoteLimits, type LockedQuotePreview, type LockedQuotePreviewRequest, type OnrampQuote, type OnrampQuotesRequest, type OnrampQuotesResponse, type OnrampSessionCreatedData, type OnrampSessionCreatedEvent, type OnrampSessionPaymentMethod, type OnrampSessionRequest, type OnrampSessionResponse, type PaymentIntent, type PaymentIntentDepositAddress, type PaymentIntentExecutionsResponse, type PaymentIntentStatus, type PaymentIntentType, type PaymentNetwork, type PollExecutionsRequest, type PollExecutionsResponse, type ProductType, type ProjectConfigResponse, type QueryExecutionsRequest, type QueryExecutionsResponse, type RefreshIntegrationTokenResult, SOLANA_USDC_ADDRESS, type SendHypercoreTransactionRequest, type SendHypercoreTransactionResponse, type SendSolanaTransactionRequest, type SendSolanaTransactionResponse, type SourceToken, type SourceTokenNetwork, type StartIntegrationOAuthResult, type SupportedChain, type SupportedDepositTokensResponse, type SupportedDestinationTokensResponse, type SupportedSourceTokensQuery, type SupportedSourceTokensResponse, type SupportedToken, type TokenBalance, type TokenChain, type TokenChainIconUrl, type TokenChainsResponse, type TokenIconUrl, type TokenInfo, type TokenMetadata, type TransferDefaultTokenParams, type TransferDefaultTokenResult, type UserIpInfo, type VerifyAddressRequest, type VerifyAddressResponse, type Wallet, type WalletMobileDeepLinkDepositAddress, type WalletMobileDeepLinkResponse, type WalletMobileDeepLinkWallet, type WithdrawDirectExecutionSucceededEvent, type WithdrawEvent, WithdrawEventType, authenticateIntegrationOAuth, buildHypercoreTransaction, buildSolanaTransaction, checkHypercoreActivation, confirmIntegrationTransfer, createCashAppSession, createDepositAddress, createExchangeSession, createIntegrationTransfer, createOnrampSession, formatStablecoinAmount, generateKSUID, generatePrefixedKSUID, getAddressBalance, getAddressBalances, getApiBaseUrl, getBankTransferProviders, getCashAppLimits, getCashAppSessionStatus, getChainName, getDefaultOnrampToken, getDepositAddress, getDepositQuote, getExchangeSessionStartUrl, getExchanges, getExternalWallets, getFiatCurrencies, getIconUrl, getIconUrlWithCdn, getIntegrationExchanges, getIntegrationHoldings, getIntegrationTransferDefaultToken, getIpAddress, getOnrampQuotes, getOnrampSessionStartUrl, getPreferredIconUrl, getProjectConfig, getSupportedDepositTokens, getSupportedDestinationTokens, getTokenChains, getTokenMetadata, getWalletByChainType, getWalletMobileDeepLink, i18n, listPaymentIntentExecutions, pollDirectExecutions, queryExecutions, refreshIntegrationToken, retrievePaymentIntent, revokeIntegrationToken, sendHypercoreTransaction, sendSolanaTransaction, setApiConfig, startIntegrationOAuth, useUserIp, verifyRecipientAddress };

package/dist/index.d.ts

@@ -340,6 +340,11 @@ interface OnrampQuotesResponse {
  * @param publishableKey - Optional publishable key, defaults to configured key
  */
 declare function getOnrampQuotes(request: OnrampQuotesRequest, publishableKey?: string): Promise<OnrampQuotesResponse>;
+/**
+ * Payment method for an onramp session. Defaults to `card` server-side.
+ * `sepa` routes the session through SEPA bank transfer (Swapped-only today).
+ */
+type OnrampSessionPaymentMethod = "card" | "sepa";
 interface OnrampSessionRequest {
     service_provider: string;
     country_code: string;
@@ -352,6 +357,7 @@ interface OnrampSessionRequest {
     redirect_url?: string;
     external_id?: string;
     email?: string;
+    payment_method?: OnrampSessionPaymentMethod;
 }
 interface OnrampSessionResponse {
     url: string;
@@ -363,6 +369,51 @@ interface OnrampSessionResponse {
  * @param publishableKey - Optional publishable key, defaults to configured key
  */
 declare function createOnrampSession(request: OnrampSessionRequest, publishableKey?: string): Promise<OnrampSessionResponse>;
+/**
+ * A bank-transfer onramp provider returned by `getBankTransferProviders()`.
+ * Mirrors the shape of `IntegrationExchangeInfo` so SDK consumers can render
+ * exchanges + bank-transfer with the same UI primitives.
+ */
+interface BankTransferProvider {
+    service_provider: string;
+    service_provider_display_name: string;
+    description: string;
+    icon_url: string;
+    icon_urls: IconUrl[];
+    /**
+     * True when the provider is configured AND the rail supports the caller's
+     * country. Use this to decide whether the row is clickable.
+     */
+    enabled: boolean;
+    /**
+     * Payment methods this provider supports. Forward one of these as
+     * `payment_method` when calling `/onramps/sessions`. Stored as an array so
+     * a single provider can light up multiple rails (e.g. SEPA + ACH) without
+     * forking the row.
+     */
+    payment_methods: OnrampSessionPaymentMethod[];
+    /** All fiat currencies the rail accepts (e.g. ['eur', 'gbp']). */
+    supported_currencies: string[];
+    /**
+     * Preferred fiat for the caller's country, picked from `supported_currencies`.
+     * Forward as `source_currency` to `/onramps/sessions` — avoids the SDK
+     * re-implementing the country → fiat mapping.
+     */
+    source_currency: string;
+}
+interface BankTransferProvidersResponse {
+    data: BankTransferProvider[];
+}
+interface GetBankTransferProvidersOptions {
+    /** ISO 3166-1 alpha-2 country code. Drives the `enabled` flag per provider. */
+    countryCode?: string;
+}
+/**
+ * Get supported bank-transfer onramp providers (SEPA via Swapped today).
+ * Each provider's `enabled` flag reflects project config + native integration
+ * availability + the caller-supplied country.
+ */
+declare function getBankTransferProviders(publishableKey?: string, options?: GetBankTransferProvidersOptions): Promise<BankTransferProvidersResponse>;
 /**
  * Generate a URL for the sessions/start endpoint that redirects to the onramp provider.
  * This is useful for avoiding popup blockers by opening the URL directly via anchor tag.
@@ -484,10 +535,20 @@ interface ProjectConfigResponse {
     deposit_tracker?: {
         enabled: boolean;
     };
+    bank_transfer?: BankTransferConfig;
     hypercore_sponsorship?: {
         enabled: boolean;
     };
 }
+/**
+ * Bank-transfer project-level toggle returned by `/projects/config`.
+ *
+ * Only reflects the dashboard preference — the actual rails available for
+ * a given country live under `getBankTransferProviders()`.
+ */
+interface BankTransferConfig {
+    enabled: boolean;
+}
 /**
  * Get project configuration
  * @param publishableKey - Optional publishable key, defaults to configured key
@@ -1296,12 +1357,51 @@ declare enum DepositEventType {
 declare enum WithdrawEventType {
     DIRECT_EXECUTION_SUCCEEDED = "direct_execution.succeeded"
 }
+/** Event types emitted by the checkout flow. */
+declare enum CheckoutEventType {
+    PAYMENT_INTENT_SUCCEEDED = "payment_intent.succeeded"
+}
 /** Funding method used by a deposit flow. */
 type DepositMethod = "transfer" | "card" | "cashapp" | "pay_with_exchange" | "exchange_connect" | "wallet_connect";
+/** Funding method used by a checkout flow. */
+type CheckoutMethod = "transfer" | "wallet_connect";
 /** `data.object` payload for {@link DepositEventType.ONRAMP_SESSION_CREATED} */
 interface OnrampSessionCreatedData {
     externalId: string;
 }
+/**
+ * Callback-facing payment intent object.
+ * Mirrors the field-naming conventions used by {@link DirectExecution}
+ * (camelCase, `BaseUnit` / `Usd` amount suffixes, `failureReason`, no currency
+ * code or decimals — derive those from `*TokenAddress` if needed).
+ */
+interface CheckoutPaymentIntent {
+    id: string;
+    status: "succeeded";
+    recipientAddress: string;
+    destinationChainType: string;
+    destinationChainId: string;
+    destinationTokenAddress: string;
+    destinationAmountBaseUnit: string;
+    destinationAmountUsd: string;
+    destinationAmountReceivedBaseUnit: string;
+    destinationAmountReceivedUsd: string;
+    sourceChainType: string | null;
+    sourceChainId: string | null;
+    sourceTokenAddress: string | null;
+    sourceAmountBaseUnit: string | null;
+    sourceAmountUsd: string | null;
+    sourceAmountReceivedBaseUnit: string | null;
+    sourceAmountReceivedUsd: string | null;
+    /** Atomic payout (pool → recipient) hash. Locked-quote only; null until broadcast. */
+    transactionHash: string | null;
+    failureReason: string | null;
+}
+/**
+ * `data.object` payload for {@link CheckoutEventType.PAYMENT_INTENT_SUCCEEDED}.
+ * @deprecated Use {@link CheckoutPaymentIntent} — kept as an alias for back-compat.
+ */
+type CheckoutPaymentIntentData = CheckoutPaymentIntent;
 /**
  * Callback-facing direct execution object.
  * Intentionally separate from legacy `DirectExecutionResponse` naming.
@@ -1334,6 +1434,10 @@ interface DepositEventDataMap {
 interface WithdrawEventDataMap {
     [WithdrawEventType.DIRECT_EXECUTION_SUCCEEDED]: DirectExecution;
 }
+/** Map from event type to its `data.object` shape */
+interface CheckoutEventDataMap {
+    [CheckoutEventType.PAYMENT_INTENT_SUCCEEDED]: CheckoutPaymentIntent;
+}
 /**
  * Event envelope emitted by the deposit flow, inspired by the server-side
  * webhook payload shape: top-level metadata (`id`, `type`, `created`) with
@@ -1370,6 +1474,18 @@ type WithdrawEvent = {
         };
     };
 }[WithdrawEventType];
+/** Event envelope emitted by the checkout flow. */
+type CheckoutEvent = {
+    [K in CheckoutEventType]: {
+        id: string;
+        type: K;
+        created: number;
+        method?: CheckoutMethod;
+        data: {
+            object: CheckoutEventDataMap[K];
+        };
+    };
+}[CheckoutEventType];
 /** Convenience type for a fully-typed `onramp_session.created` event */
 type OnrampSessionCreatedEvent = Extract<DepositEvent, {
     type: DepositEventType.ONRAMP_SESSION_CREATED;
@@ -1385,6 +1501,10 @@ type DirectExecutionSucceededEvent = Extract<DepositEvent, {
 type WithdrawDirectExecutionSucceededEvent = Extract<WithdrawEvent, {
     type: WithdrawEventType.DIRECT_EXECUTION_SUCCEEDED;
 }>;
+/** Convenience type for a fully-typed `payment_intent.succeeded` checkout event */
+type CheckoutPaymentIntentSucceededEvent = Extract<CheckoutEvent, {
+    type: CheckoutEventType.PAYMENT_INTENT_SUCCEEDED;
+}>;
 
 /**
  * User IP information interface
@@ -1508,4 +1628,4 @@ declare const i18n: {
 };
 type I18nStrings = typeof i18n;
 
-export { ActionType, type AddressBalanceResponse, type AddressBalancesResponse, type AddressValidationFailureCode, type AddressValidationMetadata, type AuthenticateOAuthResult, type AutoSwapRequest, type AutoSwapResponse, type BlockedCountrySubdivision, type BuildHypercoreTransactionRequest, type BuildHypercoreTransactionResponse, type BuildSolanaTransactionRequest, type BuildSolanaTransactionResponse, type CashAppLimits, type CashAppSessionRequest, type CashAppSessionResponse, type CashAppSessionStatusResponse, type ChainType, type ConfirmIntegrationTransferResult, type CreateDepositAddressRequest, type CreateExchangeSessionRequest, type CreateExchangeSessionResponse, type CreateIntegrationTransferParams, type CreateIntegrationTransferResult, type DefaultTokenChain, type DefaultTokenMetadata, type DefaultTokenResponse, type DepositAddressResponse, type DepositEvent, DepositEventType, type DepositMethod, type DepositQuote, type DepositQuoteRequest, type DestinationToken, type DestinationTokenChain, type DirectExecution, type DirectExecutionResponse, type DirectExecutionSucceededEvent, type EvmContractCall, type ExchangeProviderInfo, type ExchangeProvidersResponse, type ExchangeSessionStartParams, type ExchangeWalletAddress, ExecutionStatus, type ExternalWalletChainType, type ExternalWalletInfo, type ExternalWalletsResponse, type FeaturedToken, type FeaturedWallet, type FiatCurrenciesResponse, type FiatCurrency, type GetExchangesQuery, type HypercoreActivationRequest, type HypercoreActivationResponse, type I18nStrings, type IconUrl, IneligibilityReason, type IntegrationAccount, type IntegrationExchangeInfo, type IntegrationExchangesResponse, type IntegrationFeeAmount, type IntegrationHoldingsResponse, IntegrationProvider, type IpAddressResponse, type LockedQuoteLimits, type LockedQuotePreview, type LockedQuotePreviewRequest, type OnrampQuote, type OnrampQuotesRequest, type OnrampQuotesResponse, type OnrampSessionCreatedData, type OnrampSessionCreatedEvent, type OnrampSessionRequest, type OnrampSessionResponse, type PaymentIntent, type PaymentIntentDepositAddress, type PaymentIntentExecutionsResponse, type PaymentIntentStatus, type PaymentIntentType, type PaymentNetwork, type PollExecutionsRequest, type PollExecutionsResponse, type ProductType, type ProjectConfigResponse, type QueryExecutionsRequest, type QueryExecutionsResponse, type RefreshIntegrationTokenResult, SOLANA_USDC_ADDRESS, type SendHypercoreTransactionRequest, type SendHypercoreTransactionResponse, type SendSolanaTransactionRequest, type SendSolanaTransactionResponse, type SourceToken, type SourceTokenNetwork, type StartIntegrationOAuthResult, type SupportedChain, type SupportedDepositTokensResponse, type SupportedDestinationTokensResponse, type SupportedSourceTokensQuery, type SupportedSourceTokensResponse, type SupportedToken, type TokenBalance, type TokenChain, type TokenChainIconUrl, type TokenChainsResponse, type TokenIconUrl, type TokenInfo, type TokenMetadata, type TransferDefaultTokenParams, type TransferDefaultTokenResult, type UserIpInfo, type VerifyAddressRequest, type VerifyAddressResponse, type Wallet, type WalletMobileDeepLinkDepositAddress, type WalletMobileDeepLinkResponse, type WalletMobileDeepLinkWallet, type WithdrawDirectExecutionSucceededEvent, type WithdrawEvent, WithdrawEventType, authenticateIntegrationOAuth, buildHypercoreTransaction, buildSolanaTransaction, checkHypercoreActivation, confirmIntegrationTransfer, createCashAppSession, createDepositAddress, createExchangeSession, createIntegrationTransfer, createOnrampSession, formatStablecoinAmount, generateKSUID, generatePrefixedKSUID, getAddressBalance, getAddressBalances, getApiBaseUrl, getCashAppLimits, getCashAppSessionStatus, getChainName, getDefaultOnrampToken, getDepositAddress, getDepositQuote, getExchangeSessionStartUrl, getExchanges, getExternalWallets, getFiatCurrencies, getIconUrl, getIconUrlWithCdn, getIntegrationExchanges, getIntegrationHoldings, getIntegrationTransferDefaultToken, getIpAddress, getOnrampQuotes, getOnrampSessionStartUrl, getPreferredIconUrl, getProjectConfig, getSupportedDepositTokens, getSupportedDestinationTokens, getTokenChains, getTokenMetadata, getWalletByChainType, getWalletMobileDeepLink, i18n, listPaymentIntentExecutions, pollDirectExecutions, queryExecutions, refreshIntegrationToken, retrievePaymentIntent, revokeIntegrationToken, sendHypercoreTransaction, sendSolanaTransaction, setApiConfig, startIntegrationOAuth, useUserIp, verifyRecipientAddress };
+export { ActionType, type AddressBalanceResponse, type AddressBalancesResponse, type AddressValidationFailureCode, type AddressValidationMetadata, type AuthenticateOAuthResult, type AutoSwapRequest, type AutoSwapResponse, type BankTransferConfig, type BankTransferProvider, type BankTransferProvidersResponse, type BlockedCountrySubdivision, type BuildHypercoreTransactionRequest, type BuildHypercoreTransactionResponse, type BuildSolanaTransactionRequest, type BuildSolanaTransactionResponse, type CashAppLimits, type CashAppSessionRequest, type CashAppSessionResponse, type CashAppSessionStatusResponse, type ChainType, type CheckoutEvent, CheckoutEventType, type CheckoutMethod, type CheckoutPaymentIntent, type CheckoutPaymentIntentData, type CheckoutPaymentIntentSucceededEvent, type ConfirmIntegrationTransferResult, type CreateDepositAddressRequest, type CreateExchangeSessionRequest, type CreateExchangeSessionResponse, type CreateIntegrationTransferParams, type CreateIntegrationTransferResult, type DefaultTokenChain, type DefaultTokenMetadata, type DefaultTokenResponse, type DepositAddressResponse, type DepositEvent, DepositEventType, type DepositMethod, type DepositQuote, type DepositQuoteRequest, type DestinationToken, type DestinationTokenChain, type DirectExecution, type DirectExecutionResponse, type DirectExecutionSucceededEvent, type EvmContractCall, type ExchangeProviderInfo, type ExchangeProvidersResponse, type ExchangeSessionStartParams, type ExchangeWalletAddress, ExecutionStatus, type ExternalWalletChainType, type ExternalWalletInfo, type ExternalWalletsResponse, type FeaturedToken, type FeaturedWallet, type FiatCurrenciesResponse, type FiatCurrency, type GetBankTransferProvidersOptions, type GetExchangesQuery, type HypercoreActivationRequest, type HypercoreActivationResponse, type I18nStrings, type IconUrl, IneligibilityReason, type IntegrationAccount, type IntegrationExchangeInfo, type IntegrationExchangesResponse, type IntegrationFeeAmount, type IntegrationHoldingsResponse, IntegrationProvider, type IpAddressResponse, type LockedQuoteLimits, type LockedQuotePreview, type LockedQuotePreviewRequest, type OnrampQuote, type OnrampQuotesRequest, type OnrampQuotesResponse, type OnrampSessionCreatedData, type OnrampSessionCreatedEvent, type OnrampSessionPaymentMethod, type OnrampSessionRequest, type OnrampSessionResponse, type PaymentIntent, type PaymentIntentDepositAddress, type PaymentIntentExecutionsResponse, type PaymentIntentStatus, type PaymentIntentType, type PaymentNetwork, type PollExecutionsRequest, type PollExecutionsResponse, type ProductType, type ProjectConfigResponse, type QueryExecutionsRequest, type QueryExecutionsResponse, type RefreshIntegrationTokenResult, SOLANA_USDC_ADDRESS, type SendHypercoreTransactionRequest, type SendHypercoreTransactionResponse, type SendSolanaTransactionRequest, type SendSolanaTransactionResponse, type SourceToken, type SourceTokenNetwork, type StartIntegrationOAuthResult, type SupportedChain, type SupportedDepositTokensResponse, type SupportedDestinationTokensResponse, type SupportedSourceTokensQuery, type SupportedSourceTokensResponse, type SupportedToken, type TokenBalance, type TokenChain, type TokenChainIconUrl, type TokenChainsResponse, type TokenIconUrl, type TokenInfo, type TokenMetadata, type TransferDefaultTokenParams, type TransferDefaultTokenResult, type UserIpInfo, type VerifyAddressRequest, type VerifyAddressResponse, type Wallet, type WalletMobileDeepLinkDepositAddress, type WalletMobileDeepLinkResponse, type WalletMobileDeepLinkWallet, type WithdrawDirectExecutionSucceededEvent, type WithdrawEvent, WithdrawEventType, authenticateIntegrationOAuth, buildHypercoreTransaction, buildSolanaTransaction, checkHypercoreActivation, confirmIntegrationTransfer, createCashAppSession, createDepositAddress, createExchangeSession, createIntegrationTransfer, createOnrampSession, formatStablecoinAmount, generateKSUID, generatePrefixedKSUID, getAddressBalance, getAddressBalances, getApiBaseUrl, getBankTransferProviders, getCashAppLimits, getCashAppSessionStatus, getChainName, getDefaultOnrampToken, getDepositAddress, getDepositQuote, getExchangeSessionStartUrl, getExchanges, getExternalWallets, getFiatCurrencies, getIconUrl, getIconUrlWithCdn, getIntegrationExchanges, getIntegrationHoldings, getIntegrationTransferDefaultToken, getIpAddress, getOnrampQuotes, getOnrampSessionStartUrl, getPreferredIconUrl, getProjectConfig, getSupportedDepositTokens, getSupportedDestinationTokens, getTokenChains, getTokenMetadata, getWalletByChainType, getWalletMobileDeepLink, i18n, listPaymentIntentExecutions, pollDirectExecutions, queryExecutions, refreshIntegrationToken, retrievePaymentIntent, revokeIntegrationToken, sendHypercoreTransaction, sendSolanaTransaction, setApiConfig, startIntegrationOAuth, useUserIp, verifyRecipientAddress };

package/dist/index.js

@@ -21,6 +21,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   ActionType: () => ActionType,
+  CheckoutEventType: () => CheckoutEventType,
   DepositEventType: () => DepositEventType,
   ExecutionStatus: () => ExecutionStatus,
   IneligibilityReason: () => IneligibilityReason,
@@ -43,6 +44,7 @@ __export(index_exports, {
   getAddressBalance: () => getAddressBalance,
   getAddressBalances: () => getAddressBalances,
   getApiBaseUrl: () => getApiBaseUrl,
+  getBankTransferProviders: () => getBankTransferProviders,
   getCashAppLimits: () => getCashAppLimits,
   getCashAppSessionStatus: () => getCashAppSessionStatus,
   getChainName: () => getChainName,
@@ -437,6 +439,29 @@ async function createOnrampSession(request, publishableKey) {
   }
   return response.json();
 }
+async function getBankTransferProviders(publishableKey, options = {}) {
+  const pk = publishableKey || DEFAULT_PUBLISHABLE_KEY;
+  validatePublishableKey(pk);
+  const params = new URLSearchParams();
+  if (options.countryCode) {
+    params.set("country_code", options.countryCode);
+  }
+  const queryString = params.toString();
+  const url = `${API_BASE_URL}/v1/public/onramps/bank_transfer/providers${queryString ? `?${queryString}` : ""}`;
+  const response = await fetch(url, {
+    method: "GET",
+    headers: {
+      accept: "application/json",
+      "x-publishable-key": pk
+    }
+  });
+  if (!response.ok) {
+    throw new Error(
+      `Failed to fetch bank-transfer providers: ${response.statusText}`
+    );
+  }
+  return response.json();
+}
 function getOnrampSessionStartUrl(request, publishableKey) {
   const params = new URLSearchParams();
   params.append("publishable_key", publishableKey);
@@ -454,6 +479,9 @@ function getOnrampSessionStartUrl(request, publishableKey) {
   if (request.email) {
     params.append("email", request.email);
   }
+  if (request.payment_method) {
+    params.append("payment_method", request.payment_method);
+  }
   return `${API_BASE_URL}/v1/public/onramps/sessions/start?${params.toString()}`;
 }
 async function getDefaultOnrampToken(params, publishableKey) {
@@ -1110,6 +1138,10 @@ var WithdrawEventType = /* @__PURE__ */ ((WithdrawEventType2) => {
   WithdrawEventType2["DIRECT_EXECUTION_SUCCEEDED"] = "direct_execution.succeeded";
   return WithdrawEventType2;
 })(WithdrawEventType || {});
+var CheckoutEventType = /* @__PURE__ */ ((CheckoutEventType2) => {
+  CheckoutEventType2["PAYMENT_INTENT_SUCCEEDED"] = "payment_intent.succeeded";
+  return CheckoutEventType2;
+})(CheckoutEventType || {});
 
 // src/hooks/use-user-ip.ts
 var import_react_query = require("@tanstack/react-query");
@@ -1245,6 +1277,7 @@ var i18n = en_default;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ActionType,
+  CheckoutEventType,
   DepositEventType,
   ExecutionStatus,
   IneligibilityReason,
@@ -1267,6 +1300,7 @@ var i18n = en_default;
   getAddressBalance,
   getAddressBalances,
   getApiBaseUrl,
+  getBankTransferProviders,
   getCashAppLimits,
   getCashAppSessionStatus,
   getChainName,

package/dist/index.mjs

@@ -350,6 +350,29 @@ async function createOnrampSession(request, publishableKey) {
   }
   return response.json();
 }
+async function getBankTransferProviders(publishableKey, options = {}) {
+  const pk = publishableKey || DEFAULT_PUBLISHABLE_KEY;
+  validatePublishableKey(pk);
+  const params = new URLSearchParams();
+  if (options.countryCode) {
+    params.set("country_code", options.countryCode);
+  }
+  const queryString = params.toString();
+  const url = `${API_BASE_URL}/v1/public/onramps/bank_transfer/providers${queryString ? `?${queryString}` : ""}`;
+  const response = await fetch(url, {
+    method: "GET",
+    headers: {
+      accept: "application/json",
+      "x-publishable-key": pk
+    }
+  });
+  if (!response.ok) {
+    throw new Error(
+      `Failed to fetch bank-transfer providers: ${response.statusText}`
+    );
+  }
+  return response.json();
+}
 function getOnrampSessionStartUrl(request, publishableKey) {
   const params = new URLSearchParams();
   params.append("publishable_key", publishableKey);
@@ -367,6 +390,9 @@ function getOnrampSessionStartUrl(request, publishableKey) {
   if (request.email) {
     params.append("email", request.email);
   }
+  if (request.payment_method) {
+    params.append("payment_method", request.payment_method);
+  }
   return `${API_BASE_URL}/v1/public/onramps/sessions/start?${params.toString()}`;
 }
 async function getDefaultOnrampToken(params, publishableKey) {
@@ -1023,6 +1049,10 @@ var WithdrawEventType = /* @__PURE__ */ ((WithdrawEventType2) => {
   WithdrawEventType2["DIRECT_EXECUTION_SUCCEEDED"] = "direct_execution.succeeded";
   return WithdrawEventType2;
 })(WithdrawEventType || {});
+var CheckoutEventType = /* @__PURE__ */ ((CheckoutEventType2) => {
+  CheckoutEventType2["PAYMENT_INTENT_SUCCEEDED"] = "payment_intent.succeeded";
+  return CheckoutEventType2;
+})(CheckoutEventType || {});
 
 // src/hooks/use-user-ip.ts
 import { useQuery } from "@tanstack/react-query";
@@ -1157,6 +1187,7 @@ var en_default = {
 var i18n = en_default;
 export {
   ActionType,
+  CheckoutEventType,
   DepositEventType,
   ExecutionStatus,
   IneligibilityReason,
@@ -1179,6 +1210,7 @@ export {
   getAddressBalance,
   getAddressBalances,
   getApiBaseUrl,
+  getBankTransferProviders,
   getCashAppLimits,
   getCashAppSessionStatus,
   getChainName,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unifold/core",
-  "version": "0.1.67",
+  "version": "0.1.68-beta.0",
   "description": "Unifold Core SDK - Core types, API client, and business logic",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",