> ## Documentation Index
> Fetch the complete documentation index at: https://devzone.nayax.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a New Actor

> Creates a new actor under the specified parent actor. The parent actor is identified by the `ParentActorID` provided in the path. The request body must contain the details of the new actor.



## OpenAPI

````yaml /openapi/lynx.yaml post /v2/actors/{ParentActorID}
openapi: 3.0.1
info:
  title: Nayax Operational Lynx API
  version: v1
servers:
  - url: https://qa-lynx.nayax.com/operational
security:
  - Authorization: []
paths:
  /v2/actors/{ParentActorID}:
    post:
      tags:
        - Actors
      summary: Create a New Actor
      description: >-
        Creates a new actor under the specified parent actor. The parent actor
        is identified by the `ParentActorID` provided in the path. The request
        body must contain the details of the new actor.
      operationId: create-new-actor-v2
      parameters:
        - name: ParentActorID
          in: path
          required: true
          schema:
            type: integer
            format: int64
          description: >-
            The unique identifier of the parent actor under which the new actor
            will be created.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActorCreateRequest'
      responses:
        '200':
          description: Actor created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorCreateResponse'
components:
  schemas:
    ActorCreateRequest:
      type: object
      description: >-
        Request schema for creating a new actor, including details and billing
        gateways.
      properties:
        ActorDetails:
          $ref: '#/components/schemas/ActorDetailsRequest'
          description: Detailed information about the actor.
        ActorBillingGateways:
          type: array
          items:
            $ref: '#/components/schemas/ActorBillingGatewaysRequest'
          nullable: true
          description: A list of billing gateways associated with the actor.
        ActorBillingPlanID:
          type: integer
          format: int32
          description: The identifier for the billing plan assigned to the actor.
      additionalProperties: false
    ActorCreateResponse:
      type: object
      description: >-
        Response schema returned after successfully creating a new actor,
        containing the actor's details.
      properties:
        ParentActorID:
          type: integer
          format: int64
          nullable: true
          description: The unique identifier of the parent actor, if applicable.
        ActorID:
          type: integer
          format: int64
          description: The unique identifier of the newly created actor.
        ActorDescription:
          type: string
          nullable: true
          description: A brief description of the actor.
        ActorCode:
          type: integer
          format: int64
          nullable: true
          description: >-
            A code assigned to the actor, often used for identification or
            categorization.
        ActorContact:
          type: string
          nullable: true
          description: Contact information for the actor, such as a phone number or email.
        ActorTypeID:
          type: integer
          format: int32
          description: >-
            The identifier representing the type of actor, defining their role
            or category.
        ActorStatus:
          type: integer
          format: int32
          description: The status identifier of the actor, indicating their current status.
        ActorHierarchyLevel:
          type: integer
          format: int32
          description: >-
            The level of hierarchy where the actor is positioned within the
            organizational structure.
        CurrencyID:
          type: integer
          format: int32
          description: The identifier for the currency used by the actor.
        LastUpdated:
          type: string
          format: date-time
          description: The date and time when the actor's information was last updated.
        TimeZoneKey:
          type: integer
          format: int32
          nullable: true
          description: The key representing the time zone in which the actor operates.
        CountryID:
          type: integer
          format: int32
          nullable: true
          description: The identifier for the country in which the actor is located.
        OperatorActorID:
          type: integer
          format: int64
          nullable: true
          description: The identifier for the operator managing this actor, if applicable.
        DistributorActorID:
          type: integer
          format: int64
          description: The identifier for the distributor associated with the actor.
        ActorHierarchy:
          type: string
          nullable: true
          description: The hierarchical structure to which the actor belongs.
        ActorCreatedBy:
          type: integer
          format: int64
          description: The identifier of the user who created this actor's record.
        ActorCreationDate:
          type: string
          format: date-time
          description: The date and time when this actor was created.
        UpdateBy:
          type: integer
          format: int64
          description: The identifier of the user who last updated this actor's record.
        CultureID:
          type: integer
          format: int32
          nullable: true
          description: The identifier for the culture or locale associated with the actor.
        GeoCountryID:
          type: integer
          format: int32
          nullable: true
          description: >-
            The identifier for the country based on the actor's geographic
            information.
        GeoState:
          type: string
          nullable: true
          description: The state or region based on the actor's geographic information.
        GeoCity:
          type: string
          nullable: true
          description: The city based on the actor's geographic information.
        GeoAddress:
          type: string
          nullable: true
          description: The address based on the actor's geographic information.
        GeoStreetNumber:
          type: string
          nullable: true
          description: The street number based on the actor's geographic information.
        GeoLongitude:
          type: number
          format: double
          nullable: true
          description: The geographic longitude of the actor's location.
        GeoLatitude:
          type: number
          format: double
          nullable: true
          description: The geographic latitude of the actor's location.
        GeoZipCode:
          type: string
          nullable: true
          description: The zip code based on the actor's geographic information.
        GeoZoom:
          type: integer
          format: int32
          nullable: true
          description: >-
            The zoom level for map-based services relevant to the actor's
            geographic location.
        ActorLanguageID:
          $ref: '#/components/schemas/LanguageIdEnum'
          type: integer
          format: int32
          nullable: true
          description: The identifier for the language preference of the actor.
        OverrideGeoInherritcanceBit:
          type: boolean
          description: Indicates whether the actor overrides inherited geographic settings.
      additionalProperties: false
    ActorDetailsRequest:
      type: object
      description: >-
        Detailed information about the actor, including geographic and contact
        details.
      properties:
        ActorDescription:
          type: string
          nullable: true
          description: A brief description of the actor.
        ActorCode:
          type: integer
          format: int64
          description: A unique code representing the actor.
        ActorContact:
          type: string
          nullable: true
          description: Contact information for the actor, such as a phone number or email.
        ActorTypeID:
          type: integer
          format: int32
          description: >-
            The identifier representing the type of actor, defining their role
            or category.
        StatusID:
          type: integer
          format: int32
          description: The status identifier of the actor.
        CurrencyID:
          type: integer
          format: int32
          description: The identifier for the currency used by the actor.
        TimeZoneKey:
          type: integer
          format: int32
          description: The key representing the actor's time zone.
        CountryID:
          type: integer
          format: int32
          description: The identifier for the country in which the actor is located.
        CultureID:
          type: integer
          format: int32
          description: The identifier for the culture or locale associated with the actor.
        GeoOverrideInheritanceBit:
          type: boolean
          description: >-
            Indicates whether geographic inheritance settings are overridden for
            this actor.
        GeoSearchAddress:
          type: string
          nullable: true
          description: A full address string used for geographic search purposes.
        GeoCountryID:
          type: integer
          format: int32
          nullable: true
          description: >-
            The identifier for the country based on the actor's geographic
            location.
        GeoStateName:
          type: string
          nullable: true
          description: The state or region name based on the actor's geographic location.
        GeoCityName:
          type: string
          nullable: true
          description: The city name based on the actor's geographic location.
        GeoStreetName:
          type: string
          nullable: true
          description: The street name based on the actor's geographic location.
        GeoStreetNumber:
          type: string
          nullable: true
          description: The street number based on the actor's geographic location.
        GeoLogitude:
          type: number
          format: double
          nullable: true
          description: The geographic longitude of the actor's location.
        GeoLatitude:
          type: number
          format: double
          nullable: true
          description: The geographic latitude of the actor's location.
        GeoZoom:
          type: integer
          format: int32
          description: >-
            The zoom level for map-based services relevant to the actor's
            geographic location.
        GeoZipCode:
          type: string
          nullable: true
          description: The zip code based on the actor's geographic location.
        LanguageID:
          $ref: '#/components/schemas/LanguageIdEnum'
          type: integer
          format: int32
          description: The identifier for the language preference of the actor.
        MCCCode:
          type: string
          nullable: true
          description: >-
            The merchant category code (MCC) associated with the actor, if
            applicable.
      additionalProperties: false
    ActorBillingGatewaysRequest:
      type: object
      description: Information about billing gateways associated with the actor.
      properties:
        BillingProviderID:
          type: integer
          format: int32
          description: The identifier for the billing provider.
        TerminalID:
          type: integer
          format: int64
          description: The terminal identifier used for transactions.
        ShvaZField:
          type: string
          nullable: true
          description: >-
            An optional field for SHVA (Shva Payment Service Provider) Z
            information.
        TransactionKey:
          type: string
          nullable: true
          description: A key used for securing transactions.
        ZFieldAllowedBit:
          type: boolean
          description: Indicates whether the Z field is allowed for transactions.
        MerchantID:
          type: string
          nullable: true
          description: The merchant identifier associated with the actor.
        SubMerchantID:
          type: string
          nullable: true
          description: The sub-merchant identifier, if applicable.
        Username:
          type: string
          nullable: true
          description: The username used for authentication with the billing provider.
        Password:
          type: string
          nullable: true
          description: The password used for authentication with the billing provider.
        WithZipCodeBit:
          type: boolean
          description: Indicates whether the zip code is required for transactions.
        SupportForcedTransactionsBit:
          type: boolean
          description: Indicates whether forced transactions are supported.
        ForcedTransactionTerminalID:
          type: integer
          format: int64
          nullable: true
          description: The terminal identifier used for forced transactions.
        AVSOnlyBit:
          type: boolean
          description: >-
            Indicates whether only AVS (Address Verification System)
            transactions are supported.
        PartialConfirmationBit:
          type: boolean
          description: >-
            Indicates whether partial confirmations are supported for
            transactions.
        DisableDebitCards:
          type: boolean
          description: Indicates whether debit cards are disabled for this billing gateway.
        DebitCardPrefix:
          type: string
          nullable: true
          description: A prefix used for identifying debit cards, if applicable.
        DisableMagStripeBit:
          type: boolean
          description: Indicates whether magnetic stripe cards are disabled.
        FiscalBit:
          type: boolean
          description: >-
            Indicates whether fiscal requirements are enforced for this billing
            gateway.
        OverrideURL:
          type: string
          nullable: true
          description: A custom URL to override the default billing gateway URL.
        RemoteStartID:
          type: integer
          format: int32
          description: The identifier used for remote start transactions.
        EnableMultiBillingProvidersBit:
          type: boolean
          description: >-
            Indicates whether multiple billing providers are enabled for this
            actor.
        RuleSetID:
          type: integer
          format: int32
          description: >-
            The identifier for the set of rules governing transactions for this
            billing gateway.
        CustomData:
          type: object
          nullable: true
          description: Custom data specific to the billing gateway.
          additionalProperties:
            nullable: true
      additionalProperties: false
    LanguageIdEnum:
      enum:
        - 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
      x-enumDescriptions:
        '2': Turkish
        '4': Hebrew
        '7': English
        '8': French
        '9': Romanian
        '10': Swedish
        '11': Norwegian
        '12': Russian
        '13': Iceland
        '14': Portuguese
        '15': Spanish
        '16': Italian
        '17': Danish
        '18': Polish
        '21': Dutch
        '22': Chinese
        '23': Hungarian
        '27': Thai
        '28': German
        '29': Japanese
        '30': Greek
        '31': English UK
        '34': Latvian
        '41': Slovenian
        '42': Estonian
        '51': Vietnamese
        '52': Czech
        '54': Finnish
        '62': Arabic
        '64': Lithuanian
        '81': Bulgarian
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      description: Enter your Bearer token. It's required to authenticate API requests.

````