Guides

Create Operator

Suggest Edits

In Nayax Core, you can create and manage operators using the Operator menu. To create a new Operator, follow the steps below:

  1. Go to Administration > Operator.
  2. Click Create > Add New Operator.
  3. Now, you must fill out the required details on the form.
    1. Operator Internal Code: This is the SAP Customer number.
    2. Parent: Refers to the parent actor for this new operator, which, in this example, is the distributor itself.
    3. Type: The operator type.
    4. Status: The status of the operator.
    5. Regional Settings: Configuration regarding currency and timezone.
  4. When finished, click Save Information.

🚧

Actor Types

Note that when you create an actor directly below the distributor, there are only two types available: Institute or Operator. To create Routes, Area, or Location actor types, they must be below an actor with the Operator type.

Lynx API

This process can also be done programmatically through Lynx API with a POST request to the following endpoint:

post Create New Actor

🚧

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.

Create Operator Request

The Create New Actor endpoint allows for registering a new operator in the Nayax system. See the example request in the code block below:

curl --request POST \
     --url https://qa-lynx.nayax.com/operational/v1/actors/{ParentActorID} \
     --header 'Authorization: BEARER-TOKEN' \
     --header 'accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '{
       "ActorDescription": "Main Branch",
       "ActorCode": 1001,
       "ActorAddress": "123 Main Street, Metropolis",
       "ActorContact": "[email protected]",
       "ActorTypeID": 16,
       "ActorStatus": 1,
       "CurrencyID": 840,
       "CountryID": 840,
       "ActorMerchantBit": true,
       "ActorCreationDate": "2024-11-25T12:00:00Z",
       "ActorLanguageID": 7,
       "GeoCity": "Metropolis",
       "GeoLongitude": -77.0364,
       "GeoLatitude": 38.8951
     }'

📘

Path Params

Change the ParentActorID with the unique identifier of the parent actor under which the new operator will be created.

In the body parameters, fill in the following:

ParameterTypeDescription
ParentActorIDint64/nullThe unique identifier of the parent actor is if this actor is a sub-entity.
ActorIDint64/nullThe unique identifier for the actor.
ActorDescriptionstring/nullA brief description of the actor.
ActorCodeint64/nullA code representing the actor is often used for identification or categorization.
ActorAddressstring/nullThe physical address associated with the actor.
ActorContactstring/nullContact information for the actor, such as a phone number or email.
ActorTypeIDint32/nullThe identifier represents the type of actor.
ActorStatusint32/nullThe current status of the actor.
CurrencyIDint32/nullThe currency identifier used by the actor for transactions.
CountryIDint32/nullThe identifier for the country in which the actor is located.
ActorMerchantBitboolean/nullIndicates whether the actor is associated with a merchant.
ActorLanguageIDint32/nullThe language preference of the actor.
GeoCitystring/nullThe city where the actor is located.
GeoLongitudedouble/nullThe geographic longitude of the actor's location.
GeoLatitudedouble/nullThe geographic latitude of the actor's location.
ActorCreationDatedate-time/nullThe date and time when this actor was created.

A successful request will return a response with the created operator details.

Verify Creation

You can check if your operator was correctly created in Nayax Core in the Operators menu.

  1. Use the Search function to filter your operator.
  2. Select it from the list.

You can see all the operator information in the Details tab.

Updated 5 months ago