APIHub
Back to Explore

Account and Transaction API Specification

Provides a banking Open Banking API for creating, retrieving, and deleting account access consents and for fetching detailed account‑related data such as balances, beneficiaries, direct debits, offers, parties, products, scheduled payments, standing orders, statements, and transactions.

Finance
OAuth
HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

853ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
POST

/account-access-consents

Create Account Access Consents

  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
DELETE

/account-access-consents/{ConsentId}

Delete Account Access Consents

  • ConsentId (path, required) — ConsentId
  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/account-access-consents/{ConsentId}

Get Account Access Consents

  • ConsentId (path, required) — ConsentId
  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/accounts

Get Accounts

  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/accounts/{AccountId}

Get Accounts

  • AccountId (path, required) — AccountId
  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/accounts/{AccountId}/balances

Get Balances

  • AccountId (path, required) — AccountId
  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/accounts/{AccountId}/beneficiaries

Get Beneficiaries

  • AccountId (path, required) — AccountId
  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/accounts/{AccountId}/direct-debits

Get Direct Debits

  • AccountId (path, required) — AccountId
  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/accounts/{AccountId}/offers

Get Offers

  • AccountId (path, required) — AccountId
  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/accounts/{AccountId}/parties

Get Parties

  • AccountId (path, required) — AccountId
  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/accounts/{AccountId}/party

Get Parties

  • AccountId (path, required) — AccountId
  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/accounts/{AccountId}/product

Get Products

  • AccountId (path, required) — AccountId
  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/accounts/{AccountId}/scheduled-payments

Get Scheduled Payments

  • AccountId (path, required) — AccountId
  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/accounts/{AccountId}/standing-orders

Get Standing Orders

  • AccountId (path, required) — AccountId
  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/accounts/{AccountId}/statements

Get Statements

  • AccountId (path, required) — AccountId
  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
  • fromStatementDateTime (query) — 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.
  • toStatementDateTime (query) — 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.
GET

/accounts/{AccountId}/statements/{StatementId}

Get Statements

  • StatementId (path, required) — StatementId
  • AccountId (path, required) — AccountId
  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/accounts/{AccountId}/statements/{StatementId}/file

Get Statements

  • StatementId (path, required) — StatementId
  • AccountId (path, required) — AccountId
  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/accounts/{AccountId}/statements/{StatementId}/transactions

Get Transactions

  • StatementId (path, required) — StatementId
  • AccountId (path, required) — AccountId
  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/accounts/{AccountId}/transactions

Get Transactions

  • AccountId (path, required) — AccountId
  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
  • fromBookingDateTime (query) — The UTC ISO 8601 Date Time to filter transactions 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.
  • toBookingDateTime (query) — The UTC ISO 8601 Date Time to filter transactions 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.
GET

/balances

Get Balances

  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/beneficiaries

Get Beneficiaries

  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/direct-debits

Get Direct Debits

  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/offers

Get Offers

  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/party

Get Parties

  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/products

Get Products

  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/scheduled-payments

Get Scheduled Payments

  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/standing-orders

Get Standing Orders

  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/statements

Get Statements

  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • fromStatementDateTime (query) — 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.
  • toStatementDateTime (query) — 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.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/transactions

Get Transactions

  • x-fapi-auth-date (header) — 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-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
  • fromBookingDateTime (query) — The UTC ISO 8601 Date Time to filter transactions 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.
  • toBookingDateTime (query) — The UTC ISO 8601 Date Time to filter transactions 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.

29 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X POST \
  "https://openbanking.org.uk/account-access-consents"

openbanking.org.uk · HTTPS only