Configuring Hosted Payment Page Using Members
Refer to the following table to configure the payment page on your website:
ach-account-name
Decide to display the ACH Account Name field on the Payment Page.
Boolean
False
None
ach-account-name-label
Decide the text to display above the Account Name field.
String
Name on account
Set the show-labels to True before configuring the ach-account-name-label.
ach-account-name-missing-error
Decide the text to display in the error message when the account number is missing before completing the payment page for ACH transactions.
String
"Name on account is missing"
None
ach-account-name-placeholder
Decide the text to display before your customer enters values in the ACH Account Name field.
String
Name on account
None
ach-account-name-tooltip
Decide the tooltip text to display when your customers hover over the ACH Account Name field.
String
(empty string)
None
ach-account-number-invalid-error
Decide the message text should display when your customers enter an invalid account number in the field.
String
"Account number must be 1 to 17 digits"
None
ach-account-number-label
Decide the text to display for the ACH Account Number field when you set the show-labels to True.
String
Account number
None
ach-account-number-missing-error
Decide the text to display in the error message when the account number is missing before completing the payment page for ACH transactions.
String
"Account number is missing"
None
ach-account-number-placeholder
Decide the text to display before your customers enter values in the ACH Account Number field of the payment page.
String
Account number
None
ach-account-number-tooltip
Decide the tooltip text to display when your customers hover over the ACH Account Number field.
String
(empty string)
None
ach-account-type-label
Decide the text to display above the Account Type dropdown field.
String
Account type
Set the show-labels to True before configuring the ach-account-type-label.
ach-account-type-missing-error
Decide the text to display in the error message when the account type is missing before completing the payment page for ACH transactions.
String
"Account type is not selected"
None
ach-account-type-placeholder
Decide text to display before your customers select value from the dropdown list of the ACH Account type field of the payment page.
String
Account type
None
ach-account-type-tooltip
Decide the tooltip text to display when your customers hover over the ACH Account Type dropdown field.
String
(empty string)
None
ach-amount-label
Decide the text to display above the ACH Amount field.
String
Amount
Set the show-labels to True before configuring the ach-ach-amount-label.
ach-amount-placeholder
Decide the text to display before your customers enter values in the ACH Amount field of the payment page.
String
Enter amount
The payment page displays amount input if you do not set the value for the ach-amount-placeholder.
ach-amount-tooltip
Decide the tooltip text to display when your customers hover over the ACH Amount field.
String
(empty string)
None
ach-check-number-label
Decide the text to display above the ACH Check Number dropdown field.
String
Check number
Set the show-labels to True before configuring the ach-check-number-label.
ach-check-number-missing-error
Decide the text to display in the error message when the required check number is missing to complete the payment page for ACH transactions.
String
"Check number is missing"
None
ach-check-number-placeholder
Decide the text to display before your customers enter values in the ACH Check Number field of the payment page.
String
Check number
The payment page displays check number input if you do not set the value for the ach-check-number-placeholder.
ach-check-number-required
Decide if the ACH Check Number field is required to complete the payment page.
Boolean
False
None
ach-check-number-tooltip
Decide the tooltip text to display when your customers hover over the ACH Check Number field.
String
(empty string)
None
ach-description-placeholder
Decide the text to display before your customers enter values in the ACH Description field while they save payment method on the payment page.
String
ACH payment description
None
ach-description-tooltip
Decide the tooltip text to display when your customers hover over the ACH Description field.
String
(empty string)
None
ach-routing-number-invalid-error
Decide the text to display in the error message when the routing number is invalid before completing the payment page for ACH transactions.
String
"Routing number must be 9 digits"
None
ach-routing-number-label
Decide the text to display above the ACH Routing Number field.
String
Routing number
Set the show-labels to True before configuring the ach-routing-number-label.
ach-routing-number-missing-error
Decide the text to display in the error message when the routing number is missing before completing the payment page for ACH transactions.
String
"Routing number is missing"
None
ach-routing-number-placeholder
Decide the text to display before your customers enter values in the ACH Routing Number field on the payment page.
String
Routing number
The payment page displays routing number input if you do not set the value for the ach-routing-number-placeholder.
ach-routing-number-tooltip
Decide the tooltip text to display when your customers hover over the ACH Routing Number field.
String
(empty string)
None
ach-terms-not-accepted-error
Decide the text to display in the error message when the terms and conditions are not accepted before completing the payment page for ACH transactions.
String
"Check number is missing"
None
ach-validate-account-invalid-error
Decide the text to display in the error message when the validate account is not valid before completing the payment page for ACH transactions.
String
"ACH Account validation failed"
None
add-payment-button-text
Decide the text to display on the button that opens the Add Payment Method form on the payment page.
String
Add payment method
Set the request-type to token-only before configuring the add-payment-button-text member.
address2-label
Decide the text to display above the Billing Address and Street Address fields.
String
Street Address2
Set the show-labels to True before configuring the address2-label.
address2-placeholder
Decide the text to display before your customers enter values in the Billing Address field on the payment page.
String
Address2
None
address2-tooltip
Decide the tooltip text to display when your customers hover over the Billing Address and Street Address fields.
String
(empty string)
None
address-label
Decide the text to display above the Billing Address and Street Address fields.
String
Street Address
Set the show-labels to True before configuring the address-label.
address-missing-error
Decide the text to display in the error message when the required billing address is missing to complete the payment page for ACH transactions.
String
"Address required and street address is missing"
None
address-placeholder
Decide the text to display before your customers enter values in the Billing Address field on the payment page.
String
Address
None
address-tooltip
Decide the tooltip text to display when your customers hover over the Billing Address and Street Address fields.
String
(empty string)
None
amount
Decide the text to display in the Sale Transaction Amount field on the payment page.
String
None
None
amount-invalid-error
Decide the text to display in the error message when the entered amount is invalid on the payment page.
String
"Amount is not valid; Please include two decimal places (ex 1.00). Do not include $ symbol."
None
amount-label
Decide the text to display above the Amount field.
String
Amount
Set the show-labels to True before configuring the amount-label.
amount-missing-error
Decide the text to display in the error message when the amount is missing on the payment page.
String
"Amount is missing"
None
amount-placeholder
Decide the text to display before your customers enter values in the Amount field on the payment page.
String
Enter amount
The payment page displays amount input if you do not set the value for the amount-placeholder.
amount-tooltip
Decide the tooltip text to display when your customers hover over the Amount field.
String
(empty string)
The payment page displays amount input if you do not set the value for the amount-tooltip.
apple-pay-amount-label
Decide the text to display above the Total Amount field in the Apple Pay Payment Page.
String
None
If the value has not set for the apple-pay-amount-label, the label displays default Merchant DBA.
apple-pay-payment-session-error-message
Decide the text to display in the error message when the Apple Pay session fails to establish on the payment page.
String
"We were unable to establish an Apple Pay session for your payment transaction. Please try again or complete your order by entering your card details."
None
apple-pay-transaction-error-message
Decide the text to display in the error message when the Apple Pay transaction fails or unsuccessful on the payment page.
String
"We are unable to process your Apple Pay transaction. Please try again or complete your order by entering your card details below. If the problem persists, please contact us."
None
billing-address
Decide an optional property to set the billing address. When you set this property, the fields are pre-populated in billing address of the payment page.
Object
(null)
None
billing-address-label
Decide the text to display above the Billing Address section of the Payment Page.
String
Billing Address
None
billing-zip
Decide an optional property to set a zip code. When you set this property, the field is pre-populated in billing address of the payment page.
String
(null)
None
billing-zip-length-error
Decide the text to display in the error message when the zip code field value of the billing address is more than ten characters on the payment page.
String
"Zip code can not be more than 10 characters"
None
cancel-button-text
Decide the text to display on the Cancel button of the payment page.
String
Cancel
None
card
Decide an optional property to set the last four digits of card number on the payment page.
String
None
Returns null if the payment request has not submitted.
card-acceptance-label
Decide the text to display on the images of card type that are accepted for payments on the page.
String
Pay using.
Visa, MasterCard, American Express, Discover, Diners Club, and JCB.
card-description-label
Decide the text to display on the Card Description field on the payment page.
String
"Card Description"
Set the show-labels to True before configuring the card-description-label.
card-description-placeholder
Decide the text to display before your customers enter values in the Card Description field on the payment page.
String
Card description
None
card-description-tooltip
Decide the tooltip text to display when your customers hover over the Card Description field.
String
(empty string)
None
card-invalid-error
Decide the text to display in the error message when the card number is invalid on the payment page.
String
"Card number is not valid"
None
card-label
Decide the text to display on the Card Number field on the payment page.
String
Card number
Set the show-labels to True before configuring the card-label.
card-missing-error
Decide the text to display in the error message when the card number is missing on the payment page.
String
"Card number is missing"
None
card-placeholder
Decide the text to display before your customers enter values in the Card Number field on the payment page.
String
Card number
None
card-tooltip
Decide the tooltip text to display when your customers hover over the Card Number field.
String
(empty string)
None
check-field
Decide if the Hosted Payment Page checks a specific field before processing transaction.
String
null
Prevent duplicate payments.
For example, if you set the check-field to invoice to complete the transaction for the invoice, the original transaction will be returned and no new transaction will be attempted using the same invoice.
Set a unique value for the specified field name before configuring the check-field.
check-field-mid
Decide if the Hosted Payment Page checks a specific field before processing transaction across merchant level.
Boolean
False
Prevent duplicate payments.
For example, if you set the check-field to invoice to complete the transaction for the invoice, the original transaction will be returned and no new transaction will be attempted using the same invoice.
Set a unique value for the specified field name before configuring the check-field.
city-label
Decide the text to display above the City field of the Billing Address section on the payment page.
String
City
Set the show-labels to True before configuring the city-label.
city-missing-error
Decide the text to display in the error message when the required City is missing from the Billing Address section to complete the payment page.
String
"Address required and city is missing"
None
city-placeholder
Decide the text to display before your customers enter values in the City field from the Billing Address section of the payment page.
String
City
None
city-tooltip
Decide the tooltip text to display when your customers hover over the City field on the Payment Page.
String
(empty string)
None
close-button-text
Decide the text to display on the Close button of the payment page.
String
Close
None
comments
Decide to display the Comments field for setting values stored with transactions.
String
(null)
The Comments field will be displayed when you are using Clearent's Virtual Terminal to research transaction data.
When you set the comments property, the Payment Page pre-populates the Comment field.
comments-label
Decide the text to display above the Comments field on the Payment Page.
String
Comments
Set the show-labels to True before configuring the city-label.
comments-missing-error
Decide if the Comments field as required to complete the Payment Page for transactions and the text to display in the error message when comment is missing on the Payment Page.
String
"Comments required and is missing"
None
comments-placeholder
Decide the text to display before your customers enter the values in the Comments field on the Payment page.
String
Comments
None
comments-tooltip
Decide the tooltip text to display when your customers hover over the Comments field on the Payment Page.
String
(empty string)
None
customer-id
Decide to set the Customer ID field on the Payment Page for transactions.
String
(null)
Set the Customer ID field to research transaction data using Clearent's Virtual Terminal.
Also, set the property to pre-populate the Customer ID field on your payment page.
customer-id-label
Decide the text to display above the Customer ID field on the Payment Page.
String
customer-id
Set the show-labels to True before configuring the city-label.
customer-id-missing-error
Decide the text to display in the error message when customer ID is missing on the Payment Page.
String
"Customer-id required and is missing"
None
customer-id-placeholder
Decide the text to display before your customers enter the values in the Customer ID field on the Payment page.
String
Customer ID
None
customer-id-tooltip
Decide the tooltip text to display when your customers hover over the Customer ID field on the Payment Page.
String
(empty string)
None
cvc-invalid-error
Decide the text to display in the error message when card security code is invalid on the Payment Page.
String
"CSC length is not valid for card type"
None
cvc-label
Decide the text to display above the CVC field on the Payment Page.
String
Card Security Code
None
cvc-missing-error
Decide the text to display in the error message when card security code is missing on the Payment Page.
String
"CSC is missing"
None
cvc-placeholder
Decide the text to display before your customers enter the values in the CVC field on the Payment page.
String
Security Code
None
cvc-required
Decide if the CVC field is required to complete the Payment Page for transactions.
Boolean
True
None
cvc-tooltip
Decide the tooltip text to display when your customers hover over the CVC field on the Payment Page.
String
Enter security code found on back of Visa/Mastercard/Discover or front of American Express.
None
description
Decide to set the Description field on the Payment Page.
String
(null)
Set the Description field to research transaction data using Clearent's Virtual Terminal.
Also, set the property to pre-populate the Description field on your payment page.
description-label
Decide the text to display above the Description field on the Payment Page.
String
Description
None
description-missing-error
Decide if the Description field as required to complete the Payment Page for transactions and the text to display in the error message when description for transaction is missing on the Payment Page.
String
"Description required and is missing"
None
description-placeholder
Decide the text to display before your customers enter the values in the Description field on the Payment page.
String
Description
None
description-tooltip
Decide the tooltip text to display when your customers hover over the Description field on the Payment Page.
String
(empty string)
None
dob-year
Decide to set the DOB Year field on the Payment Page.
String
(null)
Set the property to pre-populate the DOB field on your payment page.
dob-year-invalid-error
Decide the text to display in the error message when date of birth year is invalid on the Payment Page.
String
"Date of birth year is not valid (check for spaces or invalid characters)"
None
dob-year-label
Decide the text to display above the DOB Year field on the Payment Page.
String
Customer year of birth
None
dob-year-missing-error
Decide the text to display in the error message when date of birth year is missing on the Payment Page.
String
"Customer year of birth required and is missing"
None
dob-year-placeholder
Decide the text to display before your customers enter the values in the DOB Year field on the Payment page.
String
Enter customer year of birth
None
dob-year-tooltip
Decide the tooltip text to display when your customers hover over the DOB Year field on the Payment Page.
String
(empty string)
None
email-address
Decide to set the Email Address field on the Payment Page.
String
(null)
Set the property to pre-populate the Email Address field on your payment page.
email-address-invalid-error
Decide the text to display in the error message for an invalid email address on the Payment Page.
String
"Email address is not valid (check for spaces or invalid characters)"
None
email-address-label
Decide the text to display above the Email Address field on the Payment Page.
String
Email Address
None
email-address-missing-error
Decide the text to display in the error message when an email address is missing on the Payment Page.
String
"Email address required and is missing"
None
email-address-placeholder
Decide the text to display before your customers enter the values in the Email Address field on the Payment page.
String
Email address
None
email-address-tooltip
Decide the tooltip text to display when your customers hover over the Email Address field on the Payment Page.
String
(empty string)
None
email-receipt-option-text
Decide to create checkbox for the Send a receipt by email option on the Payment Page.
String
Send a receipt by email
None
enable-ach
Decide to create checkbox for your customer to pay with online check option on the Payment Page.
Boolean
False
None
entry-label-manual
Decide the text to display in the label for selecting the manual entry option on the Payment Page.
String
Manual card entry
Enable the use-mobile-reader before configuring the entry-label-manual for manual entry.
entry-label-mobile
Decide the text to display in the label for selecting the mobile reader card entry option on the Payment Page.
String
Use mobile reader
Enable the use-mobile-reader before configuring the entry-label-mobile for mobile card entry.
error-message
Decide the text to display in the error message for unsuccessful transaction on the Payment Page.
String
We were unable to process your payment. Please verify your payment details and try again or contact us to complete your order...
None
exp-date-invalid-error
Decide the text to display in the error message for expiration date is not valid on the Payment Page.
String
"Expiration date is not valid or expired. Please enter as MMYY."
None
exp-date-label
Decide the text to display above the Expiration Date field on the Payment Page.
String
Expiration Date (MM / YY)
Set the show-labels to True before configuring the exp-date-label.
exp-date-missing-error
Decide the text to display in the error message for expiration date is missing on the Payment Page.
String
"Expiration date is missing"
None
exp-date-placeholder
Decide the text to display before your customers enter the values in the Expiration Date field on the Payment page.
String
MMYY
None
exp-date-tooltip
Decide the tooltip text to display when your customers hover over the Expiration Date field on the Payment Page.
String
Enter 2-digit expiration month and 2-digit expiration year
None
first-name-label
Decide the text to display above the First Name field in the Billing Address section of the Payment Page.
String
First name on card
Set the show-labels to True before configuring the first-name-label.
first-name-missing-error
Decide if the First Name field as required to complete the Payment Page for transactions and the text to display in the error message when first name in the address is missing on the Payment Page.
String
"Address required and first name is missing"
None
first-name-placeholder
Decide the text to display before your customers enter the values in the First Name field on the Payment page.
String
First name on card
None
first-name-tooltip
Decide the tooltip text to display when your customers hover over the First Name field on the Payment Page.
String
(empty string)
None
heading-text
Decide the text in the header section of the Payment page.
String
Enter Payment Information
None
invalid-message
Decide the text to display in the error message for an invalid entry in the fields on the Payment Page.
String
(null)
None
invoice-label
Decide the text to display above the Invoice field on the Payment Page.
String
Invoice
Set the show-labels to True before configuring the invoice-label.
invoice-missing-error
Decide if the Invoice field as required to complete the Payment Page for transactions and the text to display in the error message when invoice for transaction is missing on the Payment Page.
String
"Invoice required and is missing"
None
invoice-placeholder
Decide the text to display before your customers enter the values in the Invoice field on the Payment page.
String
Invoice Number
None
invoice-tooltip
Decide the tooltip text to display when your customers hover over the Invoice field on the Payment Page.
String
(empty string)
None
last-name-label
Decide the text to display above the Last Name field in the Billing Address section of the Payment Page.
String
Last name on card
Set the show-labels to True before configuring the last-name-label.
last-name-missing-error
Decide if the Last Name field as required to complete the Payment Page for transactions and the text to display in the error message when last name in the address is missing on the Payment Page.
String
"Address required and last name is missing"
None
last-name-placeholder
Decide the text to display before your customers enter the values in the Last Name field on the Payment page.
String
Last name on card
None
last-name-tooltip
Decide the tooltip text to display when your customers hover over the Last Name field on the Payment Page.
String
(empty string)
None
mask-entry
Decide the masking behavior for the card number, expiration date, card security code, routing number, and account number fields on the Payment Page.
Boolean
True
When your customers select a field for entry, the field appears unmasked. When customers deselect the field, the entry appears masked.
merchant-logo-url
Decide the logo at the top of the Payment Page with URL link for payment.
String
null
None
merchant-name
Decide the text that replaces “the merchant” in the ACH Terms and Conditions. This text appears below the logo and above the header text, including the Pay link.
String
null
None
mobile-success-url
Decide to open the mobile payment URL using the default configured browser on the mobile device when customers pay through the mobile application. Also, decide to redirect customers to your website after a successful transaction using the mobile payment URL.
String
null
None
order-id
Decide to set an order ID for transactions.
String
(null)
Set the order-id to research transaction data using Clearent's Virtual Terminal.
Also, set the property to pre-populate the Order ID field on your payment page.
order-id-label
Decide the text to display above the Order ID field on the Payment Page.
String
Order ID
Set the show-labels to True before configuring the order-id-label.
order-id-missing-error
Decide if the Order ID field as required to complete the Payment Page for transactions and the text to display in the error message when an order ID is missing on the Payment Page.
String
"Order-id required and is missing"
None
order-id-placeholder
Decide the text to display in the Order ID field on the Payment page.
String
Order ID
None
order-id-tooltip
Decide the tooltip text to display when your customers hover over the Order ID field on the Payment Page.
String
(empty string)
None
pay-button-parent
Decide the ID and element reference for the Pay Now button on the Payment Page. This will prevent the button from being added at the location of the Clearent.payButton() method call.
String
null
None
pay-button-text
Decide the text to display on the button link that opens the Payment page.
String
Pay Now
None
paylink-cancel-button-text
Decide to set the Pay with online-check option for your customer.
String
Cancel
None
payment-label-ach
Decide the text to display for selecting the Check Payment option on the Payment Page.
String
Check
Enable the ach.
payment-label-credit
Decide the text to display for selecting the Credit Payment option on the Payment Page.
String
Credit/Debit
Enable the ach.
payment-method-heading-text
Decide the text to display above the Payment section on the Payment Page. This section includes card entry fields and digital wallets.
String
"Payment Method"
None
phone-label
Decide the text to display above the Phone Number field in the Billing Address section of the Payment Page.
String
Phone number
None
phone-missing-error
Decide if the Phone Number field as required to complete the Payment Page for transactions and the text to display in the error message when phone number is missing on the Payment Page.
String
"Phone required is missing"
None
phone-placeholder
Decide the text to display before your customers enter the values in the Phone Number field on the Payment page.
String
Phone
None
phone-tooltip
Decide the tooltip text to display when your customers hover over the Phone Number field on the Payment Page.
String
(empty string)
None
pk
Public Key
String
Null
None
purchase-order
Decide to set a Purchase Order field for transactions.
String
Null
Set the purchase-order to research transaction data using Clearent's Virtual Terminal.
Also, set the property to pre-populate the Purchase Order field on your payment page.
purchase-order-label
Decide the text to display above the Purchase Order field on the Payment Page.
String
Purchase Order
None
purchase-order-missing-error
Decide if the Purchase Order field as required to complete the Payment Page for transactions and the text to display in the error message when purchase order is missing on the Payment Page.
String
"Purchase-order required and is missing"
None
purchase-order-placeholder
Decide the text to display in the Purchase Order field on the Payment page.
String
Purchase Order
None
purchase-order-tooltip
Decide the tooltip text to display when your customers hover over the Purchase Order field on the Payment Page.
String
(empty string)
None
read-only-amount
Decide if the Amount field on the Payment Page is editable for customers.
Boolean
False
None
read-only-sales-tax-amount
Decide if the Sales Tax Amount field on the Payment Page is editable for customers.
Boolean
False
None
read-only-tip-amount
Decide if the Tip Amount field on the Payment Page is editable for customers.
Boolean
False
None
request-type
Decide to set the type of request for processing the transaction.
String
Sale
Available types are:
SALE
AUTH: This type will display successful payments to customers using transaction response.
TOKEN-ONLY
require-ach-account-name
Decide if the ACH Account Name field is required on the Payment Page to complete the transaction.
Boolean
False
None
require-billing-address
Decide if the Billing Address section is required on the Payment Page to complete the transaction.
Boolean
False
None
require-billing-zip
Decide if the Zip field in the Billing Address section is required on the Payment Page to complete the transaction.
Boolean
False
None
require-card-inquiry
Decide if the Card Inquiry is performed to create a token.
Boolean
True
This applies only to TOKEN-ONLY request type.
require-comments
Decide if the Comments field is required on the Payment Page to complete the transaction.
Boolean
False
None
require-customer-id
Decide if the Customer ID field is required on the Payment Page to complete the transaction.
Boolean
False
None
require-description
Decide if the Description field is required on the Payment Page to complete the transaction.
Boolean
False
None
require-dob-year
Decide if the DOB Year field is required on the Payment Page to complete the transaction.
Boolean
False
None
require-email-address
Decide if the Email Address field is required on the Payment Page to complete the transaction.
Boolean
False
None
require-invoice
Decide if the Invoice field is required on the Payment Page to complete the transaction.
Boolean
False
None
require-order-id
Decide if the Order field is required on the Payment Page to complete the transaction.
Boolean
False
None
require-phone
Decide if the Phone Number field is required on the Payment Page to complete the transaction.
Boolean
False
None
require-purchase-order
Decide if the Purchase Order field is required on the Payment Page to complete the transaction.
Boolean
False
None
require-sales-tax
Decide if the Sales Tax field is required on the Payment Page to complete the transaction.
Boolean
False
None
require-shipping-address
Decide if the Shipping Address section is required on the Payment Page to complete the transaction.
Boolean
False
None
require-shipping-phone
Decide if the Shipping Phone Number field is required on the Payment Page to complete the transaction.
Boolean
False
Do not configure the require-shipping-phone if you have already set require-shipping-address or show-shipping-address to True.
require-tip-amount
Decide if the Tip Amount field is required on the Payment Page to complete the transaction.
Boolean
False
Do not configure the require-tip-amount if you have already set the show-shipping-address to True.
sales-tax-amount
Decide to set the Sales Tax Amount field on the Payment Page for transactions.
String
None
To pre-populate the Sales Tax Amount field, set the sales-tax-amount property.
sales-tax-invalid-error
Decide the text to display in the error message when sales tax is invalid on the Payment Page.
String
"Sales tax amount is not valid; Please include two decimal places (ex 1.00). Do not include $ symbol."
None
sales-tax-label
Decide the text to display above the Sales Tax field on the Payment Page.
String
Sales tax
Set the show-labels to True before configuring the sales-tax-label.
sales-tax-missing-error
Decide if the Sales Tax field as required to complete the Payment Page for transactions and the text to display in the error message when sales tax is missing on the Payment Page.
String
"Sales tax amount required and is missing"
None
sales-tax-placeholder
Decide the text to display before customers enter values in the Sales Tax field on the Payment page.
String
Enter sales tax
None
sales-tax-tooltip
Decide the tooltip text to display when your customers hover over the Sales Tax field on the Payment Page.
String
(empty string)
None
save-ach-option-text
Decide the text to display next to the “Save this ACH account” checkbox when the show-save-card-option is set to True.
String
Save this account for future use
None
save-card-option-text
Decide the text to display next to the “Save this Card” checkbox when the show-save-card-option is set to True.
String
Save this account for future use
None
save-card-zip-missing-error
Decide if the Zip Code field is required to save a card on the Payment Page and the text to display in the error message when zip code is missing on the Payment Page.
String
"Zip code is missing"
None
shipping-address
Decide to set the Shipping Address field on the Payment Page.
String
(null)
To pre-populate the Shipping Address field, set the shipping-address property.
shipping-address-label
Decide the text to display above the Shipping Address field on the Payment Page.
String
Shipping Address
Set the show-labels to True before configuring the shipping-address-label.
shipping-address-missing-error
Decide if the Shipping Address field is required on the Payment Page and the text to display in the error message when shipping address is missing on the Payment Page.
String
"Shipping address required and street address is missing"
None
shipping-address-placeholder
Decide the text to display before customers enter values in the Shipping Address field on the Payment page.
String
Address
None
shipping-address-tooltip
Decide the tooltip text to display when your customers hover over the Shipping Address field on the Payment Page.
String
(empty string)
None
shipping-city-label
Decide the text to display above the City field in the Shipping Address section of the Payment Page.
String
City
Set the show-labels to True before configuring the shipping-city-label.
shipping-city-missing-error
Decide if the City field is required on the Payment Page and the text to display in the error message when shipping city address is missing on the Payment Page.
String
"Shipping address required and city is missing"
None
shipping-city-placeholder
Decide the text to display before customers enter values in the City field in the Shipping Address section of the Payment page.
String
City
None
shipping-city-tooltip
Decide the tooltip text to display when your customers hover over the City field in the Shipping Address section of the Payment Page.
String
(empty string)
None
shipping-first-name-label
Decide the text to display above the First Name field in the Shipping Address section of the Payment Page.
String
First name
Set the show-labels to True before configuring the shipping-first-name-label.
shipping-first-name-missing-error
Decide if the First Name field is required on the Payment Page and the text to display in the error message when shipping first name is missing on the Payment Page.
String
"Shipping address required and first name is missing"
None
shipping-first-name-placeholder
Decide the text to display before customers enter values in the First Name field in the Shipping Address section of the Payment page.
String
First name
None
shipping-first-name-tooltip
Decide the tooltip text to display when your customers hover over the First Name field in the Shipping Address section of the Payment Page.
String
(empty string)
None
shipping-last-name-label
Decide the text to display above the Last Name field in the Shipping Address section of the Payment Page.
String
Last name
Set the show-labels to True before configuring the shipping-last-name-label.
shipping-last-name-missing-error
Decide if the Last Name field is required on the Payment Page and the text to display in the error message when shipping last name is missing on the Payment Page.
String
"Shipping address required and last name is missing"
None
shipping-last-name-placeholder
Decide the text to display before customers enter values in the Last Name field in the Shipping Address section of the Payment page.
String
Last name
None
shipping-last-name-tooltip
Decide the tooltip text to display when your customers hover over the Last Name field in the Shipping Address section of the Payment Page.
String
(empty string)
None
shipping-phone-label
Decide the text to display above the Phone Number field in the Shipping Address section of the Payment Page.
String
Last name
Set the show-labels to True before configuring the shipping-phone-label.
shipping-phone-missing-error
Decide if the Phone Number field is required on the Payment Page and the text to display in the error message when shipping phone number is missing on the Payment Page.
String
"Shipping phone required and is missing"
None
shipping-phone-placeholder
Decide the text to display before customers enter values in the Phone Number field in the Shipping Address section of the Payment page.
String
Phone
None
shipping-phone-tooltip
Decide the tooltip text to display when your customers hover over the Phone Number field in the Shipping Address section of the Payment Page.
String
(empty string)
None
shipping-state-label
Decide the text to display above the State dropdown field in the Shipping Address section of the Payment Page.
String
State
Set the show-labels to True before configuring the shipping-state-label.
shipping-state-missing-error
Decide if the State dropdown field is required on the Payment Page and the text to display in the error message when shipping state is missing on the Payment Page.
String
"Shipping address required and state is missing"
None
shipping-state-placeholder
Decide the text to display before customers select values from the State field in the Shipping Address section of the Payment page.
String
State
None
shipping-state-tooltip
Decide the tooltip text to display when your customers hover over the State dropdown field in the Shipping Address section of the Payment Page.
String
(empty string)
None
shipping-street-address-label
Decide the text to display above the Street field in the Shipping Address section of the Payment Page.
String
Street address
Set the show-labels to True before configuring the shipping-street-address-label.
shipping-zip-label
Decide the text to display above the Zip field in the Shipping Address section of the Payment Page.
String
Zip
Set the show-labels to True before configuring the shipping-zip-label.
shipping-zip-missing-error
Decide if the Zip field is required on the Payment Page and the text to display in the error message when shipping zip is missing on the Payment Page.
String
"Shipping address required and zip is missing"
None
shipping-zip-placeholder
Decide the text to display before customers enter values from the Zip field in the Shipping Address section of the Payment page.
String
Zip
None
shipping-zip-tooltip
Decide the tooltip text to display when your customers hover over the Zip field in the Shipping Address section of the Payment Page.
String
(empty string)
None
show-ach-check-number
Decide to display the ACH Check Number field on the Payment Page.
Boolean
True
None
show-address2
Decide to display the Address 2 field on the Payment Page.
Boolean
False
None
show-apple-pay
Decide to display the Apple Pay button link on the Payment Page.
Boolean
True
Register for Apple Pay for Web before configuring the show-apple-pay.
show-billing-address
Decide to display the Billing Address field on the Payment Page.
Boolean
False
None
show-billing-zip
Decide to display the Billing Zip field on the Payment Page.
Boolean
False
None
show-card-form-dividers
Decide to add horizontal rules between the Card Form sections.
Boolean
False
None
show-comments
Decide to display the Comments field on the Payment Page.
Boolean
False
None
show-customer-id
Decide to display the Show Customer ID field on the Payment Page.
Boolean
False
None
show-description
Decide to display the Description field on the Payment Page.
Boolean
False
Customers can use this field to add an information of their card.
Do not configure this property if you have already configured show-save-card-option.
show-dob-year
Decide to display the DOB Year field on the Payment Page.
Boolean
False
None
show-email-address
Decide to display the Email Address field on the Payment Page.
Boolean
False
None
show-email-receipt-option
Decide to display the checkbox for "Send a receipt by email" option on the Payment Page.
Boolean
False
None
show-inline
Decide to display the Payment Page inline rather than as a modal.
Boolean
False
None
show-invoice
Decide to display the Invoice field on the Payment Page.
Boolean
False
None
show-labels
Decide to display the text above the fields as labels on the Payment Page.
Boolean
False
None
show-order-id
Decide to display the Order ID field on the Payment Page.
Boolean
False
None
show-purchase-order
Decide to display the Purchase Order field on the Payment Page.
Boolean
False
None
show-sales-tax
Decide to display the Sales Tax field on the Payment Page.
Boolean
False
None
show-save-card-option
Decide to display the checkbox for "Save this Card" option on the Payment Page.
Boolean
False
None
show-shipping-address
Decide to display the Shipping Address section on the Payment Page.
Boolean
False
None
show-swipe-option
Decide to display the Swipe option for customers who want to swipe their cards on the Payment Page.
Boolean
False
Connect the card swipe device to the customer’s keyboard emulator.
For more information on supported swipe readers, contact a Clearent representative.
show-tip-amount
Decide to display the Tip Amount field on the Payment Page.
Boolean
False
None
state-dropdown
Decide to display the list of states from United State in the State dropdown field of Billing Address and Shipping Address sections.
Boolean
True
None
state-label
Decide to display the text above the State dropdown field as a label on the Payment Page.
String
State
None
state-missing-error
Decide if the State dropdown field is required on the Payment Page and the text to display in the error message when state is missing on the Payment Page.
String
"Address required and state is missing"
None
state-placeholder
Decide the text to display before customers select values from the State field in the Shipping Address section of the Payment page.
String
State
None
state-tooltip
Decide the tooltip text to display when your customers hover over the State dropdown field in the Billing Address section of the Payment Page.
String
(empty string)
None
submit-pay-button-text
Decide the text to display on the Submit button of the Payment Page.
String
Pay {$} Now
None
submit-pay-method-button-text
Decide the text to display on the Submit button of the Add Payment Method Page.
String
Save Card
Configure the submit-pay-method-button-text when request-type is TOKEN-ONLY.
success-message
Decide the text to display on the Payment Page for successful transaction.
String
Payment was successful.
None
summary-heading-text
Decide the text to display above the required section of the Payment Page. This section includes subtotal, sales tax, tip amount, and email address (for receipt).
String
"Payment Summary"
None
swipe-button-text
Decide the text to display on the Swipe button of the Payment Page.
String
"Swipe Card"
Set the show-swipe-option to True before configuring the swipe-button-text.
tip-amount
Decide to set the Tip Amount field for transactions.
String
(null)
To pre-populate the Shipping Address field, set the tip-amount property.
tip-amount-invalid-error
Decide the text to display in the error message when tip amount is not valid on the Payment Page.
String
"Tip amount is not valid; Please include two decimal places (ex 1.00). Do not include $ symbol."
None
tip-amount-label
Decide to display the text above the Tip Amount field as a label on the Payment Page.
String
Tip
None
tip-amount-missing-error
Decide if the Tip Amount field is required on the payment page and the text to display in the error message when tip amount is missing on the Payment Page.
String
"Tip amount is missing"
None
tip-amount-placeholder
Decide the text to display before customers enter values in the Tip Amount field on the Payment page.
String
Enter tip
None
tip-amount-tooltip
Decide the tooltip text to display when your customers hover over the Tip Amount field on the Payment Page.
String
(empty string)
None
tooltip-mode
Decide to display tooltips on the Payment Page.
String
focus
To configure the tooltip-mode, set the following properties:
hover: Displays a tooltip when customers hover the mouse pointer over a field on the Payment Page.focus: Displays a tooltip when customers select a field on the Payment Page.none: No tooltip is displayed when customers select a field on the Payment Page.
total-amount-label
Decide the text to display above the Total Amount field on the Payment Page.
String
null
Set the show-labels to True and payment type to card before configuring the total-amount-label.
track-format
Decide to set the track format for card swipes.
String
null
For more information on supported swipe readers, contact a Clearent representative.
use-external-terminal
Decide to complete transactions using an external terminal device.
Boolean
False
Configure an external terminal device with Clearent before using the use-external-terminal member.
use-mobile-reader
Decide to display the Use Mobile Reader option for customers who want to pay using Clearent's mobile application.
Boolean
False
Customer’s Mobile device must have an audio jack and Bluetooth to complete the transaction using the Use Mobile Reader option.
use-terminal-service-fee-setting
Decide to add a service fee for transactions processed using the terminal settings.
Boolean
True
None
validate-account
Decide to display the enable and disable options for the “validate account for ach” on the Payment Page.
Boolean
False
None
zip-label
Decide the text to display above the Zip field as a label in the Billing Address section of the Payment Page.
String
Zip
None
zip-missing-error
Decide if the Zip field is required on the Payment Page and the text to display in the error message when billing zip is missing on the Payment Page.
String
"Address required and zip is missing"
None
zip-placeholder
Decide the text to display before customers enter values in the Zip field on the Payment page.
String
Zip
None
zip-tooltip
Decide the tooltip text to display when your customers hover over the Zip field on the Payment Page.
String
(empty string)
None
Last updated