Get Actor Details by ActorID

curl --request GET \
  --url https://qa-lynx.nayax.com/operational/v1/actors/{ActorID} \
  --header 'Authorization: <api-key>'

{
  "ParentActorID": 123,
  "ActorID": 123,
  "ActorDescription": "<string>",
  "ActorCode": 123,
  "ActorAddress": "<string>",
  "ActorContact": "<string>",
  "ActorTypeID": 123,
  "ActorStatus": 123,
  "ActorHierarchyLevel": 123,
  "CurrencyID": 123,
  "LastUpdated": "2023-11-07T05:31:56Z",
  "RouteManagerName": "<string>",
  "RouteManagerMobile": "<string>",
  "TimeZoneKey": 123,
  "DayLightSavingsBit": true,
  "CountryID": 123,
  "DailyCCTransLimitPerCard": 123,
  "DailyPPTransLimitPerCard": 123,
  "DailyExternalPPTransLimitPerCard": 123,
  "DailyCCTransLimitPerCardPerOperator": 123,
  "OperatorActorID": 123,
  "DistributorActorID": 123,
  "AreaActorID": 123,
  "RouteActorID": 123,
  "ActorHierarchy": "<string>",
  "ActorHasChildrenBit": true,
  "ActorHasMachinesBit": true,
  "ActorImageURL": "<string>",
  "ActorContractInfo": "<string>",
  "ActorSQSID": 123,
  "UseProductGroupVATBit": true,
  "EreceiptTransactionEndEnableBit": true,
  "MaximumRevalueAmountLimit": 123,
  "ActorCreatedBy": 123,
  "ActorCreationDate": "2023-11-07T05:31:56Z",
  "UpdateBy": 123,
  "CultureID": 123,
  "RevaluePayoutByDistributor": true,
  "FiscalizationBit": true,
  "GeoCountryID": 123,
  "GeoState": "<string>",
  "GeoCity": "<string>",
  "GeoAddress": "<string>",
  "GeoStreetNumber": "<string>",
  "GeoLongitude": 123,
  "GeoLatitude": 123,
  "GeoZipCode": "<string>",
  "GeoZoom": 123,
  "ActorLanguageID": 2,
  "ActorMerchantBit": "<string>",
  "ActorMerchantNameForDescriptor": "<string>",
  "OverrideGeoInherritcanceBit": true,
  "AirportID": 123,
  "VerticalCustomJSON": "<string>",
  "FiscalizationActorID": 123,
  "SupportIncrementalAuth": true,
  "MaximumDefaultCredit": 123,
  "Refs": {}
}

GET

actors

{ActorID}

Get Actor Details by ActorID

curl --request GET \
  --url https://qa-lynx.nayax.com/operational/v1/actors/{ActorID} \
  --header 'Authorization: <api-key>'

{
  "ParentActorID": 123,
  "ActorID": 123,
  "ActorDescription": "<string>",
  "ActorCode": 123,
  "ActorAddress": "<string>",
  "ActorContact": "<string>",
  "ActorTypeID": 123,
  "ActorStatus": 123,
  "ActorHierarchyLevel": 123,
  "CurrencyID": 123,
  "LastUpdated": "2023-11-07T05:31:56Z",
  "RouteManagerName": "<string>",
  "RouteManagerMobile": "<string>",
  "TimeZoneKey": 123,
  "DayLightSavingsBit": true,
  "CountryID": 123,
  "DailyCCTransLimitPerCard": 123,
  "DailyPPTransLimitPerCard": 123,
  "DailyExternalPPTransLimitPerCard": 123,
  "DailyCCTransLimitPerCardPerOperator": 123,
  "OperatorActorID": 123,
  "DistributorActorID": 123,
  "AreaActorID": 123,
  "RouteActorID": 123,
  "ActorHierarchy": "<string>",
  "ActorHasChildrenBit": true,
  "ActorHasMachinesBit": true,
  "ActorImageURL": "<string>",
  "ActorContractInfo": "<string>",
  "ActorSQSID": 123,
  "UseProductGroupVATBit": true,
  "EreceiptTransactionEndEnableBit": true,
  "MaximumRevalueAmountLimit": 123,
  "ActorCreatedBy": 123,
  "ActorCreationDate": "2023-11-07T05:31:56Z",
  "UpdateBy": 123,
  "CultureID": 123,
  "RevaluePayoutByDistributor": true,
  "FiscalizationBit": true,
  "GeoCountryID": 123,
  "GeoState": "<string>",
  "GeoCity": "<string>",
  "GeoAddress": "<string>",
  "GeoStreetNumber": "<string>",
  "GeoLongitude": 123,
  "GeoLatitude": 123,
  "GeoZipCode": "<string>",
  "GeoZoom": 123,
  "ActorLanguageID": 2,
  "ActorMerchantBit": "<string>",
  "ActorMerchantNameForDescriptor": "<string>",
  "OverrideGeoInherritcanceBit": true,
  "AirportID": 123,
  "VerticalCustomJSON": "<string>",
  "FiscalizationActorID": 123,
  "SupportIncrementalAuth": true,
  "MaximumDefaultCredit": 123,
  "Refs": {}
}

