Hosted iFrame Tokenizer

The following entries describe changes to the Hosted iFrame Tokenizer and documentation.

Visit status.cardconnect.com and click subscribe to updates to receive important release and status notifications.

Date Updated: 7/26/2021

The changes below were deployed to the UAT environment on 6/25/2021 and later deployed to the production environment on 7/24/2021.

New Optional Parameters

A new sendcardtypingevent parameter is available in this release. If true, events are sent to the parent page when input to the Card Number field is detected and when the input has completed or timed out.

Additionally, a new selectinputdelay parameter is available and intended for mobile implementations where user input unexpectedly causes already populated fields to be cleared.

ParameterDefault ValueDescription
sendcardtypingeventfalse

If true, an event is sent to the parent page with 'cardTyping':true when the user begins entering a value into the Card Number field. When an onBlur event occurs or the inactivityto value has been met, the card number value is submitted for tokenization and an event is sent to the parent page with 'cardTyping':false.

An example of this event can viewed in the web browser's console on the following example page:
https://fts-uat.cardconnect.com/itoke/outer-page.html?sendcardtypingevent=true

selectinputdelay0

Note: This parameter is intended for iOS implementations where user input unexpectedly causes already populated fields to be cleared.

Controls how long (in milliseconds) to ignore input to a newly selected field after changing focus. The default value of 0 represents no delay in accepting input to a newly selected field, whereas the maximum value of 1000 represents a 1 second delay before accepting input to a newly selected field. A value of 100 is typically sufficient to avoid unintended clearing without interfering with the user experience.

Accessibility Enhancement

The iFrame Tokenizer now includes the for HTML attribute for all label HTML elements, containing a value that matches the name of the respective input field. This enhancement allows clicking on the label to focus the cursor on the label's respective input field.

Additionally, all input and select HTML elements now contain the aria-label attribute, containing a value that matches the value of the element's title for enhanced accessibility.

When no optional parameters are included to specify a custom title for input or select elements, the element's default title is used for the aria-label attribute. See the Input Labels section for information on the default values used.

You can view an example of the new for and aria-label attributes for the Card Number label and input field in a snippet of the iFrame source code below:

<label for="ccnumfield" id="cccardlabel">Card Number</label>
<input id="ccnumfield" type="tel" name="ccnumfield" size="19" maxlength="2000" autocomplete="off" title="Credit Card Number" aria-label="Credit Card Number">

Date Updated: 10/31/2020

The changes below were deployed to the UAT environment on 10/15/2020 and to the production environment on 10/31/2020. 

This release includes the changes described in the 3/6/2020 Update, which were previously deployed to the UAT environment only. The changes that are new to this release are outlined in the section below.

New Optional Parameters for Field Validation

The following optional URL parameters have been added to validate and return error messages for input to the Card Number, CVV, and Expiration Date fields:

ParameterDefault ValueDescription
invalidcreditcardeventfalse

If true, a 'message' event is sent to the parent page when the iFrame determines that the value for the Card Number field is invalid or empty.

The 'data' property in the event will contain an empty string, and the 'validationError' property will contain a description of the validation failure.

Note: This parameter should be used in place of invalidinputevent when enabling the usecvv or useexpiry parameters.

invalidcvveventfalse

If true, a 'message' event is sent to the parent page when the iFrame determines that the value for the CVV field is invalid or empty.

The 'data' property in the event will contain an empty string, and the 'validationError' property will contain a description of the validation failure.

Note: Requires usecvv=true.

invalidexpiryeventfalse

If true, a 'message' event is sent to the parent page when the iFrame determines that the value for the Expiration Date field is invalid or empty.

The 'data' property in the event will contain an empty string, and the 'validationError' property will contain a description of the validation failure.

Note: Requires useexpiry=true.

Date Updated: 3/6/2020

The following updates have been deployed only to the UAT environment on 3/6/2020, and will be deployed to the production environment at a future date.

URL Parameter Validation

This update includes additional validation to ensure that integrated iFrames are coded following standard best practices. Specifically, it is important that all special characters (including curly braces {} )provided within the iFrame URL parameters are properly URL-encoded, as described in iFrame Styling.

Failure to properly encode the URL string will result in iFrame display and rendering issues.

Additional CSS Support

The css parameter now supports custom colors for placeholder text, as well accepting CSS3 media queries for responsive design.

All arguments to the css parameter must be URL-encoded.

New Optional Parameters

The following optional parameters are new in this release:

ParameterDefault ValueDescription

cardinputmaxlength

2000Controls the maximum character limit for the card number field.

Note: Do not set cardinputmaxlength if using a USB card reader.
monthnamesJanuary-February-March-April-May-June-July-August-September-October-December

A string value to be used as alternative labels for each month in the drop-down list.

The alternative label for each month is separated by a hyphen, starting with the 1st month and ending with the 12th month.


