Platform Docs

Smart Receipts

Smart receipts allow you to add information to the bottom of Clover's paper and web receipts for the customer. This feature offers an easy way to encourage customer interaction and add value to the receipt. You can enable Smart Receipts through the Developer Dashboard.

Enable smart receipts

NOTE

It may take up to ten hours for smart receipt changes to sync to merchant devices.

  1. On your app's Settings page on the Developer Dashboard, select Smart Receipts.
  2. On the Smart Receipts page, select the Enable Smart Receipts check box.
  3. In the Smart receipt text field, enter text that will appear at the bottom of paper receipts.
  4. In the Smart receipt URL field, enter the URL that should appear on paper and web receipts. This URL typically directs customers to a third-party website.

On the receipt, we append the following parameters to the base URL you provide:

  • m - merchant ID
  • o - order ID
  • p - payment ID
  • c - receipt context (p indicates a paper receipt, i indicates an iframe in a web receipt)

Paper receipts

On a paper receipt, smart receipt data follows the regular receipt content. The name of your application appears after the bottom in all capital letters, followed by a divider. If you provided a URL, it will be embedded as a QR code to the left of any provided smart receipt text.

Paper smart receipt

Paper smart receipt

The URL format for the QR code is:

[BASE_URL]?m=[MERCHANT_ID]&o=[ORDER_ID]&p=[PAYMENT_ID]&c=p

Web receipts

On a web receipt, the name of your application appears after the receipt details. An iframe element contains the content associated with the Smart Receipt URL you provide. The URL format for the iframe is:

[BASE URL]?m=[MERCHANT_ID]&o=[ORDER_ID]&p=[PAYMENT_ID]&c=i

The iframe's alt attribute value is the smart receipt text.

NOTE

If no URL is provided, no smart receipt iframe appears on web receipts.

Localize smart receipts

If you have set up subscription tiers for countries, you can add a localized version of your smart receipt data. On the Smart Receipts page, an option will appear for each locale you support.

To update the smart receipt for a specific region, do the following:

  1. On the Smart Receipts page, select the Enable Smart Receipts check box for the region.
  2. In the Smart receipt text field, enter text that will appear at the bottom of paper receipts.
  3. In the Smart receipt URL field, enter the URL that should appear on paper and web receipts. This URL typically directs customers to a third-party website.
  4. Select Save.

The regional smart receipt data is updated.


Smart Receipts


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.