Sign in
Statements

Get Statements

get/statements

Query parameters

fromStatementDateTimestring date-time

The UTC ISO 8601 Date Time to filter statements FROM NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

toStatementDateTimestring date-time

The UTC ISO 8601 Date Time to filter statements TO NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

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

Statements Read

Example response

{
  "Data": {
    "Statement": [
      {
        "AccountId": "22289",
        "StatementId": "8sfhke-sifhkeuf-97813",
        "StatementReference": "002",
        "Type": "RegularPeriodic",
        "StartDateTime": "2017-07-12T00:00:00+00:00",
        "EndDateTime": "2017-07-12T00:00:00+00:00",
        "CreationDateTime": "2024-05-29T00:00:00Z",
        "StatementDescription": [
          "August 2017 Statement"
        ],
        "StatementBenefit": [
          {
            "Type": "UK.OBIE.Cashback",
            "Amount": {
              "Amount": "1209.06",
              "Currency": "GBP"
            }
          }
        ],
        "StatementFee": [
          {
            "Description": "International usage charge",
            "CreditDebitIndicator": "Credit",
            "Type": "UK.OBIE.Annual",
            "Rate": 0.05,
            "RateType": "UK.OBIE.AER",
            "Frequency": "UK.OBIE.StatementMonthly",
            "Amount": {
              "Amount": "1209.06",
              "Currency": "GBP"
            }
          }
        ],
        "StatementInterest": [
          {
            "Description": "Interest occurred over statement duration",
            "CreditDebitIndicator": "Credit",
            "Type": "UK.OBIE.Total",
            "Rate": 0.05,
            "RateType": "UK.OBIE.Total",
            "Frequency": "UK.OBIE.Monthly",
            "Amount": {
              "Amount": "1209.06",
              "Currency": "GBP"
            }
          }
        ],
        "StatementAmount": [
          {
            "CreditDebitIndicator": "Credit",
            "Type": "UK.OBIE.CreditLimit",
            "Amount": {
              "Amount": "1209.06",
              "Currency": "GBP"
            },
            "LocalAmount": {
              "Amount": "1209.06",
              "Currency": "GBP"
            }
          }
        ],
        "StatementDateTime": [
          {
            "DateTime": "2024-05-29T00:00:00Z",
            "Type": "UK.OBIE.NextStatement"
          }
        ],
        "StatementRate": [
          {
            "Rate": "0.224",
            "Type": "UK.OBIE.AnnualCash"
          }
        ],
        "StatementValue": [
          {
            "Type": "UK.OBIE.Credit"
          }
        ],
        "TotalValue": {
          "Amount": "1209.06",
          "Currency": "GBP"
        }
      }
    ]
  }
}

Changes