PayLink Enabled

This field includes a checkbox to activate the Paylink for your merchant account, enabling payment processing through Clearent’s Hosted Payment Page.

Editable

Optional

Clearent PayLink URL

This field contains the web link that will be sent via a traditional or progressive web application or as a text message (SMS) to your customer's mobile devices for online payment processing using Clearent’s Hosted Payment Page.

Not Editable

Optional

Merchant Success URL

This field allows you to enter your business URL, which redirects customers to your business website after a secure and successful payment process.

Editable

Required

Merchant Cancel URL

This field allows you to enter your personal URL, which redirects customers to your website if they cancel the payment.

Editable

Required

Configurable Payment Page Properties

This field has various sections to configure the properties of Paylink according to your preferences.

Editable

Optional

Method

GET, PUT

Production Host

gateway.clearent.net

Sandbox Host

gateway-sb.clearent.net

Basepath

/rest/v2/settings/terminal/paylink

Schemes

HTTPS

Content-Type

application/json

Accept

application/json

AccessKey

SECRET ACCESS KEY

200

OK

401

Unauthorized

403

Forbidden

ach-account-name-label

This field has an ACH Account Name set for the Paylink.

String

ach-account-name-missing-error

This field has the text for an error message when an ACH Account Name is missing in the Paylink Payment Page and can be modified using Paylink Settings.

String

ach-account-name-placeholder

This field has the text for an ACH Account Name, which is haed in the Paylink Payment Page and can be modified using Paylink Settings.

String

ach-account-name-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

ach-account-number-invalid-error

This field has the default error message when an ACH Account Number is invalid.

String

ach-account-number-label

This field has the default placeholder text for an ACH Account Number.

String

ach-account-number-missing-error

This field has the default error message when the Account Number is missing for an ACH payment.

String

ach-account-number-placeholder

This field has the default placeholder text for the Account Number of an ACH payment.

String

ach-account-number-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

ach-account-type-label

This field has the default placeholder text for the Account Type input of an ACH payment.

String

ach-account-type-missing-error

This field has the default error message when the Account Type is not selected for an ACH payment.

String

ach-account-type-placeholder

This field has the default placeholder text for the Account Type of an ACH payment.

String

ach-account-type-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

ach-amount-label

This field has the default placeholder text for the Amount input label of an ACH payment.

String

ach-amount-placeholder

This field has the default placeholder text for the Amount input of an ACH payment.

String

ach-amount-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

ach-check-number-label

This field has the default placeholder text label for the Check Number input label of an ACH payment.

String

ach-check-number-missing-error

This field has the default error message when the Check Number is missing for an ACH payment.

String

ach-check-number-placeholder

This field has the default placeholder text for the Check Number input of an ACH Payment.

String

ach-check-number-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

ach-routing-number-invalid-error

This field has the default error message when the Routing Number is invalid for an ACH payment.

String

ach-routing-number-label

This field has the default placeholder text label for the Routing Number input label of an ACH payment.

String

ach-routing-number-missing-error

This field has the default error message when the Routing Number is missing for an ACH payment.

String

ach-routing-number-placeholder

This field has the default placeholder text for the Routing Number input of an ACH Payment.

String

ach-routing-number-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

ach-terms-not-accepted-error

This field has the default error message when the terms are not accepted for an ACH payment.

String

ach-validate-account-invalid-error

This field has the default error message when the Routing Number is invalid for an ACH payment.

String

address-label

This field has the default placeholder text label for the Address input label of an ACH payment.

String

address-missing-error

This field has the default error message when the Address is missing for an ACH payment.

String

address-placeholder

This field has the default placeholder text for the Address input of an ACH Payment.

String

address-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

address2-label

This field has the default text label for the Second Address input of an ACH payment.

String

address2-placeholder

This field has the default placeholder text for the Second Address input of an ACH Payment.

String

amount

This field has the Final Total to be processed when it is used independently.

Note: This field has the Subtotal when it is used with another calculated amount data field.

String

amount-invalid-error

This field has the default error message when the Amount is invalid for a payment.

String

amount-missing-error

This field has the default error message when the Amount is missing from the Amount input for a payment.

String

amount-placeholder

This field has the default placeholder text for the Amount input of a Payment.

String

amount-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

billing-address-label

This field has the default text label for the Billing Address input of a payment.

String

billing-zip

This field has the default text for the Billing Zip input of a payment.

String

billing-zip-length-error

This field has the default error message when the Billing ZIP character limit is not valid or more than 10 characters for a payment.

String

card-acceptance-label

This field has the default card acceptance image text label.

String

card-invalid-error

This field has the default error message for the invalid credit card.

String

card-label

This field has the default text for the credit card input field label.

String

card-missing-error

This field has default error message for the missing input in the credit card field.

String

card-placeholder

This field has default placeholder text for the credit card input field.

String

card-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

city-label

This field has the default text for the city input field label.

String

city-missing-error

This field has default error message for the missing input in the city field.

String

city-placeholder

This field has default placeholder text in the city input field.

String

city-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

comments

This field has the default text to apply in the comment input text field.

String

comments-label

This field has the default text for the comments input field label.

String

comments-missing-error

This field has default error message for the missing input in the comments field.

String

comments-placeholder

This field has default placeholder text in the comments input field.

String

comments-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

customer-id

This field has the default value of the customer ID.

String

customer-id-label

This field has the default text for the customer ID input field label.

String

customer-id-missing-error

This field has default error message for the missing input from the customer ID field.

String

customer-id-placeholder

This field has default placeholder text for the customer ID input field.

String

customer-id-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

cvc-invalid-error

This field has default error message for the invalid input from the CVC field.

String

cvc-label

This field has the default text for the CVC input field label.

String

cvc-missing-error

This field has default error message for the missing input from the CVC field.

String

cvc-placeholder

This field has default placeholder text for the CVC input field.

String

cvc-required

This field has a true value when the CVC input field is set as required for the payment process.

This field has a false value when the CVC input field is set as optional for the payment process.

Boolean

cvc-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

description

The description input text field.

String

description-label

This field has the default text for the description input field label.

String

description-missing-error

This field has default error message for the missing input from the description field.

String

description-placeholder

This field has default placeholder text for the description input field.

String

description-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

dob-year

The date of birth year input text field for ACH payments.

String

dob-year-invalid-error

This field has default error message for the invalid input from the dob year field.

String

dob-year-label

This field has the default text for the dob year input field label.

String

dob-year-missing-error

This field has default error message for the missing input from the dob year field.

String

dob-year-placeholder

This field has default placeholder text for the dob year input field.

String

dob-year-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

email-address

The email address input text field.

String

email-address-invalid-error

This field has default error message for the invalid input from the email address field.

String

email-address-label

This field has the default text for the description input field label.

String

email-address-missing-error

This field has default error message for the missing input from the email address field.

String

email-address-placeholder

This field has default placeholder text for the email address input field.

String

email-address-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

email-receipt-option-text

This field has the default text for the email receipt option checkbox text.

String

enable-ach

This field has a true value when the Paylink Setting is set to the ACH radio button as the payment method.

This field has a false value when the Paylink Setting is set to the credit card option as the payment method.

Boolean

error-message

This field has the default text for the error message heading text.

String

exp-date-invalid-error

This field has default error message for the invalid input from the expiry date field.

String

exp-date-label

This field has the default text for the expiry date input field label.

String

exp-date-missing-error

This field has default error message for the missing input from the expiry date field.

String

exp-date-placeholder

This field has default placeholder text for the expiry date input field.

String

exp-date-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

first-name-label

This field has the default text for the first name input field label.

String

first-name-missing-error

This field has default error message for the missing input from the first name field.

String

first-name-placeholder

This field has default placeholder text for the first name input field.

String

first-name-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

heading-text

This field has default text for heading on the Paylink page.

String

invalid-message

Modify default heading for error message box. This field has default heading text for the error message box of the Paylink page.

String

invoice

The invoice input text field.

String

invoice-label

This field has the default text for the invoice input field label.

String

invoice-missing-error

This field has default error message for the missing input from the invoice field.

String

invoice-placeholder

This field has default placeholder text for the invoice input field.

String

invoice-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

last-name-label

This field has the default text for the last name input field label.

String

last-name-missing-error

This field has default error message for the missing input from the last name field.

String

last-name-placeholder

This field has default placeholder text for the last name input field.

String

last-name-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

mask-entry

This field has a true value when the Paylink Setting masks the PAN, Expiry, and CVC input fields.

This field has a false value when the Paylink Setting does not mask the PAN, Expiry, and CVC input fields.

Boolean

merchant-logo-url

This field has an external URL for the merchant logo on the Paylink page.

String

merchant-name

This field has the default merchant name on the Paylink page.

String

order-id

An Order ID value.

String

order-id-label

This field has the default text for the order ID input field label.

String

order-id-missing-error

This field has default error message for the missing input from the order ID field.

String

order-id-placeholder

This field has default placeholder text for the order ID input field.

String

order-id-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

paylink-cancel-button-text

This field has default text for the cancel button on the Paylink page.

String

payment-label-ach

This field has the default text for the ACH payment button on the Paylink page.

String

payment-label-credit

This field has the default text for the credit payment button on the Paylink page.

String

phone-label

This field has the default text for the phone input field label.

String

phone-missing-error

This field has default error message for the missing input from the phone field.

String

phone-placeholder

This field has default placeholder text for the phone input field.

String

phone-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

purchase-order

The Purchase Order value

String

purchase-order-label

This field has the default text for the purchase order input field label.

String

purchase-order-missing-error

This field has default error message for the missing input from the purchase order field.

String

purchase-order-placeholder

This field has default placeholder text for the purchase order input field.

String

purchase-order-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

request-type

This field has type of requests such as SALE, AUTH, or TOKEN ONLY.

String

require-ach-account-name

This field has a true value when the Paylink requires the ACH account name input.

This field has a false value when the Paylink does not require the ACH account name input.

Boolean

require-billing-address

This field has a true value when the Paylink requires the billing address input.

This field has a false value when the Paylink does not require the billing address input.

Boolean

require-billing-zip

This field has a true value when the Paylink requires the billing zip code input.

This field has a false value when the Paylink does not require the billing zip code input.

Boolean

require-comments

This field has a true value when the Paylink requires the comments input.

This field has a false value when the Paylink does not require the comments input.

Boolean

require-customer-id

This field has a true value when the Paylink requires the customer ID input.

This field has a false value when the Paylink does not require the customer ID input.

Boolean

require-description

This field has a true value when the Paylink requires the description input.

This field has a false value when the Paylink does not require the description input.

Boolean

require-dob-year

This field has a true value when the Paylink requires the description input.

This field has a false value when the Paylink does not require the description input.

Boolean

require-email-address

This field has a true value when the Paylink requires the email address input.

This field has a false value when the Paylink does not require the email address input.

Boolean

require-invoice

This field has a true value when the Paylink requires the invoice input.

This field has a false value when the Paylink does not require the invoice input.

Boolean

require-order-id

This field has a true value when the Paylink requires the order ID input.

This field has a false value when the Paylink does not require the order ID input.

Boolean

require-phone

This field has a true value when the Paylink requires the phone input.

This field has a false value when the Paylink does not require the phone input.

Boolean

require-purchase-order

This field has a true value when the Paylink requires the purchase order input.

This field has a false value when the Paylink does not require the purchase order input.

Boolean

require-sales-tax

This field has a true value when the Paylink requires the sales tax input.

This field has a false value when the Paylink does not require the sales tax input.

Boolean

require-shipping-address

This field has a true value when the Paylink requires the shipping address input.

This field has a false value when the Paylink does not require the shipping address input.

Boolean

require-shipping-phone

This field has a true value when the Paylink requires the shipping phone input.

This field has a false value when the Paylink does not require the shipping phone input.

Boolean

require-tip-amount

This field has a true value when the Paylink requires the tip input.

This field has a false value when the Paylink does not require the tip input.

Boolean

sales-tax-amount

The Sales Tax Amount value.

String

sales-tax-invalid-error

This field has default error message for the invalid input from the sales tax field.

String

sales-tax-label

This field has the default text for the sales tax input field label.

String

sales-tax-missing-error

This field has default error message for the missing input from the sales tax field.

String

sales-tax-placeholder

This field has default placeholder text for the sales tax input field.

String

sales-tax-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

save-ach-option-text

This field has the default text for the save ACH option checkbox.

String

save-card-option-text

This field has the default text for the save card option checkbox.

String

shipping-address-label

This field has the default text for the shipping address input field label.

String

shipping-address-missing-error

This field has default error message for the missing input from the shipping address field.

String

shipping-address-placeholder

This field has default placeholder text for the shipping address input field.

String

shipping-address-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

shipping-city-label

This field has the default text for the shipping city input field label.

String

shipping-city-missing-error

This field has default error message for the missing input from the shipping city field.

String

shipping-city-placeholder

This field has default placeholder text for the shipping city input field.

String

shipping-city-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

shipping-first-name-label

This field has the default text for the shipping first name input field label.

String

shipping-first-name-missing-error

This field has default error message for the missing input from the shipping first name field.

String

shipping-first-name-placeholder

This field has default placeholder text for the shipping first name input field.

String

shipping-first-name-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

shipping-last-name-label

This field has the default text for the shipping last name input field label.

String

shipping-last-name-missing-error

This field has default error message for the missing input from the shipping last name field.

String

shipping-last-name-placeholder

This field has default placeholder text for the shipping last name input field.

String

shipping-last-name-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

shipping-phone-label

This field has the default text for the shipping phone input field label.

String

shipping-phone-missing-error

