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

INTRODUCTION

  • Home
    • Developer documentation
    • Text formats and notational conventions
    • Technical support
  • 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
    • Build 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
    • Developer account roles
    • Manage developer accounts
    • Manage test merchants
    • Submit developer account for approval
    • Understand the app approval process
    • Add or update bank account information
    • Set up two-factor authentication (2FA)

PLATFORM OVERVIEW

  • Clover architecture
    • SDKs and sample code
  • Clover data model
  • Clover devices
    • Clover Dev Kits
    • Dev Kits at non-US addresses
    • 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
  • Manage your apps
    • Set up a sandbox account
    • Create an app
    • Manage app settings
    • Work with private apps
    • Transaction data
    • Set app permissions
    • Set modules for merchant plans
    • Customize receipts
    • Manage Android app releases
    • Set App Market listings
    • Set up pricing tiers
    • Revise and review approved or published apps
    • Handle app billing
  • Launch your apps
    • Navigate the Clover App Market
    • Launch in multiple markets
    • International App Market readiness
    • Review app installs
    • Showcase apps
    • View billing transactions and lifecycle
    • View billing status
    • Gain insights into your app's performance
    • Use app ratings and reviews
    • Clover policies
    • Legal templates
    • Template—Clover Privacy Policy
    • Template—Clover EULA/Terms of Service
  • Manage your APKs
    • Manage release groups
    • Add release notes
  • Region-specific features and limitations
    • Region icons
    • Argentine merchants
    • Canadian merchants
    • German/Austrian merchants
    • Netherlands merchants
    • UK/Ireland merchants
    • US merchants
    • Support for regional payment flows
  • Provide support resources

BUILD WITH ANDROID

  • Clover Android basics
  • Set up emulator in Android Studio
    • Emulator requirements
    • Emulator limitations
    • Emulator hardware profiles
    • Clover development APKs
    • Troubleshoot emulators
  • Work with APKs
    • Set up Android SDK versions
    • Generate a signed APK
    • Upload an APK to your app
    • Install your app to your test merchant
    • Submit an APK for approval
    • Sideload an APK
  • Integrate with Clover Android SDK
  • Advanced information to build with Android
    • Query web services
    • OAuth for web views and non-Clover devices
    • Set up broadcasts and intents
    • Send app notifications
    • Use external USB devices
    • Test with printer receipt images
    • Build with Android NFC
    • Build apps for Clover Station Duo 2 — Dual touch screen device
    • Build apps for Clover Station Duo 1 — Dual touch screen device
  • Build payment solutions
    • Custom tenders
    • Create custom tender apps
    • Use Payment Connector
  • Expand merchant business
    • Use Order Connector
    • Use Merchant Connector
    • Work with transaction data (Clover Android SDK)

BUILD WITH REST API

  • Clover REST API basics
    • Make a REST API call
    • Use test merchant IDs and API tokens
    • Navigate merchants to apps
    • Set app URL and CORS
  • Use OAuth 2.0
  • Use Clover REST API
    • Use API tokens
    • Work with API usage and rate limits
    • Sort collections
    • Apply filters
    • Use filters to retrieve multiple results from an endpoint
    • Add pagination requests
    • Use expandable fields
    • Request inventory stock
    • Use object associations
    • Display null fields
    • Customer API EU permissions
  • Retrieve funding information (beta)
    • Funding API—Deposits
    • Funding API—dateFunded
    • Funding API—card_types
    • Funding API—Appendix
  • Use inventory
    • Import inventory
    • Manage items and item groups
    • Manage item availability
    • Manage categories
    • Manage modifier groups and modifiers
    • Manage tags
  • Manage orders data
    • Create custom orders
    • Calculate order totals
    • Tax Reports: Examples
    • Print orders with the REST API
    • Use webhooks
  • Manage transaction data (REST API)
  • Export merchant data
  • Troubleshoot 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

BUILD WITH ECOMMERCE API

  • Clover Ecommerce basics
  • Ecommerce data model
  • Integration types
  • Ecommerce app permissions
    • Ecommerce permission sets
  • Configure Ecommerce hosted checkout webhooks
  • Recurring Payments and Subscriptions APIs
    • Recurring Payments APIs - Configure Plans
    • Recurring Payment APIs - Configure subscriptions
  • Create a charge in 5 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
  • Understand purchasing cards
    • Levels and processing of purchasing cards
  • Hosted checkout API
    • Request a checkout
    • Create a hosted checkout session
    • Redirect customers
    • Test your hosted checkout integration (macOS/Linux)
    • Test your hosted checkout integration (Windows)
  • Clover iframe integrations
    • Clover iframe features
    • Use the Clover-hosted iframe
    • Customize iframe elements with CSS
  • Ecommerce API tutorials
    • Generate a card token
    • Accept payments and tips
    • Refund payments
    • Save a card for future transactions
    • Paginate requests
    • Confirm customer information with fraud tools
    • Set soft descriptors
  • Ecommerce software development kits (SDKs)
    • Set up the SDK
    • Make simple charges (SDK)
    • Create and pay for orders (SDK)
    • Work with customers (SDK)
    • Refund charges (SDK)
    • Python SDK
    • Node SDK
  • Migrate from Developer Pay to Ecommerce
  • Error codes
  • ACH TeleCheck
    • Accept checks by telephone
    • Internet check acceptance
    • Sales decline disclosure templates
    • State abbreviations for TeleCheck

