Jump to Content
Home
Guides
API Reference
v0.1
v1.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.0
Home
Guides
API Reference
Onboard Machine
Search
JUMP TO
Nayax Operational Lynx API
Overview
Cards
Actor Types
Machine Types
Languages
Actors
Get Actor Details by ActorID
get
Update Operator/Sub-Operator
put
Get Actor by ActorCode
get
Create a New Actor
post
Create a New Actor
post
Get payment methods by ActorID
get
Update Actor's Payment Methods
put
Create Actor's Payment Methods
post
Delete a Payment Method
delete
Get Operator EV Meter Dashboard
get
Get Encryption Keys by ActorID
get
Get Actor Hierarchy for Current User
get
Generate Encryption Key
put
Decrypt Message by Encryption Version
put
List All Machine Groups for Actor
get
Add Machine Group
post
Update Machine Group
put
Get All Actor Groups by ActorID
get
Add Actor Group
post
Delete Actor Group
delete
Cards
Get Cards
get
Create Virtual Card
post
Update Card Details
put
Get the Credit from a Card
get
Get Card by ID
get
Get Card's Revalue
get
Get Card by the Cards Display Number
get
Get Prepaid Card
get
Update Prepaid Card
put
Validates Card for Machine Use
get
Get Card Group
get
Get Credit Card's Latest Transactions
post
Add Credit to a Card
post
Add to the Card's Revalue
post
Transfer Revalue Between Cards
post
Update Card Status
post
Update Card Details by Display Number
put
Update Card Groups
put
Create New Card
post
Update Card by ID
put
Devices
Get Device by DeviceID
get
Update Device
put
Get All Devices
get
Move Devices to Actor ID
put
EReceipt
Generate eReceipt for your Transaction
post
Lookups
Get All Actor Types
get
Get Lookup Types
get
Get Machine Models
get
Get Lookup Values by Lookup Type ID
get
Get Lookup Value by Lookup ID
get
Get Time Zones by Offset
get
Get Time Zones by Time Zone Key
get
Get Countries
get
Get Country by Code
get
Get Currencies
get
Get Currency by Code
get
Get Billing Providers
get
Get Payment Methods
get
Get States
get
Get Cities
get
Get Groups
get
Get Group Roles
get
Get Regions
get
Machine Attribute
Update Machine Attribute to Model Defaults
post
Update Machine Attribute to Current Configuration
post
Get All Machine Attributes
get
Bulk Update Machine Attributes
put
Insert/Update Machine Attributes
post
Get Specific Machine Attribute
get
Update Specific Machine Attribute
put
Machine Inventory
Get Pick List
get
Create Pick List
post
Delete Pick List
delete
Set All Machine Bins as Full
post
Empty Machine Products Inventory
post
Update Pick List
put
Machine Products
Get Machine Products
get
Create Machine Products
post
Update Machine Products
put
Get a Machine Product
get
Update a Machine Product
put
Machines
Get Specific Machine Basic Info
get
Update Specific Machine Basic Info
put
Create New Machine
post
Get All Machine Basic Info
get
Search Machine Basic Info
post
Get Machine Change Logs
get
Get Specific Machine Basic Info by Device
get
Get Specific Machine Basic Info by VPOS
get
Get Specific Machine Statistics
get
Get Machine Last Alerts
get
Get Payment Methods for Machine
get
Update Payment Methods for Machine
put
Create Payment Methods for Machine
post
Get Last Sales for Machine by MachineID
get
Delete Specific Payment Method for Machine
delete
Metadata
Upload Picture
post
Get Event Rules
get
Payment
Request a Payment Refund
post
Decline a Payment Refund
post
Approve Payment Refund
post
Upload Refund Documentation
post
Product Groups
Get Product Group
get
Update Product Group
put
Get Product Groups by Actor
get
Create New Product Groups
post
Get All Product Groups
get
Get Product Group Tax
get
Update Product Group Tax
put
Create Product Group Tax
post
Delete Product Group Tax
delete
Products
Get Specific Operator Products
get
Create New Operator Product
post
Get Specific Product
get
Update Specific Product
put
Scheduling
Get Drivers
get
Add New Driver
post
Update Driver
put
Delete Driver
delete
Get Routes
get
Create New Route
post
Update Route
put
Get Route Machines
get
Assign Machine to Route
post
Remove Machine from Route
delete
Get Visit Orders
get
Create Visit Orders
post
Get Machine Tasks
get
Create Machine Tasks
post
Update Machine Tasks
put
Delete Machine Tasks
delete
Sign In
User Sign In
post
Sign In
get
Nayax Cortina API
Cortina API Overview
Cortina
Cortina Age Verification
post
Post Renew Key
post
Post Sale End Notification
post
Post Start Session
post
Get Version
get
Cortina Credit Card
Cortina Credit Card Authorization
post
Cortina Credit Card Cancel
post
Cortina Credit Card Incremental Auth
post
Cortina Credit Card Inquiry3DS
post
Cortina Credit Card Refund
post
Cortina Credit Card Sale
post
Cortina Credit Card Settlement
post
Cortina Credit Card Void
post
DynamicQR
Cortina DynamicQR GenerateQR
post
Cortina DynamicQR Inquiry
post
Cortina DynamicQR Refund
post
Cortina DynamicQR Void
post
Cortina Prepaid
Cortina Prepaid Authorization
post
Cortina Prepaid Cancel
post
Cortina Prepaid Refund
post
Cortina Prepaid Sale
post
Cortina Prepaid Settlement
post
Cortina Prepaid Void
post
StaticQR
Cortina StaticQR Authorization
post
Cortina StaticQR Cancel
post
Cortina StaticQR Refund
post
Cortina StaticQR Sale
post
Cortina StaticQR Settlement
post
Cortina StaticQR Void
post
Cortina StaticQR Start
post
Cortina Onboarding
Onboard Actor
post
Onboard Machine
post
Get Version
get
Powered by
Onboard Machine
post
https://{domain}:{port}/api/OnboardMachine
Onboard Machine
Language
Shell
Node
Ruby
PHP
Python
URL
Base URL
https://
example.com
:
443
/api
/OnboardMachine
