Skip to main content

ThreeDSFingerprintOptions

Options for threeDSFingerprint.

Extends

Properties

completion?

optional completion?: ThreeDSCompletion;

How the iframe reports completion. Required for a challenge — there is no other way to know the cardholder is done.

Inherited from

ThreeDSFrameOptionsBase.completion


container?

optional container?: string | HTMLElement;

Where the hidden iframe is attached: an element id or the element itself. Defaults to document.body.


fields?

optional fields?: Record<string, string>;

Form fields to post, one hidden input per entry.

Inherited from

ThreeDSFrameOptionsBase.fields


frameName?

optional frameName?: string;

name and id given to the iframe. Defaults to a unique per-call name; set it only if you need to find the frame yourself.

Inherited from

ThreeDSFrameOptionsBase.frameName


keepFrame?

optional keepFrame?: boolean;

Keeps the iframe and its form in the DOM after settling. Off by default — leaving 3DS frames behind is what leaks memory across retries.

Inherited from

ThreeDSFrameOptionsBase.keepFrame


resolveAfterLoads?

optional resolveAfterLoads?: number;

How many navigations of the iframe count as "done".

The EMVCo 3DS Method navigates twice: the ACS fingerprinting page, then its auto-submitted form to the notification URL. Hence the default of 2. Set 1 for a provider whose collection endpoint answers in a single response.


signal?

optional signal?: AbortSignal;

Aborts the flow: the iframe is torn down and the promise resolves with status: 'aborted'.

Inherited from

ThreeDSFrameOptionsBase.signal


threeDSMethodData?

optional threeDSMethodData?: string;

EMVCo alias for fields — posted as a single threeDSMethodData field.


threeDSMethodUrl?

optional threeDSMethodUrl?: string;

EMVCo alias for url — the ACS 3DS Method endpoint from the versioning response.


timeoutMs?

optional timeoutMs?: number;

Hard stop, in milliseconds. Defaults to 10_000 — the EMVCo 3DS Method rule.


url?

optional url?: string;

Endpoint the form is posted to. Must be http: or https:.

Inherited from

ThreeDSFrameOptionsBase.url