Use Clover REST API

United States
Latin America

Clover provides its REST API at a separate base URL in the production environment for each of its supported markets.

  • United States and Canada:
  • Europe:
  • Latin America:

While building and testing your apps in the sandbox environment, use the sandbox REST API with the Android emulator or with our Developer Kits and sandbox test merchants:

You can find a list of supported endpoints in the Clover REST API Reference. These endpoints accept query parameters in the following format:

[Endpoint URI]?field=value[,additionalValues...]&[additionalQueryStrings...]

Sample REST API requests

To retrieve information about your test merchant, send a GET request to /v3/merchants/mId:

curl --request GET \
  --url{mId} \
  --header 'accept: application/json' \  
  --header 'authorization: Bearer {auth_token}'

To update the test merchant name, send a POST request to /v3/merchants/mId`:

curl --request POST \
  --url{mId} \
  --header 'accept: application/json' \  
  --header 'authorization: Bearer {auth_token}'
  --data '{"name":"{updated_merchant_name}"}'

In both requests:

  • mId is the test merchant's universally unique identifier (UUID), also known as the merchantId.
  • auth_token is the API token (or access token).

See Use test merchant identifier and API token for more information.

Here is some key information about the Clover REST API:

  • HTTPS: Clover API is only accessible through HTTPS
  • JSON: Request and response entities are in JSON
  • OAuth: All API requests in production are protected by an OAuth2-derived access token. See OAuth flows in Clover.
  • Permissions: Using Clover API endpoints requires access to necessary permissions. See Platform API permissions and E-Commerce API permissions for more information.