Print Receipts

On this page, we will explore how to print receipts using the ePOS SDK for Android in an All-In-One integration setup.

Note: If the payments app is not available on the device, the printingApi instance will be null, and you will not be able to print receipts.

Check printer availability

Before printing, you can check whether the device has a printer using the hasPrinter method:

This method will work reliably from card machine APK version 3.9.17 and above.

Kotlin

teyaAllInOneSDK.printingApi.hasPrinter {
    println("Device has a printer: $it")
}

Java

teyaAllInOneSDK.getPrintingApi().hasPrinter(result -> {
    System.out.println("Device has a printer: " + result);
    return Unit.INSTANCE;
});

Print transaction receipt

To print a transaction receipt, call the printTransactionReceipt method on the printingApi instance, specifying the payment gateway ID and the type of receipt (Merchant or Customer).

Kotlin

teyaAllInOneSDK.printingApi.printTransactionReceipt(
    paymentGatewayId, // The gatewayPaymentId of the payment you want to print the receipt for
    AioReceiptPrintingApi.ReceiptType.Merchant // Use Merchant or Customer
)

Java

teyaAllInOneSDK.getPrintingApi().printTransactionReceipt(
        paymentGatewayId, // The gatewayPaymentId of the payment you want to print the receipt for
        AioReceiptPrintingApi.ReceiptType.Merchant // Use Merchant or Customer
);

Print custom template

Using our SDK, you can print fully customizable receipts by defining your own template. This lets you tailor the layout and content to match your specific business needs.
To print a custom template, simply call the printCustomTemplate function:

Kotlin

teyaAllInOneSDK.printingApi.printCustomTemplate(buildCustomTemplate())

Java

teyaAllInOneSDK.getPrintingApi().printCustomTemplate(buildCustomTemplate());

You can build your template using the Template class, which allows you to add rows containing text, images, tables, and other elements. Here’s an example of how to construct a custom template:

Kotlin

fun buildCustomTemplate() = Template(
  listOf(
    ReceiptRow.Item(
      RowElement.Text(
        text = "MMF TEST A920",
        align = Align.Center,
        bold = true,
      )
    ),
    ReceiptRow.Item(
      RowElement.Text(
        text = "Ruzova Dolina 6, Bratislava 85104",
        align = Align.Center,
      )
    ),

    ReceiptRow.Spacer,

    ReceiptRow.Items(
      items = listOf(
        RowElement.Image(
          imageToPrint = Image(
            BitmapFactory.decodeResource(
              this.resources,
              R.drawable.teya_logo
            )
          )
        ),

        RowElement.Image(
          imageToPrint = Image(
            BitmapFactory.decodeResource(
              this.resources,
              R.drawable.success_image
            ),
          ),
          align = Align.Right
        ),

        RowElement.Text(
          text = " Approved",
          align = Align.Left,
          bold = true
        )
      )
    ),

    ReceiptRow.Items(
      items = listOf(
        RowElement.Text(
          text = "CUSTOMER RECEIPT",
          align = Align.Left,
          bold = true
        ),
        RowElement.Text(
          text = "21/02/22 · 10:25",
          align = Align.Right,
          bold = true
        ),
      )
    ),

    ReceiptRow.Spacer,
    ReceiptRow.Divider,

    ReceiptRow.Table(
      headerCells = listOf(
        TableHeaderCell(
          element = RowElement.Text(
            text = "ITEM",
            bold = true,
            align = Align.Left
          ),
          1f
        ),
        TableHeaderCell(
          element = RowElement.Text(
            text = "PRICE",
            bold = true,
            align = Align.Right
          ),
          1f
        ),
      ),
      rows = listOf(
        TableRow(
          cells = listOf(
            RowElement.Text(
              text = "1x SANDWICH",
              align = Align.Left,
              bold = true
            ),
            RowElement.Text(
              text = "£ 5.00",
              align = Align.Right,
              bold = true
            ),
          )
        ),
        TableRow(
          cells = listOf(
            RowElement.Text(
              text = "1x WATER",
              align = Align.Left,
              bold = true
            ),
            RowElement.Text(
              text = "£ 1.00",
              align = Align.Right,
              bold = true
            )
          )
        )
      )
    ),

    ReceiptRow.Spacer,

    ReceiptRow.Items(
      items = listOf(
        RowElement.Text(
          text = "AMOUNT",
          align = Align.Left,
          bold = true
        ),
        RowElement.Text(
          text = "£ 6.00",
          align = Align.Right,
          bold = true
        )
      )
    ),
    ReceiptRow.Items(
      items = listOf(
        RowElement.Text(
          text = "TIPS",
          align = Align.Left,
          bold = true
        ),
        RowElement.Text(
          text = "£ 2.00",
          align = Align.Right,
          bold = true
        )
      )
    ),

    ReceiptRow.Divider,

    ReceiptRow.Items(
      items = listOf(
        RowElement.Text(
          text = "TOTAL",
          align = Align.Left,
          bold = true
        ),
        RowElement.Text(
          text = "£ 8.00",
          align = Align.Right,
          bold = true
        )
      )
    ),

    ReceiptRow.Divider,
    ReceiptRow.Spacer,

    ReceiptRow.Item(
      RowElement.Text(
        text = "Mastercard Contactless ****6787",
        align = Align.Left,
        bold = true
      )
    ),
    ReceiptRow.Item(
      RowElement.Text(
        text = "AID: A00000000041010",
        align = Align.Left,
        bold = true
      )
    ),
    ReceiptRow.Item(
      RowElement.Text(
        text = "Approval code: SsF4e",
        align = Align.Left,
        bold = true
      )
    ),
    ReceiptRow.Items(
      items = listOf(
        RowElement.Text(
          text = "MID: ****5678",
          align = Align.Left,
          bold = true
        ),
        RowElement.Text(
          text = "TID: ****Y002",
          align = Align.Right,
          bold = true
        )
      )
    ),
    ReceiptRow.Item(
      RowElement.Text(
        text = "Reference: 12345678901234567890",
        align = Align.Left,
        bold = true
      )
    ),

    ReceiptRow.Item(
      RowElement.QrCode(
        url = "https://teya.com",
        align = Align.Center
      )
    ),

    ReceiptRow.Spacer,
    ReceiptRow.Spacer,

    ReceiptRow.Item(
      RowElement.Text(
        text = "Thank you",
        align = Align.Center,
        bold = true
      )
    ),
  )
)

