Stop Transaction
++++++++++++++++

.. admonition:: Description.
   :class: seealso

   Sent by the CS to end the transaction on an EVSE, for example when a time, energy or cost
   limit that the CS monitors is reached. The OCPP module stops charging the same way as for
   a remote stop, with a :doc:`stop_charging` request to the CS (or to ISO15118 during HLC),
   and reports the stop to the CSMS. The CS must answer that stop_charging request while its
   stop_transaction request is still pending.

.. jsonschema:: ../../../schemas/StopTransactionRequest.json
   :hide_key: /**/additionalProperties

Example::

    {
        "id": "4f1c2a8e-0b7d-4c3e-9a51-2d6f8e7b9c10",
        "name": "stop_transaction",
        "type": "request",
        "data": {
            "evse_id": "DE*SEV*E123456789",
            "reason": "cost_limit_reached",  # Optional, defaults to local
            "transaction_id": "7742590f745a44caba31489922ab2b56"  # Optional
        }
    }

.. jsonschema:: ../../../schemas/StopTransactionResponse.json
   :hide_key: /**/additionalProperties

Example::

    {
        "id": "4f1c2a8e-0b7d-4c3e-9a51-2d6f8e7b9c10",
        "name": "stop_transaction",
        "type": "response",
        "data": {
            "evse_id": "DE*SEV*E123456789",
            "status": "accepted",  # or rejected
            "transaction_id": "7742590f745a44caba31489922ab2b56"
        }
    }

.. admonition:: NOTE
   :class: tip

   **reason** tells the CSMS why the transaction stopped. When it is absent, the stop is
   reported as a local stop, the same as an EV Driver stopping the transaction at the
   Charging Station.

   ==================== ============================================== ==================
   reason               OCPP triggerReason                             OCPP stoppedReason
   ==================== ============================================== ==================
   local (default)      StopAuthorized                                 Local
   energy_limit_reached EnergyLimitReached                             EnergyLimitReached
   time_limit_reached   TimeLimitReached                               TimeLimitReached
   cost_limit_reached   CostLimitReached (2.1), StopAuthorized (2.0.1) LocalOutOfCredit
   soc_limit_reached    SoCLimitReached (2.1), StopAuthorized (2.0.1)  SOCLimitReached
   ==================== ============================================== ==================

   Whether the transaction ends right away depends on the configured TxStopPoint, as for a
   stop by the EV Driver: with Authorized (or PowerPathClosed) in TxStopPoint the transaction
   ends; otherwise the energy transfer is suspended and the transaction ends at the next
   configured stop point, e.g. when the cable is unplugged.

   The request is rejected when there is no ongoing transaction on the EVSE, or when
   transaction_id is given and does not match it. A rejected request leaves the transaction
   untouched.