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

Properties

final: boolean

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

Deprecated

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.

Deprecated

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.