Skip to main content
POST
/
v2
/
actors
/
{ParentActorID}
Create a New Actor
curl --request POST \
  --url https://qa-lynx.nayax.com/operational/v2/actors/{ParentActorID} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ActorDetails": {
    "ActorDescription": "<string>",
    "ActorCode": 123,
    "ActorContact": "<string>",
    "ActorTypeID": 123,
    "StatusID": 123,
    "CurrencyID": 123,
    "TimeZoneKey": 123,
    "CountryID": 123,
    "CultureID": 123,
    "GeoOverrideInheritanceBit": true,
    "GeoSearchAddress": "<string>",
    "GeoCountryID": 123,
    "GeoStateName": "<string>",
    "GeoCityName": "<string>",
    "GeoStreetName": "<string>",
    "GeoStreetNumber": "<string>",
    "GeoLogitude": 123,
    "GeoLatitude": 123,
    "GeoZoom": 123,
    "GeoZipCode": "<string>",
    "LanguageID": 2,
    "MCCCode": "<string>"
  },
  "ActorBillingGateways": [
    {
      "BillingProviderID": 123,
      "TerminalID": 123,
      "ShvaZField": "<string>",
      "TransactionKey": "<string>",
      "ZFieldAllowedBit": true,
      "MerchantID": "<string>",
      "SubMerchantID": "<string>",
      "Username": "<string>",
      "Password": "<string>",
      "WithZipCodeBit": true,
      "SupportForcedTransactionsBit": true,
      "ForcedTransactionTerminalID": 123,
      "AVSOnlyBit": true,
      "PartialConfirmationBit": true,
      "DisableDebitCards": true,
      "DebitCardPrefix": "<string>",
      "DisableMagStripeBit": true,
      "FiscalBit": true,
      "OverrideURL": "<string>",
      "RemoteStartID": 123,
      "EnableMultiBillingProvidersBit": true,
      "RuleSetID": 123,
      "CustomData": {}
    }
  ],
  "ActorBillingPlanID": 123
}
'
{
  "ParentActorID": 123,
  "ActorID": 123,
  "ActorDescription": "<string>",
  "ActorCode": 123,
  "ActorContact": "<string>",
  "ActorTypeID": 123,
  "ActorStatus": 123,
  "ActorHierarchyLevel": 123,
  "CurrencyID": 123,
  "LastUpdated": "2023-11-07T05:31:56Z",
  "TimeZoneKey": 123,
  "CountryID": 123,
  "OperatorActorID": 123,
  "DistributorActorID": 123,
  "ActorHierarchy": "<string>",
  "ActorCreatedBy": 123,
  "ActorCreationDate": "2023-11-07T05:31:56Z",
  "UpdateBy": 123,
  "CultureID": 123,
  "GeoCountryID": 123,
  "GeoState": "<string>",
  "GeoCity": "<string>",
  "GeoAddress": "<string>",
  "GeoStreetNumber": "<string>",
  "GeoLongitude": 123,
  "GeoLatitude": 123,
  "GeoZipCode": "<string>",
  "GeoZoom": 123,
  "ActorLanguageID": 2,
  "OverrideGeoInherritcanceBit": true
}

Authorizations

Authorization
string
header
required

Enter your API key. It's required to authenticate API requests.

Path Parameters

ParentActorID
integer<int64>
required

The unique identifier of the parent actor under which the new actor will be created.

Body

application/json

Request schema for creating a new actor, including details and billing gateways.

ActorDetails
object

Detailed information about the actor.

ActorBillingGateways
object[] | null

A list of billing gateways associated with the actor.

ActorBillingPlanID
integer<int32>

The identifier for the billing plan assigned to the actor.

Response

200 - application/json

Actor created successfully.

Response schema returned after successfully creating a new actor, containing the actor's details.

ParentActorID
integer<int64> | null

The unique identifier of the parent actor, if applicable.

ActorID
integer<int64>

The unique identifier of the newly created actor.

ActorDescription
string | null

A brief description of the actor.

ActorCode
integer<int64> | null

A code assigned to the actor, often used for identification or categorization.

ActorContact
string | null

Contact information for the actor, such as a phone number or email.

ActorTypeID
integer<int32>

The identifier representing the type of actor, defining their role or category.

ActorStatus
integer<int32>

The status identifier of the actor, indicating their current status.

ActorHierarchyLevel
integer<int32>

The level of hierarchy where the actor is positioned within the organizational structure.

CurrencyID
integer<int32>

The identifier for the currency used by the actor.

LastUpdated
string<date-time>

The date and time when the actor's information was last updated.

TimeZoneKey
integer<int32> | null

The key representing the time zone in which the actor operates.

CountryID
integer<int32> | null

The identifier for the country in which the actor is located.

OperatorActorID
integer<int64> | null

The identifier for the operator managing this actor, if applicable.

DistributorActorID
integer<int64>

The identifier for the distributor associated with the actor.

ActorHierarchy
string | null

The hierarchical structure to which the actor belongs.

ActorCreatedBy
integer<int64>

The identifier of the user who created this actor's record.

ActorCreationDate
string<date-time>

The date and time when this actor was created.

UpdateBy
integer<int64>

The identifier of the user who last updated this actor's record.

CultureID
integer<int32> | null

The identifier for the culture or locale associated with the actor.

GeoCountryID
integer<int32> | null

The identifier for the country based on the actor's geographic information.

GeoState
string | null

The state or region based on the actor's geographic information.

GeoCity
string | null

The city based on the actor's geographic information.

GeoAddress
string | null

The address based on the actor's geographic information.

GeoStreetNumber
string | null

The street number based on the actor's geographic information.

GeoLongitude
number<double> | null

The geographic longitude of the actor's location.

GeoLatitude
number<double> | null

The geographic latitude of the actor's location.

GeoZipCode
string | null

The zip code based on the actor's geographic information.

GeoZoom
integer<int32> | null

The zoom level for map-based services relevant to the actor's geographic location.

ActorLanguageID
enum<integer> | null

The identifier for the language preference of the actor.

Available options:
2,
4,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
21,
22,
23,
27,
28,
29,
30,
31,
34,
41,
42,
51,
52,
54,
62,
64,
81
OverrideGeoInherritcanceBit
boolean

Indicates whether the actor overrides inherited geographic settings.