Remote Management
The EMV Core SDK includes features for remote management that streamline device configuration, firmware updates, and diagnostics. These capabilities reduce maintenance overhead and enhance reliability by allowing centralized control through Nayax’s Terminal Management System (TMS) or local updates when necessary.
These are the methods regarding the management of the SDK:
- Initialize
- Destroy
- isEMVCoreConnected
- SetPaymentCallbacks
- GetStatus
- ShowMessage
- Getversion
- GetKioskID
See the sections below for more details on each of them.
Initialize
Initialize
Initializes the EMV Core SDK to prepare it for operation by establishing initial settings and connections. It should be called during application startup to establish a session with the reader. Setting up the environment before performing any transactions or management tasks is essential.
See the Initialize
API signature in the code below:
void Initialize() throws EmvCoreException;
Destroy
Destroy
Terminates the session with the reader and releases any associated resources. Use it during application shutdown or when the reader is no longer needed to prevent resource leaks and ensure proper cleanup of SDK-related processes.
See the Destroy
API signature in the code below:
void Destroy();
isEMVCoreConnected
isEMVCoreConnected
Retrieves the current status of the reader, including readiness for transactions and connectivity state.
See the isEMVCoreConnected
API signature in the code below:
boolean isEmvCoreConnected();
SetPaymentCallbacks
SetPaymentCallbacks
Registers callbacks for transaction-related events, such as transaction completion or errors, enabling the application to respond dynamically to events triggered during payment flows and provide real-time updates to the application about transaction progress.
See the SetPaymentCallbacks
API signature in the code below:
void SetPaymentCallbacks(IPaymentCallbacks iPaymentCallbacks);
Parameters:
iPaymentCallbacks
: Payment transaction Details
Event Callbacks
To learn more about callbacks, see Event Callbacks.
GetStatus
GetStatus
It retrieves the reader's current status, including readiness for transactions and connectivity state, and helps monitor its state during integration or deployment.
See the GetStatus
API signature in the code below:
EmvCoreStatus GetStatus() throws EmvCoreException;
The possible result values are: NotReady
, Ready
, PaymentTransaction
, Update
, NoReader
and NoTerminalId
.
Update
andNoTerminalId
Update
status means EMV-Core is busy with TMS updates (e.g. new firmware or configuration)NoTerminalId
status means Emv-Core doesn't know the Terminal ID.
ShowMessage
ShowMessage
Displays a custom message on the reader’s screen if the reader has a display.
See the ShowMessage
API signature in the code below:
void ShowMessage(String line1, String line2) throws EmvCoreException;
Parameters:
Parameter | Description |
---|---|
line1 | Text to show in the 1st line of the reader display (limited to 16 characters) |
line2 | Text to show in the 2nd line of the reader display (limited to 16 characters. |
UNO-PLUS Exclusive
This method is available only for UNO-PLUS reader.
Getversion
(for EMV-Core and the reader)
Getversion
(for EMV-Core and the reader)Fetches the firmware version of the reader and the EMV Core SDK version. Use it to verify that the latest updates are applied.
String GetEmvCoreVersion() throws EmvCoreException;
String GetReaderVersion() throws EmvCoreException;
GetKioskID
GetKioskID
Called by the POS application to get the Device identification number. This ID is critical for identifying the device in the Nayax server and linking it to transactions, configurations, and monitoring systems.
See the isEMVCoreConnected
API signature in the code below:
String GetKioskID() throws EmvCoreException;
Updated 4 months ago