Get Transaction Status
Source: OCPP 2.0.1 Part 2 — Specification (Edition 2, 2022-12-15) — Section 1.27 (Messages); Use Case E14 — Check transaction status (Functional Block E. Transactions)
Overview
The CSMS sends GetTransactionStatusRequest to ask the Charging Station whether transaction-related messages are still queued for delivery. When transactionId is provided, only messages for that specific transaction are queried.
This is typically used when the CSMS is unsure whether a transaction has actually ended (e.g. after a long offline period) or wants to confirm that all TransactionEvent messages have been delivered.
Sequence Diagram
CSMS ──── GetTransactionStatusRequest ────▶ Charging Station
(transactionId?)
CSMS ◀─── GetTransactionStatusResponse ──── Charging Station
(ongoingIndicator?, messagesInQueue)
Initiator
CSMS → Charging Station
Fields
| Field Name | Field Type | Card. | Description |
|---|---|---|---|
| transactionId | identifierString [0..36] | 0..1 | Optional. Id of the transaction whose status is requested. |
| Field Name | Field Type | Card. | Description |
|---|---|---|---|
| ongoingIndicator | boolean | 0..1 | Optional. Whether the transaction is still ongoing. |
| messagesInQueue | boolean | 1..1 | Required. Whether there are still messages to be delivered. |
Examples
{
"transactionId": "tx-1234"
}{
"ongoingIndicator": false,
"messagesInQueue": true
}Schema
Source:
schemas/GetTransactionStatusRequest.json,schemas/GetTransactionStatusResponse.json(OCPP 2.0.1 FINAL)