# Nayax Developer Portal: English Terminal SDKs

## Terminal SDKs

### Marshall

#### Marshall Guides

- [Overview](https://devzone.nayax.com/docs/integrate-pos-device/marshall/marshall-sdk.md)
- [Integration Process](https://devzone.nayax.com/docs/integrate-pos-device/marshall/get-started/marshall-integration-process.md): A step-by-step guide to integrating with Nayax
- [Create Payments](https://devzone.nayax.com/docs/integrate-pos-device/marshall/marshall-create-payments.md)

##### Payment Flows

- [Payment Flows](https://devzone.nayax.com/docs/integrate-pos-device/marshall/payment-flows/marshall-payment-flows.md)
- [Single Session with Pre-Selection](https://devzone.nayax.com/docs/integrate-pos-device/marshall/payment-flows/marshall-single-session-with-pre-sel.md)
- [Single Session with Pre-Authorization](https://devzone.nayax.com/docs/integrate-pos-device/marshall/payment-flows/marshall-single-session-with-pre-auth.md)
- [Multi-Session](https://devzone.nayax.com/docs/integrate-pos-device/marshall/payment-flows/marshall-multi-session.md)
- [Multi-Vending with Pre-Selection](https://devzone.nayax.com/docs/integrate-pos-device/marshall/payment-flows/marshall-multi-vend-with-pre-sel.md)
- [Multi-Vending with Pre-Authorization](https://devzone.nayax.com/docs/integrate-pos-device/marshall/payment-flows/marshall-multi-vend-with-pre-auth.md)
- [Sub Flows & Features](https://devzone.nayax.com/docs/integrate-pos-device/marshall/payment-flows/sub-flows-features.md): Reference for Marshall's payment sub-flows and features, including Transfer Data, Display Control, eReceipt, and Incremental Authorization.
- [Single Session Pre-Authorization with External Settlement](https://devzone.nayax.com/docs/integrate-pos-device/marshall/payment-flows/external-settlement-marshall.md)
- [Multi-Session Pre-Authorization with External Settlement](https://devzone.nayax.com/docs/integrate-pos-device/marshall/payment-flows/multi-session-pre-authorization-with-external-settlement.md)

##### Get Started

- [Get Started](https://devzone.nayax.com/docs/integrate-pos-device/marshall/get-started/marshall-get-started.md)
- [C# & Java SDK Integration](https://devzone.nayax.com/docs/integrate-pos-device/marshall/get-started/marshall-csharp-java-integration.md)
- [C SDK Integration](https://devzone.nayax.com/docs/integrate-pos-device/marshall/get-started/c-sdk-integration.md)
- [VMC Configuration Object](https://devzone.nayax.com/docs/integrate-pos-device/marshall/get-started/vmc-configuration-object.md)
- [SDK Flags](https://devzone.nayax.com/docs/integrate-pos-device/marshall/get-started/sdk-flags-descriptions.md)
- [Certification Process](https://devzone.nayax.com/docs/integrate-pos-device/marshall/get-started/certification-proccess.md)

##### Simulators & Sample Codes

- [Simulators & Sample Codes](https://devzone.nayax.com/docs/integrate-pos-device/marshall/simulators-sample-codes/marshall-sdk-simulators.md)
- [Java SDK Simulator](https://devzone.nayax.com/docs/integrate-pos-device/marshall/simulators-sample-codes/java-sdk-simulator.md)
- [C# SDK Simulator](https://devzone.nayax.com/docs/integrate-pos-device/marshall/simulators-sample-codes/csharp-sdk-simulator.md)
- [C SDK Simulator](https://devzone.nayax.com/docs/integrate-pos-device/marshall/simulators-sample-codes/c-sdk-simulator.md)
- [C SDK Single Session](https://devzone.nayax.com/docs/integrate-pos-device/marshall/simulators-sample-codes/single-session.md)
- [C SDK Multi-Session](https://devzone.nayax.com/docs/integrate-pos-device/marshall/simulators-sample-codes/multi-session.md)
- [C SDK Multi-Vend](https://devzone.nayax.com/docs/integrate-pos-device/marshall/simulators-sample-codes/multi-vend.md)
- [C SDK Always Idle Mode](https://devzone.nayax.com/docs/integrate-pos-device/marshall/simulators-sample-codes/marshall-c-always-idle.md)

##### Methods & Functions

- [Methods & Functions](https://devzone.nayax.com/docs/integrate-pos-device/marshall/methods-functions/marshall-methods-and-functions.md)
- [Framework](https://devzone.nayax.com/docs/integrate-pos-device/marshall/methods-functions/framework.md)
- [Link and Events Configuration](https://devzone.nayax.com/docs/integrate-pos-device/marshall/methods-functions/link-and-events-configuration.md)
- [Vending Events](https://devzone.nayax.com/docs/integrate-pos-device/marshall/methods-functions/vending-events.md)
- [Vending Session Management](https://devzone.nayax.com/docs/integrate-pos-device/marshall/methods-functions/data-structures.md)
- [General Marshall Events](https://devzone.nayax.com/docs/integrate-pos-device/marshall/methods-functions/general-marshall-events.md)

##### HW Integration Kit and Setup

- [HW Integration Kit and Setup](https://devzone.nayax.com/docs/integrate-pos-device/marshall/hw-integration-kit-and-setup/vpos-touch-installation.md)
- [Marshall Integration Kit](https://devzone.nayax.com/docs/integrate-pos-device/marshall/hw-integration-kit-and-setup/sales-kit.md)
- [Installation Steps](https://devzone.nayax.com/docs/integrate-pos-device/marshall/hw-integration-kit-and-setup/installation-steps.md)
- [Set Up Nayax Core for Marshall Integration](https://devzone.nayax.com/docs/integrate-pos-device/marshall/hw-integration-kit-and-setup/set-up-nayax-core-for-marshall-integration.md)

##### Logs and Diagnostics

- [Log Analysis](https://devzone.nayax.com/docs/integrate-pos-device/marshall/log-analysis/overview.md)
- [SDK Log Generation](https://devzone.nayax.com/docs/integrate-pos-device/marshall/log-analysis/log-generation.md)
- [Log Trace Comparator](https://devzone.nayax.com/docs/integrate-pos-device/marshall/log-analysis/log-trace-comparator.md)
- [Checkpoints & Scenario Tags](https://devzone.nayax.com/docs/integrate-pos-device/marshall/log-analysis/log-trace-comparator-guide.md)

##### Additional Resources

- [Display Control (Screen Display)](https://devzone.nayax.com/docs/integrate-pos-device/marshall/additional-resources/marshall-display.md)
- [Transfer Data](https://devzone.nayax.com/docs/integrate-pos-device/marshall/additional-resources/marshall-ontransferdata.md)
- [Stability & Starvation Issues](https://devzone.nayax.com/docs/integrate-pos-device/marshall/additional-resources/stablity-issues.md)
- [Capabilities](https://devzone.nayax.com/docs/integrate-pos-device/marshall/additional-resources/capabilities.md)

##### Marshall FAQs

- [Marshall FAQs](https://devzone.nayax.com/docs/integrate-pos-device/marshall/marshall-faqs/index.md)
- [General](https://devzone.nayax.com/docs/integrate-pos-device/marshall/marshall-faqs/faq-general.md)
- [Device](https://devzone.nayax.com/docs/integrate-pos-device/marshall/marshall-faqs/faq.md)
- [Flow & Configurations](https://devzone.nayax.com/docs/integrate-pos-device/marshall/marshall-faqs/faq-marshall-flowconfigurations.md): Answers to common questions about Marshall's flow behavior and configuration, including timeouts, status codes, and session handling.

#### Marshall Release Notes

- [Marshall Java SDK Release Notes](https://devzone.nayax.com/docs/integrate-pos-device/marshall/marshall-java-release-notes.md): Track Marshall Java SDK changes as they ship.
- [Marshall C# SDK Release Notes](https://devzone.nayax.com/docs/integrate-pos-device/marshall/marshall-csharp-release-notes.md): Track Marshall C# SDK changes as they ship.
- [Marshall C SDK Release Notes](https://devzone.nayax.com/docs/integrate-pos-device/marshall/marshall-c-release-notes.md): Track Marshall C SDK changes as they ship.

### Marshall Pro (Fuel)

#### Marshall Pro Guides

- [Overview](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/getting-started/index.md)
- [Integration Process](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/getting-started/marshall-pro-integration-process.md): A step-by-step guide to integrating with Nayax
- [Forecourt Architecture](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/getting-started/forecourt-architecture.md)
- [Marshall Pro Network Requirements](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/getting-started/network-requirements.md): Ports, domains, and IP ranges to whitelist so Marshall Pro terminals, including VPOS Media-5, can connect to Nayax.
- [Best Practices](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/getting-started/best-practices.md): Optimize your VPOS integration for reliability and user experience.
- [Security & Digital Signatures](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/getting-started/security-digital-signatures.md): Implement RSA SHA-256 signatures for secure data entry.

#### Payment Flows

- [Two-Phase Pre-Authorization Flow](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/methods/payment/two-phase-pre-authorization.md): Enable external data collection and manual authorization triggers for fueling sessions.
- [Post-Pay Flow](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/methods/payment/post-pay.md): Process immediate payments for fixed-price services or completed transactions without the need for pre-authorization.
- [Periodic Reconciliation](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/methods/payment/periodic-reconciliation.md): Maintain system integrity by querying and settling open transactions to ensure all fueling sessions are correctly finalized.

#### Messaging Protocol

- [TCP Communication](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/messaging-protocol/tcp-communication.md)
- [Request and Response Format](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/messaging-protocol/request-response-format.md)
- [Error Codes](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/messaging-protocol/error-codes.md)
- [Example: Fuel Station Flow](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/messaging-protocol/example-fuel-station-flow.md): A step-by-step guide through a standard fueling transaction.

#### Methods

- [API Introduction](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/methods/api.md)

##### General

- [info](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/methods/general/info.md): Exchange system metadata and retrieve terminal configuration settings.
- [status](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/methods/general/status.md): Retrieve the current operational state of the VPOS terminal.

##### Payment

- [cardDetect](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/methods/payment/card-detect.md): Enable the reader to detect and read payment methods without immediate authorization.
- [stopCardDetect](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/methods/payment/stop-card-detect.md): Deactivate the terminal reader and cancel the card detection phase.
- [authorize](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/methods/payment/authorize.md): Initiate a financial pre-authorization on a previously detected payment method.
- [detectAndAuth](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/methods/payment/detect-and-auth.md): Detect, read, and pre-authorize funds in a single-phase operation.
- [settle](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/methods/payment/settle.md): Finalize a pre-authorized transaction with the actual fueling amount.
- [pay](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/methods/payment/pay.md): Process an immediate, single-phase payment transaction.
- [query](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/methods/payment/query.md): Retrieve the open (unsettled) transaction.

##### Display

- [displayScreen](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/methods/display/display-screen.md): Control the terminal's visual interface to display custom messages to the customer.
- [displayInput](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/methods/display/display-input.md): Request specific alphanumeric input from the customer via the terminal interface.
- [displaySelect](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/methods/display/display-select.md): Present the customer with a list of options for selection on the terminal screen.
- [displayConfirm](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/methods/display/display-confirm.md): Prompt the customer for a simple Yes/No or OK/Cancel confirmation.

##### Utility

- [print](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/methods/utility/print.md): Trigger the integrated thermal printer to generate custom receipts or documents.

#### Marshall Pro Release Notes

- [FuelApp Release Notes](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/fuelapp-release-notes.md): What changed in each FuelApp version, and what it means for your integration.

#### FAQ

- [Flow & Configuration](https://devzone.nayax.com/docs/integrate-pos-device/marshall-pro/faq.md): Answers to common questions about activating, connecting, configuring, and updating Marshall Pro devices.

### TweezerComm

#### TweezerComm Guides

- [Overview](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/overview-tweezer.md)
- [Integration Process](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/tweezercomm-integration-process.md): A step-by-step guide to integrating with Nayax
- [Get Started](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/tweezercomm-get-started.md)
- [PinPad Mode](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/pinpad-mode.md)
- [Resilience Mechanism](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/resilience-mechanism-copy.md)
- [TC Service](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/tc-service.md)

##### Global Payment Flows

- [Global Payment Flows](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/global-payment-flows/payment-flows-copy-1.md)
- [Pre-Selection](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/global-payment-flows/tweezercomm-engine-preselection-flow.md)
- [Pre-Authorization](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/global-payment-flows/tweezercomm-engine-preauth-flow.md)

##### Global Payment Methods

- [Global Payment Methods](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/global-payment-methods/payment-services-methods-copy-1.md)
- [doTransaction](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/global-payment-methods/dotransaction.md)
- [Refunds](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/global-payment-methods/refunds-dotransaction.md)
- [abortTransaction](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/global-payment-methods/abort-transaction.md)
- [getTransactionByVuid](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/global-payment-methods/gettransactionbyvuid.md)
- [getReport](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/global-payment-methods/getreport.md)
- [getStatus](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/global-payment-methods/getstatus.md)
- [getInternalStatus](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/global-payment-methods/getinternalstatus.md)
- [getRetailerInfo](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/global-payment-methods/getretailerinfo.md)
- [startPinpadTransaction](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/global-payment-methods/startpinpadtransaction.md)
- [doPinpadTransaction](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/global-payment-methods/dopinpadtransaction.md)
- [endPinpadTransaction](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/global-payment-methods/endpinpadtransaction.md)

##### Israel Payment Flows

- [Israel Payment Flows](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/israel-payment-flows/tweezercomm-israel-payment-flows.md)
- [Regular Transaction](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/israel-payment-flows/single-phase-transaction.md)
- [Two Phases Transaction](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/israel-payment-flows/2-phase-transaction.md)
- [Pre-Authorization (Israel)](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/israel-payment-flows/tweezercomm-pre-authorization-israel.md)
- [Deferred Payment](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/israel-payment-flows/tweezercomm-deferred-payment.md)
- [Split Transaction](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/israel-payment-flows/tweezercomm-split-transaction.md)

##### Israel Payment Methods

- [Israel Payment Methods](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/israel-payment-methods/tweezercomm-israel-payment-methods.md)
- [doTransaction](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/israel-payment-methods/dotransaction-ashrait.md)
- [doTransactionPhase1](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/israel-payment-methods/dotransactionphase1.md)
- [doTransactionPhase2](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/israel-payment-methods/dotransactionphase2.md)
- [doPeriodic](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/israel-payment-methods/doperiodic.md)
- [doMiniSettlement](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/israel-payment-methods/dominisettlement.md)
- [addSubRetailer](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/israel-payment-methods/addsubretailer.md)
- [abortTransaction](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/israel-payment-methods/aborttransaction-copy.md)
- [cancelTransaction](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/israel-payment-methods/canceltransaction-1.md)
- [getTransactionByUid](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/israel-payment-methods/gettransactionbyvuid-copy.md)
- [getTransactionByVuid](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/israel-payment-methods/gettransactionbyvuid-copy-1.md)
- [getReport](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/israel-payment-methods/getreport-1.md)
- [getRetailerInfo](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/israel-payment-methods/getreport-copy-1.md)
- [getStatus](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/israel-payment-methods/getreport-copy.md)
- [getInternalStatus](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/israel-payment-methods/getstatus-copy.md)
- [getSubRetailer](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/israel-payment-methods/addsubretailer-copy.md)
- [removeSubRetailer](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/israel-payment-methods/dotransactionphase2-copy-1.md)
- [authorizePendingTransactions](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/israel-payment-methods/authorizependingtransactions.md)

##### Device Methods

- [Device Methods](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/device-methods/index.md)
- [getInfo](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/device-methods/getinfo.md)
- [readCard](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/device-methods/readcard.md)
- [abortReadCard](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/device-methods/abortreadcard.md)
- [getConfig](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/device-methods/getconfig.md)
- [setConfig](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/device-methods/setconfig.md)
- [getVersion](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/device-methods/getversion.md)
- [uploadLogs](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/device-methods/uploadlogs.md)
- [getProperty](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/device-methods/getproperty.md)
- [getUserInput](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/device-methods/getuserinput.md)
- [abortGetUserInput](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/device-methods/abortgetuserinput.md)
- [getUserSelection](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/device-methods/getuserselection.md)
- [abortGetUserSelection](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/device-methods/abortgetuserselection.md)
- [showAnimation](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/device-methods/showanimation.md)
- [hideAnimation](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/device-methods/hideanimation.md)
- [displaySwipeCard](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/device-methods/displayswipecard.md)
- [abortSwipe](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/device-methods/abortswipe.md)
- [displayQR](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/device-methods/displayqr.md)
- [abortDisplayQR](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/device-methods/abortdisplayqr.md)
- [abortDisplay](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/device-methods/abortdisplay.md)
- [sendGeneralEvent](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/device-methods/sendgeneralevent.md)
- [readCardForExternalTransaction](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/device-methods/readcardforexternaltransaction.md): Read card data from the device for authorization by an external payment processor.
- [updatePinpadTransactionStatus](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/device-methods/updatepinpadtransactionstatus.md): Report the outcome of an externally authorized transaction back to the device.
- [getLocation](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/device-methods/getlocation.md): Get the device's GPS location for location-based terminal features.

##### Additional Resources

- [Additional Resources](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/additional-resources/tweezercomm-additional-resources.md)
- [Certification & Testing](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/additional-resources/certification-files.md)
- [Response Codes](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/additional-resources/response-codes.md)
- [Configure Static IP](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/additional-resources/configuring-static-ip.md)
- [Test Terminal Setup](https://devzone.nayax.com/docs/integrate-pos-device/tweezercomm/additional-resources/using-test-cards-real-cards-during-the-integration.md)

### EMV Core

#### EMV Core Guides

- [Overview](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/overview.md)
- [Integration Process](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/get-started/emv-core-integration-process.md): A step-by-step guide to integrating with Nayax

#### Android & Linux SDK

- [Get Started](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/get-started/emv-core-get-started-1.md)
- [Obtain Your Device ID](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/get-started/emv-core-device-id.md)
- [Configuration Parameters](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/emv-core-configuration.md)

##### Installation

- [Android SDK Installation](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/get-started/emv-core-android-installation.md)
- [Linux SDK Installation](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/get-started/emv-core-linux-installation.md)

##### Payment Flows

- [Payment Flows](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/payment-flows/transaction-flow.md)
- [Payment with Pre-Authorization](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/payment-flows/payment-with-authorization.md)
- [Closed Loop Transaction](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/payment-flows/closed-loop-transaction.md)
- [Single Step Payment](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/payment-flows/single-step-payment.md)
- [Pre-Authorization with External Settlement](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/payment-flows/pre-authorization-with-external-settlement.md)

##### SDK Methods & Functions

- [SDK Methods & Functions](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/sdk-methods-functions/emv-core-apis.md)
- [Payment](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/sdk-methods-functions/payment-1.md)
- [Remote Management](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/sdk-methods-functions/remote-management.md)
- [Event Callbacks](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/sdk-methods-functions/event-callbacks.md)
- [Reader Messages](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/sdk-methods-functions/reader-messages.md)

##### Demo Applications

- [Demo Applications](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/demo-applications/emv-core-demo-applications.md)
- [Android App](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/demo-applications/android-demo-application.md)
- [Linux App](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/demo-applications/linux-demo-application.md)

#### RTOS SDK

- [Overview](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/rtos/rtos-overview.md)
- [Get Started](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/rtos/rtos-get-started.md)
- [Platform Porting](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/rtos/rtos-platform-porting.md)
- [Integration Guide](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/rtos/rtos-integration-guide.md)
- [Linux Sample Application](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/rtos/rtos-linux-sample-app.md)
- [Configuration File Reference](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/rtos/rtos-configuration.md)
- [Firmware & Configuration Updates](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/rtos/rtos-firmware-updates.md)
- [Error Handling & Troubleshooting](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/rtos/rtos-troubleshooting.md)

##### API Reference

- [C API Reference](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/rtos/rtos-c-api.md)
- [JSON-RPC API](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/rtos/rtos-json-rpc-api.md)
- [Datalink Layer](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/rtos/rtos-datalink-layer.md)

#### UNO-mini Hardware

- [UNO-mini Overview](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/uno-mini/uno-mini-overview.md): Hardware overview and specifications for the Nayax UNO-mini contactless EMV reader.
- [Mechanical Integration](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/uno-mini/uno-mini-mechanical.md): Mounting guidelines and serial number display requirements for the UNO-mini.
- [User Interface Requirements](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/uno-mini/uno-mini-user-interface.md): EMV logo placement, card scheme branding, and LED and audio requirements for UNO-mini integrations.
- [Power Supply](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/uno-mini/uno-mini-power-supply.md): Power requirements, wiring recommendations, and reset recovery procedure for the UNO-mini.
- [Connection Interfaces](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/uno-mini/uno-mini-connections.md): Connector pinout, USB 2.0, and UART TTL connection specifications for the UNO-mini.

#### EMV Core Release Notes

- [EMV Core Android & Linux SDK Release Notes](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/emv-core-android-linux-release-notes.md): Track EMV Core Android & Linux SDK changes as they ship.
- [EMV Core RTOS SDK Release Notes](https://devzone.nayax.com/docs/integrate-pos-device/emv-core/emv-core-rtos-release-notes.md): Track EMV Core RTOS SDK changes as they ship.

### Spark

#### Spark Guides

- [Overview](https://devzone.nayax.com/docs/integrate-pos-device/spark/spark.md)
- [Integration Process](https://devzone.nayax.com/docs/integrate-pos-device/spark/spark-integration-process.md): A step-by-step guide to integrating with Nayax
- [Spark Network Requirements](https://devzone.nayax.com/docs/integrate-pos-device/spark/spark-network-requirement.md): Ports, IP addresses, and connection methods to whitelist so Spark terminals can reach Nayax.

##### Security & Authentication

- [Security & Authentication](https://devzone.nayax.com/docs/integrate-pos-device/spark/security-authentication/index.md)
- [Authentication](https://devzone.nayax.com/docs/integrate-pos-device/spark/security-authentication/spark-authentication.md)
- [Legacy Authentication](https://devzone.nayax.com/docs/integrate-pos-device/spark/security-authentication/spark-legacy-authentication.md)
- [Interactive Authentication Tool](https://devzone.nayax.com/docs/integrate-pos-device/spark/security-authentication/spark-auth-tool.md)

##### Payment Flows

- [Payment Flows](https://devzone.nayax.com/docs/integrate-pos-device/spark/payment-flows/transaction-flows-spark.md)
- [Device Start](https://devzone.nayax.com/docs/integrate-pos-device/spark/payment-flows/spark-device-start.md)
- [Remote Start](https://devzone.nayax.com/docs/integrate-pos-device/spark/payment-flows/spark-remote-start.md)
- [Device Stop](https://devzone.nayax.com/docs/integrate-pos-device/spark/payment-flows/spark-device-stop.md)
- [External Settlement](https://devzone.nayax.com/docs/integrate-pos-device/spark/payment-flows/external-settlement.md)
- [External Cancel](https://devzone.nayax.com/docs/integrate-pos-device/spark/payment-flows/external-cancel.md)

##### Machine Configuration

- [Machine Configuration Overview](https://devzone.nayax.com/docs/integrate-pos-device/spark/machine-configuration/index.md): Set up your Operator and machine in Nayax Core before configuring a Spark feature, including device firmware requirements and provider association.
- [Remote Start Configuration](https://devzone.nayax.com/docs/integrate-pos-device/spark/machine-configuration/spark-remote-start-configuration.md): Configure a machine in Nayax Core to support the Spark Remote Start feature, where your server starts transactions on the terminal remotely.
- [Device Start Configuration](https://devzone.nayax.com/docs/integrate-pos-device/spark/machine-configuration/spark-device-start-configuration.md): Configure a machine in Nayax Core to support Spark Device Start, for a single service station or for two to six service stations.
- [Device Stop Configuration](https://devzone.nayax.com/docs/integrate-pos-device/spark/machine-configuration/spark-device-stop-configuration.md): Configure a machine in Nayax Core to support Spark Device Stop alongside the Remote Start or Device Start feature.
- [External Settlement Configuration](https://devzone.nayax.com/docs/integrate-pos-device/spark/machine-configuration/spark-external-settlement-configuration.md): Configure a machine in Nayax Core to support Spark External Settlement, where a server settles or cancels a terminal-authorized transaction.
- [Additional Features](https://devzone.nayax.com/docs/integrate-pos-device/spark/machine-configuration/additional-features.md): Optional Nayax Core settings for Spark machines, including POS display timeouts, idle mode images, Auto Cancel, and eReceipt.

##### Webhook Callbacks

- [Webhook Callbacks](https://devzone.nayax.com/docs/integrate-pos-device/spark/webhook-callbacks/index.md)
- [TransactionCallback](https://devzone.nayax.com/docs/integrate-pos-device/spark/webhook-callbacks/transactioncallback.md)
- [StopCallback](https://devzone.nayax.com/docs/integrate-pos-device/spark/webhook-callbacks/stopcallback.md)
- [TimeoutCallback](https://devzone.nayax.com/docs/integrate-pos-device/spark/webhook-callbacks/timeoutcallback.md)
- [DeclineCallback](https://devzone.nayax.com/docs/integrate-pos-device/spark/webhook-callbacks/declinecallback.md)

##### Additional Resources

- [Additional Resources](https://devzone.nayax.com/docs/integrate-pos-device/spark/additional-resources/index.md)
- [Closed Loop Card Support](https://devzone.nayax.com/docs/integrate-pos-device/spark/additional-resources/smc-support.md)
- [PosDisplay Format](https://devzone.nayax.com/docs/integrate-pos-device/spark/additional-resources/spark-posdisplay-format.md)
- [eReceiptData Format](https://devzone.nayax.com/docs/integrate-pos-device/spark/additional-resources/spark-ereceiptdata-format.md)
- [Response Codes](https://devzone.nayax.com/docs/integrate-pos-device/spark/additional-resources/spark-response-codes.md)

##### Sample Codes

- [Authentication Code Sample](https://devzone.nayax.com/docs/integrate-pos-device/spark/sample-codes/spark-authentication-code-sample.md)

#### API Reference

##### Transactions

- [Get Version](https://devzone.nayax.com/reference/spark/transactions/get-version.md)
- [ExternalCancel](https://devzone.nayax.com/reference/spark/transactions/externalcancel.md)
- [ExternalSettlement](https://devzone.nayax.com/reference/spark/transactions/externalsettlement.md)
- [StartAuthentication](https://devzone.nayax.com/reference/spark/transactions/startauthentication.md)
- [StartSession](https://devzone.nayax.com/reference/spark/transactions/startsession.md)
- [TriggerTransaction](https://devzone.nayax.com/reference/spark/transactions/triggertransaction.md)
- [TransactionCallback](https://devzone.nayax.com/reference/spark/transactions/transactioncallback.md)
- [TransactionNotify](https://devzone.nayax.com/reference/spark/transactions/transactionnotify.md)
- [Settlement](https://devzone.nayax.com/reference/spark/transactions/settlement.md)
- [TimeoutCallback](https://devzone.nayax.com/reference/spark/transactions/timeoutcallback.md)
- [CancelTransaction](https://devzone.nayax.com/reference/spark/transactions/canceltransaction.md)
- [StopNotify](https://devzone.nayax.com/reference/spark/transactions/stopnotify.md)
- [AvailabilityCheck](https://devzone.nayax.com/reference/spark/transactions/availabilitycheck.md)
- [StopCallback](https://devzone.nayax.com/reference/spark/transactions/stopcallback.md)
- [DeclineCallback](https://devzone.nayax.com/reference/spark/transactions/declinecallback.md)
- [InfoQuery](https://devzone.nayax.com/reference/spark/transactions/infoquery.md)

## OpenAPI Specs

- [spark](/openapi/spark.yaml)