Clover made the following API updates for February 2025.

Platform API

Implemented Date Range Restriction for Payment Data Retrieval

Updated the GetPayments API to restrict data fetching to a 90-day date range when no DateTime filter is provided in the request.

Android Payments API

Added Tender Options and Bypass Tenders Example

Updated the Accept a payment documentation to include a new TenderOptions section and a new example for Bypass Tenders and go straight to card payment.

Clover made the following API updates for January 2025.

Platform API

Order API

Updated Order API discount amount parameter

Updated the amount parameter definition under the discount object to include that it accepts a negative value and 0 (zero).

Affected endpoints:

• Create online order
• Checkout online order
• Create atomic order
• Checkout atomic order

Clover made the following API updates for November 2024.

Ecommerce

Token API

Added Create an Apple Pay token endpoint to support wallet

Introduced Create an Apple Pay^® wallet token endpoint. This endpoint is:

• Unique, single-use code that represents an Apple Pay wallet.
• Securely processes payments without exposing the actual wallet details or directly handling sensitive information.

Use this token as the payment source in single-payment endpoints, such as create a charge or pay for an order.

Clover made the following API updates for October 2024.

Ecommerce API

Token API

Added a new attribute to the endpoint—Create Clover token from an external token

Added token_type attribute under the external_token object of the Create Clover token from an external token endpoint.

Introduced a new endpoint—Create an Apple Pay token

Introduced the Create an Apple Pay token endpoint to create an Apple Pay^® payment token for the digital wallet. Use this token with endpoints like create a charge or pay for an order.

Clover made the following API updates for September 2024.

Core payments

Added Android payment APIs

Added new APIs to Clover Android payments. These APIs offer an Intent-based solution to support third-party applications running on Clover devices. For details, see the following tutorials:

• Issue a manual refund
• Read a card
• Incremental authorization
• Request a tip
• Select a receipt
• Adjust a tip
• Closeout

Ecommerce

Updated Ecommerce APIs for TransArmor^® tokens

Updated Ecommerce APIs for TransArmor token to provide:

• Additional layer of security to protect cardholder data during transactions.
• Limited requirement of the regeneration of payment tokens.

To support the (TransArmor) TA token, Clover has:

• Introduced the Create Clover token from an external token endpoint.
• Added intent parameter to create a charge and pay for an order endpoints. Use this parameter to create a new TA token.

Fixed missing response body issue

Fixed an issue with the following endpoints to display the response bodies:

• Charges
  • Create a charge
  • Get charges
  • Get a charge
  • Capture a charge
• Customers
  • Create a card-on-file customer
  • Revoke a payment source
  • Update a customer
• Refunds
  • Create a refund
  • Get refunds list
  • Get a refund
• Orders
  • Get orders
  • Create an order
  • Get an order
  • Pay for an order
  • Return an order

Clover made the following API updates for July 2024.

Ecommerce

Gift card API

Updated the parameter name from card_number to number of the Create a gift card token endpoint.

Charge API

To comply with the RCL 31/32 upgrade, Clover added the following new fields under the installment_info object of the Create a charge endpoint.

• total_count
• total_amount
• sequence_number
• amount_type
• interval
• interval_count

Clover made the following API updates for June 2024.

Platform API

Order API

Removed the following body parameters from the update a line item endpoint. These parameters are no longer supported while updating a line item for an order.

• id
• item
• colorCode
• name
• alternateName
• price
• priceWithModifiers
• priceWithModifiersAndItemAndOrderDiscounts
• unitQty
• unitName
• exchangedLineItem
• createdTime
• orderClientCreatedTime
• discounts
• orderLevelDiscounts
• exchanged
• modifications
• tags
• refunded
• refund
• isRevenue
• taxRates
• payments
• revenueAmount
• quantitySold
• printGroup

Clover made the following API updates for May 2024.

Platform API

Inventory API

Updated identifiers (id) for the following body parameters under the Create or delete associations between inventory items and modifier groups endpoint.

• modifierGroup
• item

Clover made the following API updates for January 2024.

Ecommerce API

Gift Card API

Added the Gift Card API that allows the use of gift cards as a prepaid payment source for services, merchandise, or even cash, depending on the terms and conditions set by the card issuer. To support this feature, Clover introduced the following API endpoints:

• Create a gift card token
• Create and activate physical and virtual gift card
• Request gift card balance
• Reload gift card
• Request cashout of gift card balance

Added gift card parameters to the response bodies of the following Ecomm API endpoints:

• Create a charge
• Create a refund
• Capture a charge

For more information, see Use the Gift Card API tutorial.

Clover made the following API updates for October 2023.

Platform API

Inventory

Added offset and limit parameters to the following endpoints. This lets you search your line items results with a specific limit and offset:

• Get all items in a single modifier group
• Get all modifiers
• Get all modifiers in a single modifier group
• Get all attributes
• Get all options
• Get all options for an attribute
• Get all discounts

offset Position of the first line item returned in the search results indicates the number of line items that are excluded from the search results.`

limit Maximum number of line items returned in the search result.

Ecommerce API

Charge API

Added global currency support

Clover added Multi-Currency Pricing (MCP) support for merchants in the United States (US) and Canada. They can now accept customer payments in currency other than the US Dollar (USD). To use this feature, enter a currency code other than USD in the currency parameter of Create a charge endpoint.

Added split shipment support

Clover added the split_shipment parameter to support Split Shipment for a single pre-authorization. You can create 1-99 split shipments for a single order. To use this feature, enter shipment information in the split_shipment parameter in n/m format, where n is the current shipment and m is the total number of shipments. See Capture a charge.

Customer API

Updated Revoke a payment source endpoint to support ACH (Automated Clearing House) token. You can use Revoke a payment source to remove an ACH token as a payment source from the customer profile.