Guides

Create New Machine

Suggest Edits

In Nayax Core you can create a new machine in the Machines menu, follow the steps below to do so.

  1. In your Dashboard go to Operations > Machines.
  2. Click Create > New Machine.
  1. Now you can fill all the details on the form, once you are finished click on Save.

Lynx API allows you to do this process programatically trough a POST request. This page will gudie you on how to do so using the endpoint below:

post Create New Machine

🚧

Authentication

Refer to the Security & Token page of this documentation to learn how to access your tokens, and how to properly use it to authenticate your API requests.

Request to Create New Machine

Use the Create New Machine endpoint to create a new machine. The following code block exemplifies the request to create a new machine:

curl -X POST "https://lynx.nayax.com/operational/api/v1/machines" \
-H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
  "ActorID": 2001492652,
  "CountryID": 105,
  "CurrencyID": 2,
  "MachineGroupID": 210631347,
  "MachineModelID": 305,
  "MachineName": "New Vending Machine",
  "MachineStatusBit": 1,
  "LanguageID": 7,
  "SalesSourceID": 30000512,
  "MachineTypeID": 555001,
  "GeoCountry": 1
}'

 {
    "MachineID": 942488501,
    "ActorID": 2001492652,
    "CountryID": 105,
    "CurrencyID": 2,
    "InstituteID": 3001,
    "LocationID": 4001,
    "MachineGroupID": 210631347,
    "MachineModelID": 305,
    "MachineName": "Marshall Vending",
    "MachineNumber": "MV001",
    "MachineStatusBit": 1,
    "LanguageID": 7,
    "OperatorActorID": 2001492652,
    "DistributorActorID": 3001492652,
    "AreaActorID": 4001492652,
    "SalesSourceID": 30000512,
    "MachineTypeID": 555001,
    "SerialNumber": "SN12345X",
    "VPOSSerialNumber": "VP12345",
    "DeviceSerialNumber": "SN12345X",
    "VPOSID": 98765,
    "DeviceID": 123456,
    "UseLocationFrom": 1,
    "GeoCountry": 1,
    "GeoState": "New York",
    "GeoCity": "New York City",
    "GeoAddress": "123 Main St",
    "GeoStreetNumber": "123",
    "GeoLongitude": -73.935242,
    "GeoLatitude": 40.730610,
    "GeoZoom": 15,
    "GeoZipCode": "10001",
    "SearchAddress": "123 Main St, New York, NY",
    "Remarks": "High-traffic area",
    "DexType": 2,
    "DexMidnightReadsEnableBit": true,
    "DexG85CheckEnableBit": true,
    "DexDivideBillsBy": 100,
    "DexG85CheckParsingFilterEnableBit": true,
    "UseCardPriceCorrectCashPriceBit": false,
    "MachineTimeZoneOffset": -5,
    "DexReadInterval": 30,
    "LocationType": 1,
    "ApplyDisplayPickListSelectionsToReportsBit": true,
    "DisplayPickListSelectionsAs": 1,
    "LastUpdated": "2024-10-09T14:38:53.474Z",
    "MachineProfile": 0,
    "CityID": 101,
    "RegionID": 201,
    "CountryDialingCode": 1,
    "DexIgnoreCRCCheckBit": true,
    "DexParseLABit": false,
    "ProductMapID": 501,
    "Longitude": -73.935242,
    "Latitude": 40.730610,
    "DexTotalSalesMinusCardSalesBit": true,
    "RouteActorID": 5001492652,
    "MachineLogicAlertEnableBit": true,
    "AlertRuleSetId": 601,
    "MachineMemberTypePricingEnableBit": false,
    "DexMultiplyCoinsBy": 10,
    "DexMultiplyTubesBy": 5,
    "CustomerID": 12345,
    "CommissionType": 2,
    "CommissionDefaultValue": 0.05,
    "CreatedBy": 105,
    "CreatedOn": "2023-06-01T12:00:00.000Z",
    "UpdateBy": 107,
    "TubeSource": 2,
    "BillSource": 3,
    "SmartStickerId": 8080,
    "EnableRemoveVendBit": true,
    "EnableEreceiptBit": true,
    "ProductMapAutomaticCreationBit": true,
    "Refs": {
      "Documentation": "https://lynx.docs.com/machine/942488501"
    }
  }
]

You need to provide various mandatory fields in the body parameters, such as:

Field NameDescription
ActorIDThe operator's ID under which the machine is being created.
CountryIDID representing the machine's country. Use the Get Countries endpoint for a list of available country codes.
CurrencyIDID for the machine's currency. Use the Get Currencies endpoint for a list of available currency codes.
MachineGroupIDID of the group to which the machine belongs. You can view existing groups with the List All Machine Groups for Actor endpoint.
MachineModelIDID for the machine's model. To obtain the machine model of an existing machine, you can copy and paste the MachineModelId from the Get Specific Machine Basic Info endpoint for a specific machine.
MachineNameThe name of the virtual machine.
MachineStatusBitStatus of the machine: 1 for active, 2 for inactive.
LanguageIDID represents the language used by the machine.
SalesSourceIDID indicating the sales source. should be 30000512, which means live transactions (other options are irrelevant)
MachineTypeIDThe type of the machine determines its icon in Nayax Core.
GeoCountryCountry code where the machine is located.

You will receive a response containing the details of the newly created machine, including the newly created machine's MachineID.

Verify Creation

Once a new machine is created, you can verify it in Nayax Core, as i nthe steps below:

  1. Go to Operations > Machines.
  2. Use the Search feature to filter the Machine, and select it from the list.

As you can see in the image above, once you select it you can see all its information on the General Information tab.


Updated 6 months ago