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
    • Working with 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

Was this helpful?

Export as PDF
  1. Paylink

Creating the Paylink

To create the paylink:

1

Use the PUT method with the /rest/v2/settings/terminal/paylink endpoint.

2

Add the parameters as shown in the following sample request body.

{
  "cancel-url":"string",
  "enabled":true,
  "metadata":
              {
                "show-billing-address":"true",
                "require-billing-address":"true",
                "amount":null
              },
  "success-url":"string",
  "terminalId":0
}

The following table describes the request body parameters:

Name
Data type
Required?
Description

cancel-url

String

Required

The URL where customers are redirected after canceling a payment.

enabled

String

Required

Indicates whether the Paylink setting is enabled.

  • true: Enable.

  • false: Disable.

metadata

Object

Required

Contains the configuration details for Paylink page elements.

metadata.show-billing-address

Boolean

Required

Indicates whether the billing address section is shown on the payment form.

  • true: Shows the billing address section.

  • false: Hides the billing address section.

metadata.require-billing-address

Boolean

Required

Indicates whether the billing address is required.

  • true: The billing address is required.

  • false: The billing address is optional.

amount

Text

Required

Specifies the payment amount.

success-url

String

Required

The URL where customers are redirected after a successful payment.

terminalId

String

Required

The internal terminal ID associated with the Paylink settings.

The following response code appears when the paylink is created successfully:

{
   "code":"200",
   "status":"SUCCESS",
   "exchange-id":"ID-clearent-gss-2-5916cad4-675d-4b15-ac5f-675989590094",
   "links":[
      {
         "rel":"terminal",
         "href":"https://gateway-sb.clearent.net/rest/v2/settings/terminal"
      },
      {
         "rel":"hpp",
         "href":"https://gateway-sb.clearent.net/rest/v2/settings/terminal/hpp"
      },
      {
         "rel":"self",
         "href":"https://gateway-sb.clearent.net/rest/v2/settings/terminal/paylink"
      }
   ],
   "payload":{
      "paylink":{
         "terminalId":42930,
         "enabled":true,
         "metadata":{
            "show-billing-address":"true",
            "require-billing-address":"true",
            "amount":null
         },
         "success-url":"https://www.website.com/success",
         "cancel-url":"https://www.website.com/cancel"
      },
      "payloadType":"paylink-settings"
   }
}

The following table describes the fields in the response body for the created paylink:

Name
Data type
Description

status

Text

A text in response to your API authentication request, such as:

  • Success: The API request was authenticated successfully.

  • Fail: The API request failed authentication.

exchange-id

String

The GUID (Global Unique Identifier) associated with the paylink.

links

Array

List of links associated with the paylink.

rel

Text

The current status of the Paylink. This field shows self when the setting is enabled for a merchant.

href

Text

The URL associated with the merchant’s Paylink.

payload

Object

Contains the details of the payload.

payload.paylink

Object

Contains the details of the paylink and configurations

payload.paylink.terminalId

Text

The internal terminal ID associated with the paylink.

payload.paylink.enabled

Boolean

Indicates whether the paylink setting is enabled.

  • true – The paylink setting is enabled.

  • false – The paylink setting is disabled.

payload.paylink.metadata

Object

Contains the details of the paylink configurations and attributes.

payload.paylink.metadata.show-billing-address

Boolean

Indicates whether the billing address section is shown on the payment form.

  • true – The billing address section is shown.

  • false – The billing address section is hidden.

payload.paylink.metadata.required-biiling-address

Boolean

Indicates whether the billing address section is required on the payment form.

  • true – The billing address section is required.

  • false – The billing address section is optional.

payload.success-url

String

The URL where customers are redirected after a successful payment.

payload.cancel-url

String

The URL where customers are redirected after canceling a payment.

payload.payloadType

String

The payload type classification.

The following table describes the HTTP status codes in the response body:

Code
Description

200

The paylink created successfully.

401

Unauthorized

403

Forbidden

PreviousGetting the paylink settingsNextSending the paylink

Last updated 3 days ago

Was this helpful?