Charger Operations API (v1)

Download OpenAPI specification:Download

The Charger Operations API provides control over Charging Stations, charging sessions ("Transactions"), and their power consumption.

Transactions, where the EV driver has plugged in the charging cable, can be authorized with the Start Transaction endpoint. An ongoing transaction can remotely be stopped with the Stop Transction endpoint.

Charging Stations status can be remotely managed, such as with the Change Availability of Connector and Restart Charging Station endpoints.

Power use of the Charging Stations can be controlled with the Power Limit-endpoints on a Charging Station, Connector and Transaction level. For further control and scheduling power use, you may pass in OCPP 2.0.1-compliant Smart Charging Profiles with the Smart Charging Profile-endpoints. For controlling power usage of Locations with multiple Charging Stations, please see the Load Balancing API.

Smart Charging Profiles

Update Charging Profile for a Charging Station

put/chargingStations/{stationId}/chargingProfile

Push a charging profile to a specific charging station. The charging profile, as according to OCPP 2.0.1, dictates the power allocation to the station over time, enabling smart charging and energy management capabilities.

SecuritybearerAuth
Request
path Parameters
stationId
required
string
query Parameters
comment
string

Add a meta comment to the charging plan

Request Body schema: application/json
required
required
object (ChargingProfile)
chargingProfileKind
required
string (ChargingProfileKindEnumType)

Charging_ Profile. Charging_ Profile_ Kind. Charging_ Profile_ Kind_ Code urn:x-oca:ocpp:uid:1:569232 Indicates the kind of schedule.

Enum: "Absolute" "Recurring" "Relative"
chargingProfilePurpose
required
string (ChargingProfilePurposeEnumType_2)

Charging_ Profile. Charging_ Profile_ Purpose. Charging_ Profile_ Purpose_ Code urn:x-oca:ocpp:uid:1:569231 Defines the purpose of the schedule transferred by this profile

Enum: "ChargingStationExternalConstraints" "ChargingStationMaxProfile" "TxDefaultProfile" "TxProfile"
required
Array of objects (ChargingScheduleType)
object (ChargingProfileConditions)

Additional conditions that should be met for this profile to be considered valid. (non standard fields, Kempower specific)

object (CustomDataType_2)

This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.

id
required
number

Identified_ Object. MRID. Numeric_ Identifier urn:x-enexis:ecdm:uid:1:569198 Id of ChargingProfile.

object (ChargingProfileMeta)

Metadata about the charging profile

recurrencyKind
string (RecurrencyKindEnumType)

Charging_ Profile. Recurrency_ Kind. Recurrency_ Kind_ Code urn:x-oca:ocpp:uid:1:569233 Indicates the start point of a recurrence.

Enum: "Daily" "Weekly"
stackLevel
required
number

Charging_ Profile. Stack_ Level. Counter urn:x-oca:ocpp:uid:1:569230 Value determining level in hierarchy stack of profiles. Higher values have precedence over lower values. Lowest level is 0.

transactionId
string

SHALL only be included if ChargingProfilePurpose is set to TxProfile. The transactionId is used to match the profile to a specific transaction.

validFrom
string

Charging_ Profile. Valid_ From. Date_ Time urn:x-oca:ocpp:uid:1:569234 Point in time at which the profile starts to be valid. If absent, the profile is valid as soon as it is received by the Charging Station.

validTo
string

Charging_ Profile. Valid_ To. Date_ Time urn:x-oca:ocpp:uid:1:569235 Point in time at which the profile stops to be valid. If absent, the profile is valid until it is replaced by another profile.

Responses
200

OK

Response Schema: application/json
response
required
string (ChargingProfileStatusEnumType)

Returns whether the Charging Station has been able to process the message successfully. This does not guarantee the schedule will be followed to the letter. There might be other constraints the Charging Station may need to take into account.

Enum: "Accepted" "Rejected"
object (StatusInfoType_2)

Element providing more information about the status.

additionalInfo
string

Additional text to provide detailed information.

object (CustomDataType_4)

This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.

reasonCode
required
string

A predefined code for the reason why the status is returned in this response. The string is case-insensitive.

401

Unauthorized - Authorization: Bearer header is missing, invalid, expired, or user has no permission

Request samples
application/json
{
  • "chargingProfile": {
    }
}
Response samples
application/json
{
  • "response": "Accepted",
  • "statusInfo": {
    }
}