ECOMMERCE PLUGINS (US and Canada only)

  • Clover Payment extension for Ecommerce (US and Canada only)
  • Ecommerce (US and Canada only) - Adobe Commerce (Magento 2) Clover Payments plugin
    • Prerequisites
    • Install, upgrade, and uninstall the Clover Payment extension
    • Update multi-lingual support
    • Configure the Clover Payment extension
    • Locate the merchant ID
    • Set up an API token
    • Process an authorization transaction
    • Capture an authorized transaction
    • Process a sales flow
    • Refund a captured order
    • Void an authorization
    • View surcharges
    • Customize iframe
    • HTTP Status and Error codes
  • Ecommerce (US and Canada only) - WordPress Clover Payments plugin
    • Install the Clover Payments for WooCommerce plugin
    • Configure the Clover Payments for WooCommerce plugin
    • Update multi-lingual support
    • Locate the merchant ID
    • Set up an API token
    • Process an authorization
    • Authorize and verify orders
    • Capture an authorization
    • Process a sale transaction
    • Verify order processing and transaction
    • Refund an order
    • Void an authorized order
    • View surcharges
    • Customize iframe
    • HTTP Status and Error codes

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
  • REST Pay Display integration requirement
  • Security
  • Get started with REST Pay Display
    • Create an app in the sandbox environment
    • Get an OAuth token
  • Connect point of sale app to the Clover device
    • 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
  • Use Postman with REST Pay Display API
  • Workflows and best practices
    • Transaction types
    • REST Pay payment flows
    • Interoperability with Ecommerce API
    • Track transactions with idempotency keys
    • Payment reconciliation and recovery
    • Card on File compliance for REST Pay Display
  • Issues and errors
    • Check for duplicate payments
    • Handle offline payments
    • Handle partial payment issues
    • Handle signature issues
    • Handle communication issues
    • Status codes and errors reference
  • REST Pay Display API tutorials
    • Verify device connectivity
    • Display a message to the customer
    • Display the welcome screen
    • Display the thank you screen
    • Cancel the current action
    • Get a signature
    • Get customer confirmation
    • Get customer input
    • Request a tip
    • Print a receipt
    • Open the cash drawer
    • Reset the device
    • Make a sale
    • Authorize and capture a tip-adjusted payment on paper
    • Authorize and capture a tipped payment on screen
    • Capture preauth payments
    • Refund a payment
    • Issue a credit
    • Create and use a card token
    • Get a customer's card data
    • Use Custom Activities with REST Pay Display
    • Display an order
  • App review and approval
    • Create an app in the production environment
    • Test REST Pay flows (Canada)
    • Test REST Pay flows (US)

SEMI-INTEGRATE WITH REMOTE PAY

  • Support timelines (Remote Pay SDKs)
  • Use Clover Connector
    • On Windows using .NET
    • On Windows using REST
    • On Windows using WebSockets
    • In the Cloud
    • On Android
    • On iOS
    • Work 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
    • Monitor device connection status
    • Payment reconciliation and recovery
    • Retrieve the device state
    • Track transactions with external IDs
  • Use customer-facing platform
  • ZVT ECR interface on Clover terminal
  • Integration repositories
  • Pay Display apps
  • Pay Display apps support matrix by devices and regions
  • Configure Secure Network Pay Display
  • Connect Clover Example POS
  • Example apps
  • Install a Pay Display app

SEMI-INTEGRATE WITH CLOVER ANDROID

  • Use the Clover Android Payments API
    • Payment tutorial
    • API reference
    • Accept a payment
    • Pre-auth operations
    • Payment retrieval operations
    • Reverse a payment
    • Tokenize a card
  • Take a payment with Payment Connector
    • Supported methods by device
    • Payment Connector example activity

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
    • Announcing Clover Station Duo 2 in Canada
    • Announcing Clover Station Duo 2 in United States
    • Clover Mini 3 is arriving soon in Europe
    • Clover Flex 3 is arriving soon in Europe
    • Clover Android ROM quarterly updates
    • Signature no longer required as CVM
    • Clover Flex 3 is available in Canada
    • 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
    • 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
    • Clover Android SDK v248.4 Release Notes

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 (FAQs)

LEGACY—CLOVER GO SEMI-INTEGRATION

  • 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

Clover Android SDK release notes

2022

  • SDK v293
  • SDK v292
  • SDK v288
  • SDK v284

Updated 6 months ago


  • Table of Contents
    • 2022