@stripe/stripe-react-native/lib/typescript/src/hooks/useOnramp.d.ts

Stripe SDK for React Native

import { Onramp, OnrampError, StripeError } from '../types';
import type { Address, PlatformPay } from '../types';
import { CryptoPaymentToken } from '../types/Onramp';
/**
 * useOnramp hook
 */
export declare function useOnramp(): {
    /**
     * Creates a `CryptoOnrampCoordinator` to facilitate authentication, identity verification, payment collection, and checkouts.
     *
     * @param config Configuration object containing merchant display name and appearance settings
     * @returns Promise that resolves to an object with an optional error property
     */
    configure: (config: Onramp.Configuration) => Promise<{
        error?: StripeError<OnrampError>;
    }>;
    /**
     * Whether or not the provided email is associated with an existing Link consumer.
     *
     * @param email The email address to look up
     * @returns Promise that resolves to an object with hasLinkAccount boolean or error
     */
    hasLinkAccount: (email: string) => Promise<Onramp.HasLinkAccountResult>;
    /**
     * Registers a new Link user with the provided details.
     *
     * @param info User information including email, phone, country, and optional full name
     * @returns Promise that resolves to an object with customerId or error
     */
    registerLinkUser: (info: Onramp.LinkUserInfo) => Promise<Onramp.RegisterLinkUserResult>;
    /**
     * Registers the given crypto wallet address to the current Link account.
     * Requires an authenticated Link user.
     *
     * @param walletAddress The crypto wallet address to register
     * @param network The crypto network for the wallet address
     * @returns Promise that resolves to an object with an optional error property
     */
    registerWalletAddress: (walletAddress: string, network: Onramp.CryptoNetwork) => Promise<{
        error?: StripeError<OnrampError>;
    }>;
    /**
     * Attaches the specific KYC info to the current Link user. Requires an authenticated Link user.
     *
     * @param kycInfo The KYC info to attach to the Link user
     * @returns Promise that resolves to an object with an optional error property
     */
    attachKycInfo: (kycInfo: Onramp.KycInfo) => Promise<{
        error?: StripeError<OnrampError>;
    }>;
    /**
     * Presents UI to verify KYC information for the current Link user.
     * Requires the user to be authenticated with prior calls to either `authenticateUser` or `authorize`, and also requires prior KYC info attachement via `attachKycInfo`.
     *
     * @param updatedAddress: An optional updated address. Specify this parameter if the user has elected to change the address after a prior call to this API returned `UpdateAddress`. Otherwise, specify `null` to show the user's existing KYC information on the presented flow.
     *
     * @returns Promise that resolves to an instance of `VerifyKycResult` indicating whether the user confirmed their address, elected to update their address, cancelled the flow, or an error occurred.
     */
    presentKycInfoVerification: (updatedAddress: Address | null) => Promise<Onramp.VerifyKycResult>;
    /**
     * Updates the user's phone number in their Link account.
     *
     * @param phone The new phone number to set for the user in E.164 format (e.g., +12125551234)
     * @returns Promise that resolves to an object with an optional error property
     */
    updatePhoneNumber: (phone: string) => Promise<{
        error?: StripeError<OnrampError>;
    }>;
    /**
     * Presents Link UI to authenticate an existing Link user.
     * `hasLinkAccount` must be called before this.
     *
     * @returns Promise that resolves to an object with customerId or error
     */
    authenticateUser: () => Promise<Onramp.AuthenticateUserResult>;
    /**
     * Authenticates the user with an encrypted Link auth token.
     * This token can be obtained by exchanging a previously consented Link OAuth token from your backend using Stripe's /v1/link/auth_token API. The response of this backend API includes information on token expiry.
     *
     * @param linkAuthTokenClientSecret An encrypted one-time-use auth token that, upon successful validation, leaves the Link account’s consumer session in an already-verified state, allowing the client to skip verification.
     * @returns Promise that resolves to an object with an optional error property if authentication fails due to an invalid token that is expired, already used, revoked, or not found, or if a network error occurs.
     */
    authenticateUserWithToken: (linkAuthTokenClientSecret: string) => Promise<{
        error?: StripeError<OnrampError>;
    }>;
    /**
     * Creates an identity verification session and launches the document verification flow.
     * Requires an authenticated Link user.
     *
     * @returns Promise that resolves to an object with an optional error property
     */
    verifyIdentity: () => Promise<{
        error?: StripeError<OnrampError>;
    }>;
    /**
     * Presents UI to collect/select a payment method of the given type.
     *
     * @param paymentMethod The payment method type to collect.
     *  - 'Card' and 'BankAccount' present Link for collection.
     *  - 'PlatformPay' presents Apple Pay / Google Pay using the provided parameters.
     * @param platformPayParams Platform-specific parameters (required when `paymentMethod` is 'PlatformPay').
     *  - iOS: provide `applePay` params
     *  - Android: provide `googlePay` params
     * @returns Promise that resolves to an object with displayData or error
     */
    collectPaymentMethod: {
        (paymentMethod: "Card" | "BankAccount", platformPayParams?: undefined): Promise<Onramp.CollectPaymentMethodResult>;
        (paymentMethod: "PlatformPay", platformPayParams: PlatformPay.PaymentMethodParams): Promise<Onramp.CollectPaymentMethodResult>;
    };
    /**
     * Creates a crypto payment token for the payment method currently selected on the coordinator.
     * Call after a successful `collectPaymentMethod(...)`.
     *
     * @returns Promise that resolves to an object with cryptoPaymentToken or error
     */
    createCryptoPaymentToken: () => Promise<Onramp.CreateCryptoPaymentTokenResult>;
    /**
     * Performs the checkout flow for a crypto onramp session, handling any required authentication steps.
     *
     * @param onrampSessionId The onramp session identifier
     * @returns Promise that resolves to an object with an optional error property
     */
    performCheckout: (onrampSessionId: string, provideCheckoutClientSecret: () => Promise<string | null>) => Promise<{
        error?: StripeError<OnrampError>;
    }>;
    /**
     * Authorizes a Link auth intent and authenticates the user if necessary.
     *
     * @param linkAuthIntentId The Link auth intent ID to authorize
     * @returns Promise that resolves to an object with status and customerId or error
     */
    authorize: (linkAuthIntentId: string) => Promise<Onramp.AuthorizeResult>;
    /**
     * Retrieves display data (icon, label, sublabel) for the given payment method details.
     * Suitable for rendering in the UI to summarize the selected payment method.
     *
     * @param token The token containing payment method details (card or bank account) to get display data for
     * @returns Promise that resolves to an object with displayData or error
     */
    getCryptoTokenDisplayData: (token: CryptoPaymentToken) => Promise<Onramp.PaymentDisplayDataResult>;
    /**
     * Logs out the current user from their Link account.
     *
     * @returns Promise that resolves to an object with an optional error property
     */
    logOut: () => Promise<{
        error?: StripeError<OnrampError>;
    }>;
    /**
     * Determines whether an error is an authentication-related error that requires re-authentication.
     * Useful for implementing automatic re-authentication flows when sessions expire or become invalid.
     *
     * @param error The error object to check, typically from onramp method calls
     * @returns True if the error indicates an authentication issue, false otherwise
     */
    isAuthError: (error: any) => boolean;
};
//# sourceMappingURL=useOnramp.d.ts.map