@stripe/stripe-terminal-react-native
    Preparing search index...

    Interface ApiErrorInformation

    API-level error information, unified across platforms.

    Sources:

    • TerminalException.apiError (both platforms)
    • PaymentIntent.lastPaymentError (both platforms, ApiError / SCPApiError)
    • SetupIntent.lastSetupError (both platforms, ApiError / SCPApiError)
    • SetupAttempt.setupError (Android: SetupError, iOS: SCPApiError)

    Android's SetupError is a distinct type from ApiError — it adds paymentMethod and paymentMethodType but lacks charge and requestLogUrl.

    interface ApiErrorInformation {
        adviceCode?: string;
        charge?: string;
        code: string;
        declineCode: string;
        docUrl?: string;
        message: string;
        networkAdviceCode?: string;
        networkDeclineCode?: string;
        param?: string;
        paymentMethod?: PaymentMethod.Type;
        paymentMethodType?: string;
        requestLogUrl?: string;
        type?: string;
    }
    Index

    Properties

    adviceCode? charge? code declineCode docUrl? message networkAdviceCode? networkDeclineCode? param? paymentMethod? paymentMethodType? requestLogUrl? type?

    Properties

    adviceCode?: string

    Advice code providing additional context about the error (optional)

    charge?: string

    Charge ID (optional)

    code: string

    API error code

    declineCode: string

    Decline code (payment-specific)

    docUrl?: string

    Documentation URL (optional)

    message: string

    API error message

    networkAdviceCode?: string

    Network-level advice code (optional)

    networkDeclineCode?: string

    Network-level decline code (optional)

    param?: string

    Related parameter name (optional)

    paymentMethod?: PaymentMethod.Type

    Payment method associated with this error (Android SetupError only)

    paymentMethodType?: string

    Payment method type string (Android SetupError only)

    requestLogUrl?: string

    URL to the Stripe request log entry for this API call (optional)

    type?: string

    Error type (optional)

    Settings

    Member Visibility

    On This Page

    Properties