Skip to main content
POST
/
OnboardActor
Onboard Actor
curl --request POST \
  --url https://{domain}:{port}/api/OnboardActor \
  --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>",
    "OnboardingStatus": 0,
    "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>",
    "OnboardingStatus": 0,
    "OperatorId": 123,
    "OperatorName": "<string>",
    "Password": "<string>",
    "SubMerchantId": "<string>",
    "SubMerchantNumber": 123,
    "TerminalId": "<string>",
    "URL": "<string>",
    "UserName": "<string>"
  },
  "OnboardingBasicInfo": {
    "BillingProviderID": 123,
    "OnboardingOperation": 1,
    "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>",
    "OnboardingStatus": 0,
    "OperatorId": 123,
    "OperatorName": "<string>",
    "Password": "<string>",
    "SubMerchantId": "<string>",
    "SubMerchantNumber": 123,
    "TerminalId": "<string>",
    "URL": "<string>",
    "UserName": "<string>"
  },
  "UpdateInfo": [
    "<string>"
  ]
}
'
{
  "ActorOnboardingData": {
    "ApiKey": "<string>",
    "AppId": "<string>",
    "CertPass": "<string>",
    "CertPath": "<string>",
    "CustomData": {
      "Actor": "<string>",
      "DirectActor": "<string>",
      "Distributor": "<string>",
      "Machine": "<string>",
      "Operator": "<string>"
    },
    "Key": "<string>",
    "MerchantId": "<string>",
    "OnboardingTransactionId": 123,
    "Password": "<string>",
    "SubMerchantId": "<string>",
    "SubMerchantNumber": 123,
    "TerminalId": "<string>",
    "URL": "<string>",
    "UserName": "<string>"
  },
  "OnboardStatus": {
    "Code": 0,
    "StatusMessage": "<string>",
    "Verdict": "<string>"
  }
}
Registers or updates a merchant (Actor) in the system. This endpoint handles the onboarding process for new merchants, distributors, or operators. It accepts their profile details and configuration settings and returns an onboarding status (e.g., Success, Pending, Failed) along with credentials such as API keys or merchant IDs.

Body

​
ActorInfo
object

Actor info for onboarding

​
CustomData
object

Custom Fields Information, Contact Nayax TPOC to define.

​
DistributorInfo
object

Distributor info for onboarding

​
OnboardingBasicInfo
object

Describing the onboarding Operation details

​
OperatorInfo
object

Operator info for onboarding

​
UpdateInfo
string[]

Response

Success

​
ActorOnboardingData
object

Echo and/or Updated onboarding actor data (Merchant data)

​
OnboardStatus
object

Transaction status