Delete a Charging Profile

post/chargingStations/{stationId}/chargingProfile/clear

Remove a charging profile or multiple matching charging profiles, on a specific charging station, resetting its power management to a default state.

SecuritybearerAuth
Request
path Parameters
stationId
required
string
Request Body schema: application/json
required
object (ClearChargingProfileType)

Charging_ Profile urn:x-oca:ocpp:uid:2:233255 A ChargingProfile consists of a ChargingSchedule, describing the amount of power or current that can be delivered per time interval.

chargingProfilePurpose
string (ChargingProfilePurposeEnumType)

Charging_ Profile. Charging_ Profile_ Purpose. Charging_ Profile_ Purpose_ Code urn:x-oca:ocpp:uid:1:569231 Specifies to purpose of the charging profiles that will be cleared, if they meet the other criteria in the request.

Enum: "ChargingStationExternalConstraints" "ChargingStationMaxProfile" "TxDefaultProfile" "TxProfile"
object (CustomDataType)

This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.

evseId
number

Identified_ Object. MRID. Numeric_ Identifier urn:x-enexis:ecdm:uid:1:569198 Specifies the id of the EVSE for which to clear charging profiles. An evseId of zero (0) specifies the charging profile for the overall Charging Station. Absence of this parameter means the clearing applies to all charging profiles that match the other criteria in the request.

stackLevel
number

Charging_ Profile. Stack_ Level. Counter urn:x-oca:ocpp:uid:1:569230 Specifies the stackLevel for which charging profiles will be cleared, if they meet the other criteria in the request.

chargingProfileId
number
Responses
200

OK

Response Schema: application/json
response
required
string (ClearChargingProfileStatusEnumType)

Indicates if the Charging Station was able to execute the request.

Enum: "Accepted" "Unknown"
object (StatusInfoType)

Element providing more information about the status.

additionalInfo
string

Additional text to provide detailed information.

object (CustomDataType_1)

This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.

reasonCode
required
string

A predefined code for the reason why the status is returned in this response. The string is case-insensitive.

401

Unauthorized - Authorization: Bearer header is missing, invalid, expired, or user has no permission

Request samples
application/json
{
  • "chargingProfileCriteria": {
    },
  • "chargingProfileId": 0
}
Response samples
application/json
{
  • "response": "Accepted",
  • "statusInfo": {
    }
}

Update Charging Profile for a Connector

put/chargingStations/{stationId}/evses/{evseId}/chargingProfile

Push a charging profile to a specific charging station's connector (evseId). The charging profile, as according to OCPP 2.0.1, dictates the power allocation to the station over time, enabling smart charging and energy management capabilities.

SecuritybearerAuth
Request
path Parameters
stationId
required
string
evseId
required
string
query Parameters
comment
string

Add a meta comment to the charging plan

Request Body schema: application/json
required
required
object (ChargingProfile)
chargingProfileKind
required
string (ChargingProfileKindEnumType)

Charging_ Profile. Charging_ Profile_ Kind. Charging_ Profile_ Kind_ Code urn:x-oca:ocpp:uid:1:569232 Indicates the kind of schedule.

Enum: "Absolute" "Recurring" "Relative"
chargingProfilePurpose
required
string (ChargingProfilePurposeEnumType_2)

Charging_ Profile. Charging_ Profile_ Purpose. Charging_ Profile_ Purpose_ Code urn:x-oca:ocpp:uid:1:569231 Defines the purpose of the schedule transferred by this profile

Enum: "ChargingStationExternalConstraints" "ChargingStationMaxProfile" "TxDefaultProfile" "TxProfile"
required
Array of objects (ChargingScheduleType)
object (ChargingProfileConditions)

Additional conditions that should be met for this profile to be considered valid. (non standard fields, Kempower specific)

object (CustomDataType_2)

This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.

id
required
number

Identified_ Object. MRID. Numeric_ Identifier urn:x-enexis:ecdm:uid:1:569198 Id of ChargingProfile.

object (ChargingProfileMeta)

Metadata about the charging profile

recurrencyKind
string (RecurrencyKindEnumType)

Charging_ Profile. Recurrency_ Kind. Recurrency_ Kind_ Code urn:x-oca:ocpp:uid:1:569233 Indicates the start point of a recurrence.

Enum: "Daily" "Weekly"
stackLevel
required
number

Charging_ Profile. Stack_ Level. Counter urn:x-oca:ocpp:uid:1:569230 Value determining level in hierarchy stack of profiles. Higher values have precedence over lower values. Lowest level is 0.

transactionId
string

SHALL only be included if ChargingProfilePurpose is set to TxProfile. The transactionId is used to match the profile to a specific transaction.

validFrom
string

Charging_ Profile. Valid_ From. Date_ Time urn:x-oca:ocpp:uid:1:569234 Point in time at which the profile starts to be valid. If absent, the profile is valid as soon as it is received by the Charging Station.

validTo
string

Charging_ Profile. Valid_ To. Date_ Time urn:x-oca:ocpp:uid:1:569235 Point in time at which the profile stops to be valid. If absent, the profile is valid until it is replaced by another profile.

Responses
200

OK

Response Schema: application/json
response
required
string (ChargingProfileStatusEnumType)

Returns whether the Charging Station has been able to process the message successfully. This does not guarantee the schedule will be followed to the letter. There might be other constraints the Charging Station may need to take into account.

Enum: "Accepted" "Rejected"
object (StatusInfoType_2)

Element providing more information about the status.

additionalInfo
string

Additional text to provide detailed information.

object (CustomDataType_4)

This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.

reasonCode
required
string

A predefined code for the reason why the status is returned in this response. The string is case-insensitive.

401

Unauthorized - Authorization: Bearer header is missing, invalid, expired, or user has no permission

Request samples
application/json
{
  • "chargingProfile": {
    }
}
Response samples
application/json
{
  • "response": "Accepted",
  • "statusInfo": {
    }
}

Charging Station Control

Change Availability of a Connector

put/chargingStations/{stationId}/evses/{evseId}/availability

Change the status of a specific connector in a charging station. It allows the operator to enable or disable a particular connector for charging.

SecuritybearerAuth
Request
path Parameters
stationId
required
string
evseId
required
string
Request Body schema: application/json
required
disableTextReason
string
type
required
string
Enum: "Inoperative" "Operative"
Responses
200

OK

Response Schema: application/json
responseFromStation
required
string
Enum: "Accepted" "Rejected" "Scheduled"
401

Unauthorized - Authorization: Bearer header is missing, invalid, expired, or user has no permission

Request samples
application/json
{
  • "disableTextReason": "string",
  • "type": "Inoperative"
}
Response samples
application/json
{
  • "responseFromStation": "Accepted"
}

Restart a Charging Station

post/chargingStations/{stationId}/restart

Remotely reboot a specific charging station. Useful for maintenance, updates, or resolving operational issues without onsite intervention.

SecuritybearerAuth
Request
path Parameters
stationId
required
string
Request Body schema: application/json
required
type
required
string

How to perform the restart?

  • Immediate: Immediate reset of the Charging Station
  • OnIdle: Delay reset until no more transactions are active
Enum: "Immediate" "OnIdle"
Responses
200

OK

Response Schema: application/json
responseFromStation
required
string
  • Accepted: Command will be executed.
  • Rejected: Command will not be executed.
  • Scheduled: Reset command is scheduled, Charging Station is busy with a process that cannot be interrupted at the moment. Reset will be executed when process is finished.
Enum: "Accepted" "Rejected" "Scheduled"
401

Unauthorized - Authorization: Bearer header is missing, invalid, expired, or user has no permission

Request samples
application/json
{
  • "type": "Immediate"
}
Response samples
application/json
{
  • "responseFromStation": "Accepted"
}

Power Limits

Update the Power Limit for a Connector

put/chargingStations/{stationId}/evses/{evseId}/powerLimit

Set the power limit for a specific Connector (evseId), controlling the maximum power it can draw during charging sessions. This aids in energy management and load balancing.

The power limit will be taken into effect typically within a few seconds.

SecuritybearerAuth
Request
path Parameters
stationId
required
string
evseId
required
string
query Parameters
chargingProfileId
number

Override charging profile ID. Unique within the charger. Defaults to 3000-5282 depending on options.

comment
string

Add a meta comment to the charging plan

condition
string

Special condition which must match for this power limit to be active.

relativeDelay
number

