Skip to main content

PurseHeadlessCheckoutHostedFormUIOptions

Some partners displays a complete form and let you configure the text through a JS configuration. We've mapped those texts and let you override all off them form this single object. During a session, while displaying a form some of the variables might not be used, it depends on the context.

Properties​

birthdateCannotBeEmptyError?​

optional birthdateCannotBeEmptyError?: string;

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;

AMERICAN_EXPRESS?​

optional AMERICAN_EXPRESS?: string;

CARTE_BANCAIRE?​

optional CARTE_BANCAIRE?: string;

DINERS_CLUB?​

optional DINERS_CLUB?: string;

DISCOVER?​

optional DISCOVER?: string;

JCB?​

optional JCB?: string;

MAESTRO?​

optional MAESTRO?: string;

MASTERCARD?​

optional MASTERCARD?: string;

ONEY?​

optional ONEY?: string;

OTHER?​

optional OTHER?: string;

UNIONPAY?​

optional UNIONPAY?: string;

VISA?​

optional VISA?: string;

brandSelectionMode?​

optional brandSelectionMode?: "implicit" | "explicit" | "hidden";

implicit - Select in pan input with logo explicit - Conventional select on top of the form hidden - Hide the brand selector

consentInputLabel?​

optional consentInputLabel?: string;

consentRequiredError?​

optional consentRequiredError?: string;

consentText?​

optional consentText?: string;

This value is interpolated with {url:string} use {{variable}} to use interpolation

Example​

'Your will agree to the <a href={{url}} target="_blank">tos</a> '

cvv4InputLabel?​

optional cvv4InputLabel?: string;

label variant for cvv of length 4 (e.g. amex)

cvv4Placeholder?​

optional cvv4Placeholder?: string;

placeholder variant for cvv of length 4 (e.g. amex)

cvvCannotBeEmptyError?​

optional cvvCannotBeEmptyError?: string;

cvvFormatError?​

optional cvvFormatError?: string;

cvvInputLabel?​

optional cvvInputLabel?: string;

cvvPlaceholder?​

optional cvvPlaceholder?: string;

cvvRequiredError?​

optional cvvRequiredError?: string;

cvvTooltipText?​

optional cvvTooltipText?: string;

emailCannotBeEmptyError?​

optional emailCannotBeEmptyError?: string;

emailFormatError?​

optional emailFormatError?: string;

emailInputLabel?​

optional emailInputLabel?: string;

emailPlaceholder?​

optional emailPlaceholder?: string;

emailRequiredError?​

optional emailRequiredError?: string;

expirationCannotBeEmptyError?​

optional expirationCannotBeEmptyError?: string;

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;

hideHolderName?​

optional hideHolderName?: boolean;

When true, the cardholder name field is hidden and not required for payment. In hostedFields mode, either this must be true or hostedFields.fields.holderName.target must be defined.

holderCannotBeEmptyError?​

optional holderCannotBeEmptyError?: string;

holderFormatError?​

optional holderFormatError?: string;

holderInputLabel?​

optional holderInputLabel?: string;

holderPlaceholder?​

optional holderPlaceholder?: string;

holderRequiredError?​

optional holderRequiredError?: string;

ibanCannotBeEmptyError?​

optional ibanCannotBeEmptyError?: string;

ibanFormatError?​

optional ibanFormatError?: string;

ibanInputLabel?​

optional ibanInputLabel?: string;

ibanPlaceholder?​

optional ibanPlaceholder?: string;

ibanRequiredError?​

optional ibanRequiredError?: string;

loanSimulation?​

optional loanSimulation?: string;

This value is interpolated with:

  • first
  • monthly
  • nb
  • total
  • cost
  • taeg use {{variable}} to use interpolation

noCVV?​

optional noCVV?: boolean;

When true, the CVV field is hidden and not required for payment. Useful for payment methods that do not require CVV verification.

panCannotBeEmptyError?​

optional panCannotBeEmptyError?: string;

panFormatError?​

optional panFormatError?: string;

panInputLabel?​

optional panInputLabel?: string;

panPlaceholder?​

optional panPlaceholder?: string;

panRequiredError?​

optional panRequiredError?: string;

panTooltipText?​

optional panTooltipText?: string;

phoneCannotBeEmptyError?​

optional phoneCannotBeEmptyError?: string;

phoneFormatError?​

optional phoneFormatError?: string;

phoneInputLabel?​

optional phoneInputLabel?: string;

phonePlaceholder?​

optional phonePlaceholder?: string;

phoneRequiredError?​

optional phoneRequiredError?: string;