Remote Sessions
No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.
No Road deviations in this section. Turn off the deviations filter in the sidebar to see all of its endpoints.
Remote Session Management
Start Remote Session
Start a new MSP remote session.
User sessionAPI credentialRequest bodyapplication/json
PSP_PREAUTH0https://success.payment.complete/200OK application/json
dataMspRemoteSession
activeSessionobject
Whether energy is flowing, where the charging station reports it.
CHARGINGNOT_CHARGINGSUSPENDED_EVSUSPENDED_EVSEcpomsprawRecordobject
CHARGESTATION_TIMED_OUTNOT_SUPPORTED_BY_CHARGING_STATIONNO_ACTIVE_SESSION_RECEIVEDREJECTED_BY_CHARGING_STATIONREJECTED_BY_CPOREQUESTED_BY_CUSTOMERUNKNOWN_SESSIONerrorobject
externalPaymentExternalPayment
authorizedAmountBSONMoney
capturedAmountBSONMoney
AUTHORIZEDCOMPLETEDFAILEDMISSINGPENDINGVOIDEDpayBridgelocationobject
businessReimbursecommunityReimburseemployeeReimbursenoReimbursesplitReimburseevsesobject[]
geoLocationobject
mspprivatepubliccpoeclearingocpiroad-cpo-internalmspSessionobject
AUTH_REQUESTCOMMANDWHITELISTbillingInfoBillingInfo
businessReimbursecommunityReimburseemployeeReimbursenoReimbursesplitReimbursedriverVatInfoVatRule
exactnetsuiteERP-facing counterpart of exactVatCode. Mixed in Mongo: existing documents hold both strings and numbers.
externalPaymentExternalPayment
AUTHORIZEDCOMPLETEDFAILEDMISSINGPENDINGVOIDEDpayBridgelimitSessionLimit
locationobject
operatorPlatformAuthorizationOperatorPlatformAuthorization
CHARGE_CARDSCAN_TO_PAYTAP_TO_PAYdeferredimmediateacdcmsprawRecordobject
ChargingEVConnectedIdleSuspendedEVSuspendedEVSEWhat the device sent as idTag when the paired charge card was authorised in its place.
How the paired charge card was applied at session start.
reimbursementobject
AUTHORIZED_NON_BILLABLE_RFIDEXTERNAL_PAYMENT_FAILEDEXTERNAL_PAYMENT_SOLUTIONEXTERNAL_REIMBURSEMENTHISTORICAL_ENDINVALID_SESSIONMANUAL_EXCLUSIONNO_AUTO_REIMBURSEMENTNO_COSTTEMPORARILY_EXCLUDED_WAITING_FOR_MISSING_DATAUNSPECIFIEDif funds decision comes from an external entity
Tri-state: null means the external funder has not answered yet.
When reimbursement decision comes from an external service
roamingCdrDeliveryReceiptobject
DELIVEREDFAILEDsyncobject
validityobject
DUPLICATEDFAILED_TO_STARTHIGH_ENERGY_USAGEIMPROBABLE_ENERGY_USAGEINTERNAL_TOKENINVALID_END_TIMEINVALID_START_TIMELOW_ENERGY_USAGEMAINTENANCE_TOKENMANUAL_CANCELLATIONMISSING_OR_INVALID_SESSIONNON_ACCEPTED_AUTHREPLACED_WITH_CORRECTED_SESSIONSHORT_DURATIONUNKNOWN_METER_VALUESUNSPECIFIEDvatInfoVatRule
exactnetsuiteERP-facing counterpart of exactVatCode. Mixed in Mongo: existing documents hold both strings and numbers.
AD_HOC_TOKENPSP_PREAUTHTOKENmspACTIVECANCELLEDCOMPLETEDERRORPENDINGSTARTINGSTOPPEDSTOPPINGmetaobject
400Invalid Request application/json
errorobject
401Unauthorized application/json
errorobject
404Not Found application/json
errorobject
500Internal server error application/json
errorobject
Get Preauth Limits
Returns preauth currency limits for a connector.
Path parameters3
200OK application/json
dataPreauthCurrencyLimits
The currency the limits below relate to
The amount pre-authorised when no amount is specified
The maximum amount that can be pre-authorised
The minimum amount that can be pre-authorised
metaobject
400Invalid Request application/json
errorobject
404Not Found application/json
errorobject
500Internal server error application/json
errorobject
Get Remote Sessions by Token
Get remote sessions by token ID.
User sessionAPI credentialPath parameters1
200OK application/json
dataMspRemoteSessionResource[]
errorobject
locationobject
metaobject
400Invalid Request application/json
errorobject
401Unauthorized application/json
errorobject
404Not Found application/json
errorobject
500Internal server error application/json
errorobject
Get Remote Session
Get a remote session by ID.
User sessionAPI credentialPath parameters1
200OK application/json
dataMspRemoteSessionResource
errorobject
locationobject
metaobject
400Invalid Request application/json
errorobject
401Unauthorized application/json
errorobject
404Not Found application/json
errorobject
500Internal server error application/json
errorobject
Cancel Remote Session
Cancel a pending MSP remote session.
User sessionAPI credentialPath parameters1
200OK application/json
400Invalid Request application/json
errorobject
401Unauthorized application/json
errorobject
404Not Found application/json
errorobject
500Internal server error application/json
errorobject
Stop Remote Session
Stop an active MSP remote session.
User sessionAPI credentialPath parameters1
200OK application/json
dataMspRemoteSession
activeSessionobject
Whether energy is flowing, where the charging station reports it.
CHARGINGNOT_CHARGINGSUSPENDED_EVSUSPENDED_EVSEcpomsprawRecordobject
CHARGESTATION_TIMED_OUTNOT_SUPPORTED_BY_CHARGING_STATIONNO_ACTIVE_SESSION_RECEIVEDREJECTED_BY_CHARGING_STATIONREJECTED_BY_CPOREQUESTED_BY_CUSTOMERUNKNOWN_SESSIONerrorobject
externalPaymentExternalPayment
authorizedAmountBSONMoney
capturedAmountBSONMoney
AUTHORIZEDCOMPLETEDFAILEDMISSINGPENDINGVOIDEDpayBridgelocationobject
businessReimbursecommunityReimburseemployeeReimbursenoReimbursesplitReimburseevsesobject[]
geoLocationobject
mspprivatepubliccpoeclearingocpiroad-cpo-internalmspSessionobject
AUTH_REQUESTCOMMANDWHITELISTbillingInfoBillingInfo
businessReimbursecommunityReimburseemployeeReimbursenoReimbursesplitReimbursedriverVatInfoVatRule
exactnetsuiteERP-facing counterpart of exactVatCode. Mixed in Mongo: existing documents hold both strings and numbers.
externalPaymentExternalPayment
AUTHORIZEDCOMPLETEDFAILEDMISSINGPENDINGVOIDEDpayBridgelimitSessionLimit
locationobject
operatorPlatformAuthorizationOperatorPlatformAuthorization
CHARGE_CARDSCAN_TO_PAYTAP_TO_PAYdeferredimmediateacdcmsprawRecordobject
ChargingEVConnectedIdleSuspendedEVSuspendedEVSEWhat the device sent as idTag when the paired charge card was authorised in its place.
How the paired charge card was applied at session start.
reimbursementobject
AUTHORIZED_NON_BILLABLE_RFIDEXTERNAL_PAYMENT_FAILEDEXTERNAL_PAYMENT_SOLUTIONEXTERNAL_REIMBURSEMENTHISTORICAL_ENDINVALID_SESSIONMANUAL_EXCLUSIONNO_AUTO_REIMBURSEMENTNO_COSTTEMPORARILY_EXCLUDED_WAITING_FOR_MISSING_DATAUNSPECIFIEDif funds decision comes from an external entity
Tri-state: null means the external funder has not answered yet.
When reimbursement decision comes from an external service
roamingCdrDeliveryReceiptobject
DELIVEREDFAILEDsyncobject
validityobject
DUPLICATEDFAILED_TO_STARTHIGH_ENERGY_USAGEIMPROBABLE_ENERGY_USAGEINTERNAL_TOKENINVALID_END_TIMEINVALID_START_TIMELOW_ENERGY_USAGEMAINTENANCE_TOKENMANUAL_CANCELLATIONMISSING_OR_INVALID_SESSIONNON_ACCEPTED_AUTHREPLACED_WITH_CORRECTED_SESSIONSHORT_DURATIONUNKNOWN_METER_VALUESUNSPECIFIEDvatInfoVatRule
exactnetsuiteERP-facing counterpart of exactVatCode. Mixed in Mongo: existing documents hold both strings and numbers.
AD_HOC_TOKENPSP_PREAUTHTOKENmspACTIVECANCELLEDCOMPLETEDERRORPENDINGSTARTINGSTOPPEDSTOPPING