If given, this power limit will not take place immediately, but only after this many seconds after charging started. May be used with or without the `condition' option. Number given in seconds.

stackLevel
number

Priority - higher the number, the higher the number. Defaults to 0 (except 1000 if there is a condition)

Request Body schema: application/json
required
required
object
acMaxPowerA
number

Maximum AC current draw

acMaxPowerKw
number

Maximum AC power draw

dcMaxPowerKw
number

Maximum DC charging power

Responses
200

OK

Response Schema: application/json
response
required
string (ChargingProfileStatusEnumType)

Returns whether the Charging Station has been able to process the message successfully. This does not guarantee the schedule will be followed to the letter. There might be other constraints the Charging Station may need to take into account.

Enum: "Accepted" "Rejected"
object (StatusInfoType)

Element providing more information about the status.

additionalInfo
string

Additional text to provide detailed information.

object (CustomDataType_1)

This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.

reasonCode
required
string

A predefined code for the reason why the status is returned in this response. The string is case-insensitive.

401

Unauthorized - Authorization: Bearer header is missing, invalid, expired, or user has no permission

Request samples
application/json
{
  • "limit": {
    }
}
Response samples
application/json
{
  • "response": "Accepted",
  • "statusInfo": {
    }
}

Delete the Power Limit for a Connector

delete/chargingStations/{stationId}/evses/{evseId}/powerLimit

Remove the power limit on a specific charging station's connector (evseId), resetting its power management to a default state.

SecuritybearerAuth
Request
path Parameters
stationId
required
string
evseId
required
string
Responses
200

OK

Response Schema: application/json
response
required
string (ClearChargingProfileStatusEnumType)

Indicates if the Charging Station was able to execute the request.

Enum: "Accepted" "Unknown"
object (StatusInfoType)

Element providing more information about the status.

additionalInfo
string

Additional text to provide detailed information.

object (CustomDataType_1)

This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.

reasonCode
required
string

A predefined code for the reason why the status is returned in this response. The string is case-insensitive.

401

Unauthorized - Authorization: Bearer header is missing, invalid, expired, or user has no permission

Request samples 
Response samples 
application/json
{
  • "response": "Accepted",
  • "statusInfo": {
    }
}
Update the Power Limit for a Charging Station
put/chargingStations/{stationId}/powerLimit
Set the power limit for a specific Charging Station, controlling the maximum power
it can draw during charging sessions. This aids in energy management and load balancing.
The available power will be distributed amongst all active charging sessions.


The power limit will be taken into effect typically within a few seconds.


SecuritybearerAuth 
Request 
path Parameters
stationId
required
string
 
query Parameters
chargingProfileId
number
Override charging profile ID. Unique within the charger.
Defaults to 3000-5282 depending on options.


 
comment
string
Add a meta comment to the charging plan


 
condition
string
Special condition which must match for this power limit to be active.


 
relativeDelay
number
If given, this power limit will not take place immediately, but only after this many seconds after charging started.
May be used with or without the `condition' option.
Number given in seconds.


 
stackLevel
number
Priority - higher the number, the higher the number. Defaults to 0 (except 1000 if there is a condition)


 
Request Body schema: application/json
required
required
object
 
acMaxPowerA
number
Maximum AC current draw


 
acMaxPowerKw
number
Maximum AC power draw


 
dcMaxPowerKw
number
Maximum DC charging power


 
Responses 
200
OK


Response Schema: application/json
response
required
string (ChargingProfileStatusEnumType) 
Returns whether the Charging Station has been able to process the message successfully. This does not guarantee the schedule will be followed to the letter. There might be other constraints the Charging Station may need to take into account.


 Enum: "Accepted" "Rejected"  
object (StatusInfoType) 
Element providing more information about the status.


 
additionalInfo
string
Additional text to provide detailed information.


 
object (CustomDataType_1) 
This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.


 
reasonCode
required
string
A predefined code for the reason why the status is returned in this response. The string is case-insensitive.


 
401
Unauthorized - Authorization: Bearer header is missing, invalid, expired, or user has no permission


Request samples 
application/json
{
  • "limit": {
    }
}
Response samples 
application/json
{
  • "response": "Accepted",
  • "statusInfo": {
    }
}
Delete the Power Limit for a Charging Station
delete/chargingStations/{stationId}/powerLimit
Remove the power limit on a specific charging station,
resetting its power management to a default state.


SecuritybearerAuth 
Request 
path Parameters
stationId
required
string
 
Responses 
200
OK