Note: The alternative labels are used only when usemonthnames is true.
cardnumbernumericonlyfalse
If true, the card number field ignores non-numeric values.

maskfirsttwo

falseIf true, the first 2 digits of the card number are masked.

Support for iOS AutoFill Feature

Selecting the Card Number input field now triggers the native AutoFill feature on iOS devices when using Safari. This allows users to enter card data by selecting a card stored in the Wallet, or by using the device's camera scan a physical card.

Note: The ability to store or save card details in the browser remains disabled.

Additional Character Support for Placeholder Values

The maximum character limit for the placeholder parameter has been increased to 60 characters.

Support for the following accented and special characters has been added: Á, É, Í, Ñ, Ó, Ú, Ü, à, á, â, ä, ã, ā, ç ,è, é, ê, ē, í, î, ī, ñ, ó, ô, ö, ō, õ, ú, û, ü, ū, ß, ё, й, ъ, ы, э, щ.

Date Updated: 8/13/2019

This release includes the following updates:

Support for CVV and Expiry Fields

The iFrame Tokenizer now supports fields for capturing the CVV and Expiry values and storing these values in the token. Additionally, these fields can contain placeholder values.

See Examples for sample implementations including the CVV and Expiry fields.

The following URL parameters have been added to support this feature:

ParameterTypeDescription

useexpiry

BooleanIf true, includes two drop-down selectors to specify the expiration month (MM) and Year (YYYY).
useexpiryfieldBooleanIf true, uses displays entry fields instead of drop-down selectors.

The Month field supports 2-digit month values from 1-12 (including support for leading zeros for single-digit months, for example "01").

The Year field supports a 4-digit year value within the next 20 years (including the current year).
usemonthnamesBooleanIf true, displays Month names instead of numbers.

usecvv

BooleanIf true, includes a field to enter the Cardholder Verification Value (CVV).

Notes:

  • If usecvv is true, the CVV must be provided to initiate the tokenization request.
  • CVV is not masked. This value remains in clear text.
orientationAN

Controls the orientation of the elements within the iFrame.

Supported values are:

  • default - the default orientation, used if no value is passed for this parameter.
  • horizontal 
  • vertical 
  • custom 
cardlabelNControls the text inside the label for the card number field.

This label is only present when either useexpiry or usecvv are true.
expirylabelNControls the text inside the label for the expiration date selectors.

The label is only present when useexpiry is true.
cvvlabelNControls the text inside the label for the CVV field.

The label is only present when usecvv is true.
placeholdercvvNA placeholder value to display in the CVV field.

The placeholder value must be a 3 or 4-digit numeric value.
placeholdermonthNA placeholder value to display in the Month field, in the format MM.
placeholderyearNA placeholder value to display in the Year field, in the format YYYY.

Support for Screen Readers

Title tags have been added to the Card Number, Expiry, and CVV fields to enable compatibility with screen reader applications. These fields are now tagged with titles, which can be understood and read by screen reader applications for users with vision impairments.

The default title values are:

  • Credit Card Number - "Credit Card Number"
  • Expiry Month - "Expiration Month"
  • Expiry Year - "Expiration Year"
  • CVV - "Card Verification Value"

You can use the following URL parameters to customize the default titles:

ParameterTypeDescription
cardtitleANA meaningful custom title for the card number field.
expirymonthtitleANA meaningful custom title for the expiry month field.
expiryyeartitleANA meaningful custom title for the expiry year field.
cvvtitleANA meaningful custom title for the cvv field.

New Field IDs

The following Field IDs have been added in this release:

iFrame Element

ID

Card Number Labelcccardlabel
Card Number Fieldccnumfield
Expiry Labelccexpirylabel
Expiry Month Dropdownccexpirymonth
Expiry Year Dropdownccexpiryyear
Expiry Month Fieldccexpiryfieldmonth
Expiry Year Fieldccexpiryfieldyear
CVV Labelcccvvlabel
CVV Fieldcccvvfield

Clear Fields when Modified

After a token is returned, if a user modifies any field on the form, all fields are cleared and must be re-entered before a new tokenization request can be made.

Date Updated: 6/25/2019

This release includes the following updates:

New fullmobilekeyboard URL Parameter

The iFrame Tokenizer includes a new fullmobilekeyboard URL parameter to allow users to enter a forward slash (/) when entering an ACH routing/account number string.

Card Expiry Returned for for IDTECH USB Card Readers

The iFrame Tokenizer response message now includes the expiry when you use a supported IDTECH USB card reader device (IDTECH SREDkey or IDTECH SecuRED) to capture card data. The expiry and name on card (if available) are captured and stored in the data associated with the token.

Additional CSS Parameters

The following CSS parameters are now whitelisted for use with the iFrame Tokenizer:

  • appearance: 
  • -moz-appearance:
  • -webkit-appearance: