LogoLogo
API ReferencesGithubSupport CenterStatus pageBecome a Partner
  • Getting Started
    • Welcome
    • Our Products
  • Integration Process
  • Devices
    • Dejavoo
    • PAX
    • ID TECH
  • Become a Partner
  • Developer Resources
    • Overview
    • Sandbox & Production Environments
  • Testing Integration
    • Test Cards & ACH Accounts
    • Onboarding API Result Codes
    • Transaction Error Generation Data
    • Card Response & Result Codes
      • Card Error Response Codes
      • Card Transaction Result Codes
      • CSC Response Codes
      • AVS Response Codes
      • Duplicate Transaction Settings
    • ACH Request Validation & Return Codes
      • ACH Request Validation Codes
      • ACH Return Codes
  • API Catalog
    • Merchant Onboarding APIs
    • Transaction (Quest) APIs
    • Automated Merchant Onboarding Setup API
    • Reporting API
  • Webhooks
    • Prerequisites
    • Register Endpoint
    • Webhook Subscriptions
    • Working with Webhooks
      • Transaction Webhook
      • Onboarding Webhooks
        • Application Status
        • Application Fixes
      • Equipment Tracking & Activation Webhooks
        • Equipment Tracking
        • Equipment Activation
  • Merchant Onboarding
    • Overview
  • Automated Merchant Onboarding
    • Prerequisites
    • Working with Automated Merchant Onboarding
      • Generating a Merchant Application
      • Completing the Application
      • Modifying Default Merchant Pricing
        • Retrieving Existing Pricing Templates
        • Modifying Pricing Fees & Completing Merchant Application Record
    • Merchant Onboarding Status Webhooks
    • Configuring Automated Merchant Onboarding
  • Merchant Onboarding via Partner Portal
    • Starting New Application
    • Adding Hierarchy & Compensation Details
    • Entering Business Information
    • Entering Profile Details
    • Conducting the Site Survey
    • Configuring Pricing Details
    • Adding Banking Information
    • Adding Equipment
    • Submitting Signature
    • Reviewing & Submitting Application
    • Viewing Application Summary
  • Merchant Onboarding via API
    • Prerequisites
    • Understanding Integration
    • Working with Merchant Onboarding API
      • Creating a Merchant Profile
      • Completing the Merchant Application
        • Gathering Merchant Demographics
        • Configuring Merchant Pricing
        • Ordering and Setting Up Equipment
      • Submitting the Signature
      • Submitting the Application
  • Payment Processing Solutions
    • Overview
    • Cloud EMV
      • Working with Cloud EMV
        • Direct Data Transfer to Clearent's Cloud
        • Payment Authorization Process via Clearent's Quest Payment Gateway
    • JavaScript SDK
      • Prerequisites
        • Browser Support
      • Working with JavaScript SDK
        • Adding the Payment Form
        • Formatting the Payment Form
        • Processing the Payment
        • Apple Pay for Web
        • Google Pay for Web
        • Using IDTech VP8300
      • Card Validations
        • Card Number Validation
        • Card Expiration Date Validation
        • Card CSC/CVC Validation
      • Configuring with JavaScript SDK
        • Using Members
        • Using Methods
  • Hosted Payments
    • Prerequisites
      • Browser Support
    • Integrating the Hosted Payments
      • Configuring the Pay Now Button
      • Configuring Payment Page with an Amount Field
      • Configuring Payment Page with an Optional Billing Address and Headline Text
      • Configuring Payment Page with the Save Card Option
      • Configuring the Add Payment Method Button
      • Styling Your Brand on the Payment Page
      • Configuring Apple Pay for Web
      • Configuring Hosted Payment Page Using Members
      • Configuring Hosted Payment Page Using Methods
      • Configuring Hosted Payment Page Using Functions
    • Transaction Responses
      • Successful Transaction Response
      • Successful Transaction Response for a Billing Address
      • Failed Transaction Response
      • Unauthorized Request Response
      • Successful Transaction Response for a Token
      • Successful Token Request Response
    • Response Validations
      • Successful Transaction Response Validation
      • Failed Transaction Response Validation
    • Card Validations
  • Mobile EMV SDK
    • VP3300 Mobile Card Reader
      • Charging the card reader
      • Reading the card data
    • iOS Framework
      • iOS Framework Pre-requisites
      • Processing payments in your iOS app
        • Optional settings
        • Starting a Bluetooth connection
        • Pairing the card reader with an iOS device
        • Integrating the iOS framework into your app
        • Setting up the iOS framework in your Objective-C app
        • Starting a transaction in your iOS app
        • Receiving feedback messages
    • Android Framework
      • Integrating the Android framework into your app
      • Additional settings
      • Generating a JSON Web Token
      • Disabling default EMV configuration
  • ACH Transactions
    • Submitting the payment request
    • Creating an ACH token
    • Getting an ACH transaction
    • ACH transaction statuses
    • ACH transaction return codes
  • Paylink
    • Getting the paylink settings
    • Creating the Paylink
    • Sending the paylink
    • Paylink URL
  • Virtual Terminal
    • Working with the Virtual Terminal
      • Accessing Virtual Terminal
      • Adding or Ordering the Equipment
      • Recurring Payments
        • Adding a New Customer
        • Adding a Payment Method
        • Adding a New Payment Plan
        • Viewing the Plans
      • Processing Sales Transaction
      • Processing ACH Transaction
      • Transaction Search
        • Viewing Transactions
        • Viewing Transaction Receipt
        • Printing Transaction Receipt
        • Emailing Transaction Receipt
        • Void a Transaction
        • Refund a Transaction
        • Processing Pending Transactions
      • Open Batches
        • Viewing Batches
      • VT Settings
        • Merchant
        • Terminal
        • External Terminal
        • Address Verification (AVS)
        • Card Security Code (CSC)
        • Hosted Payment Page (HPP)
  • Financial Management
    • Overview
    • Merchant Pricing
  • Merchant Billing & Funding
  • Financial Reporting
  • Disputes Management
    • Understanding Disputes
    • Managing Disputes via Merchant Portal
    • Managing Disputes via API (Pilot Mode)
  • Reporting
    • Overview
  • Reporting Solutions
  • Working with Reporting API
    • Accessing Reports
    • Retrieving Reports
    • Exporting Reports
  • Support Ticketing
    • Overview
    • Benefits of Support Ticketing System
    • Accessing Support in the Portals
    • Working with Support Ticketing via Partner Portal
      • Types of Support Tickets
      • Submitting a Support Ticket via Partner Portal
  • Working with Support Ticketing via Merchant Portal
    • Types of Support Tickets
    • Submitting a Support Ticket via Merchant Portal
  • Partner & Merchant Solutions
    • Overview
    • Accessing the Portals
    • Navigating the User Interface
    • Working with the Partner Portal
      • Monitoring Performance with Dashboards
      • Managing Merchant Applications
      • Managing Merchants
      • Accessing Reports & Managing Subscriptions
        • Accessing Reports
        • Managing Subscriptions
      • Submitting a Support Ticket
  • Working with the Merchant Portal
    • Monitoring Home Page
    • Accessing Batches
    • Managing Transactions
    • Managing Funding Transactions
    • Managing Virtual Terminal
    • Viewing Chargebacks
    • Managing Disputes
    • Managing Statements & Tax Forms
    • Managing Account Settings
    • Managing User Notifications
    • Managing Support Tickets
  • Security Solutions
    • Overview
    • PCI Compliance
    • Tokenization
    • Encryption
    • Advanced Compliance & Security Measures & Programs
Powered by GitBook

Resources

  • Contact
  • Support Site
  • Campus

Terms & Policies

  • Terms
  • Privacy Policy
  • Disclosures
  • Merchant Agreement

Cookies

  • Cookie List
  • Cookies Settings

Site Info

  • Sitemap

© 2025 Clearent, LLC is a registered agent for Central Bank of St. Louis, MO; Citizens Bank, N.A., Providence, RI; and Pathward, N.A., Sioux Falls, SD.

On this page
  • Providing the Saved Payment Methods
  • Providing the Saved Card Options

Was this helpful?

Export as PDF
  1. Hosted Payments
  2. Integrating the Hosted Payments

Configuring the Add Payment Method Button

PreviousConfiguring Payment Page with the Save Card OptionNextStyling Your Brand on the Payment Page

Last updated 1 month ago

Was this helpful?

To configure the Add payment method button on your website to save a card token without processing a transaction:

1

Copy the following example code.

<script>
       Clearent.payButton({
        "card-token-only": true,
        "heading-text": "Enter card information below",
        "card-acceptance-label": ""
        });
</script>
2

Paste it into your web page.

The Add payment method button appears on your website to allow customers to add a payment method for future purchases.

When customers select the Add payment method button, a hosted page opens to save their card information. The hosted page includes fields for card details and an optional billing address section.

Providing the Saved Payment Methods

You can provide saved payment methods to your customers for easier checkout process:

Call the ClearentOnSuccess function, including the following parameters:

  • Token: The token returned from a sale request, or the token returned from a sale request with the save card option.

  • Card Type: The type of card used in the previous transaction.

  • Description: The description returned from a sale request with the save card option. See for more information.

<script>
    function ClearentOnSuccess(responseRaw, ResponseJSON) {
        // If you set the card-token-only option on your page, you can get the
        // token information back like this.
        if (ResponseJSON.payload && ResponseJSON.payload.tokenResponse) {
            var tokenResponse = ResponseJSON.payload.tokenResponse;
            console.log('token-id = ' + tokenResponse['token-id']);
            console.log('token card-type = ' + tokenResponse['card-type']);
            console.log('token description = ' + tokenResponse['description']);
        }
        // If you set the show-save-card-option on your page AND the user chose
        // to save their card, you can get the token information back like this.
        if (ResponseJSON.links) {
            var links = ResponseJSON.links;
            for (var i = 0; i < links.length; i++) {
                if (links[i]['rel'] == "token") {
                    console.log('token-id = ' + links[i]['id']);
                }
            }
        }
    }

Providing the Saved Card Options

You can provide the below saved card options to your customers using the Clearent.addToken() method:

  • Enter Card Manually: This option allows your customers to enter card information manually if they do not want to use a saved card.

  • Card type ending in [last four digits of card]: This option displays the card type and card number (last four digits) from the addToken method if the description was not provided for a saved card.

  • Card ending in [last four digits of card]: This option displays the card number (last four digits) from the addToken method if the description was not provided for a saved card.

<script>
       Clearent.setProperty("pk", "307a301406072a864.....8ce3d076fde833c136b");
       Clearent.addToken({"token":"1100005218649761111","cardType":"VISA"});
       Clearent.addToken({"token":"1312451222335452217","cardType":"MasterCard"});
       Clearent.addToken({"token":"1142451131215453214","description":"Vacation card"});
       Clearent.addToken({"token":"1412451141215454218","cardType":"Visa","description":"Business travel card"});
       Clearent.addToken({"token":"1512451151215455211"});
       Clearent.addToken({"token":"1612451161215456216"});
       Clearent.payButton({"amount": "64.50"});
</script>

The following payment popup with the saved card options dropdown list will be displayed for the Card Number field on your website.

Card Description: This option displays the card description provided from the addToken method. See for more information.

Configuring Payment Page with the Save Card Option
Configuring Payment Page with the Save Card Option
Add payment method button
Payment form with the optional billing address
Payment form