Release NotesAnnouncementsBlogFAQSupport
API Changelog

Clover API updates - November 2024

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 API updates - October 2024

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 API updates - September 2024

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:

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:

Fixed missing response body issue

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

Clover API updates - July 2024

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 API updates - June 2024

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 API updates - January 2024

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:

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

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

Clover API updates - October 2023

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:

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.

Clover API updates - September 2023

Clover made the following API updates for September 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:

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.

Merchant API

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

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.

Order API

  • Updated an endpoint title name from Void a line item to the Create a list of voided line items endpoint, which was misleading to another endpoint Void a line item due to a similar name
  • Updated the state parameter definition of the Update an order endpoint for the following scenarios:
    • open or OPEN and locked - Automatically set by Clover, for example, when a line item is added to the order or a payment is taken.
    • When an order is created using REST API, Clover recommends manually setting the order state value to Open.
    • When an order is created using Android the SDK, do not manually set the order state. The value must be left empty, and Clover automatically updates the value to open and locked.
    • Null - Default value when no value is manually set. This indicates a hidden order. Hidden orders do not display on the screen but can be retrieved using the order ID.

Ecommerce

Order API

  • Updated the required objects such as city, postal_code, and state under the shipping address parameter and amount object under the items parameter for the Create an order endpoint.
  • Added important information to customer and source parameters under the Pay for an order endpoint. 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.

Invoice API

Added the following information under the customer parameter in the Create checkout endpoint:

  • If the merchant uses hosted checkout with the customer information feature enabled (HCO_CUSTOMER_INFO_FEATURE_ENABLED), then it is mandatory to enter the customer’s firstname, lastname, and email address information to create a hosted checkout session. The merchant can also customize fields required on the Merchant Dashboard > Account & Setup > Hosted Checkout > Customer Information > Customize.
  • If the merchant uses hosted checkout without enabling the customer information feature, then only the customer's first name, last name, or email address is required to create a hosted checkout session.