Verestro Paytool Client SDK
    Preparing search index...

    Interface EmbedError

    Error object emitted by CardFormEmbed.pay when a payment fails or the user cancels (if cancellation is allowed).

    interface EmbedError {
        final: boolean;
        reason: string;
        status: "COMPLETED" | "FAILED" | "IN_PROGRESS";
        success: boolean;
        transactionId: string;
    }
    Index

    Properties

    final reason status success transactionId

    Properties

    final: boolean

    Determines whether the payment can be retried or not. If true, you must create a new transaction ID to retry.

    This property will be removed in a future release. Prefer using EmbedError.status to decide on next steps.

    reason: string

    User-legible reason.

    status: "COMPLETED" | "FAILED" | "IN_PROGRESS"

    Normalized transaction status. Matches EmbedPayResult.status values for consistency.

    success: boolean = false

    Always false.

    This property will be removed in a future release. Use EmbedError.status and the fact that this is an EmbedError to branch error handling.

    transactionId: string

    Transaction id for the error.

    Settings

    Member Visibility

    On This Page

    Properties