Jump to Content
Clover Platform DocsWhat's NewAnnouncementsWebinarsCommunityBlog
GuidesRecipesAPI ReferenceAPI Changelog
What's NewAnnouncementsWebinarsCommunityBlogLog InClover Platform Docs
Log In
GuidesRecipesAPI ReferenceAPI Changelog

INTRODUCTION

  • Home
  • Get started
    • Select an integration and Clover developer tools
    • From sandbox to app launch checklist
    • Post app launch checklist
  • Monetize your apps
  • Meet our merchants
    • Building for merchant needs
  • Clover developer environments
    • Limitations by environment
  • Get started with sandbox environment
    • Create a sandbox account
    • Generate a test API token
  • Get started with production environment
    • Production developer accounts
    • Managing developer accounts
    • Developer account roles
    • Managing test merchants
    • Developer account approval
    • App approval
    • Billing information approval
  • Text formats and notational conventions
  • Technical support

PLATFORM OVERVIEW

  • Clover architecture
    • SDKs & sample code
  • Clover data model
    • Setting up a sandbox account
  • Clover devices
    • Clover Dev Kits
    • Dev Kit FAQs
    • Device diagnostics
  • Functional review playbook for Clover apps
    • Basic app configuration
    • App onboarding for merchants
    • App design requirements
    • Full app functionality tests
    • App administration checklist
  • Managing your apps
    • Create an app
    • Managing app settings
    • Work with private apps
    • Transaction data
    • Setting app permissions
    • Setting modules for merchant plans
    • Customizing receipts
    • Managing Android app releases
    • Setting App Market listings
    • Setting up pricing tiers
    • Revising and reviewing approved or published apps
    • Handling app billing
  • Manage Your APKs
    • Managing release groups
    • Adding release notes
  • Region-specific features and limitations
    • Argentine merchants
    • Canadian merchants
    • German/Austrian merchants
    • Netherlands merchants
    • UK/Ireland merchants
    • US merchants
    • Supporting regional payment flows
  • Providing support resources

BUILD WITH ANDROID

  • Clover Android basics
  • Set up emulator in Android Studio
    • Emulator requirements
    • Emulator limitations
    • Emulator hardware profiles
    • Clover development APKs
    • Troubleshooting emulators
  • Working with APKs
    • Setting Android SDK versions
    • Generating a signed APK
    • Uploading an APK to your app
    • Installing your app to your test merchant
    • Submitting an APK for approval
    • Sideloading an APK
  • Integrating with Clover Android SDK
  • Advanced topics
    • Querying web services
    • OAuth for web views & non-Clover devices
    • Setting broadcasts & intents
    • Sending app notifications
    • Using external USB devices
    • Testing with printer receipt images
    • Building with Android NFC
    • Building apps for dual touch screen devices
  • Build payment solutions
    • Custom tenders
    • Creating custom tender apps
    • Using Payment Connector
  • Expand merchant business
    • Using Order Connector
    • Using Merchant Connector
    • Working with transaction data (Clover Android SDK)

BUILD WITH REST API

  • Clover REST API basics
    • Making a REST API call
    • Test merchant IDs & API tokens
    • Navigating merchants to apps
    • Setting app URL & CORS
  • Using OAuth 2.0
  • Using Clover REST API
    • Using API tokens
    • API usage & rate limits
    • Sorting collections
    • Applying filters
    • Using filters to retrieve multiple results from an endpoint
    • Paginating requests
    • Expanding fields
    • Querying inventory
    • Using object associations
    • Displaying null fields
    • Customers API EU permissions
  • Funding data (beta)
    • Deposits
    • DateFunded
    • Card_types
    • Appendix
  • Inventory data
    • Importing inventory
    • Managing items and item groups
    • Managing item availability
    • Managing categories
    • Managing modifier groups and modifiers
    • Managing tags
  • Orders data
    • Creating custom orders
    • Calculating order totals
    • Tax Reports: Examples
    • Printing orders with the REST API
    • Use webhooks
  • Transaction data (REST API)
  • Merchant data
  • Troubleshooting API errors
    • 400 Bad Request
    • 401 Unauthorized
    • 404 Not Found
    • 429 Too Many Requests
    • 500 Internal Server Error
  • Deprecated APIs
    • Payments with Developer Pay API

