PEP DOCS

NFC Tag

The NFC Tag service is designed to pass tag data to the payment terminal for processing.

Warning

NFC Tag presents its own terminal UI. If a previous Display is still shown, abort that Display and wait for the Abort to complete before starting NFC Tag. See Device Display & Interaction for details.

NFC Tag Request

NFCTagParam

transactionReferencestringRequired

Global reference of the sale transaction for the sale system.

messageContentstringRequired

Message content.

maximumWaitingTimeinteger

Maximum time to wait for the transmission to complete.
Unit: second, the default value is 60.

detectCountinteger

The number of times an NFC tag needs to be read.
The default value is 1.

NFC Tag Response

NFCTagResult

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.

Transaction parameters

When you receive the terminal result through the SDK callback interface and NFCTagResult.response = SUCC, you can obtain additional message.

detectCountinteger

How many times the NFC tag has been read.

NFCTagParam nfcTagParam = NFCTagParam.newBuilder()
        .messageContent("https://www.apple.com/")
        .maximumWaitingTime(30)
        .transactionReference(String.valueOf(System.currentTimeMillis()))
        .detectCount(1)
        .build();
RetailerManager.provideDeviceService().newNFCTagExchange(nfcTagParam).startAsyncExchange(new Exchange.RetailerSDKCallback<NFCTagResult>() {
    @Override
    public void onError(int code, String msg) {
        Logger.e(TAG,"NfcTagResult failed: " + code + ", " + msg);
    }

    @Override
    public void onResult(NFCTagResult result) {
        Logger.i(TAG,"NfcTagResult result: " + GsonUtils.toJson(result));
    }
});

using System;
using PayExplorerConnect;

public void HandleNFCTagResult(NFCTagResult result)
{
    Console.WriteLine($"Response: {result.Response}");
}

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

public string StartNFCTag()
{
    // Set the NFC content, timeout, and detection count for your scenario.
    NFCTagParam param = new NFCTagParam.Builder()
        .MessageContent("https://www.apple.com/")
        .MaximumWaitingTime(30)
        .DetectCount(1)
        .Build();

    string exchangeId = RetailerManager
        .ProvideDeviceService()
        .NewNFCTagExchange(param)
        .StartAsyncExchange(HandleNFCTagResult, HandleNFCTagError);

    return exchangeId;
}

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

NFCTagParam *params = [NFCTagParam makeWithBuilder:^(NFCTagParamBuilder *builder) {
    builder.transactionReference(@"00000008");
    builder.messageContent(@"https://www.apple.com/");
    builder.maximumWaitingTime(30);
    builder.detectCount(1);
}];

[[RetailerManager sharedManager] nfcTag: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;
    }
    NFCTagResult *nfcResult = (NFCTagResult *)result;
    // Handle NFC tag result.
}];

NFC Tag

The NFC Tag service is designed to pass tag data to the payment terminal for processing.

Warning

NFC Tag Request

NFCTagParam

transactionReferencestringRequired

Global reference of the sale transaction for the sale system.

messageContentstringRequired

Message content.

maximumWaitingTimeinteger

Maximum time to wait for the transmission to complete.
Unit: second, the default value is 60.

detectCountinteger

The number of times an NFC tag needs to be read.
The default value is 1.

NFC Tag Response

NFCTagResult

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.

Transaction parameters

When you receive the terminal result through the SDK callback interface and NFCTagResult.response = SUCC, you can obtain additional message.

detectCountinteger

How many times the NFC tag has been read.

NFCTagParam nfcTagParam = NFCTagParam.newBuilder()
        .messageContent("https://www.apple.com/")
        .maximumWaitingTime(30)
        .transactionReference(String.valueOf(System.currentTimeMillis()))
        .detectCount(1)
        .build();
RetailerManager.provideDeviceService().newNFCTagExchange(nfcTagParam).startAsyncExchange(new Exchange.RetailerSDKCallback<NFCTagResult>() {
    @Override
    public void onError(int code, String msg) {
        Logger.e(TAG,"NfcTagResult failed: " + code + ", " + msg);
    }

    @Override
    public void onResult(NFCTagResult result) {
        Logger.i(TAG,"NfcTagResult result: " + GsonUtils.toJson(result));
    }
});

using System;
using PayExplorerConnect;

public void HandleNFCTagResult(NFCTagResult result)
{
    Console.WriteLine($"Response: {result.Response}");
}

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

public string StartNFCTag()
{
    // Set the NFC content, timeout, and detection count for your scenario.
    NFCTagParam param = new NFCTagParam.Builder()
        .MessageContent("https://www.apple.com/")
        .MaximumWaitingTime(30)
        .DetectCount(1)
        .Build();

    string exchangeId = RetailerManager
        .ProvideDeviceService()
        .NewNFCTagExchange(param)
        .StartAsyncExchange(HandleNFCTagResult, HandleNFCTagError);

    return exchangeId;
}

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

NFCTagParam *params = [NFCTagParam makeWithBuilder:^(NFCTagParamBuilder *builder) {
    builder.transactionReference(@"00000008");
    builder.messageContent(@"https://www.apple.com/");
    builder.maximumWaitingTime(30);
    builder.detectCount(1);
}];

[[RetailerManager sharedManager] nfcTag: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;
    }
    NFCTagResult *nfcResult = (NFCTagResult *)result;
    // Handle NFC tag result.
}];