--- title: "Onboard Actor" method: POST path: "/OnboardActor" tags: ["Cortina Onboarding"] --- # Onboard Actor `POST /OnboardActor` ## Request body - OnboardActorRequest - `ActorInfo` OnboardActorInfo — Actor info for onboarding - `ApiKey` string — - Optional - Length: 40 - `AppId` string — - Optional - Length: 250 - `CertPass` string — - Optional - Length: 250 - `CertPath` string — - Optional - Length: 250 - `ContactName` string — - Optional - Length: 200 - `Country` OnboardCountryInfo — Actor and Machine Country information - `Alpha2Code` string — String(2) Mandatory ISO-3166-1 format: Alpha-2 code - `Alpha3Code` string — String(3) Mandatory ISO-3166-1 format: Alpha-3 code - `Name` string — String Mandatory Country Full Name - `NumericCode` string — String(3) Mandatory ISO-3166-1 format: Numeric-3 code - `DynamicURL` string — - Optional, support different url's. - Length: 255 - Actor level url configuration - `GeoLocation` OnboardGeoLocation — Actor and Machine Geo location information - `Address` string — String(255) Optional Address as defined in the Nayax backoffice - `City` string — - String(255) - Optional - City as defined in the Nayax backoffice - `CountryCode` string — String Optional Country code (ISO3) as defined in the Nayax backoffice - `Latitude` number, double — - Machine Location Latitude as defined in the Nayax backoffice - `Longitude` number, double — - Machine Location Longitude as defined in the Nayax backoffice - `State` string — - String - Optional - Actor geo state code as defined in the Nayax backoffice - `ZipCode` string — String(255) Optional Zip code defined in the Nayax backoffice - `Id` integer — - Optional - Length: 255 - Actor ID as saved as defined in the Nayax backoffice - `Key` string — - Optional - Length: 250 - `MCC` integer — - Optional - classify merchants and businesses by the type of goods or services provided. Payment brands, issuers and acquirers. - `MerchantContactMobile` integer — - Optional - `MerchantContactPhone` integer — - Optional - `MerchantEmail` string — - Optional - Length: 400 - `MerchantId` string — - Optional, Contact Nayax TPOC to define. - Length: 255 - Merchant identifier as defined in the Nayax backoffice - `MerchantMobileCountryCode` integer — - Optional - `MerchantPhoneCountryCode` integer — - Optional - `Name` string — - Optional - Length: 255 - Direct Merchant name as defined in the Nayax backoffice - `OnboardingStatus` 0 | 1 | 2 | 3 | 4 | 5 — * 0 - None * 1 - Pending * 2 - Success * 3 - Failed * 4 - Expired * 5 - Skip - `OperatorId` integer — - Optional - Length: 255 - Merchant Operator ID as defined in the Nayax backoffice - `OperatorName` string — - Optional - Length: 255 - Merchant Operator name as defined in the Nayax backoffice - `Password` string — - Optional - Length: 50 - `SubMerchantId` string — - Optional - Length: 50 - `SubMerchantNumber` integer — - Optional - `TerminalId` string — - Optional - Length: 255 - `URL` string — - Optional - Length: 250 - `UserName` string — - Optional - Length: 40 - `CustomData` OnboardCustomData — Custom Fields Information, Contact Nayax TPOC to define. - `Actor` string — Actor custom data (String in json format) - `DirectActor` string — Direct actor custom data (String in json format) - `Distributor` string — Distributor custom data (String in json format) - `Machine` string — Machine custom data (String in json format) - `Operator` string — Operator custom data (String in json format) - `DistributorInfo` OnboardDistributorInfo — Distributor info for onboarding - `ApiKey` string — - Optional - Length: 40 - `AppId` string — - Optional - Length: 250 - `CertPass` string — - Optional - Length: 250 - `CertPath` string — - Optional - Length: 250 - `Country` OnboardCountryInfo — Actor and Machine Country information - `Alpha2Code` string — String(2) Mandatory ISO-3166-1 format: Alpha-2 code - `Alpha3Code` string — String(3) Mandatory ISO-3166-1 format: Alpha-3 code - `Name` string — String Mandatory Country Full Name - `NumericCode` string — String(3) Mandatory ISO-3166-1 format: Numeric-3 code - `DynamicURL` string — - Optional, support different url's. - Length: 255 - Actor level url configuration - `GeoLocation` OnboardGeoLocation — Actor and Machine Geo location information - `Address` string — String(255) Optional Address as defined in the Nayax backoffice - `City` string — - String(255) - Optional - City as defined in the Nayax backoffice - `CountryCode` string — String Optional Country code (ISO3) as defined in the Nayax backoffice - `Latitude` number, double — - Machine Location Latitude as defined in the Nayax backoffice - `Longitude` number, double — - Machine Location Longitude as defined in the Nayax backoffice - `State` string — - String - Optional - Actor geo state code as defined in the Nayax backoffice - `ZipCode` string — String(255) Optional Zip code defined in the Nayax backoffice - `Id` integer — - Optional - Length: 255 - Actor ID as saved as defined in the Nayax backoffice - `Key` string — - Optional - Length: 250 - `MCC` integer — - Optional - classify merchants and businesses by the type of goods or services provided. Payment brands, issuers and acquirers. - `MerchantId` string — - Optional, Contact Nayax TPOC to define. - Length: 255 - Merchant identifier as defined in the Nayax backoffice - `Name` string — - Optional - Length: 255 - Direct Merchant name as defined in the Nayax backoffice - `OnboardingStatus` 0 | 1 | 2 | 3 | 4 | 5 — * 0 - None * 1 - Pending * 2 - Success * 3 - Failed * 4 - Expired * 5 - Skip - `OperatorId` integer — - Optional - Length: 255 - Merchant Operator ID as defined in the Nayax backoffice - `OperatorName` string — - Optional - Length: 255 - Merchant Operator name as defined in the Nayax backoffice - `Password` string — - Optional - Length: 50 - `SubMerchantId` string — - Optional - Length: 50 - `SubMerchantNumber` integer — - Optional - `TerminalId` string — - Optional - Length: 255 - `URL` string — - Optional - Length: 250 - `UserName` string — - Optional - Length: 40 - `OnboardingBasicInfo` OnboardingBasicInfo — Describing the onboarding Operation details - `BillingProviderID` integer — - Mandatory - `OnboardingOperation` 1 | 2 | 3 | 4 — Indicates the possible onboarding operation: 1 - Register 2 - Unregister 3 - Update 4 - GetStatus - enum - Mandatory - Indicates the possible onboarding operation. - `OnboardingRequestId` integer — - Mandatory - GUID Generated by Nayax - `OnboardingTransactionId` integer — - TransactionId from provider - `PaymentMethodID` integer — - Mandatory - `RequestTime` string — - Mandatory - The date time string of when the Onboarding took place - Format: ddMMyyHHmmss - `SiteId` integer — Mandatory - `TimeoutMS` integer - `TransactionID` integer — - Mandatory - Generated by the integrator on startSession - `OperatorInfo` OnboardOperatorInfo — Operator info for onboarding - `ApiKey` string — - Optional - Length: 40 - `AppId` string — - Optional - Length: 250 - `CertPass` string — - Optional - Length: 250 - `CertPath` string — - Optional - Length: 250 - `Country` OnboardCountryInfo — Actor and Machine Country information - `Alpha2Code` string — String(2) Mandatory ISO-3166-1 format: Alpha-2 code - `Alpha3Code` string — String(3) Mandatory ISO-3166-1 format: Alpha-3 code - `Name` string — String Mandatory Country Full Name - `NumericCode` string — String(3) Mandatory ISO-3166-1 format: Numeric-3 code - `DynamicURL` string — - Optional, support different url's. - Length: 255 - Actor level url configuration - `GeoLocation` OnboardGeoLocation — Actor and Machine Geo location information - `Address` string — String(255) Optional Address as defined in the Nayax backoffice - `City` string — - String(255) - Optional - City as defined in the Nayax backoffice - `CountryCode` string — String Optional Country code (ISO3) as defined in the Nayax backoffice - `Latitude` number, double — - Machine Location Latitude as defined in the Nayax backoffice - `Longitude` number, double — - Machine Location Longitude as defined in the Nayax backoffice - `State` string — - String - Optional - Actor geo state code as defined in the Nayax backoffice - `ZipCode` string — String(255) Optional Zip code defined in the Nayax backoffice - `Id` integer — - Optional - Length: 255 - Actor ID as saved as defined in the Nayax backoffice - `Key` string — - Optional - Length: 250 - `MCC` integer — - Optional - classify merchants and businesses by the type of goods or services provided. Payment brands, issuers and acquirers. - `MerchantId` string — - Optional, Contact Nayax TPOC to define. - Length: 255 - Merchant identifier as defined in the Nayax backoffice - `Name` string — - Optional - Length: 255 - Direct Merchant name as defined in the Nayax backoffice - `OnboardingStatus` 0 | 1 | 2 | 3 | 4 | 5 — * 0 - None * 1 - Pending * 2 - Success * 3 - Failed * 4 - Expired * 5 - Skip - `OperatorId` integer — - Optional - Length: 255 - Merchant Operator ID as defined in the Nayax backoffice - `OperatorName` string — - Optional - Length: 255 - Merchant Operator name as defined in the Nayax backoffice - `Password` string — - Optional - Length: 50 - `SubMerchantId` string — - Optional - Length: 50 - `SubMerchantNumber` integer — - Optional - `TerminalId` string — - Optional - Length: 255 - `URL` string — - Optional - Length: 250 - `UserName` string — - Optional - Length: 40 - `UpdateInfo` string[] ## Response `200` Success - OnboardActorResponse - `ActorOnboardingData` ActorOnboardingData — Echo and/or Updated onboarding actor data (Merchant data) - `ApiKey` string — - Optional - Length: 40 - `AppId` string — - Optional - Length: 250 - `CertPass` string — - Optional - Length: 250 - `CertPath` string — - Optional - Length: 250 - `CustomData` OnboardCustomData — Custom Fields Information, Contact Nayax TPOC to define. - `Actor` string — Actor custom data (String in json format) - `DirectActor` string — Direct actor custom data (String in json format) - `Distributor` string — Distributor custom data (String in json format) - `Machine` string — Machine custom data (String in json format) - `Operator` string — Operator custom data (String in json format) - `Key` string — - Optional - Length: 250 - `MerchantId` string — - Optional - Length: 40 - `OnboardingTransactionId` integer — - Optional - `Password` string — - Optional - Length: 50 - `SubMerchantId` string — - Optional - Length: 50 - `SubMerchantNumber` integer — - Optional - `TerminalId` string — - Optional - Length: 255 - `URL` string — - Optional - Length: 250 - `UserName` string — - Optional - Length: 40 - `OnboardStatus` OnboardStatus — Transaction status - `Code` 0 | 1 | 2 | 3 | 4 | 5 — Indicates the onboarding status: 0 - Null-none 1 - Pending 2 - Success 3 - Failed 4 - Expired 5 - Skip - enum - Mandatory - Indicates the onboarding status. - `StatusMessage` string — - Optional - Length: 255 - Onboarding status message free text field / additional varying data - `Verdict` string — - Mandatory - Const string values: - Status of the request ('Approved'/'Declined') --- [API](https://skmtc.net/nayax/apis/nayax-cortina-api.md) · [All operations](https://skmtc.net/nayax/apis/nayax-cortina-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nayax/nayax-cortina-api/versions/421f6f83c257/schema)