GET Remote Reader API
    GET Remote Reader API
    • Basic Information
    • General
      • Get the configuration of the device
        GET
      • Cancel an active job
        GET
    • Status
      • Get the status of an asynchronous display operation on the device's screen (UI related)
        GET
      • Get the status of an asynchronous NFC tag interaction (NFC related)
        GET
    • POS
      • Start a job for a purchase
        POST
      • Initiate a refund job for a specific purchase
        POST
    • Ticketing
      • Start a job to swap a ticket to a NFC-tag
        POST
    • Display
      • Start a job to show information and interactive buttons on the device's UI
        POST
    • TagInfo
      • Start a job that prompts the end-user to scan an NFC tag
        POST

    Basic Information

    Introduction#

    The GET Remote Reader API enables external partners to integrate GET devices, specifically Remote-Readers (xGates), as payment terminals within their systems. It currently supports Point-of-Sale (POS) and ticketing operations.
    The Remote Reader (xGate) is a hardware device (28 x 22cm) that includes a touch display (Samsung xCover) and an NFC reader. It is powered via a PoE injector, recquiring power and network connectivity.
    As the API runs locally on the device, both the client and the GET device must be on the same network. The device's IPv4 address must be specified in the URL for communication.

    Sequence diagram#

    Screenshot 2025-02-13 155443.png
    Request-Flow of doing a purchase
    Modified at 2025-04-03 14:07:30
    Next
    Get the configuration of the device
    Built with