# Clover Platform Docs Documentation > Documentation for Clover Platform Docs Append .md to any documentation page URL to get its markdown version. ## Guides - [Home](https://docs.clover.com/dev/docs/home.md) - [Developer documentation for Clover](https://docs.clover.com/dev/docs/developer-documentation.md) - [Text formats and notational conventions](https://docs.clover.com/dev/docs/text-formatting-conventions.md) - [Developer support](https://docs.clover.com/dev/docs/developer-technical-support.md) - [Your feedback matters](https://docs.clover.com/dev/docs/your-feedback-matters.md) - [Payment Card Industry security guidance for app developers](https://docs.clover.com/dev/docs/pci-security-guidance-for-app-developers.md) - [Monetize your apps](https://docs.clover.com/dev/docs/monetizing-your-apps.md) - [Meet our merchants](https://docs.clover.com/dev/docs/meet-our-merchants.md) - [Build apps for merchant needs: examples](https://docs.clover.com/dev/docs/merchant-needs.md) - [Clover architecture](https://docs.clover.com/dev/docs/clover-architecture.md) - [Clover data model](https://docs.clover.com/dev/docs/clover-data-model.md) - [SDKs and sample code](https://docs.clover.com/dev/docs/sdks-doc-resources.md) - [Data types in Clover APIs](https://docs.clover.com/dev/docs/data-types-in-clover-apis.md) - [Clover devices](https://docs.clover.com/dev/docs/clover-devices.md) - [Clover devices—Technical specifications](https://docs.clover.com/dev/docs/clover-devices-tech-specs.md) - [Use device diagnostics](https://docs.clover.com/dev/docs/device-diagnostics.md) - [Fix server trust issues on Clover devices](https://docs.clover.com/dev/docs/fix-server-trust-issues-on-clover-devices.md) - [Device lifecycle and support](https://docs.clover.com/dev/docs/device-lifecycle-and-support.md) - [Clover Developer Kits (Dev Kits)](https://docs.clover.com/dev/docs/clover-dev-kits.md) - [Order a Dev Kit in the United States](https://docs.clover.com/dev/docs/order-a-dev-kit-us-address.md) - [Receive a Dev Kit outside the United States](https://docs.clover.com/dev/docs/developer-kit-faqs.md) - [Set up and use a Clover Dev Kit](https://docs.clover.com/dev/docs/set-up-and-use-a-dev-kit.md) - [Use Android Debug Bridge over USB or Wi-Fi](https://docs.clover.com/dev/docs/use-android-debug-bridge-adb.md) - [Region-specific features and limitations](https://docs.clover.com/dev/docs/region-specific-features.md) - [Argentina merchants](https://docs.clover.com/dev/docs/argentine-merchants.md) - [Canada merchants](https://docs.clover.com/dev/docs/canadian-merchants.md) - [Germany and Austria merchants](https://docs.clover.com/dev/docs/german-austrian-merchants.md) - [Netherlands merchants](https://docs.clover.com/dev/docs/netherland-merchants.md) - [United Kingdom and Ireland merchants](https://docs.clover.com/dev/docs/ukireland-merchants.md) - [United States merchants](https://docs.clover.com/dev/docs/us-merchants.md) - [Developer guides—LATAM Argentina](https://docs.clover.com/dev/docs/quick-reference-guides-latam-developers.md) - [Regional payment flows: Argentina](https://docs.clover.com/dev/docs/regional-extras.md) - [Integrate with PFAC and Non-Bank Networks for Argentina](https://docs.clover.com/dev/docs/integrate-with-argentina-pfac-and-non-bank-networks.md): Integration with Payment REST API using `regionalExtras` for Argentina through Non-Bank Networks and Payment Facilitators (PFACs) - [Use MiFare contactless card on a device](https://docs.clover.com/dev/docs/latam-mifare-contactless-card-on-a-device.md) - [Developer guides—LATAM Brazil](https://docs.clover.com/dev/docs/developer-guides-for-latam-brazil.md): Developer guides for Brazil Launch - [Developer guides—LATAM Mexico](https://docs.clover.com/dev/docs/developer-guides-for-latam-mexico.md): Developer guides for Mexico Launch - [Clover developer environments](https://docs.clover.com/dev/docs/clover-environments.md) - [Global developer platform—Quick steps](https://docs.clover.com/dev/docs/global-developer-platform-quick-steps.md) - [[Legacy] Developer platform—Quick steps](https://docs.clover.com/dev/docs/developer-platform-quick-steps.md) - [Limitations by environment](https://docs.clover.com/dev/docs/readme-limitations.md) - [Select an integration and Clover developer tools](https://docs.clover.com/dev/docs/select-an-integration.md) - [From sandbox to app launch checklist](https://docs.clover.com/dev/docs/from-sandbox-to-app-launch-checklist.md) - [Post app launch checklist](https://docs.clover.com/dev/docs/post-app-launch-checklist.md) - [Get started with the global developer platform](https://docs.clover.com/dev/docs/global-developer-platform-get-started.md) - [Create global developer account](https://docs.clover.com/dev/docs/gdp-create-global-developer-account.md) - [Set up multi-factor authentication (MFA)](https://docs.clover.com/dev/docs/set-up-multi-factor-authentication.md) - [Understand merchant service plans](https://docs.clover.com/dev/docs/understand-merchant-service-plans.md) - [Create new app](https://docs.clover.com/dev/docs/gdp-create-new-app.md) - [Manage app settings](https://docs.clover.com/dev/docs/gdp-manage-app-settings.md) - [Set app permissions](https://docs.clover.com/dev/docs/gdp-set-app-permissions.md) - [Set modules availability for your app](https://docs.clover.com/dev/docs/gde-set-modules-availability-for-your-app.md) - [Manage Android app releases](https://docs.clover.com/dev/docs/gdp-manage-android-app-releases.md) - [Install your app to a test merchant](https://docs.clover.com/dev/docs/gdp-install-your-app-to-a-test-merchant.md) - [Set up pricing tiers](https://docs.clover.com/dev/docs/gdp-set-up-pricing-tiers.md) - [Set Clover App Market listing](https://docs.clover.com/dev/docs/gdp-set-clover-app-market-listing.md) - [Submit your app for approval](https://docs.clover.com/dev/docs/gdp-submit-your-app-for-approval.md) - [Work with private apps](https://docs.clover.com/dev/docs/gdp-work-with-private-apps.md) - [Manage test merchant accounts and information](https://docs.clover.com/dev/docs/gdp-manage-test-merchants-accounts.md) - [Create merchant-specific API token](https://docs.clover.com/dev/docs/gdp-create-merchant-specific-api-token.md) - [Manage global developer account](https://docs.clover.com/dev/docs/manage-global-developer-account.md) - [Manage global developer roles](https://docs.clover.com/dev/docs/manage-global-developer-roles.md) - [Manage global developer permissions](https://docs.clover.com/dev/docs/manage-global-developer-permissions.md) - [Transfer global developer account ownership](https://docs.clover.com/dev/docs/gdp-transfer-developer-account-ownership.md) - [Submit global developer account for approval](https://docs.clover.com/dev/docs/submit-global-developer-account-for-approval.md) - [Manage developer bank account information](https://docs.clover.com/dev/docs/manage-developer-bank-account-information-gde.md) - [Add developer bank account information](https://docs.clover.com/dev/docs/add-developer-bank-account-information-gde.md) - [Update developer bank account information](https://docs.clover.com/dev/docs/update-developer-bank-account-information-gde.md) - [Global developer platform: Known issues and workarounds](https://docs.clover.com/dev/docs/gdp-known-issues-and-workarounds.md) - [Global developer platform FAQs](https://docs.clover.com/dev/docs/clover-global-developer-platform-faqs.md) - [Launch your apps](https://docs.clover.com/dev/docs/launch-overview.md) - [Understand the app approval process](https://docs.clover.com/dev/docs/developer-app-approval-archive.md) - [Functional review playbook for Clover app approval](https://docs.clover.com/dev/docs/clover-functional-review-playbook.md) - [Basic app configuration](https://docs.clover.com/dev/docs/basic-app-configuration.md) - [App onboarding for merchants](https://docs.clover.com/dev/docs/app-onboarding-for-merchants.md) - [App design requirements](https://docs.clover.com/dev/docs/app-design-requirements.md) - [Full app functionality tests](https://docs.clover.com/dev/docs/full-app-functionality-tests.md) - [App administration checklist](https://docs.clover.com/dev/docs/app-administration-checklist.md) - [Navigate the Clover App Market](https://docs.clover.com/dev/docs/navigating-the-clover-app-market.md) - [Launch app in international markets](https://docs.clover.com/dev/docs/multiple-markets.md) - [Launch in the Canadian App Market](https://docs.clover.com/dev/docs/international-app-market-readiness.md) - [Revise and review approved or published apps](https://docs.clover.com/dev/docs/draft_revising-and-reviewing-approved-or-published-apps.md) - [View billing transactions and lifecycle](https://docs.clover.com/dev/docs/billing.md) - [View billing status](https://docs.clover.com/dev/docs/billing-status.md) - [Showcase apps](https://docs.clover.com/dev/docs/showcase-your-app.md) - [Provide support resources](https://docs.clover.com/dev/docs/providing-support-resources.md) - [Transaction data: Charges and fees](https://docs.clover.com/dev/docs/transaction-data.md) - [Gain insights into your app's performance](https://docs.clover.com/dev/docs/gain-performance-insights.md) - [Review app installs](https://docs.clover.com/dev/docs/reviewing-app-installs.md) - [Use app ratings and reviews](https://docs.clover.com/dev/docs/app-ratings-reviews.md) - [Clover policies for app developers](https://docs.clover.com/dev/docs/clover-policies.md) - [Legal templates](https://docs.clover.com/dev/docs/legal-templates.md) - [Template—Clover Privacy Policy](https://docs.clover.com/dev/docs/clover-privacy-policy-template.md) - [Template—Clover EULA/Terms of Service](https://docs.clover.com/dev/docs/clover-eulaterms-of-service-template.md) - [Clover OAuth flow overview](https://docs.clover.com/dev/docs/oauth-flows-in-clover.md) - [Redirect merchants to your app](https://docs.clover.com/dev/docs/merchant-interaction.md) - [Set app link (URL) and CORS domain](https://docs.clover.com/dev/docs/using-cors.md) - [Clover v2/OAuth flow overview](https://docs.clover.com/dev/docs/oauth-intro.md): Clover OAuth processes for high-trust and low-trust apps with PKCE - [High-trust apps—Auth code flow](https://docs.clover.com/dev/docs/high-trust-app-auth-flow.md): Use the standard auth code flow to generate auth tokens using the Client Secret - [Low-trust apps—Auth code flow with PKCE](https://docs.clover.com/dev/docs/oauth-flow-for-low-trust-apps-pkce.md): Use the auth code flow with PKCE to generate auth tokens - [Initiate v2/OAuth flow from the Clover App Market](https://docs.clover.com/dev/docs/merchant-dashboard-left-navigation-oauth-flow.md) - [Authenticate with the v2/OAuth flow](https://docs.clover.com/dev/docs/use-oauth.md) - [Generate OAuth expiring (access and refresh) token](https://docs.clover.com/dev/docs/generate-expiring-tokens-using-v2-oauth-flow.md): Prerequisites and steps for generating an `access_token` and `refresh_token` pair using the v2/OAuth flow - [Use refresh token to generate new expiring token](https://docs.clover.com/dev/docs/refresh-access-tokens.md) - [Migrate legacy OAuth tokens to v2/OAuth expiring tokens](https://docs.clover.com/dev/docs/legacy-token-migration-flow.md) - [[For Reference only] Authenticate with the legacy OAuth flow](https://docs.clover.com/dev/docs/using-oauth-20.md): Legacy OAuth flow reference document for Clover apps created before October 2023. - [Clover Ecommerce](https://docs.clover.com/dev/docs/clover-ecommerce-homepage.md): Clover integrations for online businesses to transform the ecommerce experience - [Ecommerce integration types](https://docs.clover.com/dev/docs/ecommerce-integration-types.md) - [Ecommerce integration and payment flows—Use cases](https://docs.clover.com/dev/docs/ecommerce-integration-and-payment-flows-use-cases.md) - [Ecommerce API—Accept payments flow](https://docs.clover.com/dev/docs/ecommerce-api-payments-flow.md) - [Ecommerce settings and permissions](https://docs.clover.com/dev/docs/clover-development-basics-ecommerce.md) - [Ecommerce data model](https://docs.clover.com/dev/docs/ecommerce-data-model.md) - [Set app permissions for endpoints and integrations](https://docs.clover.com/dev/docs/ecommerce-app-permissions.md) - [API keys and OAuth tokens for secure ecommerce](https://docs.clover.com/dev/docs/ecommerce-api-tokens-and-oauth-api-tokens.md) - [Generate Ecommerce API tokens (public and private keys)](https://docs.clover.com/dev/docs/create-ecommerce-api-tokens.md): Create and use public and private keys for single merchant integrations. - [OAuth expiring token overview](https://docs.clover.com/dev/docs/generate-an-oauth-api-token-or-access_token.md): Overview of the OAuth flow for Clover app integrations for multiple businesses. - [Generate OAuth expiring (access and refresh) token](https://docs.clover.com/dev/docs/generate-oauth-expiring-access-and-refresh-token.md): Prerequisites and steps for generating an `access_token` and `refresh_token` pair to build Clover Ecommerce app integrations. - [Use refresh token to generate new expiring token](https://docs.clover.com/dev/docs/use-refresh-token-to-generate-new-expiring-token.md) - [Ecommerce tokenization](https://docs.clover.com/dev/docs/ecommerce-tokenization-overview.md) - [Generate a public API access key or PAKMS key](https://docs.clover.com/dev/docs/generate-ecommerce-api-key-or-pakms-key.md) - [Create a card token](https://docs.clover.com/dev/docs/create-a-card-token.md) - [Use external multi-pay tokens with Clover Ecommerce APIs](https://docs.clover.com/dev/docs/use-transarmor-token.md) - [Create a multi-pay token](https://docs.clover.com/dev/docs/create-a-transarmor-token.md): Create a multi-pay token, such as a card-on-file (COF) token or a TransArmor® (TA) token - [Use existing multi-pay tokens](https://docs.clover.com/dev/docs/use-existing-transarmor-tokens.md): Merchants/developers using TransArmor® tokens can now process payments with Clover by converting the TA token into a multi-pay CLV token using these steps. - [Save a card for future transactions](https://docs.clover.com/dev/docs/save-a-card-for-future-transactions.md): How to save a customer's card on file for use in future purchases or recurring payments. - [Ecommerce services APIs](https://docs.clover.com/dev/docs/ecommerce-api-tutorials.md) - [Create a charge](https://docs.clover.com/dev/docs/create-a-charge.md) - [Use 3D Secure for ecommerce transactions](https://docs.clover.com/dev/docs/use-3ds.md) - [Pre-authorize card transactions](https://docs.clover.com/dev/docs/create-pre-authorization.md) - [Get charges endpoints](https://docs.clover.com/dev/docs/get-a-charge-tutorial.md) - [Get a charge](https://docs.clover.com/dev/docs/get-a-charge.md) - [Get charges](https://docs.clover.com/dev/docs/get-charges.md) - [Capture a charge](https://docs.clover.com/dev/docs/capture-a-charge-tutorial.md) - [Capture charge for split shipment](https://docs.clover.com/dev/docs/capture-charge-for-split-shipment.md) - [Accept payments and tips](https://docs.clover.com/dev/docs/ecommerce-accepting-payments.md) - [Refund payments and void transactions](https://docs.clover.com/dev/docs/ecommerce-refunding-payments.md) - [Recurring payments with plans and subscriptions](https://docs.clover.com/dev/docs/recurring-payments-and-subscriptions-apis.md) - [Recurring payments API—Configure Plans](https://docs.clover.com/dev/docs/working-with-recurring-payments-and-subscriptions.md) - [Recurring payments API—Configure subscriptions for plans](https://docs.clover.com/dev/docs/recurring-apis-subscriptions.md) - [[Pilot] Card Account Updater to support recurring payments](https://docs.clover.com/dev/docs/card-account-updater.md): Ensures seamless recurring payments using card-on-file - [Ecommerce Gift Card API](https://docs.clover.com/dev/docs/gift-card-api.md) - [Create a gift card token](https://docs.clover.com/dev/docs/create-a-gift-card-token.md) - [Activate a gift card](https://docs.clover.com/dev/docs/ecomm-activate-a-gift-card.md) - [Redeem a gift card](https://docs.clover.com/dev/docs/ecomm-redeem-gift-card.md) - [Check and use gift card balance](https://docs.clover.com/dev/docs/ecomm-check-and-use-gift-card-balance.md) - [Reload an active gift card](https://docs.clover.com/dev/docs/ecomm-reload-an-active-gift-card.md) - [Void and refund for a gift card](https://docs.clover.com/dev/docs/ecomm-void-and-refund-for-a-gift-card.md) - [Ecommerce services APIs—Learn more](https://docs.clover.com/dev/docs/ecommerce-services-apis-learn-more.md) - [PCI DSS version 4.0 Requirements 6.4.3 and 11.6.1](https://docs.clover.com/dev/docs/pci-dss-version-40-requirements-643-and-1161.md): Learn about client-side web security for Clover Ecommerce merchants, focusing on PCI v4.0 requirements for HTTP headers and payment page scripts. - [Protect Ecommerce merchants from card testing fraud](https://docs.clover.com/dev/docs/protect-ecommerce-merchants-from-card-testing-fraud.md) - [Confirm customer information with fraud tools](https://docs.clover.com/dev/docs/confirming-customer-information-with-ecommerce-fraud-tools.md) - [Purchasing cards](https://docs.clover.com/dev/docs/l3-l2-support.md) - [Levels and processing of purchasing cards](https://docs.clover.com/dev/docs/accepting-purchase-cards.md) - [Level 3 data](https://docs.clover.com/dev/docs/understanding-level-3-data.md) - [Level 2 data](https://docs.clover.com/dev/docs/understanding-level-2-data.md) - [Paginate requests](https://docs.clover.com/dev/docs/ecommerce-paginating-requests.md) - [Set soft descriptors](https://docs.clover.com/dev/docs/setting-soft-descriptors.md) - [Ecommerce API error codes](https://docs.clover.com/dev/docs/ecommerce-error-codes.md) - [Ecommerce API response codes and descriptions](https://docs.clover.com/dev/docs/ecommerce-api-response-codes-descriptions.md) - [Units of measurement codes](https://docs.clover.com/dev/docs/units-of-measurement-codes.md) - [Hosted Checkout integration](https://docs.clover.com/dev/docs/hosted-checkout-api.md) - [Create a Hosted Checkout session request](https://docs.clover.com/dev/docs/creating-a-hosted-checkout-session.md) - [Customize a Hosted Checkout page](https://docs.clover.com/dev/docs/making-a-checkout-request.md) - [Configure Hosted Checkout webhooks](https://docs.clover.com/dev/docs/ecomm-hosted-checkout-webhook.md) - [Redirect customers to another URL](https://docs.clover.com/dev/docs/redirecting-customers.md) - [Test your Hosted Checkout integration (macOS/Linux)](https://docs.clover.com/dev/docs/testing-your-hosted-checkout-integration-macoslinux.md) - [Test your Hosted Checkout integration (Windows)](https://docs.clover.com/dev/docs/testing-your-hosted-checkout-integration-windows.md) - [Iframe integrations](https://docs.clover.com/dev/docs/clover-iframe-integrations.md) - [Iframe—Create a payment form](https://docs.clover.com/dev/docs/using-the-clover-hosted-iframe.md) - [Iframe—Use card and page elements](https://docs.clover.com/dev/docs/clover-iframe-features.md) - [Add Apple Pay button to the Clover iframe](https://docs.clover.com/dev/docs/clover-iframe-features-apple-pay.md) - [Add Google Pay button to the Clover iframe](https://docs.clover.com/dev/docs/clover-iframe-features-google-pay.md) - [Iframe—Customize iframe elements with CSS](https://docs.clover.com/dev/docs/customizing-iframe-elements-with-css.md) - [Iframe—Customize ACH elements with CSS](https://docs.clover.com/dev/docs/iframe-customize-ach-elements-with-css.md) - [TeleCheck ACH for online payments](https://docs.clover.com/dev/docs/ach-telecheck.md) - [Create an ACH token](https://docs.clover.com/dev/docs/create-an-ach-token.md) - [Accept checks by telephone](https://docs.clover.com/dev/docs/accepting-checks-by-telephone.md) - [Use internet check acceptance](https://docs.clover.com/dev/docs/internet-check-acceptance.md) - [Sales decline disclosure templates](https://docs.clover.com/dev/docs/sales-decline-disclosure-templates.md) - [State abbreviations for TeleCheck](https://docs.clover.com/dev/docs/state-abbreviation-for-telecheck.md) - [Apple Pay integration—Implementation options](https://docs.clover.com/dev/docs/apple-pay-implementation-options.md): Apple Pay payments integration with Clover Ecommerce API integration and Clover-hosted iframe - [Create an Apple Pay payment token](https://docs.clover.com/dev/docs/create-applepaywallet-token.md): Use the Apple Pay payment token as a `source` token to create a charge or pay for an order. - [Samsung Pay integration for Clover Ecommerce](https://docs.clover.com/dev/docs/ecommerce-samsung-pay-implementation.md) - [3D Secure (3DS) authentication overview](https://docs.clover.com/dev/docs/3d-secure-authentication-overview.md) - [Select a provider and enable 3DS](https://docs.clover.com/dev/docs/enable-3ds-on-merchant-dashboard.md) - [3D Secure deep dive—How it works for CNP transactions](https://docs.clover.com/dev/docs/3d-secure-deep-dive.md) - [Test 3DS integration in the sandbox](https://docs.clover.com/dev/docs/test-3ds-integration.md) - [Configure 3D Secure SDK with iframe and API integration](https://docs.clover.com/dev/docs/configure-3d-secure-sdk-with-iframe-and-api-integration.md) - [Initiate 3DS SDK with the `Create a charge` endpoint](https://docs.clover.com/dev/docs/initiate-3ds-sdk-with-the-create-a-charge-endpoint.md) - [Initiate 3DS SDK with the `Pay for an order` endpoint](https://docs.clover.com/dev/docs/initiate-3ds-sdk-with-the-pay-for-order-endpoint.md) - [Add 3DS authentication to `Create a charge` endpoint](https://docs.clover.com/dev/docs/add-3ds-authentication-to-create-a-charge-endpoint.md) - [Add 3DS authentication to 'Pay for an order' endpoint](https://docs.clover.com/dev/docs/add-3ds-authentication-to-pay-for-an-order-endpoint.md) - [3D Secure—Frequently asked questions](https://docs.clover.com/dev/docs/3d-secure-faqs.md) - [Use Clover REST API](https://docs.clover.com/dev/docs/making-rest-api-calls.md) - [Clover REST API basics](https://docs.clover.com/dev/docs/clover-development-basics-web-app.md) - [Use test API tokens in sandbox](https://docs.clover.com/dev/docs/using-api-tokens.md) - [Use test merchant identifier and API token](https://docs.clover.com/dev/docs/merchant-id-and-api-token-for-development.md) - [Make a sample REST API call](https://docs.clover.com/dev/docs/make-a-rest-api-call.md) - [Clover REST API tutorials](https://docs.clover.com/dev/docs/clover-rest-api-index.md) - [Apply filters to API requests](https://docs.clover.com/dev/docs/applying-filters.md) - [Use filters to retrieve multiple results from an endpoint](https://docs.clover.com/dev/docs/using-filters-to-retrieve-multiple-results-from-an-endpoint.md) - [Use expandable fields for API responses](https://docs.clover.com/dev/docs/expanding-fields.md) - [Work with API usage and rate limits](https://docs.clover.com/dev/docs/api-usage-rate-limits.md) - [Sort collections](https://docs.clover.com/dev/docs/sorting-collections.md) - [Add pagination requests](https://docs.clover.com/dev/docs/paginating-elements.md) - [Use object associations](https://docs.clover.com/dev/docs/using-object-associations.md) - [Use webhooks](https://docs.clover.com/dev/docs/webhooks.md) - [Display null fields](https://docs.clover.com/dev/docs/displaying-null-fields.md) - [Convert Clover timestamps to Unix time](https://docs.clover.com/dev/docs/convert-timestamps-to-unix-time.md) - [Troubleshoot API errors](https://docs.clover.com/dev/docs/troubleshooting-api-errors.md) - [400 Bad Request](https://docs.clover.com/dev/docs/400-bad-request.md) - [401 Unauthorized](https://docs.clover.com/dev/docs/401-unauthorized.md) - [404 Not Found](https://docs.clover.com/dev/docs/404-not-found.md) - [429 Too Many Requests](https://docs.clover.com/dev/docs/429-too-many-requests.md) - [500 Internal Server Error](https://docs.clover.com/dev/docs/500-internal-server-error.md) - [Export merchant data](https://docs.clover.com/dev/docs/exporting-merchant-data.md) - [Manage transaction data (REST API)](https://docs.clover.com/dev/docs/working-with-transaction-data-rest.md) - [Customers API permissions in Europe](https://docs.clover.com/dev/docs/customers-api-eu-permissions.md) - [Deprecated APIs](https://docs.clover.com/dev/docs/deprecated-apis.md) - [Payments with Developer Pay API](https://docs.clover.com/dev/docs/developer-pay-api.md) - [Manage inventory and items](https://docs.clover.com/dev/docs/working-with-inventory.md) - [Bulk import inventory](https://docs.clover.com/dev/docs/importing-inventory.md) - [Manage items and item groups](https://docs.clover.com/dev/docs/managing-items-item-groups.md) - [Manage item availability and low stock alerts](https://docs.clover.com/dev/docs/managing-item-availability.md) - [Manage modifier groups and modifiers](https://docs.clover.com/dev/docs/managing-modifier-groups-modifiers.md) - [Manage item modifiers availability](https://docs.clover.com/dev/docs/manage-item-modifiers-availability.md) - [Manage categories](https://docs.clover.com/dev/docs/managing-categories.md) - [Manage subcategories](https://docs.clover.com/dev/docs/manage-subcategories.md) - [Manage tags](https://docs.clover.com/dev/docs/managing-tags.md) - [Manage orders data](https://docs.clover.com/dev/docs/working-with-orders.md) - [Create an atomic order](https://docs.clover.com/dev/docs/create-an-atomic-order.md): Use a single Clover API call to build an order cart, check an order, and the create the order record for payment. - [Create custom orders](https://docs.clover.com/dev/docs/creating-custom-orders.md): Use multiple Clover API endpoints to create an order with customized line items. - [Calculate order totals](https://docs.clover.com/dev/docs/calculating-order-totals.md) - [Tax Reports: Examples](https://docs.clover.com/dev/docs/tax-reports-examples.md) - [Print orders with the REST API](https://docs.clover.com/dev/docs/printing-orders-rest-api.md) - [Get all payments](https://docs.clover.com/dev/docs/get-all-payments.md) - [Multiple service charges (MSC) overview](https://docs.clover.com/dev/docs/msc-overview.md): Help your merchants by updating your app to support multiple service charges (MSC). The MSC documentation shows you how. - [Manage multiple service charges for Web apps](https://docs.clover.com/dev/docs/msc-web-apps.md): Learn how to use the MSC REST API to manage multiple service charges (MSC) for Web apps. - [Test your app for multiple service charges](https://docs.clover.com/dev/docs/msc-set-up-and-test-your-app.md): Set up and test your app to manage multiple service charges (MSC). - [Frequently asked questions (FAQ) for multiple service charges](https://docs.clover.com/dev/docs/msc-faqs.md): Frequently asked questions (FAQ) about the multiple service charges (MSC) feature. - [Manage age-restricted items](https://docs.clover.com/dev/docs/manage-age-restricted-items.md) - [Manage age-restricted items in the Inventory API](https://docs.clover.com/dev/docs/manage-age-restricted-items-inventory-api.md) - [Manage age-restricted items in the Orders API](https://docs.clover.com/dev/docs/manage-age-restricted-items-orders-api.md) - [Custom Android basics for Clover devices](https://docs.clover.com/dev/docs/clover-development-basics-android.md) - [Android Emulator for Clover devices](https://docs.clover.com/dev/docs/android-emulator-overview.md) - [Set up emulator in Android Studio](https://docs.clover.com/dev/docs/setting-up-an-android-emulator.md) - [Troubleshoot Android Emulator for Clover devices](https://docs.clover.com/dev/docs/troubleshooting-emulators.md) - [Work with APKs](https://docs.clover.com/dev/docs/working-with-apks.md) - [Set up Android SDK versions](https://docs.clover.com/dev/docs/setting-android-sdk-versions.md) - [Generate a signed APK](https://docs.clover.com/dev/docs/generating-a-signed-apk.md) - [Upload an APK to your app](https://docs.clover.com/dev/docs/adding-an-apk-to-your-app.md) - [Submit an APK for approval](https://docs.clover.com/dev/docs/submitting-an-apk-for-approval.md) - [Sideload an APK](https://docs.clover.com/dev/docs/sideloading-an-apk.md) - [Manage approved APKs](https://docs.clover.com/dev/docs/app-submission.md) - [Manage release groups](https://docs.clover.com/dev/docs/beta-releases-staged-rollouts.md) - [Add release notes to APKs](https://docs.clover.com/dev/docs/adding-release-notes.md) - [Integrate with Clover Android SDK](https://docs.clover.com/dev/docs/integrate-with-clover-android-sdk.md) - [Manage service charges (MSC) for Android apps](https://docs.clover.com/dev/docs/msc-android-apps.md): Learn how to use the Android APIs to manage multiple service charges (MSC) for Android apps. - [Advanced information to build with Android](https://docs.clover.com/dev/docs/advanced-topics.md) - [OAuth for web views and non-Clover devices](https://docs.clover.com/dev/docs/oauth-for-web-views-non-clover-devices.md) - [Query web services](https://docs.clover.com/dev/docs/query-web-services.md) - [Set up broadcasts and intents](https://docs.clover.com/dev/docs/intents-and-broadcasts.md) - [Send app notifications](https://docs.clover.com/dev/docs/app-notifications.md) - [Use external USB devices](https://docs.clover.com/dev/docs/external-usb-devices.md) - [Test with printer receipt images](https://docs.clover.com/dev/docs/testing-with-printer-receipt-images.md) - [Build with Android NFC (support ended July 2023)](https://docs.clover.com/dev/docs/building-with-android-nfc.md) - [Build apps for Clover Station Duo 2: Dual touch screen device](https://docs.clover.com/dev/docs/build-apps-for-station-duo-2.md) - [Build apps for Clover Station Duo 1 — Dual touch screen device](https://docs.clover.com/dev/docs/building-apps-for-station-pro.md) - [Build payment solutions](https://docs.clover.com/dev/docs/build-payment-solutions.md) - [Custom tender—Use cases and design requirements](https://docs.clover.com/dev/docs/custom-tenders.md) - [Create a custom tender app](https://docs.clover.com/dev/docs/creating-custom-tender-apps.md) - [Payment Connector](https://docs.clover.com/dev/docs/using-payment-connector.md) - [Expand merchant business](https://docs.clover.com/dev/docs/expand-merchant-business.md) - [Use the Order Connector](https://docs.clover.com/dev/docs/using-order-connector.md) - [Use Merchant Connector](https://docs.clover.com/dev/docs/using-merchant-connector.md) - [Work with transaction data: Clover Android SDK](https://docs.clover.com/dev/docs/working-with-transaction-data-android.md) - [Introduction](https://docs.clover.com/dev/docs/semi-integration-introduction.md) - [Payment integration overview](https://docs.clover.com/dev/docs/payments-integration-overview.md) - [Clover device configurations](https://docs.clover.com/dev/docs/clover-device-configurations.md) - [Developer quick start: Clover Kiosk integration](https://docs.clover.com/dev/docs/developer-quick-start-clover-kiosk-integration.md) - [Clover semi-integration basics](https://docs.clover.com/dev/docs/clover-development-basics-semi.md) - [Payments integration options](https://docs.clover.com/dev/docs/paas-integration-options.md) - [Examples of transaction flows](https://docs.clover.com/dev/docs/transaction-flow-examples.md) - [Create your Remote App ID (RAID)](https://docs.clover.com/dev/docs/create-your-remote-app-id.md) - [Private semi-integrated apps](https://docs.clover.com/dev/docs/private-semi-integrated-apps.md) - [Integration development and approval process](https://docs.clover.com/dev/docs/semi-integration-process.md) - [Step 1: Application](https://docs.clover.com/dev/docs/application.md) - [Step 2: Education](https://docs.clover.com/dev/docs/integration-education.md) - [Step 3: Development](https://docs.clover.com/dev/docs/integration-development.md) - [Step 4: Approval](https://docs.clover.com/dev/docs/approval.md) - [Step 5: Maintenance](https://docs.clover.com/dev/docs/integration-maintenance.md) - [Test region-based payment flows](https://docs.clover.com/dev/docs/testing-payment-flows.md) - [Test US payment flows](https://docs.clover.com/dev/docs/testing-us-payment-flows.md) - [Test Canadian payment flows](https://docs.clover.com/dev/docs/testing-canadian-payment-flows.md) - [Customer transactions](https://docs.clover.com/dev/docs/customer-transactions.md) - [Transaction types](https://docs.clover.com/dev/docs/transaction-types.md) - [Per-transaction settings](https://docs.clover.com/dev/docs/using-per-transaction-settings.md) - [Use Remote Pay SDKs for surcharging](https://docs.clover.com/dev/docs/working-with-transaction-data-remote-pay-sdks.md) - [Use Payment Connector for surcharging](https://docs.clover.com/dev/docs/working-with-transaction-data-payment-connector.md) - [Handle voids and refunds](https://docs.clover.com/dev/docs/voids-and-refunds.md) - [Create custom receipts with CloverConnector](https://docs.clover.com/dev/docs/creating-custom-receipts.md) - [Reprint transaction receipts](https://docs.clover.com/dev/docs/reprinting-transaction-receipts.md) - [Vault cards for future transactions](https://docs.clover.com/dev/docs/vaulting-cards.md) - [Handle challenges during payment processing](https://docs.clover.com/dev/docs/working-with-challenges.md) - [Electronic benefit transfer (EBT) transactions](https://docs.clover.com/dev/docs/electronic-benefit-transfer-ebt-cards.md) - [Electronic benefit transfer (EBT) overview](https://docs.clover.com/dev/docs/ebt-overview.md) - [Clover support for EBT](https://docs.clover.com/dev/docs/clover-support-for-ebt.md) - [Semi-Integration glossary](https://docs.clover.com/dev/docs/semi-integration-glossary.md) - [REST Pay Display API overview](https://docs.clover.com/dev/docs/rest-pay-overview.md) - [REST Pay Display API introduction](https://docs.clover.com/dev/docs/rest-pay-intro.md) - [REST Pay Display integration requirement](https://docs.clover.com/dev/docs/rest-pay-architecture.md) - [REST Pay Display Security](https://docs.clover.com/dev/docs/security.md): Security features of REST Pay Display on Clover devices emphasize PCI compliance and require OAuth token authentication for calls to the REST service. - [Get started with REST Pay Display](https://docs.clover.com/dev/docs/rest-pay-development-basics.md) - [Create a semi-integrated app](https://docs.clover.com/dev/docs/creating-a-sandbox-app.md) - [Get an OAuth token](https://docs.clover.com/dev/docs/obtaining-an-oauth-token.md) - [Connect point of sale app to the Clover device](https://docs.clover.com/dev/docs/rest-pay-connection.md) - [Build a cloud connection request](https://docs.clover.com/dev/docs/build-a-cloud-connection-request.md) - [Configure a cloud connection](https://docs.clover.com/dev/docs/configuring-a-cloud-connection.md) - [Build a local connection request](https://docs.clover.com/dev/docs/build-a-local-connection-connection.md) - [Install REST Pay Display app on merchant device](https://docs.clover.com/dev/docs/install-rest-pay-display-app-on-merchant-device.md) - [Configure a local connection](https://docs.clover.com/dev/docs/configuring-a-local-connection.md) - [Workflows and best practices](https://docs.clover.com/dev/docs/workflows-and-best-practices.md) - [Transaction types](https://docs.clover.com/dev/docs/rest-pay-transaction-types.md) - [REST Pay payment flows](https://docs.clover.com/dev/docs/rest-pay-payment-flows.md) - [REST Pay Display interoperability with Ecommerce API](https://docs.clover.com/dev/docs/interoperability-with-ecommerce-api.md) - [Track transactions with idempotency keys](https://docs.clover.com/dev/docs/tracking-transactions-with-idempotency-keys.md) - [Payment reconciliation and recovery](https://docs.clover.com/dev/docs/payment-reconciliation-and-recovery-rest-pay.md) - [Card on File compliance for REST Pay Display](https://docs.clover.com/dev/docs/card-on-file-compliance-for-rest-pay-display.md) - [Currency rounding adjustments](https://docs.clover.com/dev/docs/currency-rounding-adjustments.md) - [Issues and errors](https://docs.clover.com/dev/docs/issues-and-errors.md) - [Check for duplicate payments](https://docs.clover.com/dev/docs/checking-for-duplicate-payments.md) - [Handle offline payments](https://docs.clover.com/dev/docs/handling-offline-payments.md) - [Handle partial payment issues](https://docs.clover.com/dev/docs/handling-partial-payment-issues.md) - [Handle signature issues](https://docs.clover.com/dev/docs/handling-signature-issues.md) - [Handle communication issues](https://docs.clover.com/dev/docs/handling-communication-issues.md) - [Status codes and errors reference](https://docs.clover.com/dev/docs/status-code-and-error-reference.md) - [REST Pay Display API tutorials](https://docs.clover.com/dev/docs/api-tutorials.md) - [Verify device connectivity](https://docs.clover.com/dev/docs/verifying-connectivity.md) - [Display a message to the customer](https://docs.clover.com/dev/docs/displaying-a-message-to-the-customer.md) - [Display the welcome screen](https://docs.clover.com/dev/docs/showing-the-welcome-screen.md) - [Display the thank you screen](https://docs.clover.com/dev/docs/showing-the-thank-you-screen.md) - [Cancel the current action](https://docs.clover.com/dev/docs/canceling-the-current-action.md) - [Get a signature](https://docs.clover.com/dev/docs/getting-a-signature.md) - [Get customer confirmation](https://docs.clover.com/dev/docs/getting-customer-confirmation.md) - [Get customer input](https://docs.clover.com/dev/docs/getting-customer-input.md) - [Request a tip](https://docs.clover.com/dev/docs/requesting-a-tip.md) - [Print a receipt](https://docs.clover.com/dev/docs/printing-a-receipt.md) - [Open the cash drawer](https://docs.clover.com/dev/docs/opening-the-cash-drawer.md) - [Reset the device](https://docs.clover.com/dev/docs/resetting-the-device.md) - [Make a sale](https://docs.clover.com/dev/docs/making-a-sale.md) - [Authorize and capture a tip-adjusted payment on paper](https://docs.clover.com/dev/docs/authorizing-a-tip-adjusted-payment-on-paper.md) - [Authorize and capture a tipped payment on screen](https://docs.clover.com/dev/docs/authorizing-a-tipped-payment-on-screen.md) - [Capture pre-authorized payments](https://docs.clover.com/dev/docs/preauth-payments.md) - [Refund a payment](https://docs.clover.com/dev/docs/refunding-a-charge.md) - [Issue a credit](https://docs.clover.com/dev/docs/issuing-a-credit.md) - [Tokenize and vault a card with REST Pay Display](https://docs.clover.com/dev/docs/creating-a-card-token.md) - [Get a customer's card data](https://docs.clover.com/dev/docs/getting-a-customers-card-data.md) - [Use Custom Activities with REST Pay Display](https://docs.clover.com/dev/docs/using-custom-activities-with-rest-pay-display.md) - [Display an order](https://docs.clover.com/dev/docs/displaying-an-order.md) - [App review and approval](https://docs.clover.com/dev/docs/app-review-and-approval.md) - [Create an app in the production environment](https://docs.clover.com/dev/docs/creating-a-production-app.md) - [Test REST Pay flows (Canada)](https://docs.clover.com/dev/docs/testing-rest-pay-flows-canada.md) - [Test REST Pay flows (Europe)](https://docs.clover.com/dev/docs/test-rest-pay-flows-european-region.md) - [Test REST Pay flows (US)](https://docs.clover.com/dev/docs/testing-rest-pay-flows-us.md) - [Use the Clover Android Payments APIs](https://docs.clover.com/dev/docs/using-clover-android-payments-api.md) - [Android Payments API tutorial](https://docs.clover.com/dev/docs/android-payments-api-payment-tutorial.md) - [Accept a payment](https://docs.clover.com/dev/docs/android-pay-payment.md): Android Payments API - [Retrieve a payment](https://docs.clover.com/dev/docs/payment-retrieval-operations.md): Android Payments API - [Reverse a payment](https://docs.clover.com/dev/docs/android-pay-reverse.md): Android Payments API - [Tokenize a card](https://docs.clover.com/dev/docs/android-pay-tokenize.md): Android Payments API - [Accept a pre-authorization](https://docs.clover.com/dev/docs/android-pay-preauth.md): Android Payments API - [Capture a pre-auth](https://docs.clover.com/dev/docs/android-pay-capture.md): Android Payments API - [Issue a manual refund](https://docs.clover.com/dev/docs/android-payments-api-manual-refund.md): Android Payments API - [Read a card](https://docs.clover.com/dev/docs/android-payments-api-read-a-card.md): Android Payments API - [Incremental authorization](https://docs.clover.com/dev/docs/android-payments-api-incremental-auths.md): Android Payments API - [Request a tip](https://docs.clover.com/dev/docs/android-payments-api-request-a-tip.md): Android Payments API - [Select a receipt](https://docs.clover.com/dev/docs/android-payments-api-select-a-receipt.md): Android Payments API - [Adjust a tip](https://docs.clover.com/dev/docs/android-payments-api-tip-adjust.md): Android Payments API - [Closeout](https://docs.clover.com/dev/docs/android-payments-api-closeout.md): Android Payments API - [Take a payment with Payment Connector](https://docs.clover.com/dev/docs/take-a-payment-with-payment-connector.md): Android Payments API - [Supported methods by device](https://docs.clover.com/dev/docs/supported-methods-by-device.md): Payment Connector - [Payment Connector example activity](https://docs.clover.com/dev/docs/payment-connector-activity-example.md): Android Payments API - [Support timelines (Remote Pay SDKs)](https://docs.clover.com/dev/docs/support-timelines-remote-pay.md) - [Use Clover Connector](https://docs.clover.com/dev/docs/using-clover-connector.md) - [On Windows using .NET](https://docs.clover.com/dev/docs/windows.md): Refers to Windows SDK v4.0 - [On Windows using REST](https://docs.clover.com/dev/docs/on-windows-using-rest.md): Refers to Windows SDK v1.4 version - [On Windows using WebSockets](https://docs.clover.com/dev/docs/on-windows-using-websockets.md): Refers to Windows SDK v1.4 version - [In the Cloud](https://docs.clover.com/dev/docs/cloud-sdk-v3.md) - [On Android](https://docs.clover.com/dev/docs/semi-integrated-android-apps.md): Refers to Android SDK v3.0 - [On iOS](https://docs.clover.com/dev/docs/ios.md): Refers to iOS SDK v4.0 - [Work with user interface state messages](https://docs.clover.com/dev/docs/ui-state-messages.md) - [User interface (UI) state reference](https://docs.clover.com/dev/docs/ui-state-reference.md) - [Payment response reference](https://docs.clover.com/dev/docs/payment-response-reference.md) - [Refund response reference](https://docs.clover.com/dev/docs/refund-response-reference.md) - [Credit response reference](https://docs.clover.com/dev/docs/credit-response-reference.md) - [Remote Pay SDK best practices](https://docs.clover.com/dev/docs/remote-pay-sdk-best-practices.md) - [Device connection and disposal](https://docs.clover.com/dev/docs/device-connection-and-disposal.md) - [Monitor device connection status](https://docs.clover.com/dev/docs/monitoring-device-connection-status.md) - [Payment reconciliation and recovery](https://docs.clover.com/dev/docs/payment-reconciliation-and-recovery.md) - [Retrieve the device state](https://docs.clover.com/dev/docs/retrieving-device-state.md) - [Track transactions with external identifiers (Ids)](https://docs.clover.com/dev/docs/tracking-transactions-with-external-ids.md) - [Use customer-facing platform](https://docs.clover.com/dev/docs/using-customer-facing-platform.md) - [ZVT ECR interface on Clover terminal](https://docs.clover.com/dev/docs/zvt-ecr-interface-on-clover-terminal-1.md) - [Integration repositories](https://docs.clover.com/dev/docs/integration-repositories.md) - [Pay Display apps](https://docs.clover.com/dev/docs/pay-display-apps.md) - [Pay Display apps support matrix by devices and regions](https://docs.clover.com/dev/docs/pay-display-apps-support-matrix-by-devices-and-regions.md) - [Install a Pay Display app](https://docs.clover.com/dev/docs/installing-a-pay-display-app.md) - [Configure Secure Network Pay Display](https://docs.clover.com/dev/docs/configuring-secure-network-pay-display.md) - [Connect the example point of sale (POS) for Clover Windows SDK](https://docs.clover.com/dev/docs/connecting-your-pos-to-clover.md) - [Example apps for the Clover Connector SDKs](https://docs.clover.com/dev/docs/example-apps.md) - [Clover Payments plugins and extensions](https://docs.clover.com/dev/docs/clover-payment-plugins.md): Streamline your online checkout experience with Clover Payments plugins for Adobe Commerce, Shopify, and WordPress. - [Clover Payments plugin for Shopify Online Shop](https://docs.clover.com/dev/docs/clover-payments-plugin-for-shopify-online-shop.md): Merchants with Shopify Online Shops in North America can accept payments using Clover. - [Integrate Clover Payments plugin with Shopify Online Shop](https://docs.clover.com/dev/docs/integrate-clover-payments-plugin-with-shopify-online-shop.md): Pay Anywhere, Sell Everywhere - [Accept and process MOTO payments](https://docs.clover.com/dev/docs/accept-and-process-moto-payments.md) - [Get help—Clover Payments plugin for Shopify Online Shop](https://docs.clover.com/dev/docs/get-help-clover-payments-plugin.md) - [Clover Payments for WooCommerce](https://docs.clover.com/dev/docs/woocommerce.md) - [Install the Clover Payments for WooCommerce plugin](https://docs.clover.com/dev/docs/installing-upgrading-and-uninstalling-payment-extension.md) - [Configure the Clover Payments for WooCommerce plugin](https://docs.clover.com/dev/docs/configuring-the-clover-payment-extension.md) - [Update multi-lingual support](https://docs.clover.com/dev/docs/multilingual-support-1.md) - [Locate the merchant identifier (merchantId)](https://docs.clover.com/dev/docs/locating-merchant-id-1.md) - [Set up an Ecommerce API token](https://docs.clover.com/dev/docs/setting-up-an-api-token.md) - [Process an authorization](https://docs.clover.com/dev/docs/processing-an-authorization.md) - [Authorize and verify orders](https://docs.clover.com/dev/docs/authorizing-and-verifying-orders.md) - [Capture an authorization](https://docs.clover.com/dev/docs/capturing-an-authorization.md) - [Process a sale transaction](https://docs.clover.com/dev/docs/processing-a-sales-transaction.md) - [Verify order processing and transaction](https://docs.clover.com/dev/docs/verifying-order-processing-and-transaction.md) - [Refund an order](https://docs.clover.com/dev/docs/refunding-an-order.md) - [Void an authorized order](https://docs.clover.com/dev/docs/voiding-an-authorized-order.md) - [View surcharges](https://docs.clover.com/dev/docs/viewing-surcharges.md) - [Apple Pay integration for WooCommerce](https://docs.clover.com/dev/docs/woocommerce-apple-pay-integration.md) - [HTTP Status and Error codes](https://docs.clover.com/dev/docs/appendix-1.md) - [Adobe Commerce (Magento 2) Clover Payments plugin](https://docs.clover.com/dev/docs/magento.md) - [Prerequisites](https://docs.clover.com/dev/docs/prerequisites.md) - [Install, upgrade, and uninstall the Clover Payment extension](https://docs.clover.com/dev/docs/installing-magento.md) - [Update multi-lingual support](https://docs.clover.com/dev/docs/multilingual-support.md) - [Configure the Clover Payment extension](https://docs.clover.com/dev/docs/configuration.md) - [Locate the merchant identifier (merchantId)](https://docs.clover.com/dev/docs/locating-merchant-id.md) - [Set up an Ecommerce API token](https://docs.clover.com/dev/docs/configuration-1.md) - [Process an authorization transaction](https://docs.clover.com/dev/docs/authorization-flow.md) - [Capture an authorized transaction](https://docs.clover.com/dev/docs/capturing-authorized-transactions-invoice-generation.md) - [Process a sales flow](https://docs.clover.com/dev/docs/order-status-verification.md) - [Refund a captured order](https://docs.clover.com/dev/docs/refunding-a-captured-order.md) - [Void an authorization](https://docs.clover.com/dev/docs/void-order-request.md) - [View surcharges](https://docs.clover.com/dev/docs/surcharge.md) - [HTTP Status and Error codes](https://docs.clover.com/dev/docs/appendix.md) - [[Legacy] Developer Platform](https://docs.clover.com/dev/docs/legacy-developer-platform.md) - [[Legacy] Get started with the developer platform](https://docs.clover.com/dev/docs/get-started-developer-platform.md): Quick overview of how to use the sandbox and production environments with separate developer accounts - [[Legacy] Get started with the sandbox environment](https://docs.clover.com/dev/docs/get-started-with-sandbox-environment.md) - [Create a sandbox developer account](https://docs.clover.com/dev/docs/create-a-sandbox-account.md): On the legacy Developer Dashboard - [Work with test merchants in sandbox](https://docs.clover.com/dev/docs/use-test-merchants-dashboard.md): On the legacy Developer Dashboard - [Generate a merchant-specific test API token](https://docs.clover.com/dev/docs/generate-a-test-api-token.md): On the legacy Developer Dashboard - [Create an app](https://docs.clover.com/dev/docs/creating-an-app.md): On the legacy Developer Dashboard - [Install your app to a test merchant](https://docs.clover.com/dev/docs/installing-your-app-to-your-test-merchant.md): On the legacy Developer Dashboard - [[Legacy] Get started with the production environment](https://docs.clover.com/dev/docs/clover-app-approval-process.md) - [Create a production developer account](https://docs.clover.com/dev/docs/developer-accounts.md): On the legacy Developer Dashboard - [Set up two-factor authentication (2FA)](https://docs.clover.com/dev/docs/set-up-two-factor-authentication-2fa.md) - [[Legacy] Manage developer accounts](https://docs.clover.com/dev/docs/managing-developer-accounts.md): On the legacy Developer Dashboard - [Add business account details](https://docs.clover.com/dev/docs/add-business-account-details.md) - [Transfer developer account ownership](https://docs.clover.com/dev/docs/transfer-developer-ownership.md): On the legacy Developer Dashboard - [Submit developer account for approval](https://docs.clover.com/dev/docs/developer-account-approval.md): On the legacy Developer Dashboard - [Manage developer account roles and permissions](https://docs.clover.com/dev/docs/developer-account-roles.md): On the legacy Developer Dashboard - [Manage test merchants in production](https://docs.clover.com/dev/docs/working-with-test-merchants.md): On the legacy Developer Dashboard - [[Legacy] Submit your app for approval](https://docs.clover.com/dev/docs/submit-app-for-approval.md): On the legacy Developer Dashboard - [[Legacy] Manage developer bank account information](https://docs.clover.com/dev/docs/billing-information-approval.md): On the legacy Developer Dashboard - [Add developer bank account information](https://docs.clover.com/dev/docs/add-developer-bank-account-information.md): On the legacy Developer Dashboard - [Update developer bank account information](https://docs.clover.com/dev/docs/update-developer-bank-account-information.md): On the legacy Developer Dashboard - [[Legacy] Manage your apps](https://docs.clover.com/dev/docs/app-info-mgmt.md): On the legacy Developer Dashboard - [Manage app settings](https://docs.clover.com/dev/docs/app-settings.md): On the legacy Developer Dashboard - [Work with private apps](https://docs.clover.com/dev/docs/private-apps.md): On the legacy Developer Dashboard - [Set app permissions](https://docs.clover.com/dev/docs/permissions.md): On the legacy Dashboard - [Set modules availability for your app](https://docs.clover.com/dev/docs/understanding-modules.md): On the legacy Developer Dashboard - [Test an app with different merchant service plans](https://docs.clover.com/dev/docs/test-an-app-with-different-merchant-service-plans.md): On the legacy Developer Dashboard - [Customize receipts](https://docs.clover.com/dev/docs/smart-receipts.md): On the legacy Developer Dashboard - [Manage Android app releases](https://docs.clover.com/dev/docs/managing-app-releases.md): On the legacy Developer Dashboard - [Handle app billing](https://docs.clover.com/dev/docs/billing-for-apps.md): On the legacy Developer Dashboard - [Set up pricing tiers](https://docs.clover.com/dev/docs/configuring-billing.md): On the legacy Developer Dashboard - [Set Clover App Market listing](https://docs.clover.com/dev/docs/managing-app-details.md): On the legacy Developer Dashboard - [New and latest: Information for developers](https://docs.clover.com/dev/docs/whats-new.md) - [What's new: 2025](https://docs.clover.com/dev/docs/whats-new-2025.md) - [What's new: 2024](https://docs.clover.com/dev/docs/whats-new-2024.md) - [What's new: 2023](https://docs.clover.com/dev/docs/whats-new-2023.md) - [What's new: 2022](https://docs.clover.com/dev/docs/whats-new-2022.md) - [What's new: 2021](https://docs.clover.com/dev/docs/whats-new-2021.md) - [What's new: 2020](https://docs.clover.com/dev/docs/whats-new-2020.md) - [Bug fixes](https://docs.clover.com/dev/docs/bug-fixes.md) - [Announcements](https://docs.clover.com/dev/docs/release-notes-announcements.md): Developer announcements about products and features - [Clover Kiosk available for Semi-Integration | US](https://docs.clover.com/dev/docs/announcing-clover-kiosk-for-semi-integration-in-us.md) - [Test merchants get the new Clover dashboard](https://docs.clover.com/dev/docs/test-merchants-get-the-new-clover-dashboard.md): March 30, 2026 - [New server-side limits for line items and bulk inventory updates](https://docs.clover.com/dev/docs/new-server-side-limits-for-line-items-and-bulk-inventory-updates.md): March 2026 - [Clover developer round-up 2025: Year in review](https://docs.clover.com/dev/docs/announcement-clover-developer-round-up-2025-year-in-review.md): December 2025 - [End-of-App-Update (EOAU) | Clover 1st Gen devices](https://docs.clover.com/dev/docs/announcement-end-of-app-update-gen-1-devices.md): Cutoff date: May 15, 2026 - [Clover Compact available for Semi-Integration | US](https://docs.clover.com/dev/docs/announcing-clover-compact-for-semi-integration-in-us.md) - [Announcing 2025 Clover code freeze](https://docs.clover.com/dev/docs/announcing-2025-clover-code-freeze.md): Effective: November 10, 2025–January 4, 2026 - [Ecommerce: Updates to WooCommerce plugin](https://docs.clover.com/dev/docs/announcement-woocommerce-plugin-updates.md) - [Expiring access tokens required for apps in all regions](https://docs.clover.com/dev/docs/expiring-tokens-required-in-all-regions.md): Clover apps for merchants across all regions are required to use expiring tokens. - [Launch new apps on the global developer platform](https://docs.clover.com/dev/docs/announcement-launch-new-apps-on-the-global-developer-platform.md): The Global Developer Dashboard is now available for merchants across all regions. - [Arriving soon! Clover Flex Pocket for UK merchants](https://docs.clover.com/dev/docs/arriving-soon-clover-flex-pocket-for-uk-merchants.md): A sleek, handheld device for a quick and secure payment experience - [Elevating payment security with 3D Secure authentication](https://docs.clover.com/dev/docs/announcing-3d-secure-authentication-services.md): Reduce chargebacks and boost checkout confidence - [Available now! Clover Flex 4 for merchants in the UK](https://docs.clover.com/dev/docs/available-soon-clover-flex-4-for-merchants-in-uk.md): A fast and optimized handheld device for a quick and secure payment experience - [Available now! Clover Flex 4 for merchants in Canada](https://docs.clover.com/dev/docs/available-now-clover-flex-4-for-merchants-in-canada.md): A fast and optimized handheld device for a quick and secure payment experience - [PCI DSS v4.0 Requirements 6.4.3 and 11.6.1](https://docs.clover.com/dev/docs/pci-dss-v40-requirements-643-and-1161.md): March 2025 - [Update—Expiring access tokens required in US and Canada](https://docs.clover.com/dev/docs/expiring-access-tokens-coming-in-october-2023-1.md): Updated this announcement to inform that the mandate will be enforced in March 2025. - [Update—Decommissioning of Payeezy Payments plugin on Shopify](https://docs.clover.com/dev/docs/decommissioning-of-payeezy-payments-plugin.md): Switch to the Clover Payments plugin available on Shopify no later than May 1, 2025 - [Clover Android ROM updates](https://docs.clover.com/dev/docs/clover-android-rom-updates-2025.md): Quarterly schedule and update to the Android ROM update on Clover devices - [2024 Announcements](https://docs.clover.com/dev/docs/2024-announcements.md): Developer announcements about products and features in 2024 - [Ecommerce: Clover plugin now supports WordPress 6.7.1](https://docs.clover.com/dev/docs/ecommerce-clover-plugin-supports-wordpress-6-7-1.md): Clover Payments for WooCommerce plugin is now fully compatible with WordPress 6.7.1 - [Arriving soon! Clover Flex 4 for merchants in Europe](https://docs.clover.com/dev/docs/arriving-soon-clover-flex-4-for-merchants-in-europe.md): A fast and optimized handheld device for a quick and secure payment experience - [Test apps for variable length OAuth tokens](https://docs.clover.com/dev/docs/test-apps-for-variable-length-oauth-tokens.md): November 2024 - [Sandbox maintenance updates | November 2024](https://docs.clover.com/dev/docs/sandbox-maintenance-updates-november-2024.md): Sandbox maintenance - [Available now! Clover Flex 4 for US merchants](https://docs.clover.com/dev/docs/available-now-clover-flex-4-for-us-merchants.md): A fast and optimized handheld device for a quick and secure payment experience - [Arriving soon! Clover Flex 4 for merchants in Canada](https://docs.clover.com/dev/docs/arriving-soon-clover-flex-4-for-merchants-in-canada.md): A fast and optimized handheld device for a quick and secure payment experience - [Arriving soon! Clover Flex 4 for US merchants](https://docs.clover.com/dev/docs/arriving-soon-clover-flex4-for-us-merchants.md): A fast and optimized handheld device for a quick and secure payment experience - [Announcing 2024 Clover code freeze](https://docs.clover.com/dev/docs/announcing-2024-clover-code-freeze.md): Effective: November 18, 2024 - January 5, 2025 - [[Latin America] Clover Platform maintenance | October 29](https://docs.clover.com/dev/docs/advance-notice-latin-america-clover-platform-maintenance-october-29.md): October 29, 2024 - [Available now! Clover Flex Pocket for Canada merchants](https://docs.clover.com/dev/docs/available-now-clover-flex-pocket-for-canada-merchants.md): A sleek, handheld device for a quick and secure payment experience - [[Europe] Clover Platform maintenance | October 15](https://docs.clover.com/dev/docs/advanced-notice-europe-platform-maint-ip-address-change.md): October 15, 2024 - [Global developer platform: Enhanced user experience](https://docs.clover.com/dev/docs/announcement-global-developer-dashboard-new-user-interface.md): September, 2024 - [Arriving soon! Clover Flex Pocket for Canada merchants](https://docs.clover.com/dev/docs/arriving-soon-clover-flex-pocket-for-canada-merchants.md): A sleek, handheld device for a quick and secure payment experience - [Action required: Multi-factor authentication (MFA) set up](https://docs.clover.com/dev/docs/mfa-reset-for-global-developer-accounts.md): September, 2024 - [Available now! Clover Flex Pocket for US merchants](https://docs.clover.com/dev/docs/available-now-clover-flex-pocket-for-us-merchants.md): A sleek, handheld device for a quick and secure payment experience - [Arriving soon! Clover Flex Pocket for US merchants](https://docs.clover.com/dev/docs/arriving-soon-clover-flex-pocket-for-us-merchants.md): A sleek, handheld device for a quick and secure payment experience - [Support for credit card surcharging in Canada](https://docs.clover.com/dev/docs/suppport-credit-card-surcharging-canada.md) - [Secure your site: Remove Polyfill references from iframe settings](https://docs.clover.com/dev/docs/alert-remove-iframe-references-to-polyfillio.md): polyfill.io malware security alert - [Announcing multiple service charges feature for new apps](https://docs.clover.com/dev/docs/update-app-to-support-multiple-service-charges.md) - [Updated app charges monthly invoice format and delivery method](https://docs.clover.com/dev/docs/europe-developers-app-charges-pdf-invoice.md) - [Upgraded Merchant Dashboard for US test merchants](https://docs.clover.com/dev/docs/upgraded-merchant-dashboard-for-test-merchants.md) - [Sandbox update planned | January 4, 2024](https://docs.clover.com/dev/docs/sandbox-update-planned-january-4-2024.md) - [Clover Android ROM 2024 updates](https://docs.clover.com/dev/docs/clover-android-rom-2024-update.md): Quarterly schedule and update to the Android ROM update on Clover devices - [Clover Android SDK release notes](https://docs.clover.com/dev/docs/clover-android-sdk.md) - [v306 release notes](https://docs.clover.com/dev/docs/v306-release-notes.md): Clover Android SDK - [v304 release notes](https://docs.clover.com/dev/docs/clover-android-rn-v304.md): Clover Android SDK - [v293 release notes](https://docs.clover.com/dev/docs/v293.md): Clover Android SDK - [v292 release notes](https://docs.clover.com/dev/docs/v292.md): Clover Android SDK - [v288 release notes](https://docs.clover.com/dev/docs/v288.md): Clover Android SDK - [v284 release notes](https://docs.clover.com/dev/docs/clover-android-sdk-v284-release-notes.md): Clover Android SDK - [Clover Go SDK contents](https://docs.clover.com/dev/docs/clover-go-sdk-contents.md) - [Clover Go SDK](https://docs.clover.com/dev/docs/clover-go-sdk.md): Learn how to integrate your iOS® or Android apps with the Clover Go Card Reader. - [Clover Go SDK release notes](https://docs.clover.com/dev/docs/clover-go-sdk-release-notes.md) - [Android—Clover Go SDK release notes](https://docs.clover.com/dev/docs/androidclover-go-sdk-release-notes.md): v1.0.0 - [iOS—Clover Go SDK release notes (v1.0.0)](https://docs.clover.com/dev/docs/clover-go-ios-sdk-release-notes.md): v1.0.0 - [iOS—Clover Go SDK release notes (v1.1.0)](https://docs.clover.com/dev/docs/iosclover-go-sdk-release-notes-v110.md) - [Clover Go SDK quick start guides](https://docs.clover.com/dev/docs/clover-go-sdk-quick-start-guides.md) - [Android—Clover Go SDK quick start guide](https://docs.clover.com/dev/docs/android-clover-go-sdk-quick-start.md) - [iOS—Clover Go SDK quick start guide](https://docs.clover.com/dev/docs/ios-clover-go-sdk-quick-start.md) - [Clover OAuth on Mobile](https://docs.clover.com/dev/docs/clover-oauth-on-mobile.md) - [OAuth terminology for mobile](https://docs.clover.com/dev/docs/go-sdk-terminology.md) - [Android—OAuth on mobile](https://docs.clover.com/dev/docs/android-oauth-on-mobile.md) - [iOS—OAuth on mobile](https://docs.clover.com/dev/docs/iosoauth-on-mobile.md) - [iOS—Full OAuth implementation](https://docs.clover.com/dev/docs/ios-full-oauth.md) - [iOS—Partial OAuth implementation](https://docs.clover.com/dev/docs/ios-partial-oauth.md) - [iOS—No OAuth implementation](https://docs.clover.com/dev/docs/ios-no-oauth.md) - [Device connection](https://docs.clover.com/dev/docs/device-connection.md) - [Android—Device connection](https://docs.clover.com/dev/docs/android-device-connection.md) - [iOS—Device connection](https://docs.clover.com/dev/docs/ios-device-connection.md) - [Clover Go SDK reference](https://docs.clover.com/dev/docs/go-sdk-reference.md) - [Card present payments](https://docs.clover.com/dev/docs/card-present-payments.md) - [Manual entry payments](https://docs.clover.com/dev/docs/manual-entry-payments.md) - [Payment reversal](https://docs.clover.com/dev/docs/payment-reversal.md) - [Capture and tip adjust](https://docs.clover.com/dev/docs/capture-and-tip-adjust.md) - [Closeout](https://docs.clover.com/dev/docs/closeout.md) - [Receipts](https://docs.clover.com/dev/docs/receipts.md) - [Turn on logs for iOS SDK](https://docs.clover.com/dev/docs/turn-on-logs-for-ios-sdk.md) - [Offline payments](https://docs.clover.com/dev/docs/clover-go-offline-payments.md) - [Card-present tokenization](https://docs.clover.com/dev/docs/go-sdk-tokenization.md) - [Design resources](https://docs.clover.com/dev/docs/design-resources.md) - [Supported barcode formats](https://docs.clover.com/dev/docs/supported-barcode-formats-on-clover-devices.md) - [Test card numbers](https://docs.clover.com/dev/docs/test-card-numbers.md) - [Country code reference](https://docs.clover.com/dev/docs/country-code-reference.md) - [Frequently asked questions (FAQs)](https://docs.clover.com/dev/docs/faqs.md) - [Developer support: Frequently asked questions](https://docs.clover.com/dev/docs/developer-support-faqs.md) - [Developer account set up FAQs](https://docs.clover.com/dev/docs/developer-account-set-up-faqs.md) - [App approval and App Market FAQs](https://docs.clover.com/dev/docs/app-approval-and-app-market-faqs.md): Building an app or integrating with Clover? Explore frequently asked questions from developers working with the Clover platform and our Developer Relations team. - [Devices and Dev Kits FAQs](https://docs.clover.com/dev/docs/devices-and-dev-kits-faqs.md) - [OAuth and tokens FAQs](https://docs.clover.com/dev/docs/oauth-and-tokens-faqs.md) - [Android SDK FAQs](https://docs.clover.com/dev/docs/android-sdk-faqs.md) - [Ecommerce FAQs](https://docs.clover.com/dev/docs/ecommerce-faqs.md) - [Inventory FAQs](https://docs.clover.com/dev/docs/inventory-faqs.md) - [Orders FAQs](https://docs.clover.com/dev/docs/orders-faqs.md) - [Payments and Refunds FAQs](https://docs.clover.com/dev/docs/payments-and-refunds-faqs.md) - [Payments (semi) integration FAQs](https://docs.clover.com/dev/docs/payments-semi-integration-faqs.md) - [Automated Clearing House (ACH) FAQs](https://docs.clover.com/dev/docs/ach-faqs.md) - [Merchant dashboard and Reports FAQs](https://docs.clover.com/dev/docs/merchant-dashboard-and-reports-faqs.md) - [General FAQs](https://docs.clover.com/dev/docs/general-faqs.md) ## API Reference - [API Reference overview](https://docs.clover.com/dev/reference/api-reference-overview.md) - [Data types in Clover APIs](https://docs.clover.com/dev/reference/data-types-clover-apis.md): Understand the key data types used in Clover API requests and responses. - [Get all inventory items](https://docs.clover.com/dev/reference/inventorygetitems.md): Displays line items for each category in the inventory for an order. - [Create an inventory item](https://docs.clover.com/dev/reference/inventorycreateitem.md): Creates an inventory item. - [Delete multiple inventory items](https://docs.clover.com/dev/reference/inventorybulkdeleteitems.md): Deletes multiple inventory items in a single request. Add a query string with the parameter `itemIds` and a comma-separated list of one or more `itemId` values. Use this example to create a request to delete three items: {merchantId}/items?itemIds={itemId},{itemId},{itemId} - [Get all inventory without a revenue class](https://docs.clover.com/dev/reference/inventorygetitemsnorevenueclass.md): Retrieves inventory items without a tag or revenue class. `Note:` A revenue class tracks and compares revenue streams and sales of items taxed at variable rates. Tag items you want to track as part of a revenue class. - [Get a single inventory item](https://docs.clover.com/dev/reference/inventorygetitem.md): Retrieves an existing inventory item. - [Update an existing inventory item](https://docs.clover.com/dev/reference/inventoryupdateitem.md): Updates an existing inventory item. Use the POST HTTP method to create an inventory item.

