docs.clover.com"Clover Platform for Small Business Integration"

Jump to Content Release Notes Announcements Videos Community Blog Guides Recipes API Reference API Changelog Release Notes Announcements Videos Community Blog Log In Log In Guides Recipes API Reference API Changelog Search Loading… INTRODUCTION Developer documentation for Clover Text formats and notational conventions Technical support Your feedback matters Payment Card Industry security guidance for app developers 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 apps for merchant needs: examples Use Clover developer environments Limitations by environment Get started with sandbox environment Create a sandbox developer account Work with test merchants in sandbox Generate a test API token Get started with production environment Create production developer accounts Set up two-factor authentication (2FA) Manage developer account roles and permissions Submit developer account for approval Manage developer bank account information Add developer bank account information Update developer bank account information Manage developer accounts Transfer developer account ownership Manage test merchants Install your app to a test merchant Understand the app approval process Submit your app for approval CLOVER PLATFORM OVERVIEW Clover architecture SDKs and sample code Clover data model Clover devices Use Clover Developer Kits (Dev Kits) Receive Developer Kits at non-US addresses Use device diagnostics Use Android Debug Bridge over USB or Wi-Fi Region-specific features and limitations Argentina merchants Regional payment flows: Argentina Quick reference guides for LATAM region: Argentina developers Canada merchants Germany and Austria merchants Netherlands merchants United Kingdom and Ireland merchants United States merchants GlobAL DEVELOPER PLATFORM Clover global developer platform environments Get started with the global developer platform Clover global developer platform FAQs Known issues and workarounds Create global developer account Set up two-factor authentication (2FA) CREATE and MANAGE ClovER APPS 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 SaaS or service plans Test an app with different merchant service plans Customize receipts Manage Android app releases Set up pricing tiers Set Clover App Market listing Handle app billing Functional review playbook for Clover app approval Basic app configuration App onboarding for merchants App design requirements Full app functionality tests App administration checklist Launch your apps Navigate the Clover App Market Launch app in international markets Launch in the Canadian App Market 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 Revise and review approved or published apps Clover policies Legal templates Template—Clover Privacy Policy Template—Clover EULA/Terms of Service Provide support resources BUILD WITH ANDROID Custom Android basics for Clover devices 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 Submit an APK for approval Sideload an APK Manage your APKs Manage release groups Add release notes 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 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 sample REST API call Use test merchant identifier and API token Redirect merchants to apps OAuth flows in Clover Set app link (URL) and CORS domain Authenticate with OAuth—Canada and US OAuth at Clover High trust apps—Auth code flow Low trust apps—Auth code flow with PKCE Refresh access tokens Legacy token migration flow Initiate OAuth flow from the Clover App Market app selection Use OAuth 2.0—Europe and Latin America 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 permissions in the Europe region Convert Clover timestamps to Unix time Retrieve funding information (beta) Funding API—deposits Funding API—dateFunded Funding API—card_types Funding API—appendix Work with 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 Manage transaction data (REST API) Export merchant data Use webhooks 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 Integration types Ecommerce data model Ecommerce app permissions Ecommerce permission sets Configure Ecommerce hosted checkout webhooks Understand purchasing cards Levels and processing of purchasing cards Level 2 data Level 3 data Units of measurement codes Recurring Payments and Subscriptions APIs Recurring Payments APIs - Configure Plans Recurring Payment APIs - Configure subscriptions 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 Use the Clover-hosted iframe Clover iframe features Customize iframe elements with CSS Ecommerce API tutorials Generate a card token Create a charge Get charges endpoints Get a charge Get charges Create pre-authorization Capture a charge Capture charge for split shipment Accept payments and tips Refund payments Save a card for future transactions Confirm customer information with fraud tools Set soft descriptors Use 3-D Secure for e-commerce transactions Create a gift card token Use the Gift Card API Paginate requests 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 Ecommerce API: Error codes Use ACH TeleCheck Create an ACH token Accept checks by telephone Use internet check acceptance Sales decline disclosure templates State abbreviations for TeleCheck Protect Ecommerce merchants from card testing fraud Migrate from Developer Pay to Ecommerce ECOMMERCE PLUGINS (US and Canada only) Clover Payment extension for Ecommerce (US and Canada only) 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 identifier (merchantId) 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 Ecommerce (US and Canada only) - Adobe Commerce (Magento 2) Clover Payments plugin Prerequisites Install, upgrade, and uninstall the Clover...