Paper Receipt Inserts

This section is relevant to you if your flexEngage receipt services package includes support for paper receipt inserts.

In This Guide

• Receipts API Integration Guide — authentication, request/response flow, error handling, and best practices.
• Request Field Reference — field-by-field usage notes for headers, discounts, loyalty, tenders, taxes, items, custom fields, and more.
• Receipt Data Elements — how request fields map to sections of a rendered receipt (orders, returns, totals, deposits, payment history, and more).
• Point of Sale UI Guidelines — recommended configuration options and UI flow.
• Paper Receipt Inserts — for merchants whose package includes paper receipt inserts.
• SMS Receipts — for merchants whose package includes SMS delivery.
• Integration Testing Checklist — validate your integration before launch.

Introduction

Below is a diagram explaining how paper receipt inserts are processed:

Sending the Request and Receiving the Responses

Sending the request to the flexEngage API works the same way as it does for digital receipts. If you are already sending receipts to the flexEngage API for digital receipts, no further coding is required except if you are not currently sending the printed receipt transactions to flexEngage. If you are not sending the printed receipts to flexEngage, you will need to make a modification to send printed receipts to the flexEngage API.

The API will then check the transaction and see if it qualifies for a configured paper receipt insert. If the transaction qualifies for a paper receipt insert, the response will contain additional information about the image that needs to print on the receipt, including:

• The ASCII representation of the image OR the HTML text OR the plain text
• The image MIME type (ex: image/jpeg, image/png)
• The image width

You will need to add logic to check the response for image information, render the information into an image, and include the image on the printed receipt. You can decide whether the image appears at the top or bottom of the receipt. Based on what other merchants do and the responses that they receive from the offers, we recommend putting the insert at the bottom of the receipt.

Below is an example of the JSON payload response returned by flexEngage for a receipt that qualifies for a paper receipt insert.

{
    "customerEmailAddress": "SOME.PERSON@SOMESITE.COM",
    "receiptId": "32c0b76b-516c-44a1-9fda-1e5a2f43b7d8",
    "offers": [
        {
            "offerContentType": "image/png",
            "content": "iVBORw0KGgoAAAANSUhEUgAA...",
            "imageWidth": 250
        }
    ]
}

Configuring Paper Receipt Inserts

Once a merchant is set up to provide paper receipt inserts, configuring the images and campaigns happens in the merchant portal. The POS does not need to send images to the API; all the configuration happens in the merchant portal.

Setting up the campaigns in the merchant portal is similar to setting up campaigns for digital offers, but there are a few changes:

1. In Marketing Content under Marketing Management, add the content to print in the Paper Receipt Insert Content section. It can be an image, text, or both.

   

2. In Campaigns under Marketing Management, select the marketing content and turn on Insert In Paper Receipt. The example shows a campaign that applies to both the digital and paper receipt. To make it a paper-only insert, turn off On Digital Receipt.