SEMI-INTEGRATION OVERVIEW

  • Introduction
  • Payment integration overview
  • Clover device configurations
  • Clover semi-integration basics
    • Payments integration options
    • Examples of transaction flows
    • Create your Remote App ID
  • Integration development and approval process
    • Step 1: Application
    • Step 2: Education
    • Step 3: Development
    • Step 4: Approval
    • Step 5: Maintenance
  • Test region-based payment flows
    • Test US payment flows
    • Test Canadian payment flows
  • Customer transactions
    • Transaction types
    • Per-transaction settings
    • Work with transaction data (Remote Pay SDKs)
    • Handle voids and refunds (US region)
    • Work with transaction data (Payment Connector)
    • Create custom receipts with CloverConnector
    • Reprint transaction receipts
    • Vault cards for future transactions
    • Handle challenges during payment processing
    • Alipay payment transactions
  • Electronic benefit transfer (EBT) transactions
    • Electronic benefit transfer (EBT) overview
    • Clover support for EBT
  • Semi-Integration glossary

Semi-Integrate with REST Pay

  • REST Pay Display API overview
  • REST Pay Display API introduction
  • Get started using REST Pay Display
    • Create an app in the sandbox environment
    • Obtain an OAuth token
  • Device Connection Options
    • Build a cloud connection request
    • Configure a cloud connection
    • Build a local connection request
    • Install REST Pay Display app on merchant device
    • Configure a local connection
  • Security
  • REST Pay architecture
  • Using Postman with REST Pay Display API
  • Workflows and best practices
    • Transaction types
    • REST Pay payment flows
    • Interoperability with Ecommerce API
    • Tracking transactions with idempotency keys
    • Payment reconciliation and recovery
  • Issues and errors
    • Checking for duplicate payments
    • Handling offline payments
    • Handling partial payment issues
    • Handling signature issues
    • Handling communication issues
    • Status codes and errors reference
  • API tutorials
    • Verifying connectivity
    • Displaying a message to the customer
    • Displaying the welcome screen
    • Displaying the thank you screen
    • Canceling the current action
    • Getting a signature
    • Getting customer confirmation
    • Getting customer input
    • Requesting a tip
    • Printing a receipt
    • Opening the cash drawer
    • Resetting the device
    • Making a sale
    • Authorizing and capturing a tip-adjusted payment on paper
    • Authorizing and capturing a tipped payment on screen
    • Capturing preauth payments
    • Refunding a payment
    • Issuing a credit
    • Creating and using a card token
    • Getting a customer's card data
    • Using Custom Activities with REST Pay Display
    • Displaying an order
  • App review and approval
    • Creating a production app
    • Testing REST Pay flows (Canada)
    • Testing REST Pay flows (US)
  • REST Pay Display FAQs

Semi-Integrate with Remote Pay

  • Support timelines (Remote Pay SDKs)
  • Using Clover Connector
    • On Windows using .NET
    • On Windows using REST
    • On Windows using WebSockets
    • In the Cloud
    • On Android
    • On iOS
    • Working with UI state messages
    • UI state reference
    • Payment response reference
    • Refund response reference
    • Credit response reference
  • Remote Pay SDK best practices
    • Device connection and disposal
    • Monitoring device connection status
    • Payment reconciliation and recovery
    • Retrieving the device state
    • Tracking transactions with external IDs
  • Using Customer-Facing Platform
  • ZVT ECR interface on Clover terminal
  • Integration repositories
  • Pay Display apps
  • Pay Display apps support matrix by devices and regions
  • Configuring Secure Network Pay Display
  • Connecting Clover Example POS
  • Example apps
  • Installing a Pay Display app

Semi-Integrate with Clover Android

  • Using Clover Android Payments API
    • Payment Tutorial
    • API Reference
    • Accept a payment
    • Pre-auth operations
    • Payment retrieval operations
    • Reverse a payment
    • Tokenize a card
  • Taking a payment with Payment Connector
    • Supported methods by device
    • Payment Connector example activity

Semi-Integrate with Clover Go

  • Integrating your POS with Clover Go
    • Clover Go and Clover Go SDK
    • Clover Go integration process overview
    • Integrating with the Clover Go SDK sample app
    • Running the Clover Go Android SDK sample app
    • Running the Clover Go iOS SDK sample app
    • Leveraging the Clover Go Android SDK in your app
    • Leveraging the Clover Go iOS SDK in your app
    • Clover Go SDK FAQs

