Skip to content

RedirectingPaymentData

Options for a confirm that may need the customer to leave the page.

export interface RedirectingPaymentData extends ConfirmDataBase
NameTypeDescription
redirect?"always" | "if_required""always" (default) navigates the browser when the payment needs the customer elsewhere. "if_required" returns the transaction with nextAction set and leaves the navigation to you.
customer?CustomerDetailsThe customer paying.
metadata?Record<string, string>Sent with the payment and echoed back on transaction.metadata. Stored against the transaction, so not a place for anything sensitive.
paymentMethodCode?stringOverride the payment method code, such as PZW211 for EcoCash USD. Leave it unset: the SDK picks it from the card’s brand, or from the element’s provider and the transaction’s currency.
signal?AbortSignalAbandons the confirm. Resolves with an outcome_unknown error rather than throwing: a payment already sent cannot be recalled.