Skip to main content
This guide shows you how to integrate the Marshall SDK into your C# or Java application. You’ll learn how to:
  • Import the SDK package into your project
  • Create and configure a VMC settings object
  • Set up the serial (COM) port for communication
  • Register event listeners and start the SDK
The instructions are presented side by side for both languages.

​
Prerequisites

Before you begin, make sure you have:
  • Downloaded the appropriate SDK files, .jar for Java or .dll for C#.
  • Identified the correct COM port for the Marshall cable.
  • For Java- ensure that you have Java 8 (also known as Java 1.8) and above. Note that for the newest version of Nayax’s Java SDK (0.1.6.8) you’d need Java 11- but should you like us to, we can look into having it be compiled with Java 8.

​
Integrate Marshall

To perform the integration, follow the steps below:
  1. Import the provided..JAR or SDK DLL file into your project.
  2. Import the necessary namespaces in your code. 
    import com.bitmick.marshall.models.*;
  3. Instantiate a VMC configuration object: 
    public vmc_configuration vmc_config = new vmc_configuration();
  4. Fill in the appropriate fields. The following code block presents a standard configuration: 
    public static void main(string[] args) {
        vmc_config.multi_vend_support = false;
        vmc_config.multi_session_support = false;
        vmc_config.price_not_final_support = false;
        vmc_config.reader_always_on = false;
        vmc_config.always_idle = false;
        vmc_config.vend_denied_policy = vmc_configuration.vend_denied_policy_cancel;
        vmc_config.explicit_vend_success = false;
        vmc_config.long_price = false;

        vmc_config.mifare_approved_by_vmc_support = false;
        vmc_config.mag_card_approved_by_vmc_support = false;
        vmc_config.qr_approved_by_vmc_support = false;

        vmc_config.dump_packets_level = vmc_configuration.debug_level_dump_moderate;
        vmc_config.debug = true;
}
Mandatory FieldsThe customer machine information is mandatory for the VMC configuration. These are the model, serial, hw_ver, and the manuf_code. Read more about these fields in VMC Configuration Object.
  1. Setup the COM port. 
    m_vmc.link.set_serial_port(new pc_port("COM18", 115200))
COM PortMake sure that you change the COM parameter to the one your Marshall cable is connected to.
  • Note- in the near future we plan on having the possibility to use Marshall over ETH (supported only for VPOSM)- in that case, the would be no COM port but rather an IP address which would be under the same local network as the Nayax device, and optionally the relevant IP port (which by default should remain untouched [has by default the value of “12345” which is meaningless]) 
    m_vmc.link.set_serial_port(new eth_port("192.168.112.127", (short) 12345, false));
  1. Configure the SDK and register to link events.
m_vmc.link.configure(vmc_config);
m_vmc.link.set_events(new vmc_link_events());
  1. Start the SDK and wait for the onReady() event:
vmc_instance .start();
Using AndroidOn android, you either need support from your provider or use a FTDI chip, which we provide port implementation for. (see the “android” folder in the JAVA SDK release)

​
See Also

C SDK Integration

Methods & Functions