Authorizations

Authorization

string

header

required

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

Path Parameters

ActorID

string

required

The unique identifier of the actor whose details are to be retrieved.

Response

200 - application/json

Actor details retrieved successfully.

ParentActorID

integer<int64> | null

The unique identifier of the parent actor, if applicable.

ActorID

integer<int64> | null

The unique identifier for this actor.

ActorDescription

string | null

A brief description of the actor.

ActorCode

integer<int64> | null

A unique code assigned to the actor.

ActorAddress

string | null

The address associated with the actor.

ActorContact

string | null

The contact details for the actor.

ActorTypeID

integer<int32> | null

The identifier for the type of actor, defining the actor's role or category.

ActorStatus

integer<int32> | null

The current status of the actor, represented by a status code.

ActorHierarchyLevel

integer<int32> | null

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

CurrencyID

integer<int32> | null

The identifier for the currency used by the actor.

LastUpdated

string<date-time> | null

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

RouteManagerName

string | null

The name of the route manager associated with the actor.

RouteManagerMobile

string | null

The mobile number of the route manager associated with the actor.

TimeZoneKey

integer<int32> | null

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

DayLightSavingsBit

boolean | null

Indicates whether daylight saving time is observed by the actor.

CountryID

integer<int32> | null

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

DailyCCTransLimitPerCard

integer<int32> | null

The daily credit card transaction limit per card for the actor.

DailyPPTransLimitPerCard

integer<int32> | null

The daily prepaid card transaction limit per card for the actor.

DailyExternalPPTransLimitPerCard

integer<int32> | null

The daily external prepaid card transaction limit per card for the actor.

DailyCCTransLimitPerCardPerOperator

integer<int32> | null

The daily credit card transaction limit per card per operator for the actor.

OperatorActorID

integer<int64> | null

The identifier for the operator managing this actor.

DistributorActorID

integer<int64> | null

The identifier for the distributor associated with the actor.

AreaActorID

integer<int64> | null

The identifier for the area actor that encompasses this actor.

RouteActorID

integer<int64> | null

The identifier for the route actor associated with this actor.

ActorHierarchy

string | null

The hierarchical structure to which the actor belongs.

ActorHasChildrenBit

boolean | null

Indicates whether the actor has child entities.

ActorHasMachinesBit

boolean | null

Indicates whether the actor is associated with any machines.

ActorImageURL

string | null

The URL to an image representing the actor.

ActorContractInfo

string | null

Contractual information related to the actor.

ActorSQSID

integer<int64> | null

The identifier for the actor's SQS (Simple Queue Service) system, if applicable.

UseProductGroupVATBit

boolean | null

Indicates whether VAT is applied based on the product group for this actor.

EreceiptTransactionEndEnableBit

boolean | null

Indicates whether e-receipts are enabled for transactions ending with this actor.

MaximumRevalueAmountLimit

number<double> | null

The maximum amount limit for revaluing transactions for this actor.

ActorCreatedBy

integer<int64> | null

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

ActorCreationDate

string<date-time> | null

The date and time when this actor was created.

UpdateBy

integer<int64> | null

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.

RevaluePayoutByDistributor

boolean | null

Indicates whether the revalue payout is handled by the distributor.

FiscalizationBit

boolean | null

Indicates whether fiscalization is enabled for this 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

ActorMerchantBit

string | null

Indicates whether the actor is associated with a merchant.

ActorMerchantNameForDescriptor

string | null

The merchant name used for transaction descriptors related to this actor.

OverrideGeoInherritcanceBit

boolean | null

Indicates whether the actor overrides inherited geographic settings.

AirportID

integer<int32> | null

The identifier for the airport associated with the actor, if applicable.

VerticalCustomJSON

string | null

Custom JSON data specific to the vertical market or industry the actor operates in.

FiscalizationActorID

integer<int64> | null

The identifier for the actor responsible for fiscalization.

SupportIncrementalAuth

boolean | null

Indicates whether incremental authorization is supported by this actor.

MaximumDefaultCredit

number<double> | null

The maximum default credit limit allowed for this actor.

Refs

object

A key-value pair object containing additional references associated with the actor.

Show child attributes

Languages Update Operator/Sub-Operator

⌘I

Guides

API Reference

Get Actor Details by ActorID

Authorizations

Path Parameters

Response