Library Selector - Flatpeak

This step allows the customer to select their tariff from Flatpeak’s tariff library. The list is automatically filtered based on the selected provider and property location. If the customer’s tariff is not listed, they can continue using the PLAN_MISSING action. Your application should support this action to ensure all customers can complete the connection flow, even if their tariff is not listed in the library.

Preview
Code

{
  "connect_token": "cot_6587fa4362341be5b524de3b",
  "route": "library_select",
  "direction": "IMPORT",
  "type": "COMMODITY",
  "live_mode": false,
  "actions": [
    "PLAN_MISSING",
    "BACK",
    "CLOSE"
  ],
  "data": {
    "provider": {
      "id": "prv_65de3071e0c5570f767f06f1",
      "display_name": "SSE",
      "logo_url": "https://s.flatpeak.com/570f767f06f1.png"
    },
    "tariffs": [
      {
        "id": "trt_8587fa49c7e5297ccc6c57e4",
        "name": "EV Energy Plan",
        "description": "November 2022 tariff"
      },
      {
        "id": "trt_6587fa49c7e5297ccc6c57e7",
        "name": "Next Flex 2023 (37p/11.2p)",
        "description": ""
      }
    ]
  }
}

Actions

Following actons are supported when responding to Connect on this route:

Action	Result
`PLAN_MISSING`	Returns next page depending on flow logic
`BACK`	Returns previous page.
`CLOSE`	Returns `callback_url` you specified when creating the Connect token.

Errors

When you POST your response to Connect, the following validation errors may be returned

Error Code	Error Description
`tariff_id_missing`	Tariff template ID is required.
`tariff_not_found`	Tariff template ID trf_XX not found.
`tariff_id_invalid`	Provider ID prv_XX does not support tariff template ID trt_XX.
`data_json_invalid`	Data does not conform to the JSON schema.

Documentation Index

​Actions

​Errors

Actions

Errors