Use Postman with REST Pay Display API

United States

Clover provides a complete Postman collection for testing REST Pay Display API and working through common payment scenarios for POS integrations. This collection:

  • Lets you quickly generate and use an OAuth token for your test merchants.
  • Supports only cloud connections for ease of setup.

Set up your test app

To use Postman for testing all available endpoints, you need to create a Clover app configured with proper permissions for REST Pay. See Creating a sandbox app instructions.



When setting up the app's REST configuration, set the site URL to the Postman client you want to use:

  • Desktop
  • Web

Install the test app

  1. On the App Settings page, select More > Preview in App Market.
  2. Copy the App ID and App Secret values to a temporary location for use in a later section.
    The More Tools page appears.
  1. In the test app field, click Connect, and then click Accept.

Open the collection

Click the Run in Postman button to open the collection in a workspace of your choice.

Run in Postman

Set environment variables

A few variables are used in requests to identify your app and test merchant. To set these variables:

  1. Log in to the sandbox Developer Dashboard.
  2. Navigate to Your Apps Dashboard.
  3. In the Your Apps list, click your REST Pay app. The App Settings page appears. Leave this browser tab open.
  4. In Postman, click Environments.
  5. Click the Clover Sandbox environment. The variables table appears.
  6. For the appId variable, copy your App ID value from the App Settings page and paste it into the Current Value field.
  7. For the appSecret variable, copy your App Secret value from the App Settings page and paste it into the Current Value field.
  8. On the side-nav, click Dev Kits.
  9. For the mId variable, copy your test merchant ID (mId) and paste it in the Current Value field.
    Note: mId is a 13-character alphanumeric string in the Test Merchant column.
  10. For the deviceId variable, copy the serial number of the device and paste the device serial number in the Current Value field.
  11. For the clientId variable, enter a name for the client making requests through your app, for example: myPOS.
  12. For the email variable, enter a valid email address to receive web receipts for test transactions.
  13. For the phone variable, enter a 10-digit phone number to receive SMS receipts for test transactions.
  14. Select the checkbox for the siteUrl variable with the same value as that configured for your test app.
  15. Click Save and then close the Clover Sandbox environment tab.
  16. In the Environments list, point to Clover Sandbox, and select the Set active checkbox.

Retrieve an OAuth token with Postman

Once your test app is installed for your test merchant and you've set up your environment, you can request an OAuth token. This token has the necessary permissions to access and update merchant information. To create the token:

  1. In Postman, click Collections and select Clover REST Pay API. The Clover REST Pay API tab appears.
  2. On the Authorization tab, click Get New Access Token. The Postman OAuth 2.0 window appears and redirects to the Clover dashboard login.
  3. Enter your sandbox credentials and click Log in. If you have multiple test merchants, the Select a Merchant page appears.
  4. Click the merchant that installed the REST Pay API app. The request is processed, and an API token is returned.
  1. Click Use Token.
  2. Click Save.
    The collection's authorization setup is complete.

Connect to a Clover device

Once you set the needed variables and retrieve an API token, finish setting up the collection and test the connection to your Clover device.

  1. In Postman, click Collections, and select Clover REST Pay API > Setup.
  2. Send each setup request to check connectivity, configure the device printer, and finalize the setup.
    Your environment is configured and ready for use.