Skip to main content
GET
/
v2
/
transactions
/
{id}
Get a transaction by ID
curl --request GET \
  --url https://api.spirii.com/v2/transactions/{id} \
  --header 'Authorization: <api-key>'
{
  "auth": {
    "idTag": {
      "uid": "<string>",
      "id": 123,
      "type": "<string>",
      "label": "<string>",
      "customerId": 123,
      "operatorId": 123,
      "companyId": 123,
      "familyTreeCompanyIds": [
        "<string>"
      ],
      "crmCustomerId": 123,
      "comment": "<string>",
      "billingReference": "<string>",
      "customerCrmCustomerId": 123,
      "companyCrmCustomerId": 123,
      "operator": {
        "id": 123,
        "name": "<string>",
        "crmId": 123
      },
      "company": {
        "id": 123,
        "name": "<string>"
      },
      "customer": {
        "id": 123,
        "firstName": "<string>",
        "lastName": "<string>",
        "operator": {
          "id": 123,
          "name": "<string>"
        },
        "company": {
          "id": 123,
          "name": "<string>"
        },
        "familyTreeCompanyIds": [
          "<string>"
        ]
      }
    }
  },
  "chargeBoxId": 123,
  "chargingDetails": {
    "consumed": 123,
    "meterStart": 123,
    "meterStop": 123,
    "co2Emitted": 123,
    "highestPowerDrawn": 123,
    "vehicleStateOfCharge": {}
  },
  "company": {
    "id": 123456,
    "name": "Spirii"
  },
  "duration": {
    "charging": 123,
    "idle": 123,
    "total": 123
  },
  "evseId": "FR.SPI.Z000001*1",
  "id": 123456,
  "isRoaming": true,
  "location": {
    "id": 654321,
    "name": "Boulevard Garibaldi",
    "address": "14-16 Boulevard Garibaldi",
    "zipCode": "12345",
    "city": "Paris",
    "crmId": 123,
    "crmCustomerId": 123,
    "isEligibleForRefund": true,
    "countryCode": "FR"
  },
  "price": {
    "amount": 100.5,
    "amountExVat": 80.9,
    "currency": "EUR",
    "vatRate": 19.6,
    "isDynamic": true,
    "perKwh": 0.5
  },
  "startedAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "isPriority": true,
  "appUserId": 123,
  "endedAt": "2023-11-07T05:31:56Z",
  "roamingDetails": {
    "roamingOperator": "<string>",
    "roamingEvcoId": "<string>",
    "roamingIdTagUid": "<string>",
    "sessionStatus": "<string>",
    "type": "Hubject",
    "sessionPayload": {}
  },
  "tariff": {
    "id": "79804bf6-0d6d-4e74-ae00-16c7238c4e77",
    "name": "Spirii Tariff",
    "type": "standard"
  },
  "voucher": {
    "id": 123,
    "groupId": 123,
    "code": "<string>"
  },
  "voucherGroup": {
    "id": 123,
    "type": "<string>",
    "name": "<string>",
    "notes": "<string>",
    "perKwh": 123,
    "currency": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Authorization: Bearer <SPIRII_API_KEY>

Path Parameters

id
number
required

ID of the transaction.

Example:

12345678

Response

auth
object
required
chargeBoxId
integer
required

ID of the ChargeBox..

chargingDetails
object
required
company
object
required
duration
object
required

Duration of the transaction. Unit of measure is seconds. This object is not dynamic and it is only generated on when the transaction ends.

evseId
string
required
Example:

"FR.SPI.Z000001*1"

id
integer
required
Example:

123456

isRoaming
boolean
required
location
object
required
paymentMethod
enum<string>
required
Available options:
PaymentTerminal,
RoamingOperator,
Stripe,
MobilePay,
Free,
System,
Invoice,
Unknown
paymentStatus
enum<string>
required
Available options:
succeeded,
unknown,
mobilepay,
canceled,
expired,
n/a,
paid,
pending
price
object
required
startedAt
string<date-time>
required
updatedAt
string<date-time>
required
isPriority
boolean

Flag signalling if this is a priority transaction

appUserId
integer

ID of an App User. This property can be null if the authenticated user is no registered to any app.

endedAt
string<date-time>
roamingDetails
object
tariff
object

Value is null when no tariff is applied, e.g. Free transaction.

voucher
object
voucherGroup
object