Sign in
Balances

Get Balances

get/balances

Headers

x-fapi-auth-datestring

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-addressstring

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-idstring

An RFC4122 UID used as a correlation id.

Authorizationstring required

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agentstring

Indicates the user-agent that the PSU is using.

Response

Balances Read

Example response

{
  "Data": {
    "Balance": [
      {
        "AccountId": "22289",
        "CreditDebitIndicator": "Credit",
        "Type": "CLAV",
        "Amount": {
          "Amount": "1209.06",
          "Currency": "GBP"
        },
        "CreditLine": [
          {
            "Amount": {
              "Amount": "1209.06",
              "Currency": "GBP"
            }
          }
        ],
        "LocalAmount": {
          "Amount": "1209.06",
          "Currency": "GBP"
        }
      }
    ],
    "TotalValue": {
      "Amount": "1209.06",
      "Currency": "GBP"
    }
  }
}

Changes