Skip to content
SPARK

User Compensations

How user compensations are generated

After submitting reports on behalf of your users in regards to specific events of the type PriceCurve, compensations will be generated for these users. The compensation is based on the reported energy usage for a given hour and the price incentive specified for that same hour on the event.

How to fetch compensations for your users

User compensation can be fetched by sending a GET request to the following endpoint: /user/{userId}/compensation.

Request Headers

  • Content-Type: application/json
  • Accept: application/json
  • Authorization: Bearer YOUR_API_TOKEN

Response Body

{
    "userId": "string",
    "period": {
        "from": "2024-05-01",
        "to": "2024-05-31"
    },
    "activeAmount": 55.50,
    "blockedAmount": 110.15,
    "currency": "EUR",
    "problems": [
        {
            "problemType": 1,
            "message": "Missing meter point ID"
        }
    ]
}

The response contains the accumulated active and blocked compensation for a user. The active amount is the sum of all compensations generated through reports within the current month, while the blocked amount is the sum of all compensations that could potentially be compensated. Compensations are tagged as blocked if the have any issues that makes it impossible to identify for grid companies. The main problem is a missing meter point ID (MPID) tied to the location of the user. If MPID is missing from reports and the reported location(s) does not have an MPID by the end of the month, the compensation will expire and we’ll no longer be able to pay it out. If the locations are updated with the correct MPID, the compensation will be unblocked. There is no need to resubmit the report(s) to unblock the compensation given that the location has an MPID.

Active Amount

This is the amount within the current month which could potentially be compensated given that the required information is provided.

Blocked Amount

This is the amount within the current month which is blocked due to missing information. This amount will be lost if the required information is not provided by the end of the month.

Currency

Amounts will be returned in local currency with regards to where the user is located.

Problems

A list of all potential problems that could block compensation(s). As of now these are mostly with regards to missing MPID(s) on reports and/or locations.

  • MissingMpid: There’s neither an MPID on the report used to generate the compensation nor on the location specified in the report. This error will block the compensation from being paid out as there is no identifier to tie it to a grid company.
  • MissingMpidOnLocation: There’s an MPID on the report used to generate the compensation, but not on the location specified in the report. This error is a warning and will not block the compensation from being paid, but it’s recommended to update the location with the correct MPID.