> ## Documentation Index
> Fetch the complete documentation index at: https://devzone.nayax.com/llms.txt
> Use this file to discover all available pages before exploring further.

# StopNotify

The `StopNotify` endpoint enables Spark to determine whether a card
presented at the payment terminal while idle is authorized to stop an
ongoing session.

A matching card should result in an `Approved`
response; otherwise, the Spark integrator should return a `Declined`
verdict.


## OpenAPI

````yaml /openapi/spark.yaml post /StopNotify
openapi: 3.0.1
info:
  title: Nayax Spark API
  description: RemoteStart V2
  version: v2
servers:
  - url: https://{domain}/api
    variables:
      domain:
        default: nayax-spark-dmz.nayax.com
        description: >-
          Your Nayax-assigned domain (e.g., nayax-spark-dmz.nayax.com). Nayax
          provides a QA domain during sandbox onboarding and a production domain
          after certification.
security: []
tags:
  - name: Transactions
paths:
  /StopNotify:
    post:
      tags:
        - Transactions
      summary: StopNotify
      requestBody:
        description: >-
          The request payload containing card and terminal identifiers to
          validate a stop request.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopNotifyRequest'
      responses:
        '200':
          description: Success. The stop request was successfully processed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopNotifyResponse'
components:
  schemas:
    StopNotifyRequest:
      type: object
      nullable: true
      description: desc
      properties:
        StopSiteId:
          type: integer
          format: int16
          description: Indication for Nayax Engine in which Site the transaction originated
        MachineId:
          type: integer
          format: int64
          description: |
            - Length: 255
            - Unique Identifier for the Nayax Machine
        HwSerial:
          type: string
          nullable: false
          description: |
            - Length: 255
            - Unique Identifier for the Nayax Device
        CardLast4Digits:
          type: string
          nullable: true
          description: Payment card's last 4 digits
        CardHash:
          type: string
          nullable: false
        CardUid:
          type: string
          nullable: true
          description: Payment card's Unique identifier
        ServiceStationNumber:
          type: string
          nullable: true
          description: >
            - Identifies the Spark Provider’s Point of Interaction number

            - Will be provided by Nayax when the Nayax Device is configured to
            support several service points via the Nayax backoffice system
    StopNotifyResponse:
      type: object
      nullable: true
      description: >
        The response sent by the integrator to Nayax's `StopNotify` request,
        which indicates whether the card presented can be used to stop a session
        on the terminal. A `Verdict` of `"Approved"` indicates that the card
        matches an ongoing session and the flow can proceed.
      properties:
        SparkTransactionId:
          type: string
          nullable: true
          description: |
            The Spark session identifier for the matched transaction.
        NayaxTransactionId:
          type: integer
          nullable: true
          format: int64
          description: |
            The unique ID for the Nayax transaction.
        SiteId:
          type: integer
          format: int16
          description: |
            The original site ID where the transaction was initiated.
        StopSiteId:
          type: integer
          format: int16
          description: |
            The site ID where the card was presented to stop the session.
        MachineId:
          type: integer
          format: int64
          description: |
            The ID of the machine where the card was presented.
        HwSerial:
          type: string
          nullable: false
          description: |
            The serial number of the machine.
        MachineAuTime:
          type: string
          nullable: true
          description: >
            The local machine timestamp of the authorization in the format
            `yyyyMMddHHmmssSSS`.
        Status:
          $ref: '#/components/schemas/Status'
      example:
        SparkTransactionId: 12c7cec2-c690-4425-9a1f-db0db60e2d8c
        NayaxTransactionId: 2004545072
        SiteId: 2
        StopSiteId: 4
        MachineId: 71234996
        HwSerial: '0434334921100366'
        MachineAuTime: '20240205194122328'
        Status:
          Verdict: Approved
          ErrorDescription: No Errors
    Status:
      type: object
      nullable: false
      description: Transaction Status Details
      properties:
        Verdict:
          type: string
          nullable: false
          description: Status of the request (Approved / Declined)
        ErrorCode:
          type: integer
          format: int16
          nullable: true
          description: |
            - Conditional
            - Reason for declined request
        ErrorDescription:
          type: string
          nullable: true
          description: |
            - Conditional
            - Length: 255
            - Error description
        StatusMessage:
          type: string
          nullable: true
          description: |
            - Optional
            - Length: 255
            - Transaction status message as free text field

````