Transactions

Get Transactions

Enables an AISP to retrieve transaction information for account(s) that the PSU has consented to.

get/transactions

Query parameters

fromBookingDateTimestring date-time
Example:2026-01-01T00:00:00

The UTC ISO 8601 Date Time to filter transactions FROM.

Note: Time component is optional - set to 00:00:00 for just Date.

The value must not include the timezone component.

toBookingDateTimestring date-time
Example:2026-12-31T23:59:59

The UTC ISO 8601 Date Time to filter transactions TO.

Note: Time component is optional - set to 00:00:00 for just Date.

The value must not include 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.

x-client-idstring

Only used if an ASPSP requires the client ID in order to return rate limit headers.

TPPs must refer to ASPSP developer portals for further information on any rate limit policies, if the headers are supported and any additional requirements.

This header must not be used for client authentication

Response

Transactions Read

Example response

{
  "Data": {
    "Transaction": [
      {
        "AccountId": "22289",
        "StatementReference": [
          "002"
        ],
        "Amount": {
          "Amount": "1209.06",
          "Currency": "GBP"
        },
        "ChargeAmount": {
          "Amount": "1209.06",
          "Currency": "GBP"
        },
        "CurrencyExchange": {
          "InstructedAmount": {
            "Amount": "1209.06",
            "Currency": "GBP"
          }
        },
        "Balance": {
          "CreditDebitIndicator": "Credit",
          "Type": "CLAV",
          "Amount": {
            "Amount": "1209.06",
            "Currency": "GBP"
          }
        },
        "CreditorAgent": {
          "SchemeName": "UK.OBIE.BICFI",
          "Name": "Agent Name",
          "LEI": "IZ9Q00LZEVUKWCQY6X15",
          "PostalAddress": {
            "AddressType": "BIZZ",
            "Department": "Finance",
            "SubDepartment": "Payroll",
            "StreetName": "Bank Street",
            "BuildingNumber": "11",
            "Floor": "11",
            "UnitNumber": "A88",
            "Room": "Basement 03",
            "PostBox": "PO Box 123456",
            "TownLocationName": "London",
            "DistrictName": "Greater London",
            "CareOf": "Jane Smith",
            "PostCode": "EC2N 4AG",
            "TownName": "London"
          }
        },
        "CreditorAccount": {
          "Identification": "80200112344562",
          "Name": "Jane Smith",
          "SecondaryIdentification": "87562298675897",
          "Proxy": {
            "Identification": "2360549017905188",
            "Code": "TELE"
          }
        },
        "DebtorAgent": {
          "SchemeName": "UK.OBIE.BICFI",
          "Name": "Agent Name",
          "LEI": "IZ9Q00LZEVUKWCQY6X15",
          "PostalAddress": {
            "AddressType": "BIZZ",
            "Department": "Finance",
            "SubDepartment": "Payroll",
            "StreetName": "Bank Street",
            "BuildingNumber": "11",
            "Floor": "11",
            "UnitNumber": "A88",
            "Room": "Basement 03",
            "PostBox": "PO Box 123456",
            "TownLocationName": "London",
            "DistrictName": "Greater London",
            "CareOf": "Jane Smith",
            "PostCode": "EC2N 4AG",
            "TownName": "London"
          }
        },
        "DebtorAccount": {
          "Identification": "80200112344562",
          "Name": "Jane Smith",
          "SecondaryIdentification": "87562298675897",
          "Proxy": {
            "Identification": "2360549017905188",
            "Code": "TELE"
          }
        },
        "UltimateCreditor": {
          "LEI": "IZ9Q00LZEVUKWCQY6X15",
          "PostalAddress": {
            "AddressType": "BIZZ",
            "Department": "Finance",
            "SubDepartment": "Payroll",
            "StreetName": "Bank Street",
            "BuildingNumber": "11",
            "Floor": "11",
            "UnitNumber": "A88",
            "Room": "Basement 03",
            "PostBox": "PO Box 123456",
            "TownLocationName": "London",
            "DistrictName": "Greater London",
            "CareOf": "Jane Smith",
            "PostCode": "EC2N 4AG",
            "TownName": "London"
          }
        },
        "UltimateDebtor": {
          "LEI": "IZ9Q00LZEVUKWCQY6X15",
          "PostalAddress": {
            "AddressType": "BIZZ",
            "Department": "Finance",
            "SubDepartment": "Payroll",
            "StreetName": "Bank Street",
            "BuildingNumber": "11",
            "Floor": "11",
            "UnitNumber": "A88",
            "Room": "Basement 03",
            "PostBox": "PO Box 123456",
            "TownLocationName": "London",
            "DistrictName": "Greater London",
            "CareOf": "Jane Smith",
            "PostCode": "EC2N 4AG",
            "TownName": "London"
          }
        },
        "IntermediaryAgent1": {
          "LEI": "IZ9Q00LZEVUKWCQY6X15",
          "PostalAddress": {
            "AddressType": "BIZZ",
            "Department": "Finance",
            "SubDepartment": "Payroll",
            "StreetName": "Bank Street",
            "BuildingNumber": "11",
            "Floor": "11",
            "UnitNumber": "A88",
            "Room": "Basement 03",
            "PostBox": "PO Box 123456",
            "TownLocationName": "London",
            "DistrictName": "Greater London",
            "CareOf": "Jane Smith",
            "PostCode": "EC2N 4AG",
            "TownName": "London"
          }
        },
        "IntermediaryAgent2": {
          "LEI": "IZ9Q00LZEVUKWCQY6X15",
          "PostalAddress": {
            "AddressType": "BIZZ",
            "Department": "Finance",
            "SubDepartment": "Payroll",
            "StreetName": "Bank Street",
            "BuildingNumber": "11",
            "Floor": "11",
            "UnitNumber": "A88",
            "Room": "Basement 03",
            "PostBox": "PO Box 123456",
            "TownLocationName": "London",
            "DistrictName": "Greater London",
            "CareOf": "Jane Smith",
            "PostCode": "EC2N 4AG",
            "TownName": "London"
          }
        },
        "IntermediaryAgent3": {
          "LEI": "IZ9Q00LZEVUKWCQY6X15",
          "PostalAddress": {
            "AddressType": "BIZZ",
            "Department": "Finance",
            "SubDepartment": "Payroll",
            "StreetName": "Bank Street",
            "BuildingNumber": "11",
            "Floor": "11",
            "UnitNumber": "A88",
            "Room": "Basement 03",
            "PostBox": "PO Box 123456",
            "TownLocationName": "London",
            "DistrictName": "Greater London",
            "CareOf": "Jane Smith",
            "PostCode": "EC2N 4AG",
            "TownName": "London"
          }
        }
      }
    ]
  }
}

