Surcharge Input

If customers enter their tariff rate manually, depending on their choices, Connect may, depending on your customer’s energy provider, request you to render a page where they can specify tariff rate surcharges. For example, they might be on a MARKET tariff and will be paying additional brokerage fees or taxes on top.

Surcharges are applied by first adding the fixed fee, then applying the percentage to the result.

Preview
Code

{
  "connect_token": "cot_6587fa4362341be5b524de3b",
  "route": "surcharge_input",
  "direction": "IMPORT",
  "type": "COMMODITY",
  "live_mode": false,
  "actions": [
    "BACK"
  ],
  "data": {
    "currency_code": "EUR",
    "provider": {
      "id": "prv_65de3024be51ded101a3a555",
      "display_name": "EDF",
      "logo_url": "https://s.flatpeak.com/1ded101a3a555.png"
    },
    "surcharge": {
      "fixed": 0,
      "percentage": 0
    }
  }
}

surcharge.fixed shall be returned in large currency units.

When you POST the response, Connect may return any of these validation errors:

Error Code	Error Description
`surcharge_percentage_invalid`	Surcharge percentage must be larger than zero.
`data_json_invalid`	Data does not conform to the JSON schema.

Supported actions:

Action	Result
`BACK`	Returns previous page.
`CLOSE`	Returns `callback_url` you specified when creating the Connect token.

Rate Input Area Selector

⌘I

Core Endpoints

Connect Endpoints

Get Energy Price

Schedule Energy

Submit Telemetry

Calculate Energy Cost

Providers

Core Endpoints

Connect Endpoints

Get Energy Price

Schedule Energy

Submit Telemetry

Calculate Energy Cost

Providers

Documentation Index