--- title: "Create a New Actor" method: POST path: "/v2/actors/{ParentActorID}" tags: ["Actors"] --- # Create a New Actor `POST /v2/actors/{ParentActorID}` ## Request - Base URL: `https://example.com:443` - URL: `https://example.com:443/v2/actors/{ParentActorID}` - Auth: none required - TypeScript: (a function with typed inputs; its response is checked against the schema) 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. ## Path parameters - `ParentActorID` integer, required ## Request body - ActorCreateRequest: Request schema for creating a new actor, including details and billing gateways. - `ActorDetails` ActorDetailsRequest: Detailed information about the actor, including geographic and contact details. - `ActorDescription` string, nullable: A brief description of the actor. - `ActorCode` integer: A unique code representing the actor. - `ActorContact` string, nullable: Contact information for the actor, such as a phone number or email. - `ActorTypeID` integer: The identifier representing the type of actor, defining their role or category. - `StatusID` integer: The status identifier of the actor. - `CurrencyID` integer: The identifier for the currency used by the actor. - `TimeZoneKey` integer: The key representing the actor's time zone. - `CountryID` integer: The identifier for the country in which the actor is located. - `CultureID` integer: The identifier for the culture or locale associated with the actor. - `GeoOverrideInheritanceBit` boolean: Indicates whether geographic inheritance settings are overridden for this actor. - `GeoSearchAddress` string, nullable: A full address string used for geographic search purposes. - `GeoCountryID` integer, nullable: The identifier for the country based on the actor's geographic location. - `GeoStateName` string, nullable: The state or region name based on the actor's geographic location. - `GeoCityName` string, nullable: The city name based on the actor's geographic location. - `GeoStreetName` string, nullable: The street name based on the actor's geographic location. - `GeoStreetNumber` string, nullable: The street number based on the actor's geographic location. - `GeoLogitude` number, double, nullable: The geographic longitude of the actor's location. - `GeoLatitude` number, double, nullable: The geographic latitude of the actor's location. - `GeoZoom` integer: The zoom level for map-based services relevant to the actor's geographic location. - `GeoZipCode` string, nullable: The zip code based on the actor's geographic location. - `LanguageID` unknown - `MCCCode` string, nullable: The merchant category code (MCC) associated with the actor, if applicable. - `ActorBillingGateways` ActorBillingGatewaysRequest[], nullable: A list of billing gateways associated with the actor. - `BillingProviderID` integer: The identifier for the billing provider. - `TerminalID` integer: The terminal identifier used for transactions. - `ShvaZField` string, nullable: An optional field for SHVA (Shva Payment Service Provider) Z information. - `TransactionKey` string, nullable: A key used for securing transactions. - `ZFieldAllowedBit` boolean: Indicates whether the Z field is allowed for transactions. - `MerchantID` string, nullable: The merchant identifier associated with the actor. - `SubMerchantID` string, nullable: The sub-merchant identifier, if applicable. - `Username` string, nullable: The username used for authentication with the billing provider. - `Password` string, nullable: The password used for authentication with the billing provider. - `WithZipCodeBit` boolean: Indicates whether the zip code is required for transactions. - `SupportForcedTransactionsBit` boolean: Indicates whether forced transactions are supported. - `ForcedTransactionTerminalID` integer, nullable: The terminal identifier used for forced transactions. - `AVSOnlyBit` boolean: Indicates whether only AVS (Address Verification System) transactions are supported. - `PartialConfirmationBit` boolean: Indicates whether partial confirmations are supported for transactions. - `DisableDebitCards` boolean: Indicates whether debit cards are disabled for this billing gateway. - `DebitCardPrefix` string, nullable: A prefix used for identifying debit cards, if applicable. - `DisableMagStripeBit` boolean: Indicates whether magnetic stripe cards are disabled. - `FiscalBit` boolean: Indicates whether fiscal requirements are enforced for this billing gateway. - `OverrideURL` string, nullable: A custom URL to override the default billing gateway URL. - `RemoteStartID` integer: The identifier used for remote start transactions. - `EnableMultiBillingProvidersBit` boolean: Indicates whether multiple billing providers are enabled for this actor. - `RuleSetID` integer: The identifier for the set of rules governing transactions for this billing gateway. - `CustomData` object, nullable: Custom data specific to the billing gateway. - `ActorBillingPlanID` integer: The identifier for the billing plan assigned to the actor. ## Response `200` Actor created successfully. - ActorCreateResponse: Response schema returned after successfully creating a new actor, containing the actor's details. - `ParentActorID` integer, nullable: The unique identifier of the parent actor, if applicable. - `ActorID` integer: The unique identifier of the newly created actor. - `ActorDescription` string, nullable: A brief description of the actor. - `ActorCode` integer, nullable: A code assigned to the actor, often used for identification or categorization. - `ActorContact` string, nullable: Contact information for the actor, such as a phone number or email. - `ActorTypeID` integer: The identifier representing the type of actor, defining their role or category. - `ActorStatus` integer: The status identifier of the actor, indicating their current status. - `ActorHierarchyLevel` integer: The level of hierarchy where the actor is positioned within the organizational structure. - `CurrencyID` integer: 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, nullable: The key representing the time zone in which the actor operates. - `CountryID` integer, nullable: The identifier for the country in which the actor is located. - `OperatorActorID` integer, nullable: The identifier for the operator managing this actor, if applicable. - `DistributorActorID` integer: The identifier for the distributor associated with the actor. - `ActorHierarchy` string, nullable: The hierarchical structure to which the actor belongs. - `ActorCreatedBy` integer: 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: The identifier of the user who last updated this actor's record. - `CultureID` integer, nullable: The identifier for the culture or locale associated with the actor. - `GeoCountryID` integer, nullable: The identifier for the country based on the actor's geographic information. - `GeoState` string, nullable: The state or region based on the actor's geographic information. - `GeoCity` string, nullable: The city based on the actor's geographic information. - `GeoAddress` string, nullable: The address based on the actor's geographic information. - `GeoStreetNumber` string, nullable: The street number based on the actor's geographic information. - `GeoLongitude` number, double, nullable: The geographic longitude of the actor's location. - `GeoLatitude` number, double, nullable: The geographic latitude of the actor's location. - `GeoZipCode` string, nullable: The zip code based on the actor's geographic information. - `GeoZoom` integer, nullable: The zoom level for map-based services relevant to the actor's geographic location. - `ActorLanguageID` unknown - `OverrideGeoInherritcanceBit` boolean: Indicates whether the actor overrides inherited geographic settings. --- [API](https://skmtc.dev/nayax/apis/nayax-cortina-api.md) - [All operations](https://skmtc.dev/nayax/apis/nayax-cortina-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nayax/apis/nayax-cortina-api/revisions/421f6f83c257?raw)