v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB
Actors

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.

get/v1/actors

Query parameters

ActorCodeinteger required

The unique code assigned to the actor. This code is used to identify and retrieve the actor's details.

Response

Actor details retrieved successfully.

ParentActorIDinteger nullable

The unique identifier of the parent actor, if applicable.

ActorIDinteger nullable

The unique identifier for this actor.

ActorDescriptionstring nullable

A brief description of the actor.

ActorCodeinteger nullable

A unique code assigned to the actor.

ActorAddressstring nullable

The address associated with the actor.

ActorContactstring nullable

The contact details for the actor.

ActorTypeIDinteger nullable

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

ActorStatusinteger nullable

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

ActorHierarchyLevelinteger nullable

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

CurrencyIDinteger nullable

The identifier for the currency used by the actor.

LastUpdatedstring date-time nullable

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

RouteManagerNamestring nullable

The name of the route manager associated with the actor.

RouteManagerMobilestring nullable

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

TimeZoneKeyinteger nullable

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

DayLightSavingsBitboolean nullable

Indicates whether daylight saving time is observed by the actor.

CountryIDinteger nullable

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

DailyCCTransLimitPerCardinteger nullable

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

DailyPPTransLimitPerCardinteger nullable

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

DailyExternalPPTransLimitPerCardinteger nullable

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

DailyCCTransLimitPerCardPerOperatorinteger nullable

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

OperatorActorIDinteger nullable

The identifier for the operator managing this actor.

DistributorActorIDinteger nullable

The identifier for the distributor associated with the actor.

AreaActorIDinteger nullable

The identifier for the area actor that encompasses this actor.

RouteActorIDinteger nullable

The identifier for the route actor associated with this actor.

ActorHierarchystring nullable

The hierarchical structure to which the actor belongs.

ActorHasChildrenBitboolean nullable

Indicates whether the actor has child entities.

ActorHasMachinesBitboolean nullable

Indicates whether the actor is associated with any machines.

ActorImageURLstring nullable

The URL to an image representing the actor.

ActorContractInfostring nullable

Contractual information related to the actor.

ActorSQSIDinteger nullable

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

UseProductGroupVATBitboolean nullable

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

EreceiptTransactionEndEnableBitboolean nullable

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

MaximumRevalueAmountLimitnumber double nullable

The maximum amount limit for revaluing transactions for this actor.

ActorCreatedByinteger nullable

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

ActorCreationDatestring date-time nullable

The date and time when this actor was created.

UpdateByinteger nullable

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

CultureIDinteger nullable

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

RevaluePayoutByDistributorboolean nullable

Indicates whether the revalue payout is handled by the distributor.

FiscalizationBitboolean nullable

Indicates whether fiscalization is enabled for this actor.

GeoCountryIDinteger nullable

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

GeoStatestring nullable

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

GeoCitystring nullable

The city based on the actor's geographic information.

GeoAddressstring nullable

The address based on the actor's geographic information.

GeoStreetNumberstring nullable

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

GeoLongitudenumber double nullable

The geographic longitude of the actor's location.

GeoLatitudenumber double nullable

The geographic latitude of the actor's location.

GeoZipCodestring nullable

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

GeoZoominteger nullable

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

{"stackTrail":"components:schemas:LanguageIdEnum","oasType":"schema","type":"unknown","extensionFields":{"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"}}}
ActorMerchantBitstring nullable

Indicates whether the actor is associated with a merchant.

ActorMerchantNameForDescriptorstring nullable

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

OverrideGeoInherritcanceBitboolean nullable

Indicates whether the actor overrides inherited geographic settings.

AirportIDinteger nullable

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

VerticalCustomJSONstring nullable

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

FiscalizationActorIDinteger nullable

The identifier for the actor responsible for fiscalization.

SupportIncrementalAuthboolean nullable

Indicates whether incremental authorization is supported by this actor.

MaximumDefaultCreditnumber double nullable

The maximum default credit limit allowed for this actor.

Refsobject nullable

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