# Nayax Developer Portal: English Platform Management Lynx API ## Lynx API ### Lynx API Guides - [Overview](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/lynx-overview.md) - [Languages](https://devzone.nayax.com/reference/manage-data-operations/lynx-api/languages.md) - [FAQs](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/product-faqs.md) #### Security & Token - [Security & Token](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/security.md) - [App Tokens (JWT)](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/app-tokens.md) #### Cards - [Create Cards](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/cards/create-cards.md) - [Retrieve Card Data](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/cards/retrieve-card-data.md) - [Add Credit to Card](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/cards/add-credit-to-card.md) - [Cards](https://devzone.nayax.com/reference/manage-data-operations/lynx-api/cards.md) #### Refunds - [Request Refunds](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/refunds/request-refunds.md) - [Approve or Decline Refunds](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/refunds/approve-or-decline-a-refund.md) - [Upload Refund Documentation](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/refunds/upload-refund-document.md) #### Operator - [Nayax Hierarchy](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/operator/nayax-hierarchy.md) - [Retrieve Hierarchy](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/operator/retrieve-hierarchy.md) - [Create Operator](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/operator/create-operator.md) - [Operator Actions](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/operator/operator-actions.md) - [Actor Types](https://devzone.nayax.com/reference/manage-data-operations/lynx-api/actor-types.md) #### Machines - [Create New Machine](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/machines/create-new-machine-guides.md) - [Retrieve Machine Information](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/machines/retrieve-machine-information.md) - [Get Machine's Last Sales](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/machines/getting-a-machines-last-sales.md) - [Get Monyx ID](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/machines/get-monyx-id.md) - [Machine Attributes](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/machines/updating-a-machines-attribute.md) - [Restart a Machine](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/machines/restart-a-machine.md) - [Get a Machine's ID by the Device's ID](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/machines/getting-a-machines-id-by-the-devices-serial-number.md) - [Get a Machine's Last Sales & Generate eReceipt](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/machines/getting-a-machines-last-sales-ereceipt-information.md) - [Machine Types](https://devzone.nayax.com/reference/manage-data-operations/lynx-api/machine-types.md) #### Devices - [Retrieve Device Information](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/devices/getting-all-devices-under-an-operator.md) - [Disable a Device](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/devices/disabling-a-device.md) - [Move Devices Between Operators](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/devices/moving-device-between-operators.md) #### Inventory Management - [Inventory Workflow](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/inventory-management/inventory-workflow.md) - [Product Groups](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/inventory-management/create-product-group.md) - [Operator Products](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/inventory-management/create-products.md) - [Machine Products](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/inventory-management/machine-products-1.md) - [Pick Lists](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/inventory-management/pick-lists.md) - [Pick List Actions](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/inventory-management/pick-list-actions.md) #### Reports - [Reports](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/reports/index.md) ##### Dashboard Widgets - [Dashboard Widgets Overview](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/reports/widgets-overview.md): Widgets are visual components on the Lynx Reports dashboard that display machine and operator data. - [Sales By Period](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/reports/widget-sales-by-period.md): A bar chart widget showing revenue generated across your fleet or a specific set of machines over a selected time period. - [Dashboard Sales Table](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/reports/widget-dashboard-sales-table.md): A table widget providing a numeric breakdown of revenue and transaction counts across standard reporting windows. - [Last Year vs This Year Monthly Sales](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/reports/widget-last-year-vs-this-year.md): A chart widget comparing monthly sales performance between the current and previous year to track business growth and seasonal trends. - [10 Most Popular Machines Sales/Vends](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/reports/widget-10-most-popular-machines.md): A bar chart widget ranking the top-performing machines in your fleet by sales and vend volume. ##### Widget API - [Get Machine Widget Data (API)](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/reports/retrieve-machine-widget-data.md) - [Widgets ID List](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/reports/available-widgets.md) - [Widget Filters Reference](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/reports/widget-filters.md): Field reference for widget parameters, filter names, and filter types used with the Widgets Dashboard API. - [Revenue Per Machine: Integration Guide](https://devzone.nayax.com/docs/manage-data-operations/lynx-api/reports/integration-guide.md): A step-by-step guide to retrieving revenue data broken down per machine, per day, and per month using the Widgets Dashboard API. ### API Reference #### Endpoints ##### Actors - [Get Actor Details by ActorID](https://devzone.nayax.com/reference/lynx/actors/get-actor-details-by-actorid.md): This endpoint retrieves comprehensive information about a single actor. You must specify the actor's unique identifier, `ActorID`, in the request path to obtain their full profile, including attributes. - [Update Operator/Sub-Operator](https://devzone.nayax.com/reference/lynx/actors/update-operatorsub-operator.md): Updates the details of an existing actor (operator or sub-operator) identified by `ActorID`. The request body must contain the updated attributes for the actor. - [Get Actor by ActorCode](https://devzone.nayax.com/reference/lynx/actors/get-actor-by-actorcode.md): 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. - [Create a New Actor](https://devzone.nayax.com/reference/lynx/actors/create-a-new-actor.md): 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. - [Get payment methods by ActorID](https://devzone.nayax.com/reference/lynx/actors/get-payment-methods-by-actorid.md): Retrieves a list of payment methods associated with a specific actor, identified by the `ActorID`. - [Update Actor's Payment Methods](https://devzone.nayax.com/reference/lynx/actors/update-actors-payment-methods.md): Updates the payment methods associated with a specific actor, identified by the `ActorID`. - [Create Actor's Payment Methods](https://devzone.nayax.com/reference/lynx/actors/create-actors-payment-methods.md): Creates new payment methods for a specific actor, identified by the `ActorID`. - [Delete a Payment Method](https://devzone.nayax.com/reference/lynx/actors/delete-a-payment-method.md): Deletes a specific payment method associated with a given actor, identified by `ActorID` and `paymentMethodID`. - [Get Operator EV Meter Dashboard](https://devzone.nayax.com/reference/lynx/actors/get-operator-ev-meter-dashboard.md): Retrieves the EV meter dashboard for a specific operator, identified by `ActorID`. Optional query parameters allow filtering by date range, machine ID, time period, and machine number. - [Get Encryption Keys by ActorID](https://devzone.nayax.com/reference/lynx/actors/get-encryption-keys-by-actorid.md): Retrieves the encryption keys associated with a specific actor, identified by the `actorID` query parameter. - [Get Actor Hierarchy for Current User](https://devzone.nayax.com/reference/lynx/actors/get-actor-hierarchy-for-current-user.md): Retrieves the actor hierarchy for the current user. Optionally, you can specify an `ActorID` to get the hierarchy for a specific actor, filter by `StatusID`, or limit the hierarchy levels returned. - [Generate Encryption Key](https://devzone.nayax.com/reference/lynx/actors/generate-encryption-key.md): Generates a new encryption key for the specified actor, identified by `actorID`. - [Decrypt Message by Encryption Version](https://devzone.nayax.com/reference/lynx/actors/decrypt-message-by-encryption-version.md): Decrypts a message using a specific encryption version for a given actor, identified by `actorID` and `encVer`. - [List All Machine Groups for Actor](https://devzone.nayax.com/reference/lynx/actors/list-all-machine-groups-for-actor.md): Retrieves all machine groups associated with a specific actor, identified by `ActorID`. - [Update Machine Group](https://devzone.nayax.com/reference/lynx/actors/update-machine-group.md): Updates the details of a machine group associated with a specific actor, identified by `ActorID`. - [Add Machine Group](https://devzone.nayax.com/reference/lynx/actors/add-machine-group.md): Adds a new machine group for a specific actor, identified by `ActorID`. - [Get All Actor Groups by ActorID](https://devzone.nayax.com/reference/lynx/actors/get-all-actor-groups-by-actorid.md): Retrieves all actor groups associated with a specific actor, identified by `ActorID`. - [Add Actor Group](https://devzone.nayax.com/reference/lynx/actors/add-actor-group.md): Adds a new actor group for a specific actor, identified by `ActorID`. - [Delete Actor Group](https://devzone.nayax.com/reference/lynx/actors/delete-actor-group.md): Deletes an actor group associated with a specific actor, identified by `ActorID`. ##### Cards - [Get Cards](https://devzone.nayax.com/reference/lynx/cards/get-cards.md): Retrieves card details based on various query parameters. - [Update Card Details](https://devzone.nayax.com/reference/lynx/cards/update-card-details.md): Updates the details of an existing card. - [Create Virtual Card](https://devzone.nayax.com/reference/lynx/cards/create-virtual-card.md): Creates a new virtual card with the provided details. - [Get the Credit from a Card](https://devzone.nayax.com/reference/lynx/cards/get-the-credit-from-a-card.md): Retrieves the credit value associated with a specific card, identified by its unique identifier. - [Get Card by ID](https://devzone.nayax.com/reference/lynx/cards/get-card-by-id.md): Retrieves card details associated with a specific unique identifier. - [Get Card's Revalue](https://devzone.nayax.com/reference/lynx/cards/get-cards-revalue.md): Retrieves the revalue amount associated with a specific card, identified by the card's unique identifier. - [Get Card by the Cards Display Number](https://devzone.nayax.com/reference/lynx/cards/get-card-by-the-cards-display-number.md): Retrieves card details associated with a specific display number. - [Get Prepaid Card](https://devzone.nayax.com/reference/lynx/cards/get-prepaid-card.md): Retrieves details of a prepaid card associated with a specific card ID. - [Update Prepaid Card](https://devzone.nayax.com/reference/lynx/cards/update-prepaid-card.md): Updates the details of a prepaid card associated with a specific card ID. - [Validates Card for Machine Use](https://devzone.nayax.com/reference/lynx/cards/validates-card-for-machine-use.md): Validates whether a prepaid or discount card can be used with a specific machine. - [Get Card Group](https://devzone.nayax.com/reference/lynx/cards/get-card-group.md): Retrieves the group details associated with a specific card, identified by its card ID. - [Get Credit Card's Latest Transactions](https://devzone.nayax.com/reference/lynx/cards/get-credit-cards-latest-transactions.md): Retrieves the latest transactions associated with a specific credit card number, identified by the SHA1 hash of the card number in base64 format. - [Add Credit to a Card](https://devzone.nayax.com/reference/lynx/cards/add-credit-to-a-card.md): Adds a specified amount to the credit of a card, identified by its unique identifier. - [Add to the Card's Revalue](https://devzone.nayax.com/reference/lynx/cards/add-to-the-cards-revalue.md): Adds a specified amount to the revalue of a card, identified by its unique identifier. - [Transfer Revalue Between Cards](https://devzone.nayax.com/reference/lynx/cards/transfer-revalue-between-cards.md): Transfers a specified amount of revalue from one card to another, identified by their unique identifiers. - [Update Card Status](https://devzone.nayax.com/reference/lynx/cards/update-card-status.md): Updates the status of a card, identified by its unique identifier. - [Update Card Details by Display Number](https://devzone.nayax.com/reference/lynx/cards/update-card-details-by-display-number.md): Updates the details of a card identified by the card's display number. - [Update Card Groups](https://devzone.nayax.com/reference/lynx/cards/update-card-groups.md): Updates the group details associated with a card, identified by the card's unique identifier. - [Create New Card](https://devzone.nayax.com/reference/lynx/cards/create-new-card.md): Creates a new card with the specified details. - [Update Card by ID](https://devzone.nayax.com/reference/lynx/cards/update-card-by-id.md): Updates the details of a card identified by its unique ID. ##### Devices - [Get Device by DeviceID](https://devzone.nayax.com/reference/lynx/devices/get-device-by-deviceid.md): Retrieve detailed information about a specific device using its `DeviceID`. The unique identifier of the device is provided in the path to ensure accurate retrieval of the device's data. - [Update Device](https://devzone.nayax.com/reference/lynx/devices/update-device.md): Update the details of an existing device using its `DeviceID`. The unique identifier of the device is provided in the path to ensure that the correct device is updated. - [Get All Devices](https://devzone.nayax.com/reference/lynx/devices/get-all-devices.md): Retrieve a list of devices with optional filters such as actor ID, connection status, serial number, and other device attributes. - [Move Devices to Actor ID](https://devzone.nayax.com/reference/lynx/devices/move-devices-to-actor-id.md): Assigns or moves a list of devices to a specified actor identified by `actorId`. The request body should include an array of device identifiers (e.g., serial numbers). ##### EReceipt - [Generate eReceipt for your Transaction](https://devzone.nayax.com/reference/lynx/ereceipt/generate-ereceipt-for-your-transaction.md): Generates an electronic receipt (eReceipt) for a specified transaction. The request body should include the transaction details necessary to generate the eReceipt. ##### Lookups - [Get All Actor Types](https://devzone.nayax.com/reference/lynx/lookups/get-all-actor-types.md): Retrieves a list of all actor types, optionally filtered by a specific `ActorTypeID`. - [Get Lookup Types](https://devzone.nayax.com/reference/lynx/lookups/get-lookup-types.md): Retrieves a list of lookup types, optionally filtered by a specific `LutTypeID`. - [Get Machine Models](https://devzone.nayax.com/reference/lynx/lookups/get-machine-models.md): Retrieves a list of machine models, optionally filtered by a specific `MachineModeID`. - [Get Lookup Values by Lookup Type ID](https://devzone.nayax.com/reference/lynx/lookups/get-lookup-values-by-lookup-type-id.md): Retrieves a list of lookup values associated with a specific lookup type identified by `LutTypeID`. - [Get Lookup Value by Lookup ID](https://devzone.nayax.com/reference/lynx/lookups/get-lookup-value-by-lookup-id.md): Retrieves a specific lookup value identified by `LutID`. - [Get Time Zones by Offset](https://devzone.nayax.com/reference/lynx/lookups/get-time-zones-by-offset.md): Retrieves a list of time zones based on the specified time zone offset. - [Get Time Zones by Time Zone Key](https://devzone.nayax.com/reference/lynx/lookups/get-time-zones-by-time-zone-key.md): Retrieves a specific time zone identified by `TimeZoneKey`. - [Get Countries](https://devzone.nayax.com/reference/lynx/lookups/get-countries.md): Retrieves a list of countries, optionally filtered by `CountryID` or `DialCode`. - [Get Country by Code](https://devzone.nayax.com/reference/lynx/lookups/get-country-by-code.md): Retrieves the details of a specific country identified by `CountryCode`. - [Get Currencies](https://devzone.nayax.com/reference/lynx/lookups/get-currencies.md): Retrieves a list of currencies, optionally filtered by `CurrencyID`. - [Get Currency by Code](https://devzone.nayax.com/reference/lynx/lookups/get-currency-by-code.md): Retrieves the details of a specific currency identified by `CurrencyCode`. - [Get Billing Providers](https://devzone.nayax.com/reference/lynx/lookups/get-billing-providers.md): Retrieves a list of billing providers, optionally filtered by `BillingProviderID`. - [Get Payment Methods](https://devzone.nayax.com/reference/lynx/lookups/get-payment-methods.md): Retrieves a list of payment methods, optionally filtered by `PaymentMethodID`. - [Get States](https://devzone.nayax.com/reference/lynx/lookups/get-states.md): Retrieves a list of regions (states or provinces) within a specified country, optionally filtered by `CountryID`. - [Get Cities](https://devzone.nayax.com/reference/lynx/lookups/get-cities.md): Retrieves a list of cities within a specified country, optionally filtered by `CountryID`. - [Get Groups](https://devzone.nayax.com/reference/lynx/lookups/get-groups.md): Retrieves a list of groups, optionally filtered by `GroupID`. - [Get Group Roles](https://devzone.nayax.com/reference/lynx/lookups/get-group-roles.md): Retrieves a list of roles associated with a specific group identified by `GroupID`. - [Get Regions](https://devzone.nayax.com/reference/lynx/lookups/get-regions.md): Retrieves a list of regions (states or provinces), optionally filtered by `CountryID` or `RegionID`. ##### Machine Attribute - [Update Machine Attribute to Model Defaults](https://devzone.nayax.com/reference/lynx/machine-attribute/update-machine-attribute-to-model-defaults.md): Resets the machine attributes to the default values defined by the machine model. This operation is typically used to restore default configurations. - [Update Machine Attribute to Current Configuration](https://devzone.nayax.com/reference/lynx/machine-attribute/update-machine-attribute-to-current-configuration.md): Resends the current machine configuration, updating the machine attributes to match the latest configuration settings. - [Get All Machine Attributes](https://devzone.nayax.com/reference/lynx/machine-attribute/get-all-machine-attributes.md): Retrieves all attributes associated with a specific machine identified by `MachineID`. - [Bulk Update Machine Attributes](https://devzone.nayax.com/reference/lynx/machine-attribute/bulk-update-machine-attributes.md): Performs a bulk update of machine attributes for the specified machine identified by `MachineID`. - [Insert/Update Machine Attributes](https://devzone.nayax.com/reference/lynx/machine-attribute/insertupdate-machine-attributes.md): Allows bulk insertion or updating of machine attributes. The request body should include an array of machine attributes to be processed. - [Get Specific Machine Attribute](https://devzone.nayax.com/reference/lynx/machine-attribute/get-specific-machine-attribute.md): Retrieves the details of a specific machine attribute identified by `MachineID` and `DeviceAttributeID`. - [Update Specific Machine Attribute](https://devzone.nayax.com/reference/lynx/machine-attribute/update-specific-machine-attribute.md): Updates the details of a specific machine attribute identified by `MachineID` and `DeviceAttributeID`. ##### Machine Inventory - [Get Pick List](https://devzone.nayax.com/reference/lynx/machine-inventory/get-pick-list.md): Retrieves the pick list associated with a specific machine identified by `MachineID`. - [Create Pick List](https://devzone.nayax.com/reference/lynx/machine-inventory/create-pick-list.md): Generates a new pick list for a specific machine, with options to adjust the pick list based on various criteria. - [Delete Pick List](https://devzone.nayax.com/reference/lynx/machine-inventory/delete-pick-list.md): Deletes the existing pick list for a specific machine identified by `MachineID`. - [Set All Machine Bins as Full](https://devzone.nayax.com/reference/lynx/machine-inventory/set-all-machine-bins-as-full.md): Marks all bins in the specified machine as fully stocked, indicating that all product slots are filled to capacity. - [Empty Machine Products Inventory](https://devzone.nayax.com/reference/lynx/machine-inventory/empty-machine-products-inventory.md): Empties the inventory of all products in the specified machine, marking all product slots as empty. - [Update Pick List](https://devzone.nayax.com/reference/lynx/machine-inventory/update-pick-list.md): Updates the pick list for a specific machine, allowing changes to the quantity of products to be picked. ##### Machine Products - [Get Machine Products](https://devzone.nayax.com/reference/lynx/machine-products/get-machine-products.md): Retrieves the list of products associated with a specific machine identified by `MachineID`. - [Update Machine Products](https://devzone.nayax.com/reference/lynx/machine-products/update-machine-products.md): Updates the products associated with a specific machine identified by `MachineID`, with an option to avoid deletion. - [Create Machine Products](https://devzone.nayax.com/reference/lynx/machine-products/create-machine-products.md): Creates new products for the specified machine identified by `MachineID`. - [Get a Machine Product](https://devzone.nayax.com/reference/lynx/machine-products/get-a-machine-product.md): Retrieves details of a specific machine product identified by `MachineProductID` within the machine identified by `MachineID`. - [Update a Machine Product](https://devzone.nayax.com/reference/lynx/machine-products/update-a-machine-product.md): Updates the details of a specific machine product identified by `MachineProductID` within the machine identified by `MachineID`. ##### Machines - [Get Specific Machine Basic Info](https://devzone.nayax.com/reference/lynx/machines/get-specific-machine-basic-info.md): Retrieves basic information about a specific machine identified by `MachineID`. - [Update Specific Machine Basic Info](https://devzone.nayax.com/reference/lynx/machines/update-specific-machine-basic-info.md): Updates the basic information of a specific machine identified by `MachineID`. - [Get All Machine Basic Info](https://devzone.nayax.com/reference/lynx/machines/get-all-machine-basic-info.md): Retrieves basic information for all machines, with optional filtering by parameters. - [Create New Machine](https://devzone.nayax.com/reference/lynx/machines/create-new-machine.md): Creates a new machine entry with the provided details. - [Search Machine Basic Info](https://devzone.nayax.com/reference/lynx/machines/search-machine-basic-info.md): Retrieves a list of machines based on the search criteria provided in the request body. This allows users to filter and find specific machines or groups of machines by applying various parameters. - [Get Machine Change Logs](https://devzone.nayax.com/reference/lynx/machines/get-machine-change-logs.md): Fetches the change logs for machines within a specified date range. Users can filter the logs by various parameters such as ActorID, StartDate, EndDate, MachineID, TimePeriod, and MachineNumber to retrieve the relevant changes. - [Get Specific Machine Basic Info by Device](https://devzone.nayax.com/reference/lynx/machines/get-specific-machine-basic-info-by-device.md): Retrieves the basic information of a specific machine associated with the provided device serial number. This allows users to fetch machine details by referencing the device it is connected to. - [Get Specific Machine Basic Info by VPOS](https://devzone.nayax.com/reference/lynx/machines/get-specific-machine-basic-info-by-vpos.md): Retrieves the basic information of a specific machine associated with the provided VPOS serial number. This allows users to fetch machine details by referencing the VPOS device it is connected to. - [Get Specific Machine Statistics](https://devzone.nayax.com/reference/lynx/machines/get-specific-machine-statistics.md): Retrieves the current status and statistics of a specific machine identified by the provided MachineID. This includes details like operational status, performance metrics, and other relevant statistics. - [Get Machine Last Alerts](https://devzone.nayax.com/reference/lynx/machines/get-machine-last-alerts.md): Retrieves the most recent alerts for a specific machine identified by the provided MachineID. This helps in monitoring recent issues or notifications related to the machine's operation. - [Get Payment Methods for Machine](https://devzone.nayax.com/reference/lynx/machines/get-payment-methods-for-machine.md): Retrieves the list of payment methods associated with a specific machine, identified by MachineID. This allows users to view the available payment options configured for the machine. - [Update Payment Methods for Machine](https://devzone.nayax.com/reference/lynx/machines/update-payment-methods-for-machine.md): Updates the payment methods associated with a specific machine, identified by MachineID. This operation allows users to modify the existing payment options for the machine. - [Create Payment Methods for Machine](https://devzone.nayax.com/reference/lynx/machines/create-payment-methods-for-machine.md): Creates new payment methods for a specific machine, identified by MachineID. This operation allows users to add new payment options to the machine. - [Get Last Sales for Machine by MachineID](https://devzone.nayax.com/reference/lynx/machines/get-last-sales-for-machine-by-machineid.md): Retrieves the most recent sales transactions for a specific machine, identified by MachineID. This allows users to view the latest sales activity associated with the machine. - [Delete Specific Payment Method for Machine](https://devzone.nayax.com/reference/lynx/machines/delete-specific-payment-method-for-machine.md): Deletes a specific payment method associated with a machine, identified by the provided MachineID and paymentMethodID. This operation allows users to remove a payment option from the machine. ##### Metadata - [Upload Picture](https://devzone.nayax.com/reference/lynx/metadata/upload-picture.md): Uploads a picture to the server with associated metadata. The picture and its details are provided in the request body. - [Get Event Rules](https://devzone.nayax.com/reference/lynx/metadata/get-event-rules.md): Retrieves the event rules configured in the system. The response contains an array of event rules that are currently active. ##### Payment - [Request a Payment Refund](https://devzone.nayax.com/reference/lynx/payment/request-a-payment-refund.md): Submits a request to refund a specific payment. The request body includes details such as the refund amount, reason, and transaction ID. - [Approve Payment Refund](https://devzone.nayax.com/reference/lynx/payment/approve-payment-refund.md): Approves a previously requested payment refund. The request body includes details such as whether the refund was processed externally and any associated documentation. - [Decline a Payment Refund](https://devzone.nayax.com/reference/lynx/payment/decline-a-payment-refund.md): Submits a request to decline a previously submitted payment refund request. The request body includes details such as the transaction ID and reason for declining the refund. - [Upload Refund Documentation](https://devzone.nayax.com/reference/lynx/payment/upload-refund-documentation.md): Uploads a file related to a payment refund. The file could be documentation or other relevant data associated with the refund. ##### Product Groups - [Get Product Group](https://devzone.nayax.com/reference/lynx/product-groups/get-product-group.md): Retrieves details of a specific product group identified by the ProductGroupID. The response includes information such as the product group name, code, and other related details. - [Update Product Group](https://devzone.nayax.com/reference/lynx/product-groups/update-product-group.md): Updates the details of a specific product group identified by the ProductGroupID. The request body should include the updated information such as the product group name, code, and category. - [Get Product Groups by Actor](https://devzone.nayax.com/reference/lynx/product-groups/get-product-groups-by-actor.md): Retrieves a list of product groups associated with a specific actor, identified by the ActorID. The response includes details of each product group. - [Get All Product Groups](https://devzone.nayax.com/reference/lynx/product-groups/get-all-product-groups.md): Retrieves a list of all product groups. The response includes details of each product group such as the name, code, and associated actor. - [Create New Product Groups](https://devzone.nayax.com/reference/lynx/product-groups/create-new-product-groups.md): Creates new product groups based on the details provided in the request body. The request includes information such as the product group name, code, and associated actor. - [Get Product Group Tax](https://devzone.nayax.com/reference/lynx/product-groups/get-product-group-tax.md): Retrieves the tax details associated with a specific product group, identified by the ProductGroupID. Optionally, a specific tax row can be retrieved using the TaxRowID query parameter. - [Update Product Group Tax](https://devzone.nayax.com/reference/lynx/product-groups/update-product-group-tax.md): Updates the tax details for a specific product group, identified by the ProductGroupID. The request body contains the updated tax information. - [Create Product Group Tax](https://devzone.nayax.com/reference/lynx/product-groups/create-product-group-tax.md): Creates new tax details for a specific product group, identified by the ProductGroupID. The request body contains the tax information to be added. - [Delete Product Group Tax](https://devzone.nayax.com/reference/lynx/product-groups/delete-product-group-tax.md): Deletes a specific tax entry associated with a product group, identified by both ProductGroupID and TaxRowID. This operation removes the specified tax row from the product group. ##### Products - [Get Specific Operator Products](https://devzone.nayax.com/reference/lynx/products/get-specific-operator-products.md): Retrieves a list of products associated with a specific operator, identified by the OperatorID. The response includes details of each product. - [Create New Operator Product](https://devzone.nayax.com/reference/lynx/products/create-new-operator-product.md): Creates a new product associated with a specific operator, identified by the OperatorID. The request body contains the details of the product to be created. - [Get Specific Product](https://devzone.nayax.com/reference/lynx/products/get-specific-product.md): Retrieves the details of a specific product identified by the NayaxProductID. The response includes all relevant information about the product. - [Update Specific Product](https://devzone.nayax.com/reference/lynx/products/update-specific-product.md): Updates the details of a specific product identified by the NayaxProductID. The request body should contain the updated product information. ##### Scheduling - [Get Drivers](https://devzone.nayax.com/reference/lynx/scheduling/get-drivers.md): Retrieves a list of drivers based on various query parameters, such as ActorId, DriverStatusId, and multiple search options (e.g., by DriverId, UserId, Fullname, etc.). - [Update Driver](https://devzone.nayax.com/reference/lynx/scheduling/update-driver.md): Updates the details of an existing driver identified by DriverId. The request body should include the updated driver information. - [Add New Driver](https://devzone.nayax.com/reference/lynx/scheduling/add-new-driver.md): Adds a new driver to the scheduling system. The request body should include the details of the driver to be added. - [Delete Driver](https://devzone.nayax.com/reference/lynx/scheduling/delete-driver.md): Deletes a driver identified by DriverId from the scheduling system. - [Get Routes](https://devzone.nayax.com/reference/lynx/scheduling/get-routes.md): Retrieves a list of routes based on various query parameters, such as OperatorId, DriverId, Status, and multiple search options (e.g., by Name, Code, Notes, etc.). - [Update Route](https://devzone.nayax.com/reference/lynx/scheduling/update-route.md): Updates the details of an existing route identified by routeId. The request body should include the updated route information. - [Create New Route](https://devzone.nayax.com/reference/lynx/scheduling/create-new-route.md): Creates a new route for the specified operator. The request body should include the details of the route to be created. - [Get Route Machines](https://devzone.nayax.com/reference/lynx/scheduling/get-route-machines.md): Retrieves a list of machines assigned to a specific route, identified by RouteId, and optionally filtered by MachineId. - [Assign Machine to Route](https://devzone.nayax.com/reference/lynx/scheduling/assign-machine-to-route.md): Assigns a machine to a specific route. The request body should include the details of the machine to be assigned. - [Remove Machine from Route](https://devzone.nayax.com/reference/lynx/scheduling/remove-machine-from-route.md): Removes a machine from a specific route, identified by RouteId and MachineId. - [Get Visit Orders](https://devzone.nayax.com/reference/lynx/scheduling/get-visit-orders.md): Retrieves a list of visit orders based on various query parameters such as VisitDate, MachineId, DriverId, RouteId, and ActorId. - [Create Visit Orders](https://devzone.nayax.com/reference/lynx/scheduling/create-visit-orders.md): Creates new visit orders for machines. The request body should include the details of the machines to be visited. - [Get Machine Tasks](https://devzone.nayax.com/reference/lynx/scheduling/get-machine-tasks.md): Retrieves a list of scheduled machine tasks based on various query parameters such as date range, machine, driver, route, and other filters. - [Update Machine Tasks](https://devzone.nayax.com/reference/lynx/scheduling/update-machine-tasks.md): Updates existing scheduled tasks for machines. The request body should include the updated task details. - [Create Machine Tasks](https://devzone.nayax.com/reference/lynx/scheduling/create-machine-tasks.md): Creates new scheduled tasks for machines. The request body should include details of the tasks to be scheduled. - [Delete Machine Tasks](https://devzone.nayax.com/reference/lynx/scheduling/delete-machine-tasks.md): Deletes scheduled tasks for machines based on the provided query parameters such as SchedulingIds, MachineID, and date. ##### Sign In - [User Sign In](https://devzone.nayax.com/reference/lynx/sign-in/user-sign-in.md): Authenticates a user with the provided credentials (username and password). - [Sign In](https://devzone.nayax.com/reference/lynx/sign-in/sign-in.md) ##### Report - [Retrieve Widget Data](https://devzone.nayax.com/reference/lynx/report/retrieve-widget-data.md): Fetches analytical data for a specific dashboard widget based on the provided filters and widget ID. - [Get Available Widgets](https://devzone.nayax.com/reference/lynx/report/get-available-widgets.md): Retrieves a list of available dashboard widgets, optionally filtered by the screen type ID. ## OpenAPI Specs - [lynx](/openapi/lynx.yaml)