This field has default error message for the missing input from the shipping phone field.

String

shipping-phone-placeholder

This field has default placeholder text for the shipping phone input field.

String

shipping-phone-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

shipping-state-missing-error

This field has default error message for the missing input from the shipping state field.

String

shipping-state-placeholder

This field has default placeholder text for the shipping state input field.

String

shipping-state-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

shipping-street-address-label

This field has the default text for the shipping street address input field label.

String

shipping-zip-missing-error

This field has default error message for the missing input from the shipping zip field.

String

shipping-zip-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

show-ach-check-number

This field has a true value when the Paylink displays the ACH check number input field.

This field has a false value when the Paylink does not display the ACH check number input field.

Boolean

show-address2

This field has a true value when the Paylink displays the address input field.

This field has a false value when the Paylink does not display the address input field.

Boolean

show-billing-address

This field has a true value when the Paylink displays the billing address input field.

This field has a false value when the Paylink does not display the billing address input field.

Boolean

show-billing-zip

This field has a true value when the Paylink displays the billing zip input field.

This field has a false value when the Paylink does not display the billing zip input field.

Boolean

show-comments

This field has a true value when the Paylink displays the comments input field.

This field has a false value when the Paylink does not display the comments input field.

Boolean

show-customer-id

This field has a true value when the Paylink displays the customer ID input field.

This field has a false value when the Paylink does not display the customer ID input field.

Boolean

show-description

This field has a true value when the Paylink displays the description input field.

This field has a false value when the Paylink does not display the description input field.

Boolean

show-dob-year

This field has a true value when the Paylink displays the date of birth year input field.

This field has a false value when the Paylink does not display the date of birth year input field.

Boolean

show-email-address

This field has a true value when the Paylink displays the email address input field.

This field has a false value when the Paylink does not display the email address input field.

Boolean

show-invoice

This field has a true value when the Paylink displays the invoice input field.

This field has a false value when the Paylink does not display the invoice input field.

Boolean

show-labels

This field has a true value when the Paylink displays the input field labels.

This field has a false value when the Paylink does not display the input field labels.

Boolean

show-order-id

This field has a true value when the Paylink displays the order ID input field.

This field has a false value when the Paylink does not display the order ID input field.

Boolean

show-purchase-order

This field has a true value when the Paylink displays the purchase order input field.

This field has a false value when the Paylink does not display the purchase order input field.

Boolean

show-sales-tax

This field has a true value when the Paylink displays the sales tax input field.

This field has a false value when the Paylink does not display the sales tax input field.

Boolean

show-save-card-option

This field has a true value when the Paylink displays the save card option checkbox.

This field has a false value when the Paylink does not display the save card option checkbox.

Boolean

show-shipping-address

This field has a true value when the Paylink displays the shipping address input field.

This field has a false value when the Paylink does not display the shipping address input field.

Boolean

show-tip-amount

This field has a true value when the Paylink displays the tip amount input field.

This field has a false value when the Paylink does not display the tip amount input field.

Boolean

state-dropdown

This field has a true value when the Paylink displays the state input dropdown field.

This field has a false value when the Paylink does not display the state input dropdown field.

Boolean

state-missing-error

This field has default error message for the missing input from the state dropdown field.

String

state-placeholder

This field has default placeholder text for the state input field.

String

state-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

submit-pay-button-text

This field has the default text for the submit pay button.

String

success-message

This field has the default text message for the successful payment.

String

tip-amount

This field has the default text for the tip amount input field.

String

tip-amount-invalid-error

This field has default error message for the invalid input from the tip amount input field.

String

tip-amount-label

This field has the default text for the tip amount input field label.

String

tip-amount-missing-error

This field has default error message for the missing input from the tip amount input field.

String

tip-amount-placeholder

This field has default placeholder text for the tip amount input field.

String

tip-amount-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String

tooltip-mode

This field has a true value when the Paylink displays the tooltip.

This field has a false value when the Paylink does not display the tooltip.

Boolean

total-amount-label

This field has the default text for the total amount input field label.

String

use-terminal-service-fee-setting

This field has a true value when the Paylink uses the Empower Fee to Amount total.

This field has a false value when the Paylink does not use the Empower Fee to Amount total.

Boolean

validate-account

This field has a true value when Paylink performs card validation before authorization

This field has a false value when Paylink does not perform card validation before authorization.

Boolean

zip-label

This field has the default text for the zip input field label.

String

zip-missing-error

This field has default error message for the missing input from the zip input field.

String

zip-placeholder

This field has default placeholder text for the zip input field.

String

zip-tooltip

This field has the default text that enables and applies the corresponding input to the tooltip.

String