Note: This endpoint cannot be used to update an item's stock quantity. To create or update stock for an item, you must use the Update item stock endpoint. - [Delete an inventory item](https://docs.clover.com/dev/reference/inventorydeleteitem.md) - [Update existing inventory items](https://docs.clover.com/dev/reference/inventorybulkpatchinventoryitems.md): Updates only the changes in the payload without replacing existing inventory items. Use the POST HTTP method to [create multiple inventory items](https://docs.clover.com/reference/inventorybulkcreateinventoryitems). - [Create multiple inventory items](https://docs.clover.com/dev/reference/inventorybulkcreateinventoryitems.md): Creates multiple inventory items in a single request. Use the PUT HTTP method to [update existing inventory items](https://docs.clover.com/reference/inventorybulkpatchinventoryitems). - [Get the stock of all inventory items](https://docs.clover.com/dev/reference/inventorygetitemstocks.md) - [Get the stock of an inventory item](https://docs.clover.com/dev/reference/inventorygetitemstock.md) - [Update the stock of an inventory item](https://docs.clover.com/dev/reference/inventoryupdateitemstock.md) - [Delete the stock of an inventory item](https://docs.clover.com/dev/reference/inventorydeleteitemstock.md) - [Get all item groups](https://docs.clover.com/dev/reference/inventorygetitemgroups.md): Retrieves item groups that allow merchants to create and manage large groups of related items, also known as **Item with variants**. `For example:` A merchant sells a T-shirt that is available in various sizes and colors. Each of the T-shirt variations is an item within the T-shirt item group. When an item group is created, it appears in the Register app as a single button, and tapping it displays a choice of variations for sale. Before adding items to an item group, you need to create the: 1. Item group. 2. Attributes, such as size and color. 3. Options for each attribute, such as small and blue. 4. Individual items and include the item group ID to associate the items with the group. 5. Associate the options with an item. - An item can only belong to an item group if the item group ID is entered when the item is created. - An item can only be a member of a single item group, and once it is part of an item group, it can never be removed or moved to another item group; it can only be deleted. `Note:` The item number of the item group is automatically generated by the Clover server as a combination of the item group name and the names of all the options associated with that item. This item number is not editable. If the item group name or option name is changed, then the item names are automatically regenerated. - [Create an item group](https://docs.clover.com/dev/reference/inventorycreateitemgroup.md) - [Get a single item group](https://docs.clover.com/dev/reference/inventorygetitemgroup.md) - [Update an item group](https://docs.clover.com/dev/reference/inventoryupdateitemgroup.md) - [Delete an item group](https://docs.clover.com/dev/reference/inventorydeleteitemgroup.md) - [Get all tags](https://docs.clover.com/dev/reference/taggettags.md): Retrieves all tags for an order. `Note:` In the REST API, a merchant uses two types of tags: 1. Tags, also known as item labels, are used to keep track of these items in reports. 2. Tags associated with the printer work as a printer label. `Example:` If a tag is associated with both an item and a printer, when the order is printed, the tagged items are printed only on the associated printer. - [Create a tag](https://docs.clover.com/dev/reference/tagcreatetag.md) - [Delete tags](https://docs.clover.com/dev/reference/tagbulkdeletetags.md): Deletes multiple tags in a single request. Add a query string with the parameter `tagIds` and a comma-separated list of one or more `tagIds` values. Use this example to create a request to delete three tags: {merchantId}/tags?tagIds={tagId1},{tagId2},{tagId3} - [Get a single tag](https://docs.clover.com/dev/reference/taggettag.md) - [Update a single tag](https://docs.clover.com/dev/reference/tagupdatetag.md) - [Delete a tag](https://docs.clover.com/dev/reference/tagdeletetag.md) - [Get tags for a single item](https://docs.clover.com/dev/reference/taggetitemtags.md) - [Get all items for a single tag](https://docs.clover.com/dev/reference/taggettaggeditems.md) - [Get a list of all tag to item mappings](https://docs.clover.com/dev/reference/taggettagitems.md) - [Create or delete associations between tags and items](https://docs.clover.com/dev/reference/tagcreateordeletetagitems.md) - [Get all tax rates](https://docs.clover.com/dev/reference/taxrategettaxrates.md): Retrieves all tax rates applicable on an order. A tax rate is a percentage or a flat fee at which an item is taxed. - [Create a tax rate for a merchant](https://docs.clover.com/dev/reference/taxratecreatetaxrate.md) - [Get a single tax rate](https://docs.clover.com/dev/reference/taxrategettaxrate.md) - [Update a single tax rate](https://docs.clover.com/dev/reference/taxrateupdatetaxrate.md) - [Delete a single tax rate](https://docs.clover.com/dev/reference/taxratedeletetaxrate.md) - [Get all categories](https://docs.clover.com/dev/reference/categorygetcategories.md): Retrieves all categories. Items display on the Register app within categories in the order in which they are added to a category. Items may be associated with one or more categories or may not be associated with any category. Categories display in the Register app based on the sort order value for each category. - [Create an item category](https://docs.clover.com/dev/reference/categorycreatecategory.md) - [Delete categories](https://docs.clover.com/dev/reference/categorybulkdeletecategories.md): Deletes multiple categories in a single request. Add a query string with the parameter `categoryIds` and a comma-separated list of one or more `categoryIds` values. Use this example to create a request to delete three categories: {merchantId}/categories?categoryIds={categoryId},{categoryId},{categoryId} - [Get a category](https://docs.clover.com/dev/reference/categorygetcategory.md) - [Update a category](https://docs.clover.com/dev/reference/categoryupdatecategory.md) - [Delete a single item category](https://docs.clover.com/dev/reference/categorydeletecategory.md) - [Update the order for categories on the menu at a time, up to 1000 categories.](https://docs.clover.com/dev/reference/categoryupdatecategorysortorders.md) - [Get all items in a single category](https://docs.clover.com/dev/reference/categorygetcategoryitems.md): Retrieves all items in a category. - [Get all categories of a single item](https://docs.clover.com/dev/reference/categorygetitemcategories.md): Retrieves all categories of an item. - [Create or delete associations between items and categories](https://docs.clover.com/dev/reference/categorycreateordeletecategoryitems.md): Creates or removes the association between a category (or subcategory) and an item. Important: To fully move an item from a parent category to a subcategory, you must send two separate API requests: * Send a request with `delete=true` and the parent category ID to remove the current association. * Send a second request with `delete=false` and the subcategory ID to create the new association. - [Create or delete association between items and tax rates](https://docs.clover.com/dev/reference/taxratecreateordeletetaxrateitems.md): Creates or deletes association between line items and tax rates. For more information, see [Use object associations](https://docs.clover.com/docs/using-object-associations). - [Create a Subcategory](https://docs.clover.com/dev/reference/categorycreatesubcategory.md): Creates a new subcategory within a specified parent category. A subcategory inherits the parent category's hex color code when defined. For more information, see [Manage Subcategories](https://docs.clover.com/dev/docs/manage-subcategories). - [Get items by tax rate](https://docs.clover.com/dev/reference/taxrategetitemsbytaxrate.md) - [Delete a Subcategory](https://docs.clover.com/dev/reference/categorydeletesubcategory.md): Deletes a subcategory based on the `subcatid`. When a subcategory is deleted, all items assigned to it are reassigned to the parent category. For more information, see [Manage Subcategories](https://docs.clover.com/dev/docs/manage-subcategories). - [Get all modifier groups](https://docs.clover.com/dev/reference/modifiergetmodifiergroups.md): Retrieves all modifier groups. Modifier groupings are the categories to which different modifiers belong. Modifier groups can be made available for specific inventory Items by creating an item to a modifier group association. - [Update Subcategory Information](https://docs.clover.com/dev/reference/categoryupdatesubcategory.md): Updates existing information for a specific subcategory. This operation allows you to rename the subcategory or change its assigned color code. For more information, see [Manage Subcategories](https://docs.clover.com/dev/docs/manage-subcategories). - [Create a modifier group](https://docs.clover.com/dev/reference/modifiercreatemodifiergroup.md): Creates a new modifier group. After you create a modifier group, you can associate modifiers with the group. - [View items in a subcategory](https://docs.clover.com/dev/reference/categorygetitemswithsubcategoryassociations.md): Retrieves details for an inventory item, primarily to view its associations with categories and subcategories. Include the `expand=categories.items` query parameter in your request to return a detailed `categories` section listing both top-level categories and subcategories linked to the item. You can identify subcategories by their `parentCategory` field. If you omit this parameter, the response does not include category or subcategory data. For more information, see [Manage subcategories](https://docs.clover.com/dev/docs/manage-subcategories). - [Delete modifier groups](https://docs.clover.com/dev/reference/modifierbulkdeletemodifiergroups.md): Deletes multiple modifier groups in a single request. Add a query string with the parameter `modifierGroupIds` and a comma-separated list of one or more `modifierGroupId` values. Use this example to create a request to delete three modifierGroups: {merchantId}/modifierGroups?modifierGroupIds={modifierGroupId},{modifierGroupId},{modifierGroupId} - [View subcategories in a category](https://docs.clover.com/dev/reference/categorygetcategorydetailswithsubcategories.md): Retrieves category information. When the `expand=subCategories` query parameter is used, the response includes the details of the subcategories associated with the parent category. For more information, see [Manage Subcategories](https://docs.clover.com/dev/docs/manage-subcategories). - [Get a modifier group](https://docs.clover.com/dev/reference/modifiergetmodifiergroup.md): Get a single modifier group by it's UUID - [Update a modifier group](https://docs.clover.com/dev/reference/modifierupdatemodifiergroup.md): Update a modifier group. In order to add modifiers use the create modifiers endpoint. - [Delete a modifier group](https://docs.clover.com/dev/reference/modifierdeletemodifiergroup.md): Delete an existing modifier group, identified by UUID. This also deletes all modifiers within that group. - [Create or delete associations between inventory items and modifier groups](https://docs.clover.com/dev/reference/modifiercreateordeleteitemmodifiergroups.md): Creates or deletes the association between inventory items and modifier groups. Modifiers can only be applied to inventory items associated with that modifier group. For more information, see [Use object associations](https://docs.clover.com/docs/using-object-associations). - [Update the priorities for a collection of up to 200 modifier groups at a time](https://docs.clover.com/dev/reference/modifierupdatemodifiergroupsortorders.md) - [Add Modifiers to a Group](https://docs.clover.com/dev/reference/modifieraddmodifierstogroup.md): Adds one or more modifiers to a modifier group. - [Get all items in a single modifier group](https://docs.clover.com/dev/reference/modifiergetmodifiergroupitems.md): Retrieves a list of all items in a single modifier group. - [Remove Modifiers from a Group](https://docs.clover.com/dev/reference/modifierremovemodifiersfromgroup.md): Removes one or more modifiers from a modifier group. - [Get all modifiers](https://docs.clover.com/dev/reference/modifiergetmodifiers.md): Retrieves all modifiers from all modifier groups. - [Get all modifiers in a single modifier group](https://docs.clover.com/dev/reference/modifiergetmodifiersbygroup.md): Retrieves a list of modifiers in a single modifier group. - [Create a modifier](https://docs.clover.com/dev/reference/modifiercreatemodifier.md): Create a modifier object belonging to the modifier group identified in the URL. - [Get a single modifier](https://docs.clover.com/dev/reference/modifiergetmodifier.md): Get a single modifier by it's group, and it's UUID - [Update a single modifier](https://docs.clover.com/dev/reference/modifierupdatemodifier.md): Update a modifier. Note that once it has been created, it is not possible to change a modifier's group. - [Delete a single modifier](https://docs.clover.com/dev/reference/modifierdeletemodifier.md): Delete a single modifier by it's UUID - [Get all attributes](https://docs.clover.com/dev/reference/inventorygetattributes.md): Retrieves item attributes, for example: size and color of a t-shirt. - [Create an attribute](https://docs.clover.com/dev/reference/inventorycreateattribute.md) - [Get a single attribute](https://docs.clover.com/dev/reference/inventorygetattribute.md) - [Update a single attribute](https://docs.clover.com/dev/reference/inventoryupdateattribute.md) - [Delete a single attribute](https://docs.clover.com/dev/reference/inventorydeleteattribute.md) - [Get all options](https://docs.clover.com/dev/reference/inventorygetoptions.md): Retrieves all available item variants or options. For more information, see [Get all item groups](https://docs.clover.com/reference/inventorygetitemgroups). - [Get all options for an attribute](https://docs.clover.com/dev/reference/inventorygetoptionsbyattribute.md): Retrieves all available variants or options associated with an attribute. - [Create an option](https://docs.clover.com/dev/reference/inventorycreateoption.md) - [Get an attribute and option by ID](https://docs.clover.com/dev/reference/inventorygetoptionbyid.md) - [Update an option](https://docs.clover.com/dev/reference/inventoryupdateoption.md) - [Delete an option](https://docs.clover.com/dev/reference/inventorydeleteoption.md) - [Create or delete item/option association](https://docs.clover.com/dev/reference/inventorycreateordeleteoptionitems.md): See the description for 'get all item groups'. - [Get all discounts](https://docs.clover.com/dev/reference/inventorygetdiscounts.md): Retrieves all discounts associated with an inventory item. - [Create a discount](https://docs.clover.com/dev/reference/inventorycreatediscount.md) - [Get a single discount](https://docs.clover.com/dev/reference/inventorygetdiscount.md) - [Update an discount](https://docs.clover.com/dev/reference/inventoryupdatediscount.md) - [Delete a discount](https://docs.clover.com/dev/reference/inventorydeletediscount.md) - [Get all tax exemption rules](https://docs.clover.com/dev/reference/taxrulesgettaxrules.md): Get a list of tax exemption rules which links order types to items in an order to exclude certain tax rates from those items - [Get an individual tax exemption rule](https://docs.clover.com/dev/reference/taxrulesgettaxrule.md): Returns the tax exemption rule specified in the request - [Create item stock](https://docs.clover.com/dev/reference/inventorycreateitemstock.md): Create a stock count for a single item. - [Get a single merchant](https://docs.clover.com/dev/reference/merchantgetmerchant.md) - [Update a merchant](https://docs.clover.com/dev/reference/merchantupdatemerchant.md) - [Get a merchant's address](https://docs.clover.com/dev/reference/merchantgetmerchantaddress.md) - [Get a merchant's payment gateway configuration](https://docs.clover.com/dev/reference/merchantgetmerchantgateway.md) - [Get a merchant's properties](https://docs.clover.com/dev/reference/merchantgetmerchantproperties.md) - [Update merchant properties](https://docs.clover.com/dev/reference/merchantupdatemerchantproperties.md) - [Get default service charge for a merchant](https://docs.clover.com/dev/reference/merchantgetdefaultservicecharge.md): The Merchant's default service charge, set via the Setup App (https://www.clover.com/setupapp). - [Get a sync token (deprecated)](https://docs.clover.com/dev/reference/syncgetsynctoken.md) - [Get all tip suggestions for a merchant](https://docs.clover.com/dev/reference/merchantgettipsuggestions.md): Retrieves all tip suggestions for a merchant, for example: flat tip or percentage. - [Get a single tip suggestion](https://docs.clover.com/dev/reference/merchantgettipsuggestion.md) - [Update a single tip suggestion](https://docs.clover.com/dev/reference/merchantupdatetipsuggestion.md) - [Get all order types for a merchant](https://docs.clover.com/dev/reference/merchantgetordertypes.md): Retrieves all order types for a merchant. Merchants can create custom order types using the [Clover Setup App](https://www.clover.com/setupapp). These custom order types can be associated with a system order type. See [Return a list of system order types](https://docs.clover.com/reference/merchantgetsystemordertypes). Custom order types can support items in: - all categories (filterCategories=false). To view the categories, send a GET request to [Get all categories](https://docs.clover.com/reference/categorygetcategories). - a subset of the merchant’s categories (filterCategories=true and categories property contains the list of supported categories). Categories display when an order type that supports a subset of the categories is expanded. - [Create Order Type For Merchant](https://docs.clover.com/dev/reference/merchantcreateordertype.md) - [Get a single order type](https://docs.clover.com/dev/reference/merchantgetordertype.md) - [Update a single order type](https://docs.clover.com/dev/reference/merchantupdateordertype.md) - [Delete an order type](https://docs.clover.com/dev/reference/merchantdeleteordertype.md) - [Create or delete associations between order types and categories](https://docs.clover.com/dev/reference/ordercreateordeleteordertypecategories.md) - [Return a list of system order types](https://docs.clover.com/dev/reference/merchantgetsystemordertypes.md): Merchants can create custom Order Types via "/v3/merchants/{mId}/order_types". It is useful to associate these custom order types with particular system order types in order to group things functionally. For example, a merchant may have a "Lunch Take-Out" order type and a "Dinner Take-Out" order type. These two order types can be associated with the "TAKE-OUT-TYPE" system order type so that applications can understand that they are both take-out order types. - [Get all roles for a merchant](https://docs.clover.com/dev/reference/rolegetroles.md): Retrieves all system and employee roles for a merchant's business. - [Create a role](https://docs.clover.com/dev/reference/rolecreaterole.md) - [Get a single role](https://docs.clover.com/dev/reference/rolegetrole.md) - [Update a single role](https://docs.clover.com/dev/reference/roleupdaterole.md) - [Delete a role](https://docs.clover.com/dev/reference/roledeleterole.md) - [Get all tenders for a merchant](https://docs.clover.com/dev/reference/paygetmerchanttenders.md): Retrieves all tenders for a merchant. - [Adds a new tender](https://docs.clover.com/dev/reference/paycreatemerchanttender.md): Returns an object representing newly added merchant tender, with a generated ID. - [Get a single merchant tender](https://docs.clover.com/dev/reference/paygetmerchanttender.md) - [Updates an existing tender](https://docs.clover.com/dev/reference/payupdatemerchanttender.md): Returns an object representing updated merchant tender. - [Deletes an existing tender](https://docs.clover.com/dev/reference/paydeletemerchanttender.md) - [Get a list this merchant opening hours](https://docs.clover.com/dev/reference/merchantgetallmerchantopeninghours.md) - [Create a set of merchant opening hours](https://docs.clover.com/dev/reference/merchantcreatemerchantopeninghours.md) - [Get a specific set of merchant opening hours](https://docs.clover.com/dev/reference/merchantgetmerchantopeninghours.md) - [Update a set of merchant opening hours](https://docs.clover.com/dev/reference/merchantupdatemerchantopeninghours.md) - [Delete a set of merchant opening hours](https://docs.clover.com/dev/reference/merchantdeletemerchantopeninghours.md) - [Get all devices provisioned to a merchant](https://docs.clover.com/dev/reference/devicegetmerchantdevices.md): Returns a list of all devices that are provisioned to the a merchant. This list can be viewed from the Setup App on the merchant's device or web dashboard (https://www.clover.com/setupapp/m/{mId}/devices). - [Get a single device provisioned to a merchant](https://docs.clover.com/dev/reference/devicegetmerchantdevice.md): Returns a single device that is provisioned to a merchant. - [Get all cash events](https://docs.clover.com/dev/reference/cashgetallcashevents.md): Retrieve all cash events for this merchant. Cash events can also be consumed by registering a Webhook callback. See https://docs.clover.com/build/webhooks/ - [Get all cash events for an employee](https://docs.clover.com/dev/reference/cashgetemployeecashevents.md): Retrieve cash events filtered by employee ID. Cash events can also be consumed by registering a Webhook callback. See https://docs.clover.com/build/webhooks/ - [Get all cash events for a device](https://docs.clover.com/dev/reference/cashgetdevicecashevents.md): Retrieve cash events filtered by device ID. Cash events can also be consumed by registering a Webhook callback. See https://docs.clover.com/build/webhooks/ - [Get a list of customers in CSV format](https://docs.clover.com/dev/reference/handlersgetcustomerscsv.md): Gives information for every customer of a merchant by default. - [Get a list of customers](https://docs.clover.com/dev/reference/customersgetcustomers.md): Gives information for every customer of a merchant by default. - [Create a customer](https://docs.clover.com/dev/reference/customerscreatecustomer.md): Creates customer record for a merchant. Note that the request body cannot be null. - [Get a single customer](https://docs.clover.com/dev/reference/customersgetcustomer.md): Returns information for a single customer. - [Update a customer](https://docs.clover.com/dev/reference/customersupdatecustomer.md): Updates information for a single customer. - [Delete a customer](https://docs.clover.com/dev/reference/customersdeletecustomer.md): Deletes a single customer from a merchant. - [Create a phone number for a customer](https://docs.clover.com/dev/reference/customerscreatecustomerphonenumber.md): Creates a phone number associated to a merchant's customer. - [Update a phone number for a customer](https://docs.clover.com/dev/reference/customersupdatecustomerphonenumber.md): Updates a merchant's customer's phone number. - [Delete a customer phone number](https://docs.clover.com/dev/reference/customersdeletecustomerphonenumber.md): Deletes a merchant's customer's phone number. - [Create an email address for a customer](https://docs.clover.com/dev/reference/customerscreatecustomeremailaddress.md): Creates an email address associated to a merchant's customer. - [Update an email address for a customer](https://docs.clover.com/dev/reference/customersupdatecustomeremailaddress.md): Updates a merchant's customer's email address. - [Delete a customer email address](https://docs.clover.com/dev/reference/customersdeletecustomeremailaddress.md): Deletes a merchant's customer's email address. - [Create an address for a customer](https://docs.clover.com/dev/reference/customerscreatecustomeraddress.md): Creates an address associated to a merchant's customer. - [Update an address for a customer](https://docs.clover.com/dev/reference/customersupdatecustomeraddress.md): Updates a merchant's customer's address. - [Delete a customer address](https://docs.clover.com/dev/reference/customersdeletecustomeraddress.md): Deletes a merchant's customer's address. - [Create a credit/debit card entry for a customer](https://docs.clover.com/dev/reference/customerscreatecustomercard.md): "first6" and "last4" fields are required. - [Update a credit/debit card record for a customer](https://docs.clover.com/dev/reference/customersupdatecustomercard.md) - [Delete a customer card](https://docs.clover.com/dev/reference/customersdeletecustomercard.md) - [Create note, birthday, business name for a customer](https://docs.clover.com/dev/reference/customerscreateorupdatecustomermetadata.md): Creates note, birthday, business name associated to a merchant's customer. - [Get all employees](https://docs.clover.com/dev/reference/employeegetemployees.md): Retrieves information about employees associated with a merchant. - [Create an employee](https://docs.clover.com/dev/reference/employeecreateemployee.md): Creates an employee for a merchant. Accepts optional expand parameters. - [Get a single employee](https://docs.clover.com/dev/reference/employeegetemployee.md): Returns information for a single employee. Accepts optional expand query parameters - [Update an employee](https://docs.clover.com/dev/reference/employeeupdateemployee.md): Updates information for a single employee. Accepts optional expand query params. - [Delete an employee](https://docs.clover.com/dev/reference/employeedeleteemployee.md): Deletes a single employee from a merchant, also can't delete the 'owner' employee. - [Get all shifts](https://docs.clover.com/dev/reference/merchantgetallshifts.md) - [Get a single shift](https://docs.clover.com/dev/reference/merchantgetshift.md) - [Get .csv of all shifts](https://docs.clover.com/dev/reference/merchantgetallshiftscsv.md) - [Get all shifts for an employee](https://docs.clover.com/dev/reference/employeegetemployeeshifts.md) - [Create shift for an employee](https://docs.clover.com/dev/reference/employeecreateshift.md) - [Get a single shift](https://docs.clover.com/dev/reference/employeegetemployeeshift.md) - [Update a single shift](https://docs.clover.com/dev/reference/employeeupdateshift.md) - [Delete a single shift](https://docs.clover.com/dev/reference/employeedeleteshift.md): When sending a request, you must include an X-Clover-Account-Id header. The value of the header must be the ID of an employee with the permission to edit shifts. - [Get all orders for an employee](https://docs.clover.com/dev/reference/employeegetemployeeorders.md) - [Create a notification for an app](https://docs.clover.com/dev/reference/appscreatemerchantappnotification.md): Send a message to a device that has your app installed and is listening for notifications. For details on how to use Clover's Android SDK to receive notifications, see: https://github.com/clover/android-examples/tree/master/pushnotificationexample. - [Create a notification for a device](https://docs.clover.com/dev/reference/appscreatedeviceappnotification.md): Push a message to a device that has your app installed and is listening for notifications. For details on how to use Clover's Android SDK to receive notifications see: https://github.com/clover/android-examples/tree/master/pushnotificationexample - [Create an atomic order](https://docs.clover.com/dev/reference/ordercreateatomicorder.md): **Description:** Creates a complete order including line items, modifiers, discounts, and service charges with a single API call. If you need to create an order using multiple API calls with ad-hoc line items and non-Clover inventory items, use [create custom orders](https://docs.clover.com/dev/reference/ordercreateorder).
**Note:** Clover has revoked the limitations of non-Clover inventory items and ad-hoc line items from the create an atomic order endpoint. You can now use the endpoint to create orders, such as create custom orders.
**Limits:** To ensure platform stability, an order is limited to a maximum of 3,000 line items. If this call would cause the order to exceed this limit, the request will fail with a 400 Bad Request error.
**Tutorial:** [Manage orders data](https://docs.clover.com/dev/docs/working-with-orders). - [Checkout an atomic order](https://docs.clover.com/dev/reference/ordercheckoutatomicorder.md): **Description** Builds an order. This includes calculating totals, taxes, discounts, and service charges and then displaying the summary information. The response includes order cart information, the order total, and taxes.
**Note:** Clover has revoked the limitations of non-Clover inventory items and ad-hoc line items from the create an atomic order endpoint. You can now use the endpoint to create orders, such as create custom orders.
**Tutorial:** [Manage orders data](https://docs.clover.com/v3/docs/working-with-orders). - [Gets a list of orders](https://docs.clover.com/dev/reference/ordergetorders.md): Displays a list of orders. See [Manage orders data](https://docs.clover.com/build/working-with-orders/) for more details. - [Create custom orders](https://docs.clover.com/dev/reference/ordercreateorder.md): **Description:** Creates or updates orders with a non-Clover inventory and dynamically calculates taxes. Valid fields are: taxRemoved, note, title, state, testMode, manualTransaction, groupLineItems, and orderType. Use separate API calls to add line items.
**Tip:** Use the [create an atomic order](https://docs.clover.com/dev/reference/ordercreateatomicorder) endpoint to create orders using Clover inventory and leverage the real-time totals and tax calculation features using a single API call.
**Tutorial:** [Create custom orders](https://docs.clover.com/dev/docs/creating-custom-orders). - [Get a single order](https://docs.clover.com/dev/reference/ordergetorder.md): Returns a single order. See https://docs.clover.com/build/working-with-orders/ for more details. - [Update an order](https://docs.clover.com/dev/reference/orderupdateorder.md): Updates a single order. See [working-with-orders](https://docs.clover.com/build/working-with-orders/) for more details. - [Delete an order](https://docs.clover.com/dev/reference/orderdeleteorder.md): Deletes a single order. See https://docs.clover.com/build/working-with-orders/ for more details. - [Get all discounts for an order](https://docs.clover.com/dev/reference/ordergetorderdiscounts.md): Returns all discount details for an `orderid`. - [Create a discount on an order](https://docs.clover.com/dev/reference/ordercreatediscount.md): Creates a discount for an order. - [Delete an order discount](https://docs.clover.com/dev/reference/orderremoveorderdiscount.md): Deletes discount on an order. - [Get all line items for an order](https://docs.clover.com/dev/reference/ordergetorderlineitems.md): Returns all line items for an order. - [Create a new line item](https://docs.clover.com/dev/reference/ordercreatelineitem.md): Creates a new line item for an order. Requests must include either a `price` or an `item` object with an inventory item `id`. **Note:** To ensure platform stability, an order is limited to a maximum of 3,000 line items. If this call would cause the order to exceed this limit, the request will fail with a `400 Bad Request` error. - [Delete all the line items in an order](https://docs.clover.com/dev/reference/orderdeletelineitems.md): Deletes all line items for an order. - [Get a line item](https://docs.clover.com/dev/reference/ordergetorderlineitem.md): Returns a line item for an order. - [Update a line item](https://docs.clover.com/dev/reference/orderupdateorderlineitem.md): Updates a line item for an order. - [Void a line item](https://docs.clover.com/dev/reference/orderdeleteorderlineitem.md): Deletes a line item for an order. - [Create a discount on a line item](https://docs.clover.com/dev/reference/ordercreatelineitemdiscount.md): Creates a discount on a line item for an order. - [Delete a discount](https://docs.clover.com/dev/reference/orderremovediscount.md): Deletes a discount on a line item for an order. - [Apply a modification to a line item](https://docs.clover.com/dev/reference/orderapplymodification.md): Creates a modification, a record of a modifier as it exists at the time it is applied to the lineItem. To view current modifications, use the 'expand=modifications' query parameter on the lineItem. To learn more about applying a modification, see: https://docs.clover.com/build/working-with-orders/#add-item-modifiers. - [Remove a modification from a line item](https://docs.clover.com/dev/reference/orderremovemodification.md): Deletes a modification by UUID, removing the record of an applied modification. - [Create multiple line items](https://docs.clover.com/dev/reference/orderbulkcreatelineitems.md): Creates multiple line items in a single request. Each item must include a price for the request to succeed. The maximum number of line items per request is 100. See [Create multiple lineitems](https://docs.clover.com/docs/creating-custom-orders#create-multiple-line-items) tutorial. **Note:** To ensure platform stability, an order is limited to a maximum of 3,000 line items. If this call would cause the order to exceed this limit, the request will fail with a `400 Bad Request` error. - [Create a payment record on an order](https://docs.clover.com/dev/reference/ordercreatepaymentfororder.md): Payment must include a `positive amount` and a valid `tender ID`. `Note`: This endpoint references external tenders and logs them for bookkeeping purposes. This is not for Clover credits/debit tenders. A merchant's tenders and their IDs can be retrieved from /v3/merchants/mId/tenders. - [Apply a service charge to an order](https://docs.clover.com/dev/reference/orderapplyservicecharge.md): Request body must include the merchant's `service charge ID`. This ID can be retrieved from /v3/merchants/mId/default_service_charge. Each request can set a different name and percentageDecimal as needed for an order. - [Remove service charge from an order](https://docs.clover.com/dev/reference/orderremoveservicecharge.md): Removes service charge from an order. Request body must include the merchant's `service charge ID`. This ID can be retrieved from /v3/merchants/mId/default_service_charge. Each request can set a `different name` and `percentageDecimal` as needed for an order. - [Create a list of voided line items](https://docs.clover.com/dev/reference/ordervoidorderlineitem.md): Creates a list of voided line items for an order. - [Get summary about line items and orders which were deleted](https://docs.clover.com/dev/reference/handlergetvoidedlineitemstotals.md): Returns detailed information about line items and orders which were deleted. - [Create or exchange a line item](https://docs.clover.com/dev/reference/ordersetorderlineitem.md): Creates or exchange line items for an order. - [Get all payments for an order](https://docs.clover.com/dev/reference/paygetorderpayments.md): Displays payment information, including the total amount, tip amount, tax amount, and result status for an `order`. - [Get all authorizations](https://docs.clover.com/dev/reference/paygetauthorizations.md): An authorization is a permission by a card issuer that a merchant can charge the customer in the future up to the specified amount. An authorization is created when a merchant uses the Bar Tabs and Authorizations apps. - [Create an authorization on a Payment](https://docs.clover.com/dev/reference/paycreateauthorization.md): An authorization must reference a payment, have an amount greater than 0, and have a type. - [Get a single authorization](https://docs.clover.com/dev/reference/paygetauthorization.md): Retrieve an authorization for a payment, have an amount greater than 0, and have a type. - [Update an authorization](https://docs.clover.com/dev/reference/payupdateauthorization.md): Creates an authorization for a payment, have an amount greater than 0, and have a type. - [Delete an authorization](https://docs.clover.com/dev/reference/paydeleteauthorization.md): Deletes an authorization for a payment, have an amount greater than 0, and have a type. - [Get all payments](https://docs.clover.com/dev/reference/paygetpayments.md): Retrieves payment information, including the total amount, tip amount, tax amount, and result status. - [Get a single payment](https://docs.clover.com/dev/reference/paygetpayment.md): Retrieve a single payment information, including the total amount, tip amount, tax amount, and result status. - [Update a payment](https://docs.clover.com/dev/reference/payupdatepayment.md): This endpoint can only be used to update the following information: 1. `lineItemPayments` 2. `employee.id` (if the payment is a preauth with `captured` currently set to `null)`. All other properties in the request are ignored. - [Get all payments under an employee](https://docs.clover.com/dev/reference/paygetemployeepayments.md): Displays payment information, including the total amount, tip amount, tax amount, and result status for an `employee`. - [Get all refunds for a merchant](https://docs.clover.com/dev/reference/paygetrefunds-3.md): Retrieves refunds for a merchant, including associated taxes and tips. **Data Retrieval Rules:** * **90-Day Limit:** This endpoint returns a maximum of 90 days of refund data. * **Automatic Time-Filter Adjustment:** If a query's time-based filter (e.g., `createdTime` or `clientCreatedTime`) spans more than 90 days, the server automatically adjusts the range to fetch only the most recent 90 days of results. - [Get a single refund](https://docs.clover.com/dev/reference/paygetrefund-3.md): Displays a single refund associated with a payment, including taxes and tips. - [Get a list of credit refunds](https://docs.clover.com/dev/reference/paygetcreditrefunds-3.md): Displays a list of credit refunds associated with a payment, including taxes and tips. - [Get a credit refund](https://docs.clover.com/dev/reference/paygetcreditrefund-3.md): Displays a credit refund associated with a payment, including taxes and tips. - [Get merchant app billing information](https://docs.clover.com/dev/reference/appsgetmerchantbillinginfo-3.md): Retrieves the status of a merchant's app billing, including the current subscription tier and trial status. Requires an [OAuth-generated token](https://docs.clover.com/docs/using-oauth-20). - [Get all events for an app metered event type](https://docs.clover.com/dev/reference/appsgetmerchantappmeteredevents-3.md): Retrieves all billing events for app metered event types such as `reservation`. Requires an OAuth-generated token. See [Set up pricing](https://docs.clover.com/docs/configuring-billing#metered-pricing). - [Create an app billing metered event](https://docs.clover.com/dev/reference/appscreatemerchantappmeteredevent-3.md): Creates an app billing metered event. Clover charges the merchant for each action they take on the app based on the amount specified on the app's [Pricing & Distribution](https://docs.clover.com/docs/configuring-billing#subscription-pricing) page. Pass `count` as a query parameter to bill the merchant for the number of metered events. `count` is ignored if you pass it in the request body. Otherwise, `count` defaults to 1. Requires an OAuth-generated token. See [Set up pricing tiers](https://docs.clover.com/docs/configuring-billing#metered-pricing). - [Get an app billing metered event](https://docs.clover.com/dev/reference/appsgetmerchantappmeteredevent-3.md): Retrieves the event details on a merchant's app billing metered event. Requires an OAuth-generated token. See [Set up pricing tiers](https://docs.clover.com/docs/configuring-billing#metered-pricing). - [Delete app billing metered event](https://docs.clover.com/dev/reference/appsdeletemerchantappmeteredevent-3.md): Deletes an app metered event if the event was not already billed. Requires an [OAuth-generated token](https://docs.clover.com/docs/using-oauth-20). - [Submit a print request to the merchant's default order printer](https://docs.clover.com/dev/reference/ordercreateprintevent-3.md): Submits the `Printrequest` associated with the specific `merchantid`. - [Get a print event by its ID](https://docs.clover.com/dev/reference/ordergetprintevent-3.md): Returns the `PrintOrder` associated with the specified `eventId`. A complete response, which contains the printing device, print category, and job state, is returned If the state of the print event is CREATED, PRINTING, or FAILED. Once the job is successfully printed, it is discarded and cannot be replayed. - [Multiple service charges (MSC) REST API Index](https://docs.clover.com/dev/reference/msc-apiref-index.md): Index of multiple service charges (MSC) REST API endpoints. - [MSC INVENTORY](https://docs.clover.com/dev/reference/inventory-2.md): **MSC INVENTORY** contains INVENTORY API endpoints created or updated for the multiple service charges (MSC) feature. - [Get all configured service charges for a merchant](https://docs.clover.com/dev/reference/inventorygetorderfees-2.md): Retrieves all service charges created for a merchant. - [Get a specific configured service charge for a merchant](https://docs.clover.com/dev/reference/inventorygetorderfee-2.md): Retrieves a specific service charge created for a merchant. - [MSC ORDERS](https://docs.clover.com/dev/reference/orders-3.md): **MSC ORDERS** contains ORDERS API endpoints created or updated for the multiple service charges (MSC) feature. - [Gets a list of orders](https://docs.clover.com/dev/reference/ordergetorders-3.md): Displays a list of orders. See [Manage orders data](https://docs.clover.com/build/working-with-orders/) for more details. - [Create custom orders](https://docs.clover.com/dev/reference/ordercreateorder-3.md): Creates or updates orders with a non-Clover inventory and dynamically calculates taxes. Valid fields are: taxRemoved, note, title, state, testMode, manualTransaction, groupLineItems, and orderType. Use separate API calls to add line items. See the tutorial [Create custom orders](https://docs.clover.com/docs/creating-custom-orders). To create orders with Clover inventory and leverage real-time totals and tax calculation features, use the [Create an atomic order](https://docs.clover.com/docs/creating-custom-orders) endpoint and see the tutorial to [Manage orders data](https://docs.clover.com/docs/working-with-orders). - [Get a single order](https://docs.clover.com/dev/reference/ordergetorder-3.md): Returns a single order. See https://docs.clover.com/build/working-with-orders/ for more details. - [Update an order](https://docs.clover.com/dev/reference/orderupdateorder-3.md): Updates a single order. See [working-with-orders](https://docs.clover.com/build/working-with-orders/) for more details. - [Delete an order](https://docs.clover.com/dev/reference/orderdeleteorder-3.md): Deletes a single order. See https://docs.clover.com/build/working-with-orders/ for more details. - [Get all line items for an order](https://docs.clover.com/dev/reference/ordergetorderlineitems-3.md): Returns all line items for an order. - [Create a new line item](https://docs.clover.com/dev/reference/ordercreatelineitem-3.md): Creates a new item list for an order. However, requests must include a price or inventory item id. **Note:** To ensure platform stability, an order is limited to a maximum of 2,500 line items. If this call would cause the order to exceed this limit, the request will fail with a `400 Bad Request` error. - [Delete all the line items in an order](https://docs.clover.com/dev/reference/orderdeletelineitems-3.md): Deletes all line items for an order. - [Get a line item](https://docs.clover.com/dev/reference/ordergetorderlineitem-3.md): Returns a line item for an order. - [Update a line item](https://docs.clover.com/dev/reference/orderupdateorderlineitem-3.md): Updates a line item for an order. - [Void a line item](https://docs.clover.com/dev/reference/orderdeleteorderlineitem-3.md): Deletes a line item for an order. - [Create a discount on a line item](https://docs.clover.com/dev/reference/ordercreatelineitemdiscount-3.md): Creates a discount on a line item for an order. - [Create multiple line items](https://docs.clover.com/dev/reference/orderbulkcreatelineitems-3.md): Create multiple line items in a single request. Each item must include a price for the request to succeed. The maximum number of line items per request is 100. **Note:** To ensure platform stability, an order is limited to a maximum of 2,500 line items. If this call would cause the order to exceed this limit, the request will fail with a `400 Bad Request` error. - [Get all service charges applied to an order](https://docs.clover.com/dev/reference/ordergetorderfeelineitems-2.md): Retrieves all service charges applied to an order. - [Create a service charge on an order](https://docs.clover.com/dev/reference/ordercreateorderfeelineitem-2.md): Creates a service charge to an order. - [Get a specific service charge applied to an order](https://docs.clover.com/dev/reference/ordergetorderfeelineitem-2.md): Retrieves a specific service charge applicable to an order. - [Void or remove a service charge from an order](https://docs.clover.com/dev/reference/orderdeleteorderfeelineitem-2.md): Removes a service charge from an existing order. - [Get orders](https://docs.clover.com/dev/reference/getorders.md): Retrieves a list of the merchant's orders. Newest order displays first in the list. - [Create an order](https://docs.clover.com/dev/reference/postorders.md): Creates a new order object. - [Get an order](https://docs.clover.com/dev/reference/getordersid.md): Retrieves the details of an existing order. - [Pay for an order](https://docs.clover.com/dev/reference/postordersidpay.md): Pays for a specific order with a payment `source`. **Important:** Either a payment `source` or `customer` must be associated with an order for payment. If a customer is not attached to the order, then the `source` in this field is charged for the order. - [Return an order](https://docs.clover.com/dev/reference/postordersidreturns.md): Retrieves all or a part of an order. An order must be paid or fulfilled for any part of the order to display. - [Create a charge](https://docs.clover.com/dev/reference/createcharge.md): Charges a credit card or other payment source using data in the `charge` object. See [Create a charge](https://docs.clover.com/docs/create-a-charge) tutorial for more information. - [Get charges](https://docs.clover.com/dev/reference/getcharges.md): Displays a list of existing charges. First displays the newest charge in the list. See [Get charges](https://docs.clover.com/docs/get-charges) tutorials for more information. - [Get a charge](https://docs.clover.com/dev/reference/getchargescharge.md): Retrieves the details of an existing charge. This information is also returned when a charge is first created, see [create a charge](https://docs.clover.com/reference/createcharge) or if it is refunded, see [create a refund](https://docs.clover.com/reference/createrefund). - [Capture a charge](https://docs.clover.com/dev/reference/capturecharge.md): As step two of the two-part payment flow, captures the payment of an existing but uncaptured charge. The first step is to [create a charge](https://docs.clover.com/reference/createcharge) with the capture option set to `false`. - [Create a card-on-file customer](https://docs.clover.com/dev/reference/createcustomer.md): Creates a card-on-file (COF) customer record for e-commerce transations. If you do not want to save card data for the customer, use the [create a customer](https://docs.clover.com/reference/customerscreatecustomer) in the Platform API. - [Revoke a payment source](https://docs.clover.com/dev/reference/revokecard.md): Removes a payment `source`, such as card or ACH token, from the customer profile. Use [Create a card token](https://docs.clover.com/reference/create-card-token) or [Create an ACH token](https://docs.clover.com/reference/create-ach-token) to create payment source. - [Update a customer](https://docs.clover.com/dev/reference/updatecustomer.md): Updates an existing customer profile, including a card associated with the customer. - [Create a refund](https://docs.clover.com/dev/reference/createrefund.md): Creates a new refund that must be associated with an existing charge. Refunds are applied to the `source` used for the original payment. Partial refunds are allowed up to the original charge amount. - [Get refunds list](https://docs.clover.com/dev/reference/listrefunds.md): Returns a list of all existing refunds. The newest refund is first in the list. The ten most recent refunds appear by default on the `charge` object. - [Get a refund](https://docs.clover.com/dev/reference/getrefund.md): Returns details of a specific refund. - [Request gift card balance](https://docs.clover.com/dev/reference/balanceinquiry.md): Retrieves the current balance on an active gift card. For more information, see [Use the gift card API](https://docs.clover.com/docs/gift-card-api). **Note:** To view detailed information about the Gift Cards Dashboard, including activation, balance, and liability reports, see [Clover Help](https://www.clover.com/help/). Gift Card customers can also download and use the Gyft app to manage their digital gift cards and check their gift card balances conveniently. - [Reload gift card](https://docs.clover.com/dev/reference/reload.md): Reloads an active gift card with a given amount. For more information, see [Use the gift card API](https://docs.clover.com/docs/gift-card-api). **Note:** To view detailed information about the Gift Cards Dashboard, including activation, balance, and liability reports, see [Clover Help](https://www.clover.com/help/). Gift Card customers can also download and use the Gyft app to manage their digital gift cards and check their gift card balances conveniently. - [Request cashout of gift card balance](https://docs.clover.com/dev/reference/cashout.md): Removes the remaining balance from an active gift card account. For more information, see [Use the gift card API](https://docs.clover.com/docs/gift-card-api). **Note:** To view detailed information about the Gift Cards Dashboard, including activation, balance, and liability reports, see [Clover Help](https://www.clover.com/help/). Gift Card customers can also download and use the Gyft app to manage their digital gift cards and check their gift card balances conveniently. - [Create and activate physical and virtual gift card](https://docs.clover.com/dev/reference/activation.md): Activates a physical or virtual gift card. For more information, see [Use the gift card API](https://docs.clover.com/docs/gift-card-api). **Note:** To view detailed information about the Gift Cards Dashboard, including activation, balance, and liability reports, see [Clover Help](https://www.clover.com/help/). Gift Card customers can also download and use the Gyft app to manage their digital gift cards and check their gift card balances conveniently. - [Create checkout](https://docs.clover.com/dev/reference/createcheckout.md): > **Note:** To use this endpoint, please select the **API Sandbox server** (`https://apisandbox.dev.clover.com`) from the Base URL dropdown in the right panel. Creates a hosted checkout payment object to connect an application. Use this endpoint to request a new checkout session for a customer transaction. For more information, see [Create a Hosted Checkout session request](https://docs.clover.com/dev/docs/creating-a-hosted-checkout-session). - [Retrieve an Ecommerce API key or PAKMS key](https://docs.clover.com/dev/reference/getapikey.md): **Prerequisite: **[Generate an OAuth API token or access_token](https://docs.clover.com/dev/docs/generate-an-oauth-api-token-or-access_token). **Description: **Retrieves the public Ecommerce API key associated with a specific merchant and developer app. The <> and App ID are available in the OAuth API token or `access_token`. **Tutorial: **[Generate an Ecommerce API key (PAKMS key)](https://docs.clover.com/dev/docs/generate-ecommerce-api-key-or-pakms-key). **Next step: **Use the Ecommerce API key for tokenization. See [Ecommerce tokenization overview](https://docs.clover.com/dev/docs/ecommerce-tokenization-overview). - [Create a card token](https://docs.clover.com/dev/reference/create-card-token.md): Creates a single-use token, which is a unique code that indicates credit card details. Use this token with endpoints like [create a charge](https://docs.clover.com/reference/createcharge) or [pay for an order](https://docs.clover.com/reference/postordersidpay). - [Create Clover token from an external token](https://docs.clover.com/dev/reference/create-token-from-external.md): **Description:** Creates a Clover token from an external multi-pay token such as TransArmor®. **Tutorial:** [Use existing TransArmor tokens](https://docs.clover.com/dev/docs/use-existing-transarmor-tokens). **Next steps:** Use this Clover token with endpoints like [create a charge](https://docs.clover.com/reference/createcharge) or [pay for an order](https://docs.clover.com/reference/postordersidpay). - [Create an Apple Pay token](https://docs.clover.com/dev/reference/create-apple-pay-token.md): **Prerequisite:** [Generate an Ecommerce API key (PAKMS key)](https://docs.clover.com/dev/reference/getapikey).
**Description:** Creates an Apple Pay® token for the digital wallet.
**Tutorial:** [Create an Apple Pay token](https://docs.clover.com/dev/docs/create-applepaywallet-token).
**Next steps:** Use this token with endpoints like [create a charge](https://docs.clover.com/reference/createcharge) or [pay for an order](https://docs.clover.com/reference/postordersidpay). - [Create an ACH token](https://docs.clover.com/dev/reference/create-ach-token.md): Creates a single-use token, which is a unique code that indicates Automated Clearing House (ACH) details. Use this token with endpoints like [create a charge](https://docs.clover.com/reference/createcharge) or [pay for an order](https://docs.clover.com/reference/postordersidpay). - [Create a gift card token](https://docs.clover.com/dev/reference/create-gift-card-token.md): **Prerequisite:** [Generate an Ecommerce API key (PAKMS key)](https://docs.clover.com/dev/docs/generate-ecommerce-api-key-or-pakms-key). **Description:** Activates a <>. Also, creates and activates a <> with a promotional code. **Tutorial:** [Create a gift card token](https://docs.clover.com/dev/docs/create-a-gift-card-token). **Next steps**: Use the gift card token to [create a charge](https://docs.clover.com/reference/createcharge) or [pay for an order](https://docs.clover.com/reference/postordersidpay) and with the [Gift Card API endpoints](https://docs.clover.com/dev/docs/gift-card-api). - [Get all plans](https://docs.clover.com/dev/reference/getplans.md): Retrieves a set of merchant plans that customers can use to initiate automatic payments. Each plan defines a fixed amount, periodic frequency, tax, convenience fees, tips, and so on. You can create as many recurring payment plans as required. - [Create a plan](https://docs.clover.com/dev/reference/create.md): Creates a merchant plan that customers can use to initiate automatic payments. Each plan defines a fixed amount, periodic frequency, tax, convenience fees, tips, and so on. You can create as many recurring payment plans as required. - [Delete a plan](https://docs.clover.com/dev/reference/deleteplan.md): Deletes a plan based on the `planId`. - [Get a plan](https://docs.clover.com/dev/reference/get.md): Retrieves a specific plan based on the planId . Each plan defines a fixed amount, periodic frequency, tax, convenience fees, tips, and so on. You can create as many recurring payment plans as required. - [Update a plan](https://docs.clover.com/dev/reference/editplan.md): Updates a merchant plan that customers can use to initiate automatic payments. Each plan defines the fixed amount, periodic frequency, tax, convenience fees, tip, and so on. You can create as many recurring payment plans as required. - [Get subscriptions under a plan](https://docs.clover.com/dev/reference/getsubscriptionsbyplanid.md): Retrieves subscriptions under a plan. Merchants can create subscriptions that associate customers with specific plans, including details such as customer billing information, card-on-file, scheduled payment amount, start date, and payment intervals. - [Create a subscription under a plan](https://docs.clover.com/dev/reference/createsubscription.md): Creates a subscription under a plan, including details such as customer billing information, card-on-file, scheduled payment amount, start date, and payment intervals. - [Delete a subscription](https://docs.clover.com/dev/reference/delete.md): Deletes a subscription based on the `subscriptionId`. - [Get a subscription](https://docs.clover.com/dev/reference/getsubscription.md): Retrieves all subscriptions for a merchant. Merchants can create subscriptions that associate customers with specific plans, including details such as customer billing information, card-on-file, scheduled payment amount, start date, and payment intervals. - [Update a subscription](https://docs.clover.com/dev/reference/update.md): Updates a subscription based on the subscriptionId. Merchants can create subscriptions that associate customers with specific plans, including details such as customer billing information, card-on-file, scheduled payment amount, start date, and payment intervals. - [Get all subscriptions](https://docs.clover.com/dev/reference/getallsubscriptions.md): Retrieves all subscriptions for a merchant. Merchants can create subscriptions that associate customers with specific plans, including details such as customer billing information, card-on-file, scheduled payment amount, start date, and payment intervals. - [Send a payment request to a Clover device](https://docs.clover.com/dev/reference/pay.md): Starts the payment flow for the transaction type specified in the request. Once the customer finishes their payment, a payment response is returned, and the device returns to the idle state. - [Get a payment by externalPaymentId](https://docs.clover.com/dev/reference/get_payment_by_external_payment_id.md): Get information about a payment by a specifying its `externalPaymentId`. - [Get a payment](https://docs.clover.com/dev/reference/get_payment.md): Get information about a payment by specifying its Clover payment UUID. - [Capture a pre-auth payment](https://docs.clover.com/dev/reference/capture.md): Finish a pre-auth transaction by capturing the final amount. - [Increment an authorization (pre-auth)](https://docs.clover.com/dev/reference/increment_auth.md): Increase the authorized amount of a transaction to verify the cardholder has sufficient funds for the purchase. - [Tip adjust a payment](https://docs.clover.com/dev/reference/tip_adjust_payment.md): For an unclosed payment, add a `tipAmount` or update an existing tip. Tips are not additive; the most recent amount is applied at closeout. - [Read a card's track data using a Clover device](https://docs.clover.com/dev/reference/read_card.md): A call to this endpoint initiates a read card operation on a Clover device and returns the card track data. The data will be encrypted unless the card read is not a financial card or the card's BIN has been allowlisted. - [Create a card token for use with subsequent payments](https://docs.clover.com/dev/reference/request_token.md): A call to the token endpoint is used to create either a single-use or multi-pay token that can be used for subsequent transactions. Note: Tokenization through REST Pay Display API is not supported in Europe. - [Send a credit request to the Clover device](https://docs.clover.com/dev/reference/credit.md): A credit is a refund that is not associated with an existing payment. - [Get a credit](https://docs.clover.com/dev/reference/get_credit.md): Get information about a credit by specifying its Clover credit UUID. - [Refund a payment](https://docs.clover.com/dev/reference/refund.md): Returns some or all of a payment amount to the cardholder. - [Void a payment](https://docs.clover.com/dev/reference/void.md): Cancels the specified payment before it is settled. The payment will be recorded as a void, but Clover may convert the void into a refund at the payment gateway under certain conditions. For final payments (where the `final` flag is set to `true`), a void cannot be processed outside of the settlement window (more than 25 minutes after the payment). When a void is not possible, Clover performs a refund instead of a void. - [Cancel any in-flight operations](https://docs.clover.com/dev/reference/cancel-1.md): Sends a cancel command from the POS software to stop any in-flight operations. See the following pages for more information about canceling and the possible impact on in-progress payments: * [Tracking transactions with idempotency keys](https://docs.clover.com/docs/tracking-transactions-with-idempotency-keys) * [Payment reconciliation and recovery](https://docs.clover.com/docs/payment-reconciliation-and-recovery-rest-pay) - [Opens the specified cash drawer](https://docs.clover.com/dev/reference/open_attached_cash_drawer.md): Sends a signal to open the specified cash drawer attached to a Clover device. - [Retrieve a list of cash drawers](https://docs.clover.com/dev/reference/retrieve_cash_drawers.md): Retrieve a list of the device's connected cash drawers. Discovery of a cash drawer only indicates that it is either connected now, or there is an available hardware port allowing one to be connected. For example, local RJ12-type cash drawers may or may not actually be connected at the time this operation is invoked but will be returned regardless. Other types of cash drawers (e.g. USB cash drawers) may only be discovered if they are physically connected at the time of the call. - [Execute a custom activity](https://docs.clover.com/dev/reference/custom_activity.md): Launches the specified activity that has been previously installed to the device. - [Get merchant devices](https://docs.clover.com/dev/reference/get_devices.md): Gets activated and associated devices for the merchant - [Display a message](https://docs.clover.com/dev/reference/display_message.md): A call to the display endpoint sends a text string that is displayed on the idle terminal. - [Display an order](https://docs.clover.com/dev/reference/display_order.md): Displays the order screen on the idle terminal. The values passed in this request are used as is. They are not used in any calculations, updating of existing order. This is strictly a UI request that shows a helpful screen to customers to show them what they are purchasing before starting a payment request. - [Verify connectivity](https://docs.clover.com/dev/reference/ping_device_get.md): Check that your app can connect to the Clover device. - [Verify connectivity](https://docs.clover.com/dev/reference/ping_device.md): Check that your app can connect to the Clover device. - [Get the status of a print job](https://docs.clover.com/dev/reference/get_print_job_status.md): Checks the status of a previously sent print job. - [Print an image](https://docs.clover.com/dev/reference/print_image_on_device.md): Sends an image print job to a Clover device. - [Print text](https://docs.clover.com/dev/reference/print_text_on_device.md): Sends a text print job to a Clover device. - [Retrieve a list of printers](https://docs.clover.com/dev/reference/retrieve_printers_get.md): Retrieve a list of the device's connected printers. - [Retrieve a list of printers](https://docs.clover.com/dev/reference/retrieve_printers.md): Retrieve a list of the device's connected printers. - [Get a user confirmation response](https://docs.clover.com/dev/reference/read_confirmation.md): Retrieves a confirmation response (`true` or `false`) from the specified Clover terminal. This is typically used to ask a customer a yes-no question. - [Get a text response](https://docs.clover.com/dev/reference/read_input.md): Displays a request for information and returns the data entered by the customer. The request can also specify a data entry format to make it easier for the customer to provide their information. - [Get a signature](https://docs.clover.com/dev/reference/read_signature.md): Displays the signature entry screen so the user can acknowledge acceptance with their signatures. Apps do not need to call this endpoint to get a customer's signature for a payment. The signature screen will appear automatically if the merchant's settings are configured to require one for a given transaction. - [Get a tip](https://docs.clover.com/dev/reference/read_tip.md): Displays a message on a Clover device requesting customer selection of a tip amount or percentage. - [Resets the device and cancels any in-flight operations](https://docs.clover.com/dev/reference/reset_device.md): Resets the device to an initial state, cancelling all in-flight commands, if any, from the POS software. See the following pages for more information about the possible impact on in-progress payments: * [Tracking transactions with idempotency keys](https://docs.clover.com/docs/tracking-transactions-with-idempotency-keys) * [Payment reconciliation and recovery](https://docs.clover.com/docs/payment-reconciliation-and-recovery-rest-pay) - [Get the device's status](https://docs.clover.com/dev/reference/device_status.md): Requests the status of the Clover device. - [Send device debug logs](https://docs.clover.com/dev/reference/send_debug_logs.md): Allows a developer to remotely trigger a Clover device to send its debug logs to Clover's servers. The `message` in the request body is logged to the device log, allowing developers to mark specific sequences for easier troubleshooting. **Note:** This endpoint is rate-limited to one successful request every 30 minutes per device to prevent server overload. It is intended for REST API integrations like Cloud Pay Display. - [Display a thank you screen](https://docs.clover.com/dev/reference/show_thank_you.md): Displays the thank you screen on the idle terminal. - [Display the welcome screen](https://docs.clover.com/dev/reference/show_welcome.md): Displays the welcome screen on the idle terminal. - [Deliver a credit receipt](https://docs.clover.com/dev/reference/deliver_credit_receipt.md): Deliver a credit receipt in the format specified in the request. - [Display receipt options](https://docs.clover.com/dev/reference/receipt_options.md): Presents the customer with choices for their transaction receipt. - [Deliver a payment receipt](https://docs.clover.com/dev/reference/deliver_payment_receipt.md): Deliver a payment receipt in the format specified in the request. - [Deliver a void receipt](https://docs.clover.com/dev/reference/deliver_void_receipt.md): Deliver a void receipt in the format specified in the request. `PRINT` is the only supported format at this time. - [Deliver a refund receipt](https://docs.clover.com/dev/reference/deliver_refund_receipt.md): Deliver a refund receipt in the format specified in the request. ## Recipes - [Build an order cart](https://docs.clover.com/dev/recipes/build-an-order-cart.md) - [Create an order](https://docs.clover.com/dev/recipes/create-an-order.md) - [Create multiple items](https://docs.clover.com/dev/recipes/create-multiple-items.md) - [Credit Card paid Order](https://docs.clover.com/dev/recipes/credit-card-paid-order.md) ## Changelog - [Clover API updates - April 2026](https://docs.clover.com/dev/changelog/clover-api-updates-april-2026.md) - [Clover API updates - March 2026](https://docs.clover.com/dev/changelog/clover-api-updates-march-2026.md) - [Clover API updates - August 2025](https://docs.clover.com/dev/changelog/clover-api-updates-august-2025.md) - [Clover API updates - April 2025](https://docs.clover.com/dev/changelog/clover-api-updates-april-2025.md) - [Clover API updates - February 2025](https://docs.clover.com/dev/changelog/clover-api-updates-february-2025.md) - [Clover API updates - January 2025](https://docs.clover.com/dev/changelog/clover-api-updates-november-2024-1.md) - [Clover API updates - November 2024](https://docs.clover.com/dev/changelog/clover-api-updates-november-2024.md) - [Clover API updates - October 2024](https://docs.clover.com/dev/changelog/clover-api-updates-october-2024.md) - [Clover API updates - September 2024](https://docs.clover.com/dev/changelog/clover-api-updates-september-2024.md) - [Clover API updates - July 2024](https://docs.clover.com/dev/changelog/clover-api-updates-july-2024.md)