Build with Ecommerce API

  • Clover Ecommerce basics
  • Ecommerce data model
  • Integration types
  • Ecommerce app permissions
    • Ecommerce permission sets
  • Configuring Ecomm hosted checkout webhooks
  • Recurring Payments and Subscriptions APIs
    • Recurring Payments APIs - Configuring Plans
    • Recurring Payment APIs - Configuring Subscriptions
  • Create a charge in five minutes
  • Create a charge
    • Level 2 data
    • Level 3 data
    • Units of measurement codes
  • Get charges endpoints
    • Get a charge
    • Get charges
  • Capture a charge
  • Purchasing Cards
    • Understanding purchase cards
  • Hosted Checkout API
    • Making a checkout request
    • Creating a hosted checkout session
    • Redirecting customers
    • Testing your hosted checkout integration (macOS/Linux)
    • Testing your hosted checkout integration (Windows)
  • Clover iframe integrations
    • Using the Clover-hosted iframe
    • Customizing iframe elements with CSS
    • Clover iframe features
  • Ecommerce API tutorials
    • Generating a card token
    • Accepting payments and tips
    • Refunding payments
    • Saving a card for future transactions
    • Paginating requests
    • Confirming customer information with fraud tools
    • Setting soft descriptors
  • Ecommerce Software Development Kits (SDKs)
    • Setting up the SDK
    • Making simple charges (SDK)
    • Creating and paying for orders (SDK)
    • Working with customers (SDK)
    • Refunding charges (SDK)
    • Python SDK
    • Node SDK
  • Migrating from Developer Pay to Ecommerce
  • Error codes
  • ACH TeleCheck
    • Accepting checks by telephone
    • Internet check acceptance
    • Sales decline disclosure templates
    • State Abbreviation for TeleCheck

LAUNCHING APPS

  • Launch overview
    • Navigating the Clover App Market
    • Launching in multiple markets
    • International App Market readiness
    • Reviewing app installs
    • Showcasing apps
    • Billing lifecycle
    • Gain insights into your app's performance
    • Using app ratings and reviews
  • Clover policies
    • Clover Credit Card Surcharging Policy
    • Clover App Market Ratings & Reviews Policy
  • Legal templates
    • Clover Privacy Policy Template
    • Clover EULA/Terms of Service Template

