Using Members
Refer to the following table to configure your payment page popup:
accountNumberMasked
Decide if the Account Number field should display masked information after the customer exits the field.
Boolean
True
To unmask the Account Number field when your customer exits this field, set the accountNumberMasked member to False.
accountNumberPlaceholder
Decide the text to display for the Account Number field before your customer provides input.
String
Account Number
None
accountTypePlaceholder
Decide the text to display for the Account Number field before your customer selects it.
String
Account Type
None
allowAutoComplete
Decide if the fields in the Payment Details form should autocomplete.
Boolean
True
To configure the cardholder-facing implementation, set the allowAutoComplete member to True.
To configure the merchant-facing implementation, set the allowAutoComplete member to False.
allowEmbedded
Decide if JavaScript SDK's host page should be embedded in another page.
Boolean
True
None
baseUrl
Decide if the Clearent Gateway base URL should be set to sandbox or production URL.
Note: You must set the baseUrl to sandbox or production URL.
String
Null
None
blockMetaKeys
Decide if meta key combinations (alt or ctrl) should be blocked for the hosting page.
Some card readers may generate keystrokes that include meta keys even after the card read is complete, causing unnecessary behavior in the browser window.
Mode
False
The blockMetaKeys member allows you to block meta key combinations on all pages containing the Clearent script.
This setting blocks certain meta key combinations, except for closing the window (Ctrl + W), opening a new window (Ctrl + N), or opening a new tab (Ctrl + T).
cardFormatted
Decide if the card field should be formatted as the customer enters information in the field.
Note: To make this setting effective, set the enableReader member to True.
Boolean
True
The cardFormatted member allows you to display the text in the Card Payment fields in a format similar to how the information appears on the physical card as the customer enters information.
To configure the cardholder-facing implementation, set the cardFormatted member to True.
cardMasked
Decide if the card field should display masked information after the customer exits the field.
Boolean
True
To unmask the Card Payment fields when your customer exits fields, set the cardMasked member to False.
To configure the cardholder-facing implementation, set the cardMasked member to True.
cardPlaceholder
Decide the text to display for the card field before your customer provides input.
String
Card Number
None
cardReadCompleteCallback
Decide the name of the function to call to receive a message after completing the card read.
String
ClearentCardReadComplete
None
cardReadStartCallback
Decide the name of the function to call to receive a message when starting the card read.
String
ClearentCardReadStart
None
clearFormOnSuccess
Decide if the Payment Details form should be cleared on a successful call to getPaymentToken().
Boolean
False
The clearFormOnSuccess member allows you to clear the form in a back-office implementation.
cvcMasked
Decide if the CSC field should display masked information after the customer exits the field.
Boolean
True
To unmask the Card Payment fields when your customer exits this field, set the accountNumberMasked member to False.
To configure the cardholder-facing implementation, set the cvcMasked to True.
cvcPlaceholder
Decide the text to display for the CVC field before your customer provides input.
String
CSC
None
cvcRequired
Decide if the CVC field is mandatory for customer to enter a value.
Boolean
True
None
deviceType
Decide the device type of external keyboard-emulation card reader.
String
Null
The deviceType member allows you to add an external card reader.
Clearent’s JavaScript SDK supports following Card Reader:
IDTECH
enableAch
Decide if the customer should pay with an online check.
Boolean
False
None
enableReader
Decide if an external card reader should be supported for reading cards.
Boolean
False
You need to add the Card Reader button to start reading the card details using an external keyboard-emulation card reader.
Clearent’s JavaScript SDK supports following card reader:
IDTECH
entryModeChangeCallback
Decide the name of the function to call to receive a message when changing the card entry mode.
String
ClearentEntryModeChange
None
errorCallback
Decide the name of the function to call to receive the getPaymentToken() response.
String
ClearentTokenError
None
expDateFormatted
Decide if the Expiration Date field should be formatted on entry.
Boolean
True
The expDateFormatted member allows you to display the text in the Expiration Date field in a format similar to how the information appears on the physical card as the customer enters information.
To configure the cardholder-facing implementation, set the expDateFormatted to True.
expDateMasked
Decide if the Expiration Date field should be masked when customer exits the field.
Boolean
True
To unmask the Expiration Date field when your customer exits this field, set the expDateMasked member to False.
To configure the cardholder-facing implementation, set the expDateMasked to True.
expDatePlaceholder
Decide the text to display for the Expiration Date field before your customer provides input.
String
MMYY
None
individualNamePlaceholder
This member allows you to decide the text to display for the Expiration Date field before your customer selects the field.
String
Name on account
None
initialMode
Decide if the Payment Details form should open in manual card entry mode or keyboard reader mode.
String
Manual
You need to set the enableReader member to True before setting the initialMode member.
When you set the initialMode member to manual or reader mode, the payment form will actively listen for keystrokes generated by the card reader.
Your customers will see errors and retries if they enter keystrokes that are part of the card read.
We recommend testing this use case before implementation.
paymentFormId
Decide the ID of div element that will hold the Payment Details form.
String
payment-form
To avoid conflicts with existing code and page element IDs, set the paymentFormId member to a value other than the default.
paymentTypeCallback
Decide the name of the function to call the onPaymentTypeChange().
String
ClearentOnPaymentTypeChange
To call the function, set the enableReader member to ACH.
This function is called when the payment type changes to card or ACH.
pk
Public Key
Note: You must set the pk member.
String
Null
None
routingNumberMasked
Decide if the Routing Number field should be masked when customer exits the field.
Boolean
True
To unmask the Routing Number field when your customer exits this field, set the routingNumberMasked member to False.
routingNumberPlaceholder
Decide the text to display for the Routing Number field before your customer provides input.
String
Routing Number
None
showValidationMessages
Decide if validation messages should be displayed below the payment form.
Boolean
True
To configure the handling of validation messages elsewhere, set the showValidationMessages member to False.
styles
Decide the style for the framed contents.
String
Null
You can use the IDs and classes from your browser’s Developer tools to style the frame of the payment page.
successCallback
Decide the name of the function to call to receive the getPaymentToken() response.
String
ClearentTokenSuccess
This function is called when the getPaymentToken generate successful.
validationCallback
Decide the name of the function to call to receive the validation messages.
String
ClearentValidation
None
Last updated