PEP DOCS

Print

A print request allows you to initiate printing on the payment terminal from your POS app outside of a payment flow. You can print text or images.

Print Request

PrintParam

htmlstring

Html to print.

imagestring

Image in Base64 to print.

escCommandstring

Print data in ESC command.

Print Response

PrintResult

recipientPartyIdentificationstringRequired

Unique identification of the partner that is the recipient of the message exchange.
For example, the POS SN

responseenumRequired

Result of the requested transaction.

Possible enum values

SUCC

Success. Processing OK. Information related to the result of the processing is contained in other parts of the response message.

FAIL

Failure. Processing of the request fails for various reasons.

PART

Partial Approved. The service was partially completed. Use the Message Status service to query the final transaction status.

responseReasonstring

Detail of the response.

Possible enum values

ABRT

Aborted. The initiator of the request has sent an abort message request, which was accepted and processed.

BUSY

Busy. The system is busy, try later.

CANC

Cancel. The user has aborted the transaction on the PED keyboard, for instance during PIN entering.

DEVO

DeviceOut. Device out of order.

WPIN

WrongPIN. The user has entered the PIN on the PED keyboard and the verification fails.

NHOS

UnreachableHost. Acquirer or any host is unreachable or has not answered to an online request, so is considered as temporary unavailable. Depending on the Sale context, the request could be repeated(to be compared with "Refusal")

UNVS

UnavailableService. The service is not available (not implemented, not configured, protocol version too old…).

UNVD

UnavailableDevice. The hardware is not available (absent, not configured…)

REFU

Refusal. The transaction is refused by the host or by the local rules associated to the card or the POI.

TNFD

NotFound. The transaction is not found (e.g. for a reversal or a repeat).

WIPG

InProgress. The transaction is still in progress and then the command cannot be processed.

additionalResponseInformationstring

Additional information to be logged for further examination.

PrintParam param = PrintParam.newBuilder()
        .html(getPrintHtml())
        .build();

RetailerManager.provideDeviceService()
        .newPrintExchange(param)
        .startAsyncExchange(new Exchange.RetailerSDKCallback<PrintResult>() {
            @Override
            public void onError(int code, String msg) {
                Logger.e(TAG, "Print failed: " + code + ", " + msg);
            }
            
            @Override
            public void onResult(PrintResult result) {
                Logger.i(TAG, "Print result: " + GsonUtils.toJson(result));
            }
        });

using System;
using PayExplorerConnect;

public void HandlePrintError(int code, string message)
{
    Console.WriteLine($"Error: {code}, Message: {message}");
}

public void HandlePrintResult(PrintResult result)
{
    Console.WriteLine($"Response: {result.Response}");
}

public string StartPrint()
{
    // Replace the HTML with your receipt content.
    PrintParam param = new PrintParam.Builder()
        .Html("<html><body><h1>Print test</h1></body></html>")
        .Build();

    string exchangeId = RetailerManager
        .ProvideDeviceService()
        .NewPrintExchange(param)
        .StartAsyncExchange(HandlePrintResult, HandlePrintError);

    return exchangeId;
}

#import <PayExplorerConnect/RetailerManager.h>
#import <PayExplorerConnect/PrintParam+Builder.h>

PrintParam *params = [PrintParam makeWithBuilder:^(PrintParamBuilder *builder) {
    builder.format(OutputFormatCodeHTML);
    builder.content(@"<html><body><h1>Print test</h1></body></html>");
}];

[[RetailerManager sharedManager] print:params block:^(NSString *exchangeId) {
    // Save the exchange ID to track this request.
} result:^(id result, NSInteger errcode, NSString *msg) {
    if (errcode != 0 && result == nil) {
        // Handle request error.
        return;
    }
    PrintResult *printResult = (PrintResult *)result;
    // Handle print result.
}];

Print

A print request allows you to initiate printing on the payment terminal from your POS app outside of a payment flow. You can print text or images.

Print Request

PrintParam

htmlstring

Html to print.

imagestring

Image in Base64 to print.

escCommandstring

Print data in ESC command.

Print Response

PrintResult

recipientPartyIdentificationstringRequired

Unique identification of the partner that is the recipient of the message exchange.
For example, the POS SN

responseenumRequired

Result of the requested transaction.

Possible enum values

SUCC

Success. Processing OK. Information related to the result of the processing is contained in other parts of the response message.

FAIL

Failure. Processing of the request fails for various reasons.

PART

Partial Approved. The service was partially completed. Use the Message Status service to query the final transaction status.

responseReasonstring

Detail of the response.

Possible enum values

ABRT

Aborted. The initiator of the request has sent an abort message request, which was accepted and processed.

BUSY

Busy. The system is busy, try later.

CANC

Cancel. The user has aborted the transaction on the PED keyboard, for instance during PIN entering.

DEVO

DeviceOut. Device out of order.

WPIN

WrongPIN. The user has entered the PIN on the PED keyboard and the verification fails.

NHOS

UNVS

UnavailableService. The service is not available (not implemented, not configured, protocol version too old…).

UNVD

UnavailableDevice. The hardware is not available (absent, not configured…)

REFU

Refusal. The transaction is refused by the host or by the local rules associated to the card or the POI.

TNFD

NotFound. The transaction is not found (e.g. for a reversal or a repeat).

WIPG

InProgress. The transaction is still in progress and then the command cannot be processed.

additionalResponseInformationstring

Additional information to be logged for further examination.

PrintParam param = PrintParam.newBuilder()
        .html(getPrintHtml())
        .build();

RetailerManager.provideDeviceService()
        .newPrintExchange(param)
        .startAsyncExchange(new Exchange.RetailerSDKCallback<PrintResult>() {
            @Override
            public void onError(int code, String msg) {
                Logger.e(TAG, "Print failed: " + code + ", " + msg);
            }
            
            @Override
            public void onResult(PrintResult result) {
                Logger.i(TAG, "Print result: " + GsonUtils.toJson(result));
            }
        });

using System;
using PayExplorerConnect;

public void HandlePrintError(int code, string message)
{
    Console.WriteLine($"Error: {code}, Message: {message}");
}

public void HandlePrintResult(PrintResult result)
{
    Console.WriteLine($"Response: {result.Response}");
}

public string StartPrint()
{
    // Replace the HTML with your receipt content.
    PrintParam param = new PrintParam.Builder()
        .Html("<html><body><h1>Print test</h1></body></html>")
        .Build();

    string exchangeId = RetailerManager
        .ProvideDeviceService()
        .NewPrintExchange(param)
        .StartAsyncExchange(HandlePrintResult, HandlePrintError);

    return exchangeId;
}

#import <PayExplorerConnect/RetailerManager.h>
#import <PayExplorerConnect/PrintParam+Builder.h>

PrintParam *params = [PrintParam makeWithBuilder:^(PrintParamBuilder *builder) {
    builder.format(OutputFormatCodeHTML);
    builder.content(@"<html><body><h1>Print test</h1></body></html>");
}];

[[RetailerManager sharedManager] print:params block:^(NSString *exchangeId) {
    // Save the exchange ID to track this request.
} result:^(id result, NSInteger errcode, NSString *msg) {
    if (errcode != 0 && result == nil) {
        // Handle request error.
        return;
    }
    PrintResult *printResult = (PrintResult *)result;
    // Handle print result.
}];