Documentation

MSP Sessions

No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.

MSP Sessions API

POST/1/sessions/search

Search Sessions

This endpoint allows you to search for MSP sessions, that is, sessions that were started using one of our cards.

Authorization
User sessionAPI credential
Permissions
sessions:read
OAuth
-
Request
Request bodyapplication/json
accountIdstring
currencystring
currencyConvertModestring
eur-onlyto-eur
endedAtobject
$gtestring <date-time>
$ltestring <date-time>
evseControllerIdstring
excludeCreditedSessionsboolean
default false
excludedboolean
externalCalculatedPriceobject
$eqnumber
$gtenumber
$ltenumber
filenamestring
default change-sessions.csv
formatstring
default json
fromstring <date-time>
fromToFieldstring
hasErrorsboolean
importSourcestring
includeAdditionalChargesboolean
default false
includeCreditSessionsboolean
default false
infraProviderIdstring
kwhobject
$eqnumber
$gtenumber
$ltenumber
limitnumber
default 50
locationIdstring
onlyInvoicedboolean
onlyUnInvoicedboolean
providerContextstring
default msp
searchIdstring
searchPhrasestring
skipnumber
default 0
sortobject
default {"field":"endedAt","order":"desc"}
fieldstringREQUIRED
orderstringREQUIRED
ascdesc
tostring <date-time>
Responses
200OK application/json
dataMspSessionResource[]REQUIRED
accountobject
accountIdstring
additionalChargesobject[]
authTypestring
billingPlanobject
idstringREQUIRED
namestringREQUIRED
typestringREQUIRED
chargingFinishedAtstring
connectorIdstring
createdAtstringREQUIRED
creditSessionsobject[]
currencystringREQUIRED
dischargedKwhnumber
durationSecondsnumber
endedAtstring
evseControllerobject
evseControllerIdstring
excludedboolean
excludedReasonstring
externalCalculatedPricenumber
externalIdstring
externalProviderobject
externalProviderIdstring
externalUniqueIdstring
idstringREQUIRED
infraProviderIdstring
kwhnumberREQUIRED
locationobject
locationIdstring
mspLocationobject
paymentRetryobject

The automatic MIT retry of the session payment after a failed capture, when one was attempted.

attemptedAtstring
failureReasonstring

Why the original capture failed.

originalPaymentIdstring

The payment whose capture failed.

paymentIdstring

The retry payment created in the payment system.

physicalReferencestring
powerTypestring
priceWithFXobject
providerobject
providerContextstringREQUIRED
providerIdstringREQUIRED
rawRecordobject
reimbursementobject
roamingIdstring
startedAtstring
statusstring
updatedAtstringREQUIRED
userobject
userIdstring
validityobject
vatInfoobject
metaobjectREQUIRED
limitnumberREQUIRED
skipnumberREQUIRED
totalnumberREQUIRED
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
POST/1/sessions/search/fast

Fast Search Sessions

Fast search for MSP sessions.

Authorization
User sessionAPI credential
Permissions
sessions:read
OAuth
-
Request
Request bodyapplication/json
accountIdstring
countryCodestring
currencystring
currencyConvertModestring
eur-onlyto-eur
endedAtobject
$gtestring <date-time>
$ltestring <date-time>
evseControllerIdstring
excludeCreditedSessionsboolean
default false
excludedboolean
externalCalculatedPriceobject
$eqnumber
$gtenumber
$ltenumber
fromstring <date-time>
fromToFieldstring
hasErrorsboolean
importSourcestring
includeAdditionalChargesboolean
default false
includeCreditSessionsboolean
default false
infraProviderIdstring
kwhobject
$eqnumber
$gtenumber
$ltenumber
limitnumber
default 50
locationIdstring
onlyInvoicedboolean
onlyUnInvoicedboolean
providerContextstring
default msp
searchIdstring
searchPhrasestring
skipnumber
default 0
sortobject
default {"field":"endedAt","order":"desc"}
fieldstringREQUIRED
orderstringREQUIRED
ascdesc
tostring <date-time>
Responses
200OK application/json
dataMspSessionSearch[]
accountobject
namestring
accountIdstring
calculatedDiscountnumberREQUIRED
createdAtstring <date-time>REQUIRED
currencystringREQUIRED
durationSecondsnumber
endedAtstring <date-time>
excludedboolean
excludedReasonstring
externalCalculatedPricenumberREQUIRED
externalIdstring
externalProviderobject
namestring
externalProviderIdstring
externalUniqueIdstring
fleetIdstring
idstringREQUIRED
importSourcestring
infraProviderIdstring
invoiceIdstring
kwhnumberREQUIRED
locationobject
addressstring
citystring
countryCodestring
postalCodestring
priceWithFXobject
originalAmountnumber
originalAmountWithVATnumber
originalCurrencystring
ratenumber
targetAmountnumber
targetAmountWithVATnumber
targetCurrencystring
providerobject
enableMspSessionDeletionboolean
providerContextstringREQUIRED
msp
providerIdstring
startedAtstring <date-time>
statusstring
tokenIdstring
userobject
namestring
userIdstring
vatInfoobject
vatPercentagenumber
vehicleobject
identifierstring
licensePlatestring
vinstring
vehicleIdstring
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
GET/1/sessions/{session}

Get Session

Returns a single MSP session.

Authorization
User sessionAPI credential
Permissions
sessions:read
OAuth
-
Request
Path parameters1
sessionstringREQUIRED
Responses
200OK application/json
dataMspSessionResource
accountobject
accountIdstring
additionalChargesobject[]
authTypestring
billingPlanobject
idstringREQUIRED
namestringREQUIRED
typestringREQUIRED
chargingFinishedAtstring
connectorIdstring
createdAtstringREQUIRED
creditSessionsobject[]
currencystringREQUIRED
dischargedKwhnumber
durationSecondsnumber
endedAtstring
evseControllerobject
evseControllerIdstring
excludedboolean
excludedReasonstring
externalCalculatedPricenumber
externalIdstring
externalProviderobject
externalProviderIdstring
externalUniqueIdstring
idstringREQUIRED
infraProviderIdstring
kwhnumberREQUIRED
locationobject
locationIdstring
mspLocationobject
paymentRetryobject

The automatic MIT retry of the session payment after a failed capture, when one was attempted.

attemptedAtstring
failureReasonstring

Why the original capture failed.

originalPaymentIdstring

The payment whose capture failed.

paymentIdstring

The retry payment created in the payment system.

physicalReferencestring
powerTypestring
priceWithFXobject
providerobject
providerContextstringREQUIRED
providerIdstringREQUIRED
rawRecordobject
reimbursementobject
roamingIdstring
startedAtstring
statusstring
updatedAtstringREQUIRED
userobject
userIdstring
validityobject
vatInfoobject
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED