Skip to main content

HostedFormUIOptions

Every text the hosted form displays, plus the handful of layout switches that travel with them.

This mirrors HostedFormUIOptions from @upstreampay/partner-ui key for key, so a merchant already integrating the widget can hand the exact same object to Secure Fields. Keys for payment methods Secure Fields does not collect (iban*, email*, phone*, consent*, loanSimulation) are accepted and ignored — they exist so a shared text bag type-checks against both products.

Every key is optional: DEFAULT_HOSTED_FORM_TEXTS fills the gaps.

Properties​

birthdateCannotBeEmptyError?​

optional birthdateCannotBeEmptyError?: string;

Deprecated​

use birthdateRequiredError

birthdateFormatError?​

optional birthdateFormatError?: string;

birthdateInputLabel?​

optional birthdateInputLabel?: string;

birthdateOutOfRangeError?​

optional birthdateOutOfRangeError?: string;

birthdatePlaceholder?​

optional birthdatePlaceholder?: string;

birthdateRequiredError?​

optional birthdateRequiredError?: string;

birthdateTooltipText?​

optional birthdateTooltipText?: string;

brandLabels?​

optional brandLabels?: object;

Overrides the displayed name of one or more card brands.

NameType
AMERICAN_EXPRESS?string
CARTE_BANCAIRE?string
DINERS_CLUB?string
DISCOVER?string
JCB?string
MAESTRO?string
MASTERCARD?string
ONEY?string
UNIONPAY?string
VISA?string

brandSelectionMode?​

optional brandSelectionMode?: "implicit" | "explicit" | "hidden";
  • implicit — the detected brand is shown as a badge inside the card number field, with a native select over it for co-badged cards. This is the default.
  • explicit — a labelled select on its own row below the form.
  • hidden — no selector is rendered; listen to brandDetected and pass selectedNetwork to submit() yourself.

consentInputLabel?​

optional consentInputLabel?: string;

consentRequiredError?​

optional consentRequiredError?: string;

consentText?​

optional consentText?: string;

cvv4InputLabel?​

optional cvv4InputLabel?: string;

Accepted and ignored — see HostedFormUIOptions.cvv4Placeholder.

cvv4Placeholder?​

optional cvv4Placeholder?: string;

Accepted and ignored. In the widget these only reach Adyen's own card component, which owns the 3 vs 4 digit switch; the Purse hosted fields path labels a 4 digit code "CVV" like any other, and Secure Fields matches it.

cvvCannotBeEmptyError?​

optional cvvCannotBeEmptyError?: string;

Deprecated​

use cvvRequiredError

cvvFormatError?​

optional cvvFormatError?: string;

cvvInputLabel?​

optional cvvInputLabel?: string;

cvvPlaceholder?​

optional cvvPlaceholder?: string;

cvvRequiredError?​

optional cvvRequiredError?: string;

cvvTooltipText?​

optional cvvTooltipText?: string;

emailCannotBeEmptyError?​

optional emailCannotBeEmptyError?: string;

Deprecated​

use emailRequiredError

emailFormatError?​

optional emailFormatError?: string;

emailInputLabel?​

optional emailInputLabel?: string;

emailPlaceholder?​

optional emailPlaceholder?: string;

emailRequiredError?​

optional emailRequiredError?: string;

expirationCannotBeEmptyError?​

optional expirationCannotBeEmptyError?: string;

Deprecated​

use expirationRequiredError

expirationFormatError?​

optional expirationFormatError?: string;

expirationInputLabel?​

optional expirationInputLabel?: string;

expirationOutOfRangeError?​

optional expirationOutOfRangeError?: string;

expirationPlaceholder?​

optional expirationPlaceholder?: string;

expirationRequiredError?​

optional expirationRequiredError?: string;

expirationTooltipText?​

optional expirationTooltipText?: string;

explicitBrandText?​

optional explicitBrandText?: string;

Label of the select rendered in explicit mode.

hideHolderName?​

optional hideHolderName?: boolean;

When true the cardholder name field is not rendered and not required.

holderCannotBeEmptyError?​

optional holderCannotBeEmptyError?: string;

Deprecated​

use holderRequiredError

holderFormatError?​

optional holderFormatError?: string;

holderInputLabel?​

optional holderInputLabel?: string;

holderPlaceholder?​

optional holderPlaceholder?: string;

holderRequiredError?​

optional holderRequiredError?: string;

ibanCannotBeEmptyError?​

optional ibanCannotBeEmptyError?: string;

Deprecated​

use ibanRequiredError

ibanFormatError?​

optional ibanFormatError?: string;

ibanInputLabel?​

optional ibanInputLabel?: string;

ibanPlaceholder?​

optional ibanPlaceholder?: string;

ibanRequiredError?​

optional ibanRequiredError?: string;

loanSimulation?​

optional loanSimulation?: string;

noCVV?​

optional noCVV?: boolean;

When true the CVV field is not rendered and not required.

panCannotBeEmptyError?​

optional panCannotBeEmptyError?: string;

Deprecated​

use panRequiredError

panFormatError?​

optional panFormatError?: string;

panInputLabel?​

optional panInputLabel?: string;

panPlaceholder?​

optional panPlaceholder?: string;

panRequiredError?​

optional panRequiredError?: string;

panTooltipText?​

optional panTooltipText?: string;

phoneCannotBeEmptyError?​

optional phoneCannotBeEmptyError?: string;

Deprecated​

use phoneRequiredError

phoneFormatError?​

optional phoneFormatError?: string;

phoneInputLabel?​

optional phoneInputLabel?: string;

phonePlaceholder?​

optional phonePlaceholder?: string;

phoneRequiredError?​

optional phoneRequiredError?: string;