RELEASE NOTES

  • What's new
  • Bug fixes
  • Clover Android SDK release notes
    • v293 release notes
    • v292 release notes
    • v288 release notes
    • v284 release notes
  • Announcements
    • Sandbox update planned | January 23, 2023
    • Expiring auth tokens coming in 2023 - 2024
    • Announcing the Clover Flex 3
    • 2022 Clover code freeze
    • Reminder to categorize your apps and use ratings and reviews
    • Announcing the Clover Mini 3 in Canada
    • Announcing the Clover Mini 3
    • Ratings and Reviews is Live on Clover App Market - EU
    • Ratings and reviews is live on Clover App Market - Canada (CA) and Latin America (LATAM)
    • Announcing the Clover Station Solo in Canada
    • Announcing Clover Android Payments API
    • EMEA disaster recovery readiness | June 21 and 22, 2022
    • EMEA disaster recovery readiness | June 2022
    • North America disaster recovery readiness | June 14, 2022
    • Mini 1 secure processor ROM rollout
    • Sandbox scheduled maintenance - Jan. 24th. 2022
    • Introducing: Recurring Payments and Subscriptions APIs
    • Recommend not using deprecated Android framework Fragments on Android
    • Latest information about ROM updates for Clover Station Duo, Flex 2 and Mini 2
    • API authentication changes: access_token query parameter sunset
    • DevPay API calls will fail starting on Jan. 31, 2022
    • Apache Log4j Vulnerability | CVE-2021-44228
    • Sandbox server maintenance notification - December 20th, 2021
    • New information about ROM updates for Clover Station Duo, Flex 2 and Mini 2
    • Android 10 ROM—Notes for Clover Developers
    • 2021 Clover code freeze
    • ds-1438 Announcing new service plans for merchants
    • Station Duo changes | Issues with Android NFC - March 22, 2021
    • Reminder to Categorize Your Apps & Use Ratings and Reviews
    • Announcing Station Duo (Previously Pro) launch in Canada
    • Working with surcharge data - November 13th, 2020
    • Clover Code Freeze 2020
    • Clover Flex 2 in the UK & Ireland
    • Clover Android SDK v262.2 Release Notes
    • US Dev Disbursement Statement Updated July 2020
    • July 2020 Disbursements - Follow up
    • July 2020 Disbursements
    • US: HIPAA App Impacts (July 2020)
    • Announcing a beta test for Clover REST Pay
    • Announcing a new channel partner in the UK!
    • New! App metrics on your dashboard
    • Announcing our new Clover device - Flex (2nd Generation)
    • We are in this together | Clover + Developer Partners
    • Announcing our new Clover device - Station Pro
    • .NET SDK v4.0.3 Release Notes - 18 February 2020
    • Release Notes - June 20th, 2019
    • Clover Android SDK v248.4 Release Notes
    • .NET SDK v5.0 Release Notes - TBD
    • USB Pay Display on Clover Flex - End of Support
    • Release Notes - November 12th, 2019
    • Introducing status.clover.com
    • More Information on Handling Merchant App Charges
    • Flex (2nd Generation) Release
    • Reviewing updates for Approved and Published apps
    • What's new on the Developer Dashboard
    • Release Notes - October 14th, 2019
    • Clover Code Freeze 2019 Dates
    • Release Notes - September 30th, 2019
    • Release Notes - September 16th, 2019
    • Release Notes - September 6th, 2019
    • .NET SDK v4.0.2 Release Notes - August 14th, 2019
    • Release Notes - August 2nd, 2019
    • iOS SDK v3.0.3 - August 1st, 2019
    • Release Notes - July 19th, 2019
    • Release Notes - July 5th, 2019
    • Release Notes - June 26th, 2019
    • JavaScript SDK v3.1 - June 4th, 2019
    • Release Notes - May 23rd, 2019
    • Release Notes - May 16th, 2019
    • Customers API permission changes - May 13th, 2019
    • Release Notes - April 25th, 2019
    • Release Notes - April 15th, 2019
    • Release Notes - April 10th, 2019
    • Release Notes - April 2nd, 2019
    • Release Notes - March 27th, 2019
    • .NET SDK v4.0 Release Notes - March 20th, 2019
    • iOS SDK v3.0.2 Release Notes - March 19th, 2019
    • Release Notes - March 5th, 2019
    • Deprecation Notice - href value in JSON responses - February 28th, 2019
    • Release Notes - February 15th, 2019
    • JavaScript SDK Release Notes - February 14th, 2019
    • Release Notes - February 4th, 2019
    • .NET SDK v3.0.2 Release Notes - January 28th, 2019
    • iOS SDK v3.0.1 Release Notes - February 8th, 2019
    • Java SDK v3.0 Release Notes - January 23rd, 2019
    • .NET SDK v3.0.1 Release Notes - December 10th, 2018
    • Android SDK v3.0 Release Notes - November 26th, 2018
    • iOS SDK v3.0 Release Notes - November 5th, 2018
    • .NET SDK v3.0 Release Notes - November 2nd, 2018
    • Release Notes - November 1st, 2018
    • Release Notes - October 12th, 2018
    • Release Notes - October 1st, 2018
    • Clover App Market App & APK Approval Freeze Schedule 2018
    • Release Notes - September 28th, 2018
    • Release Notes - September 25th, 2018
    • Release Notes - September 11th, 2018
    • Improvements to Clover Android SDK - September 6th, 2018
    • Release Notes - September 4th, 2018
    • Release Notes - August 24th, 2018
    • Release Notes - August 20th, 2018
    • Release Notes - August 3rd, 2018
    • Additional Security for Pairing Semi-Integrated POS with Clover Devices - July 30th, 2018
    • Release Notes - July 24th, 2018
    • Updates about Clover Sandbox in Canada & Germany - July 24th, 2018
    • Clover Developer Docs is Back Live - July 18th, 2018
    • Release Notes - July 9th, 2018
    • Ratings and Reviews is Live on Clover App Market - July 3rd, 2018
    • Release Notes - June 29th, 2018
    • Release Notes - June 20th, 2018
    • Introducing New Web Dashboard for Merchants - June 11th, 2018
    • Release Notes - June 5th, 2018
    • Release Notes - June 1st, 2018
    • Changes to the REST API - May 30th, 2018
    • Release Notes - May 16th, 2018
    • Introducing Ratings and Reviews on Clover App Market - May 9th, 2018
    • Release Notes - May 4th, 2018
    • Release Notes - May 2nd, 2018
    • Release Notes - April 4th, 2018
    • Improved 429 Response Headers - April 2nd, 2018
    • Release Notes - March 24th, 2018
    • Release Notes - March 19th, 2018
    • Secure Network Pay Display Released - January 30, 2018
    • Update for Inactive Merchant Accounts - October 31, 2017
    • Changes to Export API US Available Hours - September 20, 2017
    • 2017 Holiday App & APK Review Schedule - September 11, 2017
    • DevAsk will be temporarily read-only starting May 10, 2017
    • Deprecation Notice - Barcode scanning using intents in Clover Android SDK - April 20, 2017
    • Merchant Generated API Token Changes - April 11, 2017
    • US Production Support for Clover Flex - April 10, 2017
    • Introducing Clover Flex - March 31, 2017
    • 30 Min. Planned EU Clover Maintenance on April 4, 2017
    • 30 Min. Planned EU Clover Maintenance on March 30, 2017
    • Changes to Android SDK Auth Token Generation - March 24, 2017
    • 30 Min. Planned Clover Maintenance Periods on March 27 & 29, 2017
    • New Plan Available to Merchants - March 17, 2017
    • 30 Min. Planned Clover Maintenance Periods on March 21 & 23, 2017
    • Postponed - 30 min. Planned Clover Maintenance Periods on March 14 & 15, 2017
    • 30 Min. Planned Clover Maintenance Periods on March 7 & 8, 2017
    • Unplanned DevAsk Outage - Feb. 28, 2017
    • Sandbox Server Maintenance Notification - February 9th 2017
    • Planned Clover Maintenance - Updated SSL Certificate for EU - Feb. 8, 2017
    • Updated SSL Certificate - January 18, 2017
    • Deprecation Notice - V2 Get Inventory Items - Jan. 11, 2017
    • Upcoming IP Address Change for Clover API Services
    • Planned outage for maintenance of Sandbox Environment October 7th, 2016
    • Offline/Merchant Error on Sandbox Devices - September 20, 2016
    • Changes to Merchant Groups - September 15, 2016
    • Clover Developer Meetup @ NYC Sept 28, 2016
    • Deprecation Notice - Webhooks require HTTPS
    • Clover Station Developer Kits - Available for Order - July 5, 2016
    • Update on Inactive Merchant Accounts - July 1, 2016
    • Issue on Production Emulators
    • Identifying Real and Test Merchant Accounts
    • Clover Developer Kits Available for Pre-Order
    • Introducing Clover Mobile
    • Permissions Versus Modules
    • Order and Pay from Table at Bierhaus, powered by Apple Pay, Clover, and Estimote's iBeacon
    • SmartTables is the Disrupt SF 2014 Clover Sponsor winner!