Response Schema: application/json
response
required
string (ClearChargingProfileStatusEnumType) 
Indicates if the Charging Station was able to execute the request.


 Enum: "Accepted" "Unknown"  
object (StatusInfoType) 
Element providing more information about the status.


 
additionalInfo
string
Additional text to provide detailed information.


 
object (CustomDataType_1) 
This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.


 
reasonCode
required
string
A predefined code for the reason why the status is returned in this response. The string is case-insensitive.


 
401
Unauthorized - Authorization: Bearer header is missing, invalid, expired, or user has no permission


Request samples 
Response samples 
application/json
{
  • "response": "Accepted",
  • "statusInfo": {
    }
}
Update the Power Limit for a Transaction
put/transactions/{txId}/powerLimit
Set the power limit for a specific Transaction, controlling the maximum power
it can draw during charging. This aids in energy management and load balancing.


The power limit will be taken into effect typically within a few seconds.


SecuritybearerAuth 
Request 
path Parameters
txId
required
string
 
query Parameters
chargingProfileId
number
Override charging profile ID. Unique within the charger.
Defaults to 3000-5282 depending on options.


 
comment
string
Add a meta comment to the charging plan


 
condition
string
Special condition which must match for this power limit to be active.


 
relativeDelay
number
If given, this power limit will not take place immediately, but only after this many seconds after charging started.
May be used with or without the `condition' option.
Number given in seconds.


 
stackLevel
number
Priority - higher the number, the higher the number. Defaults to 0 (except 1000 if there is a condition)


 
Request Body schema: application/json
required
required
object
 
acMaxPowerA
number
Maximum AC current draw


 
acMaxPowerKw
number
Maximum AC power draw


 
dcMaxPowerKw
number
Maximum DC charging power


 
Responses 
200
OK


Response Schema: application/json
response
required
string (ChargingProfileStatusEnumType) 
Returns whether the Charging Station has been able to process the message successfully. This does not guarantee the schedule will be followed to the letter. There might be other constraints the Charging Station may need to take into account.


 Enum: "Accepted" "Rejected"  
object (StatusInfoType) 
Element providing more information about the status.


 
additionalInfo
string
Additional text to provide detailed information.


 
object (CustomDataType_1) 
This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.


 
reasonCode
required
string
A predefined code for the reason why the status is returned in this response. The string is case-insensitive.


 
401
Unauthorized - Authorization: Bearer header is missing, invalid, expired, or user has no permission


Request samples 
application/json
{
  • "limit": {
    }
}
Response samples 
application/json
{
  • "response": "Accepted",
  • "statusInfo": {
    }
}
Delete the Power Limit for a Transaction
delete/transactions/{txId}/powerLimit
Remove the power limit on a specific transaction,
resetting its power management to a default state.


SecuritybearerAuth 
Request 
path Parameters
txId
required
string
 
Responses 
200
OK


Response Schema: application/json
response
required
string (ClearChargingProfileStatusEnumType) 
Indicates if the Charging Station was able to execute the request.


 Enum: "Accepted" "Unknown"  
object (StatusInfoType) 
Element providing more information about the status.


 
additionalInfo
string
Additional text to provide detailed information.


 
object (CustomDataType_1) 
This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.


 
reasonCode
required
string
A predefined code for the reason why the status is returned in this response. The string is case-insensitive.


 
401
Unauthorized - Authorization: Bearer header is missing, invalid, expired, or user has no permission


Request samples 
Response samples 
application/json
{
  • "response": "Accepted",
  • "statusInfo": {
    }
}
Transaction Control
Start Transaction
post/chargingStations/{stationId}/evses/{evseId}/start
Authorize or restart a charging session on a specific charging station's connector.
Used usually after (payment) has been authorized to allow the charging to start.


May be used to re-start a stopped charging session.
Note that in DC charging, not all passenger cars support restarting the charging
without unplugging and plugging in the cable again - it is more widely supported with commercial vehicles.


SecuritybearerAuth 
Request 
path Parameters
stationId
required
string
 
evseId
required
string
 
Request Body schema: application/json
required
authorizationReference
string or null
Reference to the authorization given by an external party, will be attached to the session


 
object (ChargingProfileType) 
Charging_ Profile
urn:x-oca:ocpp:uid:2:233255
A ChargingProfile consists of ChargingSchedule, describing the amount of power or current that can be delivered per time interval.


 
chargingProfileKind
required
string (ChargingProfileKindEnumType) 
Charging_ Profile. Charging_ Profile_ Kind. Charging_ Profile_ Kind_ Code
urn:x-oca:ocpp:uid:1:569232
Indicates the kind of schedule.


 Enum: "Absolute" "Recurring" "Relative"  
chargingProfilePurpose
required
string (ChargingProfilePurposeEnumType_2) 
Charging_ Profile. Charging_ Profile_ Purpose. Charging_ Profile_ Purpose_ Code
urn:x-oca:ocpp:uid:1:569231
Defines the purpose of the schedule transferred by this profile


 Enum: "ChargingStationExternalConstraints" "ChargingStationMaxProfile" "TxDefaultProfile" "TxProfile"  
required
Array of objects (ChargingScheduleType) 
 
object (CustomDataType_2) 
This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.


 
id
required
number
Identified_ Object. MRID. Numeric_ Identifier
urn:x-enexis:ecdm:uid:1:569198
Id of ChargingProfile.


 
recurrencyKind
string (RecurrencyKindEnumType) 
Charging_ Profile. Recurrency_ Kind. Recurrency_ Kind_ Code
urn:x-oca:ocpp:uid:1:569233
Indicates the start point of a recurrence.


 Enum: "Daily" "Weekly"  
stackLevel
required
number
Charging_ Profile. Stack_ Level. Counter
urn:x-oca:ocpp:uid:1:569230
Value determining level in hierarchy stack of profiles. Higher values have precedence over lower values. Lowest level is 0.


 
transactionId
string
SHALL only be included if ChargingProfilePurpose is set to TxProfile. The transactionId is used to match the profile to a specific transaction.


 
validFrom
string
Charging_ Profile. Valid_ From. Date_ Time
urn:x-oca:ocpp:uid:1:569234
Point in time at which the profile starts to be valid. If absent, the profile is valid as soon as it is received by the Charging Station.


 
validTo
string
Charging_ Profile. Valid_ To. Date_ Time
urn:x-oca:ocpp:uid:1:569235
Point in time at which the profile stops to be valid. If absent, the profile is valid until it is replaced by another profile.


 
contractId
string
Uniquely identifies the EV Driver contract token within the eMSP’s platform (and
suboperator platforms). Recommended to follow the specification for eMA ID
from "eMI3 standard version V1.0" (http://emi3group.com/documents-links/)
"Part 2: business objects."


Passed in by external party in OCPI command (StartSession).


 
emspCountryCode
string
Country code of related eMSP (OCPI)
Source: 'OCPI-from-country-code'-routing header


 
emspPartyId
string
Party id of related eMSP (OCPI)
Source: 'OCPI-from-party-id'-routing header


 
idToken
string or null
Token the Charge Point has to use to start a new session


 
idTokenIssuer
string or null
 
idTokenType
string (IdTokenType) 
 Enum: "AD_HOC_USER" "APP_USER" "OTHER" "RFID"  
ocpiConnectionProfileId
string
ID of the ocpiConnectionProfile used when remote starting via ocpi.
Source: authtoken.sub


 
object or null
Vehicle identification from an external source


 
make
string or null
 
model
string or null
 
Responses 
200
OK


Response Schema: application/json
required
object (RequestStartTransactionResponse) 
 
status
required
string
 Enum: "Accepted" "Rejected"  
transactionId
string
 
property name*
additional property
any
 
401
Unauthorized - Authorization: Bearer header is missing, invalid, expired, or user has no permission


Request samples 
application/json
{ }
Response samples 
application/json
{
  • "transactionStartResponse": {
    }
}
Stop Transaction
post/transactions/{txId}/stop
Remotely stop an ongoing charging session ("transaction"),
allowing operators or users to end a charging session as needed.


SecuritybearerAuth 
Request 
path Parameters
txId
required
string
 
query Parameters
comment
string
Comment on why transaction is being stopped


 
Responses 
200
OK


Response Schema: application/json
required
object (RequestStopTransactionResponse) 
 
status
required
string
 Enum: "Accepted" "Rejected"  
property name*
additional property
any
 
401
Unauthorized - Authorization: Bearer header is missing, invalid, expired, or user has no permission


Request samples 
Response samples 
application/json
{
  • "transactionStopResponse": {
    }
}