Changes

Changed in 5 of the 50 revisions of this API.1219

    • added the new CRYP enum value to the Data/Transaction/items/PaymentPurposeCode response property for the response status 200 (media type: application/json; charset=utf-8)

      response-property-enum-value-added

    • added the new CRYP enum value to the Data/Transaction/items/PaymentPurposeCode response property for the response status 200 (media type: application/json)

      response-property-enum-value-added

    • added the new CRYP enum value to the Data/Transaction/items/PaymentPurposeCode response property for the response status 200 (media type: application/jose+jwe)

      response-property-enum-value-added

    • added the new optional header request parameter x-client-id

      new-optional-request-parameter

    • added the optional property Data/Transaction/items/IntermediaryAgent1 to the response with the 200 status (media type: application/json; charset=utf-8)

      response-optional-property-added

    • added the optional property Data/Transaction/items/IntermediaryAgent1 to the response with the 200 status (media type: application/json)

      response-optional-property-added

    • added the optional property Data/Transaction/items/IntermediaryAgent1 to the response with the 200 status (media type: application/jose+jwe)

      response-optional-property-added

    • added the optional property Data/Transaction/items/IntermediaryAgent2 to the response with the 200 status (media type: application/json; charset=utf-8)

      response-optional-property-added

    • added the optional property Data/Transaction/items/IntermediaryAgent2 to the response with the 200 status (media type: application/json)

      response-optional-property-added

    • added the optional property Data/Transaction/items/IntermediaryAgent2 to the response with the 200 status (media type: application/jose+jwe)

      response-optional-property-added

    • added the optional property Data/Transaction/items/IntermediaryAgent3 to the response with the 200 status (media type: application/json; charset=utf-8)

      response-optional-property-added

    • added the optional property Data/Transaction/items/IntermediaryAgent3 to the response with the 200 status (media type: application/json)

      response-optional-property-added

    • added the optional property Data/Transaction/items/IntermediaryAgent3 to the response with the 200 status (media type: application/jose+jwe)

      response-optional-property-added

    • removed the optional property Data/Transaction/items/IntermediaryAgent1 from the response with the 200 status (media type: application/json; charset=utf-8)

      response-optional-property-removed

    • removed the optional property Data/Transaction/items/IntermediaryAgent1 from the response with the 200 status (media type: application/json)

      response-optional-property-removed

    • removed the optional property Data/Transaction/items/IntermediaryAgent1 from the response with the 200 status (media type: application/jose+jwe)

      response-optional-property-removed

    • removed the optional property Data/Transaction/items/IntermediaryAgent2 from the response with the 200 status (media type: application/json; charset=utf-8)

      response-optional-property-removed

    • removed the optional property Data/Transaction/items/IntermediaryAgent2 from the response with the 200 status (media type: application/json)

      response-optional-property-removed

    • removed the optional property Data/Transaction/items/IntermediaryAgent2 from the response with the 200 status (media type: application/jose+jwe)

      response-optional-property-removed

    • removed the optional property Data/Transaction/items/IntermediaryAgent3 from the response with the 200 status (media type: application/json; charset=utf-8)

      response-optional-property-removed

    • removed the optional property Data/Transaction/items/IntermediaryAgent3 from the response with the 200 status (media type: application/json)

      response-optional-property-removed

    • removed the optional property Data/Transaction/items/IntermediaryAgent3 from the response with the 200 status (media type: application/jose+jwe)

      response-optional-property-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property Data/Transaction/items/IntermediaryAgent1 to the response with the 200 status (media type: application/json; charset=utf-8)

      response-optional-property-added

    • added the optional property Data/Transaction/items/IntermediaryAgent1 to the response with the 200 status (media type: application/json)

      response-optional-property-added

    • added the optional property Data/Transaction/items/IntermediaryAgent1 to the response with the 200 status (media type: application/jose+jwe)

      response-optional-property-added

    • added the optional property Data/Transaction/items/IntermediaryAgent2 to the response with the 200 status (media type: application/json; charset=utf-8)

      response-optional-property-added

    • added the optional property Data/Transaction/items/IntermediaryAgent2 to the response with the 200 status (media type: application/json)

      response-optional-property-added

    • added the optional property Data/Transaction/items/IntermediaryAgent2 to the response with the 200 status (media type: application/jose+jwe)

      response-optional-property-added

    • added the optional property Data/Transaction/items/IntermediaryAgent3 to the response with the 200 status (media type: application/json; charset=utf-8)

      response-optional-property-added

    • added the optional property Data/Transaction/items/IntermediaryAgent3 to the response with the 200 status (media type: application/json)

      response-optional-property-added

    • added the optional property Data/Transaction/items/IntermediaryAgent3 to the response with the 200 status (media type: application/jose+jwe)

      response-optional-property-added