Java

Template buildCustomTemplate() {
    return new Template(Arrays.asList(
        new ReceiptRow.Item(
                new RowElement.Text("MMF TEST A920", true, Align.Center)
        ),
        new ReceiptRow.Item(
                new RowElement.Text("Ruzova Dolina 6, Bratislava 85104", false, Align.Center)
        ),

        ReceiptRow.Spacer.INSTANCE,

        new ReceiptRow.Items(Arrays.asList(
                new RowElement.Image(
                        AndroidImageFactoryKt.Image(
                                BitmapFactory.decodeResource(this.getResources(), R.drawable.teya_logo)
                        ),
                        Align.Left
                ),
                new RowElement.Image(
                        AndroidImageFactoryKt.Image(
                                BitmapFactory.decodeResource(this.getResources(), R.drawable.success_image)
                        ),
                        Align.Right
                ),
                new RowElement.Text(" Approved", true, Align.Left)
        )),
        new ReceiptRow.Items(Arrays.asList(
                new RowElement.Text("CUSTOMER RECEIPT", true, Align.Left),
                new RowElement.Text("21/02/22 · 10:25", true, Align.Right)
        )),

        ReceiptRow.Spacer.INSTANCE,
        ReceiptRow.Divider.INSTANCE,

        new ReceiptRow.Table(
                Arrays.asList(
                        new TableHeaderCell(
                                new RowElement.Text("ITEM", true, Align.Left),
                                1f
                        ),
                        new TableHeaderCell(
                                new RowElement.Text("PRICE", true, Align.Right),
                                1f
                        )
                ),
                Arrays.asList(
                        new TableRow(Arrays.asList(
                                new RowElement.Text("1x SANDWICH", true, Align.Left),
                                new RowElement.Text("£ 5.00", true, Align.Right)
                        )),
                        new TableRow(Arrays.asList(
                                new RowElement.Text("1x WATER", true, Align.Left),
                                new RowElement.Text("£ 1.00", true, Align.Right)
                        ))
                )
        ),

        ReceiptRow.Spacer.INSTANCE,

        new ReceiptRow.Items(Arrays.asList(
                new RowElement.Text("AMOUNT", true, Align.Left),
                new RowElement.Text("£ 6.00", true, Align.Right)
        )),
        new ReceiptRow.Items(Arrays.asList(
                new RowElement.Text("TIPS", true, Align.Left),
                new RowElement.Text("£ 2.00", true, Align.Right)
        )),

        ReceiptRow.Divider.INSTANCE,

        new ReceiptRow.Items(Arrays.asList(
                new RowElement.Text("TOTAL", true, Align.Left),
                new RowElement.Text("£ 8.00", true, Align.Right)
        )),

        ReceiptRow.Divider.INSTANCE,
        ReceiptRow.Spacer.INSTANCE,

        new ReceiptRow.Item(
                new RowElement.Text("Mastercard Contactless ****6787", true, Align.Left)
        ),
        new ReceiptRow.Item(
                new RowElement.Text("AID: A00000000041010", true, Align.Left)
        ),
        new ReceiptRow.Item(
                new RowElement.Text("Approval code: SsF4e", true, Align.Left)
        ),
        new ReceiptRow.Items(Arrays.asList(
                new RowElement.Text("MID: ****5678", true, Align.Left),
                new RowElement.Text("TID: ****Y002", true, Align.Right)
        )),
        new ReceiptRow.Item(
                new RowElement.Text("Reference: 12345678901234567890", true, Align.Left)
        ),
        new ReceiptRow.Item(
                new RowElement.QrCode("https://teya.com", Align.Center)
        ),

        ReceiptRow.Spacer.INSTANCE,
        ReceiptRow.Spacer.INSTANCE,

        new ReceiptRow.Item(
                new RowElement.Text("Thank you", true, Align.Center)
        )
    ));
}

