> ## Documentation Index
> Fetch the complete documentation index at: https://nayax-44d6e37b-docs-marshall-faq-redistribution.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Actor by ActorCode

> Retrieves the details of an actor using their unique `ActorCode`. This is useful for fetching information about a specific actor when only their code is known.



## OpenAPI

````yaml /openapi/lynx.yaml get /v1/actors
openapi: 3.0.1
info:
  title: Nayax Operational Lynx API
  version: v1
servers:
  - url: https://qa-lynx.nayax.com/operational
security:
  - Authorization: []
paths:
  /v1/actors:
    get:
      tags:
        - Actors
      summary: Get Actor by ActorCode
      description: >-
        Retrieves the details of an actor using their unique `ActorCode`. This
        is useful for fetching information about a specific actor when only
        their code is known.
      operationId: get-actor-by-actorcode
      parameters:
        - name: ActorCode
          in: query
          schema:
            type: integer
            format: int64
          required: true
          description: >-
            The unique code assigned to the actor. This code is used to identify
            and retrieve the actor's details.
      responses:
        '200':
          description: Actor details retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Actors'
components:
  schemas:
    Actors:
      type: object
      properties:
        ParentActorID:
          type: integer
          format: int64
          nullable: true
          description: The unique identifier of the parent actor, if applicable.
        ActorID:
          type: integer
          format: int64
          nullable: true
          description: The unique identifier for this actor.
        ActorDescription:
          type: string
          nullable: true
          description: A brief description of the actor.
        ActorCode:
          type: integer
          format: int64
          nullable: true
          description: A unique code assigned to the actor.
        ActorAddress:
          type: string
          nullable: true
          description: The address associated with the actor.
        ActorContact:
          type: string
          nullable: true
          description: The contact details for the actor.
        ActorTypeID:
          type: integer
          format: int32
          nullable: true
          description: >-
            The identifier for the type of actor, defining the actor's role or
            category.
        ActorStatus:
          type: integer
          format: int32
          nullable: true
          description: The current status of the actor, represented by a status code.
        ActorHierarchyLevel:
          type: integer
          format: int32
          nullable: true
          description: >-
            The level of hierarchy where the actor is positioned within the
            organizational structure.
        CurrencyID:
          type: integer
          format: int32
          nullable: true
          description: The identifier for the currency used by the actor.
        LastUpdated:
          type: string
          format: date-time
          nullable: true
          description: The date and time when the actor's information was last updated.
        RouteManagerName:
          type: string
          nullable: true
          description: The name of the route manager associated with the actor.
        RouteManagerMobile:
          type: string
          nullable: true
          description: The mobile number of the route manager associated with the actor.
        TimeZoneKey:
          type: integer
          format: int32
          nullable: true
          description: The key representing the time zone in which the actor operates.
        DayLightSavingsBit:
          type: boolean
          nullable: true
          description: Indicates whether daylight saving time is observed by the actor.
        CountryID:
          type: integer
          format: int32
          nullable: true
          description: The identifier for the country in which the actor is located.
        DailyCCTransLimitPerCard:
          type: integer
          format: int32
          nullable: true
          description: The daily credit card transaction limit per card for the actor.
        DailyPPTransLimitPerCard:
          type: integer
          format: int32
          nullable: true
          description: The daily prepaid card transaction limit per card for the actor.
        DailyExternalPPTransLimitPerCard:
          type: integer
          format: int32
          nullable: true
          description: >-
            The daily external prepaid card transaction limit per card for the
            actor.
        DailyCCTransLimitPerCardPerOperator:
          type: integer
          format: int32
          nullable: true
          description: >-
            The daily credit card transaction limit per card per operator for
            the actor.
        OperatorActorID:
          type: integer
          format: int64
          nullable: true
          description: The identifier for the operator managing this actor.
        DistributorActorID:
          type: integer
          format: int64
          nullable: true
          description: The identifier for the distributor associated with the actor.
        AreaActorID:
          type: integer
          format: int64
          nullable: true
          description: The identifier for the area actor that encompasses this actor.
        RouteActorID:
          type: integer
          format: int64
          nullable: true
          description: The identifier for the route actor associated with this actor.
        ActorHierarchy:
          type: string
          nullable: true
          description: The hierarchical structure to which the actor belongs.
        ActorHasChildrenBit:
          type: boolean
          nullable: true
          description: Indicates whether the actor has child entities.
        ActorHasMachinesBit:
          type: boolean
          nullable: true
          description: Indicates whether the actor is associated with any machines.
        ActorImageURL:
          type: string
          nullable: true
          description: The URL to an image representing the actor.
        ActorContractInfo:
          type: string
          nullable: true
          description: Contractual information related to the actor.
        ActorSQSID:
          type: integer
          format: int64
          nullable: true
          description: >-
            The identifier for the actor's SQS (Simple Queue Service) system, if
            applicable.
        UseProductGroupVATBit:
          type: boolean
          nullable: true
          description: >-
            Indicates whether VAT is applied based on the product group for this
            actor.
        EreceiptTransactionEndEnableBit:
          type: boolean
          nullable: true
          description: >-
            Indicates whether e-receipts are enabled for transactions ending
            with this actor.
        MaximumRevalueAmountLimit:
          type: number
          format: double
          nullable: true
          description: The maximum amount limit for revaluing transactions for this actor.
        ActorCreatedBy:
          type: integer
          format: int64
          nullable: true
          description: The identifier of the user who created this actor's record.
        ActorCreationDate:
          type: string
          format: date-time
          nullable: true
          description: The date and time when this actor was created.
        UpdateBy:
          type: integer
          format: int64
          nullable: true
          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.
        RevaluePayoutByDistributor:
          type: boolean
          nullable: true
          description: Indicates whether the revalue payout is handled by the distributor.
        FiscalizationBit:
          type: boolean
          nullable: true
          description: Indicates whether fiscalization is enabled for this 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.
        ActorMerchantBit:
          type: string
          nullable: true
          description: Indicates whether the actor is associated with a merchant.
        ActorMerchantNameForDescriptor:
          type: string
          nullable: true
          description: >-
            The merchant name used for transaction descriptors related to this
            actor.
        OverrideGeoInherritcanceBit:
          type: boolean
          nullable: true
          description: Indicates whether the actor overrides inherited geographic settings.
        AirportID:
          type: integer
          format: int32
          nullable: true
          description: >-
            The identifier for the airport associated with the actor, if
            applicable.
        VerticalCustomJSON:
          type: string
          nullable: true
          description: >-
            Custom JSON data specific to the vertical market or industry the
            actor operates in.
        FiscalizationActorID:
          type: integer
          format: int64
          nullable: true
          description: The identifier for the actor responsible for fiscalization.
        SupportIncrementalAuth:
          type: boolean
          nullable: true
          description: >-
            Indicates whether incremental authorization is supported by this
            actor.
        MaximumDefaultCredit:
          type: number
          format: double
          nullable: true
          description: The maximum default credit limit allowed for this actor.
        Refs:
          type: object
          nullable: true
          description: >-
            A key-value pair object containing additional references associated
            with the actor.
          additionalProperties:
            type: string
            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.

````