ECOMMERCE PLUGINS (US and Canada only)

  • Clover Payment Extensions for Ecommerce (US and Canada only)
  • Ecommerce (US and Canada only) - Adobe Commerce (Magento 2) Clover payments plugin
    • Prerequisites
    • Installing, upgrading, and uninstalling the Clover Payment Extension
    • Updating multi-lingual support
    • Configuring the Clover Payment Extension
    • Locating the merchant ID
    • Setting up an API token
    • Processing an authorization transaction
    • Capturing an authorized transaction
    • Processing a sales flow
    • Refunding a captured order
    • Voiding an authorization
    • Viewing surcharges
    • Customizing iframe
    • Appendix
  • Ecommerce (US and Canada only) - WordPress Clover Payments plugin
    • Prerequisites
    • Installing the Clover Payments for WooCommerce plugin
    • Configuring the Clover Payments for WooCommerce plugin
    • Updating multi-lingual support
    • Locating the merchant ID
    • Setting up an API token
    • Processing an authorization
    • Authorizing and verifying orders
    • Capturing an authorization
    • Processing a sale transaction
    • Verifying order processing and transaction
    • Refunding an order
    • Voiding an authorized order
    • Viewing surcharges
    • Customizing iFrame
    • Appendix

RESOURCES

  • Design resources
  • Supported barcode formats
  • Test card numbers
  • Country code reference
  • Developer mailing list
  • Developer Dashboard
  • REST API Reference
  • SDKs & sample code
  • Clover Development APKs
  • Frequently asked questions (FAQ)

Clover policies

Clover's policies ensure legal, fair, and safe application development by third-party app developers.

In this section, we discuss the following policies:

  • Clover Credit Card Surcharging Policy
  • Clover App Market Ratings & Reviews Policy

Updated over 2 years ago