Result:
Custom receipt template

As shown in the example above, you can combine different row types and elements to create a receipt that fits your requirements. Below are the details of the available row types and element types.

Row Types

For the rows, you can use various ReceiptRow types such as Item, Items, Spacer, Divider, and Table.

Item

A single row containing only one element.

Kotlin

ReceiptRow.Item(
    // element
)

Java

new ReceiptRow.Item(
    // element
);

Items

A row that can contain multiple elements side by side, allowing for more complex layouts within a single row.
All items will be evenly distributed across the row, meaning each item will have equal width. Custom weights for items inside the Items row aren’t supported yet. If you need to use weights, consider using a Table instead.

Kotlin

ReceiptRow.Items(
    // list of elements
)

Java

new ReceiptRow.Items(Arrays.asList(
    // list of elements
));

You can’t have more than 10 elements in a single `Items` row.

Spacer

An empty row that adds vertical space between other rows, improving readability and visual separation.

Kotlin

ReceiptRow.Spacer

Java

ReceiptRow.Spacer.INSTANCE;

Divider

A dashed line that separates sections of the receipt, helping to organize the content.

Kotlin

ReceiptRow.Divider

Java

ReceiptRow.Divider.INSTANCE;

Table

A structured section with a header and multiple data rows, ideal for listing items with columns (e.g., product name and price).
If you set a column’s weight to 0f or less, its width will automatically adjust to fit its content.

Kotlin

ReceiptRow.Table(
    headerCells = listOf(
        TableHeaderCell( /* Text element */, weight = 1f), // The weight parameter allows you to control the width of each column.
        TableHeaderCell(/* Text element */, weight = 1f),
    ),
    rows = listOf(
        TableRow(
            cells = listOf(
                // Text elements
            )
        ),
        TableRow(
            cells = listOf(
                // Text elements
            )
        ),
    )
)

Java

new ReceiptRow.Table(
    Arrays.asList(
        new TableHeaderCell(/* Text element */, 1f), // The weight parameter allows you to control the width of each column.
        new TableHeaderCell(/* Text element */, 1f)
    ),
    Arrays.asList(
        new TableRow(Arrays.asList(
            // Text elements
        )),
        new TableRow(Arrays.asList(
            // Text elements
        ))
    )
);

Table limitations:

You can put only Text elements inside table cells.
The number of header cells must match the number of cells in each row.
The number of columns in a table cannot exceed 10.

Element types

Within each row, you can use different RowElement types to define the content:

Text

Displays a line of text on the receipt. You can set alignment (left, center, right) and make it bold. Used for headings, messages, or item names.

Kotlin

RowElement.Text(
    text = "Welcome!", // The text to display
    align = Align.Center, // Text alignment: Align.Left, Align.Center, Align.Right (aligns within its container)
    bold = true, // Whether the text should be bold
)

Java

new RowElement.Text(
    "Welcome!", // The text to display
    true, // Whether the text should be bold
    Align.Center // Text alignment: Align.Left, Align.Center, Align.Right (aligns within its container)
);

