Create a New Actor
curl --request POST \
--url https://qa-lynx.nayax.com/operational/v2/actors/{ParentActorID} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ActorDetails": {
"ActorDescription": "<string>",
"ActorCode": 123,
"ActorContact": "<string>",
"ActorTypeID": 123,
"StatusID": 123,
"CurrencyID": 123,
"TimeZoneKey": 123,
"CountryID": 123,
"CultureID": 123,
"GeoOverrideInheritanceBit": true,
"GeoSearchAddress": "<string>",
"GeoCountryID": 123,
"GeoStateName": "<string>",
"GeoCityName": "<string>",
"GeoStreetName": "<string>",
"GeoStreetNumber": "<string>",
"GeoLogitude": 123,
"GeoLatitude": 123,
"GeoZoom": 123,
"GeoZipCode": "<string>",
"MCCCode": "<string>"
},
"ActorBillingGateways": [
{
"BillingProviderID": 123,
"TerminalID": 123,
"ShvaZField": "<string>",
"TransactionKey": "<string>",
"ZFieldAllowedBit": true,
"MerchantID": "<string>",
"SubMerchantID": "<string>",
"Username": "<string>",
"Password": "<string>",
"WithZipCodeBit": true,
"SupportForcedTransactionsBit": true,
"ForcedTransactionTerminalID": 123,
"AVSOnlyBit": true,
"PartialConfirmationBit": true,
"DisableDebitCards": true,
"DebitCardPrefix": "<string>",
"DisableMagStripeBit": true,
"FiscalBit": true,
"OverrideURL": "<string>",
"RemoteStartID": 123,
"EnableMultiBillingProvidersBit": true,
"RuleSetID": 123,
"CustomData": {}
}
],
"ActorBillingPlanID": 123
}
'import requests
url = "https://qa-lynx.nayax.com/operational/v2/actors/{ParentActorID}"
payload = {
"ActorDetails": {
"ActorDescription": "<string>",
"ActorCode": 123,
"ActorContact": "<string>",
"ActorTypeID": 123,
"StatusID": 123,
"CurrencyID": 123,
"TimeZoneKey": 123,
"CountryID": 123,
"CultureID": 123,
"GeoOverrideInheritanceBit": True,
"GeoSearchAddress": "<string>",
"GeoCountryID": 123,
"GeoStateName": "<string>",
"GeoCityName": "<string>",
"GeoStreetName": "<string>",
"GeoStreetNumber": "<string>",
"GeoLogitude": 123,
"GeoLatitude": 123,
"GeoZoom": 123,
"GeoZipCode": "<string>",
"MCCCode": "<string>"
},
"ActorBillingGateways": [
{
"BillingProviderID": 123,
"TerminalID": 123,
"ShvaZField": "<string>",
"TransactionKey": "<string>",
"ZFieldAllowedBit": True,
"MerchantID": "<string>",
"SubMerchantID": "<string>",
"Username": "<string>",
"Password": "<string>",
"WithZipCodeBit": True,
"SupportForcedTransactionsBit": True,
"ForcedTransactionTerminalID": 123,
"AVSOnlyBit": True,
"PartialConfirmationBit": True,
"DisableDebitCards": True,
"DebitCardPrefix": "<string>",
"DisableMagStripeBit": True,
"FiscalBit": True,
"OverrideURL": "<string>",
"RemoteStartID": 123,
"EnableMultiBillingProvidersBit": True,
"RuleSetID": 123,
"CustomData": {}
}
],
"ActorBillingPlanID": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
ActorDetails: {
ActorDescription: '<string>',
ActorCode: 123,
ActorContact: '<string>',
ActorTypeID: 123,
StatusID: 123,
CurrencyID: 123,
TimeZoneKey: 123,
CountryID: 123,
CultureID: 123,
GeoOverrideInheritanceBit: true,
GeoSearchAddress: '<string>',
GeoCountryID: 123,
GeoStateName: '<string>',
GeoCityName: '<string>',
GeoStreetName: '<string>',
GeoStreetNumber: '<string>',
GeoLogitude: 123,
GeoLatitude: 123,
GeoZoom: 123,
GeoZipCode: '<string>',
MCCCode: '<string>'
},
ActorBillingGateways: [
{
BillingProviderID: 123,
TerminalID: 123,
ShvaZField: '<string>',
TransactionKey: '<string>',
ZFieldAllowedBit: true,
MerchantID: '<string>',
SubMerchantID: '<string>',
Username: '<string>',
Password: '<string>',
WithZipCodeBit: true,
SupportForcedTransactionsBit: true,
ForcedTransactionTerminalID: 123,
AVSOnlyBit: true,
PartialConfirmationBit: true,
DisableDebitCards: true,
DebitCardPrefix: '<string>',
DisableMagStripeBit: true,
FiscalBit: true,
OverrideURL: '<string>',
RemoteStartID: 123,
EnableMultiBillingProvidersBit: true,
RuleSetID: 123,
CustomData: {}
}
],
ActorBillingPlanID: 123
})
};
fetch('https://qa-lynx.nayax.com/operational/v2/actors/{ParentActorID}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://qa-lynx.nayax.com/operational/v2/actors/{ParentActorID}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ActorDetails' => [
'ActorDescription' => '<string>',
'ActorCode' => 123,
'ActorContact' => '<string>',
'ActorTypeID' => 123,
'StatusID' => 123,
'CurrencyID' => 123,
'TimeZoneKey' => 123,
'CountryID' => 123,
'CultureID' => 123,
'GeoOverrideInheritanceBit' => true,
'GeoSearchAddress' => '<string>',
'GeoCountryID' => 123,
'GeoStateName' => '<string>',
'GeoCityName' => '<string>',
'GeoStreetName' => '<string>',
'GeoStreetNumber' => '<string>',
'GeoLogitude' => 123,
'GeoLatitude' => 123,
'GeoZoom' => 123,
'GeoZipCode' => '<string>',
'MCCCode' => '<string>'
],
'ActorBillingGateways' => [
[
'BillingProviderID' => 123,
'TerminalID' => 123,
'ShvaZField' => '<string>',
'TransactionKey' => '<string>',
'ZFieldAllowedBit' => true,
'MerchantID' => '<string>',
'SubMerchantID' => '<string>',
'Username' => '<string>',
'Password' => '<string>',
'WithZipCodeBit' => true,
'SupportForcedTransactionsBit' => true,
'ForcedTransactionTerminalID' => 123,
'AVSOnlyBit' => true,
'PartialConfirmationBit' => true,
'DisableDebitCards' => true,
'DebitCardPrefix' => '<string>',
'DisableMagStripeBit' => true,
'FiscalBit' => true,
'OverrideURL' => '<string>',
'RemoteStartID' => 123,
'EnableMultiBillingProvidersBit' => true,
'RuleSetID' => 123,
'CustomData' => [
]
]
],
'ActorBillingPlanID' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://qa-lynx.nayax.com/operational/v2/actors/{ParentActorID}"
payload := strings.NewReader("{\n \"ActorDetails\": {\n \"ActorDescription\": \"<string>\",\n \"ActorCode\": 123,\n \"ActorContact\": \"<string>\",\n \"ActorTypeID\": 123,\n \"StatusID\": 123,\n \"CurrencyID\": 123,\n \"TimeZoneKey\": 123,\n \"CountryID\": 123,\n \"CultureID\": 123,\n \"GeoOverrideInheritanceBit\": true,\n \"GeoSearchAddress\": \"<string>\",\n \"GeoCountryID\": 123,\n \"GeoStateName\": \"<string>\",\n \"GeoCityName\": \"<string>\",\n \"GeoStreetName\": \"<string>\",\n \"GeoStreetNumber\": \"<string>\",\n \"GeoLogitude\": 123,\n \"GeoLatitude\": 123,\n \"GeoZoom\": 123,\n \"GeoZipCode\": \"<string>\",\n \"MCCCode\": \"<string>\"\n },\n \"ActorBillingGateways\": [\n {\n \"BillingProviderID\": 123,\n \"TerminalID\": 123,\n \"ShvaZField\": \"<string>\",\n \"TransactionKey\": \"<string>\",\n \"ZFieldAllowedBit\": true,\n \"MerchantID\": \"<string>\",\n \"SubMerchantID\": \"<string>\",\n \"Username\": \"<string>\",\n \"Password\": \"<string>\",\n \"WithZipCodeBit\": true,\n \"SupportForcedTransactionsBit\": true,\n \"ForcedTransactionTerminalID\": 123,\n \"AVSOnlyBit\": true,\n \"PartialConfirmationBit\": true,\n \"DisableDebitCards\": true,\n \"DebitCardPrefix\": \"<string>\",\n \"DisableMagStripeBit\": true,\n \"FiscalBit\": true,\n \"OverrideURL\": \"<string>\",\n \"RemoteStartID\": 123,\n \"EnableMultiBillingProvidersBit\": true,\n \"RuleSetID\": 123,\n \"CustomData\": {}\n }\n ],\n \"ActorBillingPlanID\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://qa-lynx.nayax.com/operational/v2/actors/{ParentActorID}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ActorDetails\": {\n \"ActorDescription\": \"<string>\",\n \"ActorCode\": 123,\n \"ActorContact\": \"<string>\",\n \"ActorTypeID\": 123,\n \"StatusID\": 123,\n \"CurrencyID\": 123,\n \"TimeZoneKey\": 123,\n \"CountryID\": 123,\n \"CultureID\": 123,\n \"GeoOverrideInheritanceBit\": true,\n \"GeoSearchAddress\": \"<string>\",\n \"GeoCountryID\": 123,\n \"GeoStateName\": \"<string>\",\n \"GeoCityName\": \"<string>\",\n \"GeoStreetName\": \"<string>\",\n \"GeoStreetNumber\": \"<string>\",\n \"GeoLogitude\": 123,\n \"GeoLatitude\": 123,\n \"GeoZoom\": 123,\n \"GeoZipCode\": \"<string>\",\n \"MCCCode\": \"<string>\"\n },\n \"ActorBillingGateways\": [\n {\n \"BillingProviderID\": 123,\n \"TerminalID\": 123,\n \"ShvaZField\": \"<string>\",\n \"TransactionKey\": \"<string>\",\n \"ZFieldAllowedBit\": true,\n \"MerchantID\": \"<string>\",\n \"SubMerchantID\": \"<string>\",\n \"Username\": \"<string>\",\n \"Password\": \"<string>\",\n \"WithZipCodeBit\": true,\n \"SupportForcedTransactionsBit\": true,\n \"ForcedTransactionTerminalID\": 123,\n \"AVSOnlyBit\": true,\n \"PartialConfirmationBit\": true,\n \"DisableDebitCards\": true,\n \"DebitCardPrefix\": \"<string>\",\n \"DisableMagStripeBit\": true,\n \"FiscalBit\": true,\n \"OverrideURL\": \"<string>\",\n \"RemoteStartID\": 123,\n \"EnableMultiBillingProvidersBit\": true,\n \"RuleSetID\": 123,\n \"CustomData\": {}\n }\n ],\n \"ActorBillingPlanID\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://qa-lynx.nayax.com/operational/v2/actors/{ParentActorID}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ActorDetails\": {\n \"ActorDescription\": \"<string>\",\n \"ActorCode\": 123,\n \"ActorContact\": \"<string>\",\n \"ActorTypeID\": 123,\n \"StatusID\": 123,\n \"CurrencyID\": 123,\n \"TimeZoneKey\": 123,\n \"CountryID\": 123,\n \"CultureID\": 123,\n \"GeoOverrideInheritanceBit\": true,\n \"GeoSearchAddress\": \"<string>\",\n \"GeoCountryID\": 123,\n \"GeoStateName\": \"<string>\",\n \"GeoCityName\": \"<string>\",\n \"GeoStreetName\": \"<string>\",\n \"GeoStreetNumber\": \"<string>\",\n \"GeoLogitude\": 123,\n \"GeoLatitude\": 123,\n \"GeoZoom\": 123,\n \"GeoZipCode\": \"<string>\",\n \"MCCCode\": \"<string>\"\n },\n \"ActorBillingGateways\": [\n {\n \"BillingProviderID\": 123,\n \"TerminalID\": 123,\n \"ShvaZField\": \"<string>\",\n \"TransactionKey\": \"<string>\",\n \"ZFieldAllowedBit\": true,\n \"MerchantID\": \"<string>\",\n \"SubMerchantID\": \"<string>\",\n \"Username\": \"<string>\",\n \"Password\": \"<string>\",\n \"WithZipCodeBit\": true,\n \"SupportForcedTransactionsBit\": true,\n \"ForcedTransactionTerminalID\": 123,\n \"AVSOnlyBit\": true,\n \"PartialConfirmationBit\": true,\n \"DisableDebitCards\": true,\n \"DebitCardPrefix\": \"<string>\",\n \"DisableMagStripeBit\": true,\n \"FiscalBit\": true,\n \"OverrideURL\": \"<string>\",\n \"RemoteStartID\": 123,\n \"EnableMultiBillingProvidersBit\": true,\n \"RuleSetID\": 123,\n \"CustomData\": {}\n }\n ],\n \"ActorBillingPlanID\": 123\n}"
response = http.request(request)
puts response.read_body{
"ParentActorID": 123,
"ActorID": 123,
"ActorDescription": "<string>",
"ActorCode": 123,
"ActorContact": "<string>",
"ActorTypeID": 123,
"ActorStatus": 123,
"ActorHierarchyLevel": 123,
"CurrencyID": 123,
"LastUpdated": "2023-11-07T05:31:56Z",
"TimeZoneKey": 123,
"CountryID": 123,
"OperatorActorID": 123,
"DistributorActorID": 123,
"ActorHierarchy": "<string>",
"ActorCreatedBy": 123,
"ActorCreationDate": "2023-11-07T05:31:56Z",
"UpdateBy": 123,
"CultureID": 123,
"GeoCountryID": 123,
"GeoState": "<string>",
"GeoCity": "<string>",
"GeoAddress": "<string>",
"GeoStreetNumber": "<string>",
"GeoLongitude": 123,
"GeoLatitude": 123,
"GeoZipCode": "<string>",
"GeoZoom": 123,
"OverrideGeoInherritcanceBit": true
}Actors
Create a New Actor
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.
Create a New Actor
curl --request POST \
--url https://qa-lynx.nayax.com/operational/v2/actors/{ParentActorID} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ActorDetails": {
"ActorDescription": "<string>",
"ActorCode": 123,
"ActorContact": "<string>",
"ActorTypeID": 123,
"StatusID": 123,
"CurrencyID": 123,
"TimeZoneKey": 123,
"CountryID": 123,
"CultureID": 123,
"GeoOverrideInheritanceBit": true,
"GeoSearchAddress": "<string>",
"GeoCountryID": 123,
"GeoStateName": "<string>",
"GeoCityName": "<string>",
"GeoStreetName": "<string>",
"GeoStreetNumber": "<string>",
"GeoLogitude": 123,
"GeoLatitude": 123,
"GeoZoom": 123,
"GeoZipCode": "<string>",
"MCCCode": "<string>"
},
"ActorBillingGateways": [
{
"BillingProviderID": 123,
"TerminalID": 123,
"ShvaZField": "<string>",
"TransactionKey": "<string>",
"ZFieldAllowedBit": true,
"MerchantID": "<string>",
"SubMerchantID": "<string>",
"Username": "<string>",
"Password": "<string>",
"WithZipCodeBit": true,
"SupportForcedTransactionsBit": true,
"ForcedTransactionTerminalID": 123,
"AVSOnlyBit": true,
"PartialConfirmationBit": true,
"DisableDebitCards": true,
"DebitCardPrefix": "<string>",
"DisableMagStripeBit": true,
"FiscalBit": true,
"OverrideURL": "<string>",
"RemoteStartID": 123,
"EnableMultiBillingProvidersBit": true,
"RuleSetID": 123,
"CustomData": {}
}
],
"ActorBillingPlanID": 123
}
'import requests
url = "https://qa-lynx.nayax.com/operational/v2/actors/{ParentActorID}"
payload = {
"ActorDetails": {
"ActorDescription": "<string>",
"ActorCode": 123,
"ActorContact": "<string>",
"ActorTypeID": 123,
"StatusID": 123,
"CurrencyID": 123,
"TimeZoneKey": 123,
"CountryID": 123,
"CultureID": 123,
"GeoOverrideInheritanceBit": True,
"GeoSearchAddress": "<string>",
"GeoCountryID": 123,
"GeoStateName": "<string>",
"GeoCityName": "<string>",
"GeoStreetName": "<string>",
"GeoStreetNumber": "<string>",
"GeoLogitude": 123,
"GeoLatitude": 123,
"GeoZoom": 123,
"GeoZipCode": "<string>",
"MCCCode": "<string>"
},
"ActorBillingGateways": [
{
"BillingProviderID": 123,
"TerminalID": 123,
"ShvaZField": "<string>",
"TransactionKey": "<string>",
"ZFieldAllowedBit": True,
"MerchantID": "<string>",
"SubMerchantID": "<string>",
"Username": "<string>",
"Password": "<string>",
"WithZipCodeBit": True,
"SupportForcedTransactionsBit": True,
"ForcedTransactionTerminalID": 123,
"AVSOnlyBit": True,
"PartialConfirmationBit": True,
"DisableDebitCards": True,
"DebitCardPrefix": "<string>",
"DisableMagStripeBit": True,
"FiscalBit": True,
"OverrideURL": "<string>",
"RemoteStartID": 123,
"EnableMultiBillingProvidersBit": True,
"RuleSetID": 123,
"CustomData": {}
}
],
"ActorBillingPlanID": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
ActorDetails: {
ActorDescription: '<string>',
ActorCode: 123,
ActorContact: '<string>',
ActorTypeID: 123,
StatusID: 123,
CurrencyID: 123,
TimeZoneKey: 123,
CountryID: 123,
CultureID: 123,
GeoOverrideInheritanceBit: true,
GeoSearchAddress: '<string>',
GeoCountryID: 123,
GeoStateName: '<string>',
GeoCityName: '<string>',
GeoStreetName: '<string>',
GeoStreetNumber: '<string>',
GeoLogitude: 123,
GeoLatitude: 123,
GeoZoom: 123,
GeoZipCode: '<string>',
MCCCode: '<string>'
},
ActorBillingGateways: [
{
BillingProviderID: 123,
TerminalID: 123,
ShvaZField: '<string>',
TransactionKey: '<string>',
ZFieldAllowedBit: true,
MerchantID: '<string>',
SubMerchantID: '<string>',
Username: '<string>',
Password: '<string>',
WithZipCodeBit: true,
SupportForcedTransactionsBit: true,
ForcedTransactionTerminalID: 123,
AVSOnlyBit: true,
PartialConfirmationBit: true,
DisableDebitCards: true,
DebitCardPrefix: '<string>',
DisableMagStripeBit: true,
FiscalBit: true,
OverrideURL: '<string>',
RemoteStartID: 123,
EnableMultiBillingProvidersBit: true,
RuleSetID: 123,
CustomData: {}
}
],
ActorBillingPlanID: 123
})
};
fetch('https://qa-lynx.nayax.com/operational/v2/actors/{ParentActorID}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://qa-lynx.nayax.com/operational/v2/actors/{ParentActorID}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ActorDetails' => [
'ActorDescription' => '<string>',
'ActorCode' => 123,
'ActorContact' => '<string>',
'ActorTypeID' => 123,
'StatusID' => 123,
'CurrencyID' => 123,
'TimeZoneKey' => 123,
'CountryID' => 123,
'CultureID' => 123,
'GeoOverrideInheritanceBit' => true,
'GeoSearchAddress' => '<string>',
'GeoCountryID' => 123,
'GeoStateName' => '<string>',
'GeoCityName' => '<string>',
'GeoStreetName' => '<string>',
'GeoStreetNumber' => '<string>',
'GeoLogitude' => 123,
'GeoLatitude' => 123,
'GeoZoom' => 123,
'GeoZipCode' => '<string>',
'MCCCode' => '<string>'
],
'ActorBillingGateways' => [
[
'BillingProviderID' => 123,
'TerminalID' => 123,
'ShvaZField' => '<string>',
'TransactionKey' => '<string>',
'ZFieldAllowedBit' => true,
'MerchantID' => '<string>',
'SubMerchantID' => '<string>',
'Username' => '<string>',
'Password' => '<string>',
'WithZipCodeBit' => true,
'SupportForcedTransactionsBit' => true,
'ForcedTransactionTerminalID' => 123,
'AVSOnlyBit' => true,
'PartialConfirmationBit' => true,
'DisableDebitCards' => true,
'DebitCardPrefix' => '<string>',
'DisableMagStripeBit' => true,
'FiscalBit' => true,
'OverrideURL' => '<string>',
'RemoteStartID' => 123,
'EnableMultiBillingProvidersBit' => true,
'RuleSetID' => 123,
'CustomData' => [
]
]
],
'ActorBillingPlanID' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://qa-lynx.nayax.com/operational/v2/actors/{ParentActorID}"
payload := strings.NewReader("{\n \"ActorDetails\": {\n \"ActorDescription\": \"<string>\",\n \"ActorCode\": 123,\n \"ActorContact\": \"<string>\",\n \"ActorTypeID\": 123,\n \"StatusID\": 123,\n \"CurrencyID\": 123,\n \"TimeZoneKey\": 123,\n \"CountryID\": 123,\n \"CultureID\": 123,\n \"GeoOverrideInheritanceBit\": true,\n \"GeoSearchAddress\": \"<string>\",\n \"GeoCountryID\": 123,\n \"GeoStateName\": \"<string>\",\n \"GeoCityName\": \"<string>\",\n \"GeoStreetName\": \"<string>\",\n \"GeoStreetNumber\": \"<string>\",\n \"GeoLogitude\": 123,\n \"GeoLatitude\": 123,\n \"GeoZoom\": 123,\n \"GeoZipCode\": \"<string>\",\n \"MCCCode\": \"<string>\"\n },\n \"ActorBillingGateways\": [\n {\n \"BillingProviderID\": 123,\n \"TerminalID\": 123,\n \"ShvaZField\": \"<string>\",\n \"TransactionKey\": \"<string>\",\n \"ZFieldAllowedBit\": true,\n \"MerchantID\": \"<string>\",\n \"SubMerchantID\": \"<string>\",\n \"Username\": \"<string>\",\n \"Password\": \"<string>\",\n \"WithZipCodeBit\": true,\n \"SupportForcedTransactionsBit\": true,\n \"ForcedTransactionTerminalID\": 123,\n \"AVSOnlyBit\": true,\n \"PartialConfirmationBit\": true,\n \"DisableDebitCards\": true,\n \"DebitCardPrefix\": \"<string>\",\n \"DisableMagStripeBit\": true,\n \"FiscalBit\": true,\n \"OverrideURL\": \"<string>\",\n \"RemoteStartID\": 123,\n \"EnableMultiBillingProvidersBit\": true,\n \"RuleSetID\": 123,\n \"CustomData\": {}\n }\n ],\n \"ActorBillingPlanID\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://qa-lynx.nayax.com/operational/v2/actors/{ParentActorID}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ActorDetails\": {\n \"ActorDescription\": \"<string>\",\n \"ActorCode\": 123,\n \"ActorContact\": \"<string>\",\n \"ActorTypeID\": 123,\n \"StatusID\": 123,\n \"CurrencyID\": 123,\n \"TimeZoneKey\": 123,\n \"CountryID\": 123,\n \"CultureID\": 123,\n \"GeoOverrideInheritanceBit\": true,\n \"GeoSearchAddress\": \"<string>\",\n \"GeoCountryID\": 123,\n \"GeoStateName\": \"<string>\",\n \"GeoCityName\": \"<string>\",\n \"GeoStreetName\": \"<string>\",\n \"GeoStreetNumber\": \"<string>\",\n \"GeoLogitude\": 123,\n \"GeoLatitude\": 123,\n \"GeoZoom\": 123,\n \"GeoZipCode\": \"<string>\",\n \"MCCCode\": \"<string>\"\n },\n \"ActorBillingGateways\": [\n {\n \"BillingProviderID\": 123,\n \"TerminalID\": 123,\n \"ShvaZField\": \"<string>\",\n \"TransactionKey\": \"<string>\",\n \"ZFieldAllowedBit\": true,\n \"MerchantID\": \"<string>\",\n \"SubMerchantID\": \"<string>\",\n \"Username\": \"<string>\",\n \"Password\": \"<string>\",\n \"WithZipCodeBit\": true,\n \"SupportForcedTransactionsBit\": true,\n \"ForcedTransactionTerminalID\": 123,\n \"AVSOnlyBit\": true,\n \"PartialConfirmationBit\": true,\n \"DisableDebitCards\": true,\n \"DebitCardPrefix\": \"<string>\",\n \"DisableMagStripeBit\": true,\n \"FiscalBit\": true,\n \"OverrideURL\": \"<string>\",\n \"RemoteStartID\": 123,\n \"EnableMultiBillingProvidersBit\": true,\n \"RuleSetID\": 123,\n \"CustomData\": {}\n }\n ],\n \"ActorBillingPlanID\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://qa-lynx.nayax.com/operational/v2/actors/{ParentActorID}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ActorDetails\": {\n \"ActorDescription\": \"<string>\",\n \"ActorCode\": 123,\n \"ActorContact\": \"<string>\",\n \"ActorTypeID\": 123,\n \"StatusID\": 123,\n \"CurrencyID\": 123,\n \"TimeZoneKey\": 123,\n \"CountryID\": 123,\n \"CultureID\": 123,\n \"GeoOverrideInheritanceBit\": true,\n \"GeoSearchAddress\": \"<string>\",\n \"GeoCountryID\": 123,\n \"GeoStateName\": \"<string>\",\n \"GeoCityName\": \"<string>\",\n \"GeoStreetName\": \"<string>\",\n \"GeoStreetNumber\": \"<string>\",\n \"GeoLogitude\": 123,\n \"GeoLatitude\": 123,\n \"GeoZoom\": 123,\n \"GeoZipCode\": \"<string>\",\n \"MCCCode\": \"<string>\"\n },\n \"ActorBillingGateways\": [\n {\n \"BillingProviderID\": 123,\n \"TerminalID\": 123,\n \"ShvaZField\": \"<string>\",\n \"TransactionKey\": \"<string>\",\n \"ZFieldAllowedBit\": true,\n \"MerchantID\": \"<string>\",\n \"SubMerchantID\": \"<string>\",\n \"Username\": \"<string>\",\n \"Password\": \"<string>\",\n \"WithZipCodeBit\": true,\n \"SupportForcedTransactionsBit\": true,\n \"ForcedTransactionTerminalID\": 123,\n \"AVSOnlyBit\": true,\n \"PartialConfirmationBit\": true,\n \"DisableDebitCards\": true,\n \"DebitCardPrefix\": \"<string>\",\n \"DisableMagStripeBit\": true,\n \"FiscalBit\": true,\n \"OverrideURL\": \"<string>\",\n \"RemoteStartID\": 123,\n \"EnableMultiBillingProvidersBit\": true,\n \"RuleSetID\": 123,\n \"CustomData\": {}\n }\n ],\n \"ActorBillingPlanID\": 123\n}"
response = http.request(request)
puts response.read_body{
"ParentActorID": 123,
"ActorID": 123,
"ActorDescription": "<string>",
"ActorCode": 123,
"ActorContact": "<string>",
"ActorTypeID": 123,
"ActorStatus": 123,
"ActorHierarchyLevel": 123,
"CurrencyID": 123,
"LastUpdated": "2023-11-07T05:31:56Z",
"TimeZoneKey": 123,
"CountryID": 123,
"OperatorActorID": 123,
"DistributorActorID": 123,
"ActorHierarchy": "<string>",
"ActorCreatedBy": 123,
"ActorCreationDate": "2023-11-07T05:31:56Z",
"UpdateBy": 123,
"CultureID": 123,
"GeoCountryID": 123,
"GeoState": "<string>",
"GeoCity": "<string>",
"GeoAddress": "<string>",
"GeoStreetNumber": "<string>",
"GeoLongitude": 123,
"GeoLatitude": 123,
"GeoZipCode": "<string>",
"GeoZoom": 123,
"OverrideGeoInherritcanceBit": true
}Authorizations
Enter your Bearer token. It's required to authenticate API requests.
Path Parameters
The unique identifier of the parent actor under which the new actor will be created.
Body
application/json
Request schema for creating a new actor, including details and billing gateways.
Response
200 - application/json
Actor created successfully.
Response schema returned after successfully creating a new actor, containing the actor's details.
The unique identifier of the parent actor, if applicable.
The unique identifier of the newly created actor.
A brief description of the actor.
A code assigned to the actor, often used for identification or categorization.
Contact information for the actor, such as a phone number or email.
The identifier representing the type of actor, defining their role or category.
The status identifier of the actor, indicating their current status.
The level of hierarchy where the actor is positioned within the organizational structure.
The identifier for the currency used by the actor.
The date and time when the actor's information was last updated.
The key representing the time zone in which the actor operates.
The identifier for the country in which the actor is located.
The identifier for the operator managing this actor, if applicable.
The identifier for the distributor associated with the actor.
The hierarchical structure to which the actor belongs.
The identifier of the user who created this actor's record.
The date and time when this actor was created.
The identifier of the user who last updated this actor's record.
The identifier for the culture or locale associated with the actor.
The identifier for the country based on the actor's geographic information.
The state or region based on the actor's geographic information.
The city based on the actor's geographic information.
The address based on the actor's geographic information.
The street number based on the actor's geographic information.
The geographic longitude of the actor's location.
The geographic latitude of the actor's location.
The zip code based on the actor's geographic information.
The zoom level for map-based services relevant to the actor's geographic location.
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 Indicates whether the actor overrides inherited geographic settings.
Was this page helpful?
⌘I