Get transaction history

GET

rewards

{site_id}

transactions

Get Transaction History

curl --request GET \
  --url https://api-sandbox.axle.energy/rewards/{site_id}/transactions \
  --header 'Authorization: Bearer <token>'

{
  "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "transactions": [
    {
      "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "credit_pence": 123,
      "transaction_type": "flex period",
      "start_time": "2023-11-07T05:31:56Z",
      "end_time": "2023-11-07T05:31:56Z",
      "flex_kwh": 123
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

site_id

string<uuid>

required

Response

Successful Response

Response model for transaction history.

site_id

string<uuid>

required

ID of the site

transactions

TransactionDatumResponse · object[]

required

List of transactions for the site

Show child attributes

transactions.transaction_id

string<uuid>

required

ID of the transaction

transactions.credit_pence

integer

required

Amount credited in pence

transactions.transaction_type

enum<string>

Type of the transaction

Available options:

flex period,

flex period top-up,

flex event,

withdrawal,

goodwill credit,

signup bonus,

correction

transactions.start_time

string<date-time>

For transaction_type = 'flex event': when the event started For transaction_type = 'flex period': month start For transaction_type = 'withdrawal': when the withdrawal happened

transactions.end_time

string<date-time>

For transaction_type = 'flex event': when the event ended For transaction_type = 'flex period': month end Not present for other transaction_type values

transactions.flex_kwh

number

Stored to the nearest watt-hour (3dp) For transaction_type = 'flex event': the change in energy flow during the event relative to the baseline in kwh. +ve indicates additional energy imported (or less energy exported). -ve indicates additional energy exported (or less energy imported). Not present for other transaction_type values

Validate an MPANValidates the provided MPAN as one that is well-formatted and is associated with a connected import meter

⌘I

Get Transaction History

curl --request GET \
  --url https://api-sandbox.axle.energy/rewards/{site_id}/transactions \
  --header 'Authorization: Bearer <token>'

{
  "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "transactions": [
    {
      "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "credit_pence": 123,
      "transaction_type": "flex period",
      "start_time": "2023-11-07T05:31:56Z",
      "end_time": "2023-11-07T05:31:56Z",
      "flex_kwh": 123
    }
  ]
}

API Documentation

Authorizations

Path Parameters

Response