The text parameter cannot be empty or blank.

Image

Prints a bitmap image (e.g., logo or icon) on the receipt. If you are converting an image to a bitmap, the image should be in PNG or JPEG format.

Kotlin

RowElement.Image(
    imageToPrint = Image(
        // Your bitmap here
    ),
    align = Align.Left // Alignment of the image within its container
)

Java

new RowElement.Image(
    AndroidImageFactoryKt.Image(
        /* Your bitmap here */
    ),
    Align.Left // Alignment of the image within its container
);

QrCode

Renders a QR code with a specified URL or string. You can set its alignment. Useful for adding links, payment info, or promotions.

Kotlin

RowElement.QrCode(
    url = "https://teya.com", // The URL or string to encode in the QR code
    align = Align.Left // Alignment of the qr code within its container
)

Java

new RowElement.QrCode(
    "https://teya.com", // The URL or string to encode in the QR code
    Align.Left // Alignment of the qr code within its container
);

The url parameter cannot be empty or blank.

Limitations

When building custom templates, keep the following limitations in mind:

A template can have a maximum of 150 rows.
Some row and element types have specific limitations, which are described in their individual sections.
The template is converted to JSON before being sent to the printer, and its total size must not exceed 250 KB.
- Images are converted to Base64 strings, which can significantly increase the size.

If a limitation can be detected immediately, the SDK throws an exception when creating a Template object. If the backend detects a limitation, an error is returned in PrintStateDetails as part of the printing status updates.

Print image

You can also print images directly using the SDK.
To print an image, use the printCustomImage function and pass a bitmap as a parameter:

Kotlin

val receiptBitmap = // Create or load your bitmap here
teyaAllInOneSDK.printingApi.printCustomImage(Image(receiptBitmap))

Java

Bitmap receiptBitmap = // Create or load your bitmap here
teyaAllInOneSDK.getPrintingApi().printCustomImage(AndroidImageFactoryKt.Image(receiptBitmap));

The recommended width is 384 px. Bitmaps wider than this are scaled down to fit the printer width.
If you're converting an image to a bitmap, ensure that the image you want to print is in a compatible format (PNG or JPEG) and properly scaled for the printer.

Limitations

When printing images, keep the following limitations in mind:

The maximum size for the bitmap is 20 MB
The maximum height for the bitmap is 10000 px.
The recommended width for images is 384 px. If you pass a bitmap wider than this, it will be scaled down to fit the printer width.
We are converting the bitmap to image data before sending it to the printer, and the total size of this data must not exceed 200 KB.
- If this limit is exceeded, an error will be returned in PrintStateDetails with a corresponding message.

If a limitation can be detected immediately, the SDK throws an exception when calling Image function. If the backend detects a limitation, an error is returned in PrintStateDetails as part of the printing status updates.

All printing functions return a PrintingStatusSubscription object, which lets you subscribe to real-time printing status updates.

Kotlin

val printingStatusSubscription = teyaAllInOneSDK.printingApi.printTransactionReceipt(/*...*/)
printingStatusSubscription.subscribe(object : PrintingStatusSubscription.Listener {
    override fun onPrintingStateChanged(printStateDetails: PrintStateDetails) {
        println("Printing receipt status: $printStateDetails")
    }
})

Java

PrintingStatusSubscription printingStatusSubscription = teyaAllInOneSDK.getPrintingApi().printTransactionReceipt(/*...*/);
printingStatusSubscription.subscribe(new PrintingStatusSubscription.Listener() {
    @Override
    public void onPrintingStateChanged(@NonNull PrintStateDetails printStateDetails) {
        System.out.println("Printing receipt status: " + printStateDetails);
    }
});

If printStateDetails.status is PrintStatus.Printed, the print was successful.

Print Failures

If printStateDetails.status is PrintStatus.Failed, check the printFailure property for the specific error reason:

Enum Value	Description
NetworkError	Connection error occurred.
OutOfPaper	The card machine ran out of paper during the printing process.
Busy	The printer is currently busy.
Overheated	The printer has overheated.
CoverOpen	The printer cover is open.
LowBattery	The card machine battery is too low to complete the print.
Other	An unknown issue occurred.

Print Receipts

Check printer availability

Print transaction receipt

Print custom template

Row Types

Item

Items

Spacer

Divider

Table

Element types

Text

Image

QrCode

Limitations

Print image

Limitations

Subscribe to printing status

Print Failures