APIHub
Back to Explore

Account and Transaction API Specification - UK

The API enables third‑party providers to create, retrieve and delete account‑access consents and, with consent, fetch comprehensive account data such as balances, beneficiaries, parties, scheduled payments, standing orders, statements and transactions, while also offering sandbox endpoints for creating, importing, exporting and deleting test sandboxes.

Finance
OAuth
HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

2661ms 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.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
  • sandbox-id (header, required) — The unique id of the sandbox to be used
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.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
  • sandbox-id (header, required) — The unique id of the sandbox to be used
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.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
  • sandbox-id (header, required) — The unique id of the sandbox to be used
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.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
  • sandbox-id (header, required) — The unique id of the sandbox to be used
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.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
  • sandbox-id (header, required) — The unique id of the sandbox to be used
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.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
  • sandbox-id (header, required) — The unique id of the sandbox to be used
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.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
  • sandbox-id (header, required) — The unique id of the sandbox to be used
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.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
  • sandbox-id (header, required) — The unique id of the sandbox to be used
GET

/accounts/{accountId}/party

Get Party

  • 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.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
  • sandbox-id (header, required) — The unique id of the sandbox to be used
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.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
  • sandbox-id (header, required) — The unique id of the sandbox to be used
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.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
  • sandbox-id (header, required) — The unique id of the sandbox to be used
GET

/accounts/{accountId}/statements

Get Statements

  • accountId (path, required) — AccountId
  • 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-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.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
  • sandbox-id (header, required) — The unique id of the sandbox to be used
GET

/accounts/{accountId}/statements/{statementId}

Get Statements

  • accountId (path, required) — AccountId
  • statementId (path, required) — StatementId
  • 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.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
  • sandbox-id (header, required) — The unique id of the sandbox to be used
GET

/accounts/{accountId}/statements/{statementId}/file

Get Statements

  • accountId (path, required) — AccountId
  • statementId (path, required) — StatementId
  • 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.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
  • sandbox-id (header, required) — The unique id of the sandbox to be used
GET

/accounts/{accountId}/statements/{statementId}/transactions

Get Transactions

  • accountId (path, required) — AccountId
  • statementId (path, required) — StatementId
  • 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.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
  • sandbox-id (header, required) — The unique id of the sandbox to be used
GET

/accounts/{accountId}/transactions

Get Transactions

  • accountId (path, required) — AccountId
  • 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.
  • 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.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
  • sandbox-id (header, required) — The unique id of the sandbox to be used
GET

/party

Get Party

  • 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.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
  • sandbox-id (header, required) — The unique id of the sandbox to be used
POST

/sandbox

Create Sandbox

PUT

/sandbox

Import Sandbox

DELETE

/sandbox/{sandboxId}

Delete Sandbox

  • sandboxId (path, required) — Sandbox Id
GET

/sandbox/{sandboxId}

Export Sandbox

  • sandboxId (path, required) — Sandbox Id

21 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X POST \
  "https://apis.nbg.gr/sandbox/uk.openbanking.accountinfo/oauth2/v3.1.5/account-access-consents"

apis.nbg.gr · HTTPS only