Skip to main content
Onboard Machine
curl --request POST \
  --url https://{domain}:{port}/OnboardMachine \
  --header 'Content-Type: application/*+json' \
  --data '
{
  "ActorInfo": {
    "ApiKey": "<string>",
    "AppId": "<string>",
    "CertPass": "<string>",
    "CertPath": "<string>",
    "ContactName": "<string>",
    "Country": {
      "Alpha2Code": "<string>",
      "Alpha3Code": "<string>",
      "Name": "<string>",
      "NumericCode": "<string>"
    },
    "DynamicURL": "<string>",
    "GeoLocation": {
      "Address": "<string>",
      "City": "<string>",
      "CountryCode": "<string>",
      "Latitude": 123,
      "Longitude": 123,
      "State": "<string>",
      "ZipCode": "<string>"
    },
    "Id": 123,
    "Key": "<string>",
    "MCC": 123,
    "MerchantContactMobile": 123,
    "MerchantContactPhone": 123,
    "MerchantEmail": "<string>",
    "MerchantId": "<string>",
    "MerchantMobileCountryCode": 123,
    "MerchantPhoneCountryCode": 123,
    "Name": "<string>",
    "OperatorId": 123,
    "OperatorName": "<string>",
    "Password": "<string>",
    "SubMerchantId": "<string>",
    "SubMerchantNumber": 123,
    "TerminalId": "<string>",
    "URL": "<string>",
    "UserName": "<string>"
  },
  "CustomData": {
    "Actor": "<string>",
    "DirectActor": "<string>",
    "Distributor": "<string>",
    "Machine": "<string>",
    "Operator": "<string>"
  },
  "DistributorInfo": {
    "ApiKey": "<string>",
    "AppId": "<string>",
    "CertPass": "<string>",
    "CertPath": "<string>",
    "Country": {
      "Alpha2Code": "<string>",
      "Alpha3Code": "<string>",
      "Name": "<string>",
      "NumericCode": "<string>"
    },
    "DynamicURL": "<string>",
    "GeoLocation": {
      "Address": "<string>",
      "City": "<string>",
      "CountryCode": "<string>",
      "Latitude": 123,
      "Longitude": 123,
      "State": "<string>",
      "ZipCode": "<string>"
    },
    "Id": 123,
    "Key": "<string>",
    "MCC": 123,
    "MerchantId": "<string>",
    "Name": "<string>",
    "OperatorId": 123,
    "OperatorName": "<string>",
    "Password": "<string>",
    "SubMerchantId": "<string>",
    "SubMerchantNumber": 123,
    "TerminalId": "<string>",
    "URL": "<string>",
    "UserName": "<string>"
  },
  "MachineInfo": {
    "City": "<string>",
    "Country": {
      "Alpha2Code": "<string>",
      "Alpha3Code": "<string>",
      "Name": "<string>",
      "NumericCode": "<string>"
    },
    "ExternalId": "<string>",
    "GeoLocation": {
      "Address": "<string>",
      "City": "<string>",
      "CountryCode": "<string>",
      "Latitude": 123,
      "Longitude": 123,
      "State": "<string>",
      "ZipCode": "<string>"
    },
    "GroupId": "<string>",
    "Id": 123,
    "Name": "<string>",
    "Offset": "<string>",
    "OperatorId": "<string>",
    "Password": "<string>",
    "QrString": "<string>",
    "Region": "<string>",
    "TerminalId": "<string>",
    "Type": "<string>",
    "UserName": "<string>",
    "ZipCode": "<string>"
  },
  "OnboardingBasicInfo": {
    "BillingProviderID": 123,
    "OnboardingRequestId": 123,
    "OnboardingTransactionId": 123,
    "PaymentMethodID": 123,
    "RequestTime": "<string>",
    "SiteId": 123,
    "TimeoutMS": 123,
    "TransactionID": 123
  },
  "OperatorInfo": {
    "ApiKey": "<string>",
    "AppId": "<string>",
    "CertPass": "<string>",
    "CertPath": "<string>",
    "Country": {
      "Alpha2Code": "<string>",
      "Alpha3Code": "<string>",
      "Name": "<string>",
      "NumericCode": "<string>"
    },
    "DynamicURL": "<string>",
    "GeoLocation": {
      "Address": "<string>",
      "City": "<string>",
      "CountryCode": "<string>",
      "Latitude": 123,
      "Longitude": 123,
      "State": "<string>",
      "ZipCode": "<string>"
    },
    "Id": 123,
    "Key": "<string>",
    "MCC": 123,
    "MerchantId": "<string>",
    "Name": "<string>",
    "OperatorId": 123,
    "OperatorName": "<string>",
    "Password": "<string>",
    "SubMerchantId": "<string>",
    "SubMerchantNumber": 123,
    "TerminalId": "<string>",
    "URL": "<string>",
    "UserName": "<string>"
  },
  "UpdateInfo": [
    "<string>"
  ]
}
'
{
  "MachineOnboardingData": {
    "ActorId": 123,
    "CustomData": {
      "Actor": "<string>",
      "DirectActor": "<string>",
      "Distributor": "<string>",
      "Machine": "<string>",
      "Operator": "<string>"
    },
    "MachineId": 123,
    "Password": "<string>",
    "QrString": "<string>",
    "TerminalId": "<string>",
    "UserName": "<string>"
  },
  "OnboardStatus": {
    "StatusMessage": "<string>",
    "Verdict": "<string>"
  }
}
Registers or updates a vending machine’s configuration in the system. This endpoint manages the onboarding of specific machines by linking them to an operator and distributor. It configures the machine’s details and returns its unique credentials (such as TerminalId or QrString) along with the final setup status.

Body

​
ActorInfo
object

Actor info for onboarding

​
CustomData
object

Custom Fields Information, Contact Nayax TPOC to define.

​
DistributorInfo
object

Distributor info for onboarding

​
MachineInfo
object

Machine info for onboarding

​
OnboardingBasicInfo
object

Describing the onboarding Operation details

​
OperatorInfo
object

Operator info for onboarding

​
UpdateInfo
string[]

Response

Success

​
MachineOnboardingData
object

Echo and/or Updated onboarding machine data

​
OnboardStatus
object

Transaction status