Nbg

Account and Transaction API Specification - UK

Functionality at a glance The NBG "UK OPB - Account and Transaction v3.1.5" API follows the [UK Open Banking Specification…

Finance & banking#openapi#financial

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Functionality at a glance

The NBG "UK OPB - Account and Transaction v3.1.5" API follows the [UK Open Banking Specification
v3.1.5](https://openbankinguk.github.io/read-write-api-site3/v3.1.5/profiles/account-and-transaction-api-profile.html)

This Account and Transaction API Specification describes the flows and payloads for retrieving a list of accounts and their transactions.

The API endpoints described here allow a AISP to:

  • Create the Consent with the appropriate permissions in order to be able to access the API Endpoints
  • Retrieve the list of accounts
  • Retrieve an account's details
  • Retrieve an account's balances
  • Retrieve an account's transactions
  • Retrieve an account's beneficiaries
  • Retrieve an account's standing orders
  • Retrieve an account's party
  • Retrieve an account's scheduled payments
  • Retrieve an account's statements

Quick Getting Started

  1. Login/Register to the NBG Technology HUB
  1. Go to "APPS"
  1. Select your Organization and go to step 4. If you want to create a new Organization click \"CREATE AN ORGANIZATION\" and follow the steps below:
  2. Enter the title of your Organization
  3. Enter a short description of your Organization (optional)
  4. Click "SUBMIT"
  1. Select the Organization of choice and click "ADD AN APPLICATION"
  2. Fill in the forms (title and short description)
  3. Check \"Authorization Code\" and \"Client Credentials\"
  4. Enter the OAuth Redirect and Post Logout URIs (these are the URIs that we will redirect the user upon logging in and logging out respectively)

You can use the following redirect URL to easily test the API through the portal: https://developer.nbg.gr/oauth2/redoc-callback

  1. Click "SUBMIT"
  2. Store the APPs "Client ID" and "Client Secret"
  3. Go to "API PRODUCTS" and select the ACCOUNT INFORMATION - UK OPEN BANKING API
  1. Click \"START USING THIS API\", choose your app and click

"SUBSCRIBE"

  1. Get an Access Token using the Access Token Flow and the API scopes provided in the Authentication and Authorization (OAuth2) section below
  1. Create a Sandbox
  1. Play with the API

Sandbox Flow

The Sandbox Flow matches the Production Flow. The difference lies into the Data used. Instead of live
data, the Sandbox flow uses mocked data.

Production Flow

The Production Flow is described in the [UK Open Banking v3.1.5
Specification](https://openbankinguk.github.io/read-write-api-site3/v3.1.5/profiles/account-and-transaction-api-profile.html)

More details about the implementation specifics followed, please visit section **UK OPB Implementation
Specifics**

Authentication and Authorization (OAuth2)

This API version uses the OAuth2 protocol for authentication and authorization, which means that a
Bearer (access token) should be acquired. An access token can be retrieved using the client_id and
client_secret of the APP that you created and subscribed in this API, and your own credentials
(username, password) that you use to sign in the NBG Technology HUB. The scopes are defined below:

Authorization Endpoint:

https://my.nbg.gr/identity/connect/authorize

Token Endpoint:

https://my.nbg.gr/identity/connect/token

Authorization Code

Sandbox Scopes:

sandbox-uk-account-info-api-v1 offline_access

Production Scopes:

accounts offline_access

Client Credentials

Sandbox Scopes:

sandbox-uk-account-info-api-v1

Production Scopes:

accounts

See more here

QWAC Certificates

TPPs are required to present a QWAC certificate during API consumption. The API checks that this certificate has been provided and is valid. In sandbox mode the certificate validations are optional. To validate your certificate in sandbox implementation, please send us your QWAC certificate at developer@nbg.gr and set the HTTP Header \"x-sandbox-qwac-certificate-check\" with the value \"true\" in your requests.

SMS Challenge (One Time Password)

In order to successfully authorize an Accounts Access you will need to provide the SMS OTP (One Time Password) in the corresponding Accounts Consent UI Screen.

By default the SMS OTP will be sent to the mobile number declared upon singing up in the NBG Technology HUB.

Create your Sandbox

Create a new Sandbox application by invoking the POST /sandbox. This call will generate a new Sandbox
with a unique sandbox-id.

__Important!__ Before proceeding save the sandbox id you just created.

When you create a sandbox, users and sandbox specific data are generated as sample data.

Start Testing

Once you have your sandbox-id, you can start invoking the rest of the operations by providing the
mandatory http header sandbox-id and the http headers described below.

Important notes

Request headers

The following HTTP header parameters are required for every call:

  1. Authorization. The Auth2 Token
  1. sandbox-id.…

Endpoints 21

AccountAccess

  • POSTCreate Account Access Consents/account-access-consentsCreate Account Access Consents
  • GETGet Account Access Consents/account-access-consents/:consentIdGet Account Access Consents by Consent ID
  • DELETEDelete Account Access Consents/account-access-consents/:consentIdDelete Account Access Consents by Consent ID

Accounts

  • GETGet Accounts/accountsGet Accounts
  • GETGet Accounts/accounts/:accountIdGet Accounts by Account ID

Balances

  • GETGet Balances/accounts/:accountId/balancesGet Balances by Account ID

Beneficiaries

  • GETGet Beneficiaries/accounts/:accountId/beneficiariesGet Beneficiaries by Account ID

Parties

  • GETGet Parties/accounts/:accountId/partiesGet Parties by Account ID
  • GETGet Party/accounts/:accountId/partyGet Party by Account ID
  • GETGet Party/partyGet Party

ScheduledPayments

  • GETGet Scheduled Payments/accounts/:accountId/scheduled-paymentsGet Scheduled Payments by Account ID

StandingOrders

  • GETGet Standing Orders/accounts/:accountId/standing-ordersGet Standing Orders by Account ID

Statements

  • GETGet Statements/accounts/:accountId/statements?fromStatementDateTime=2024-01-01T00:00:00Z&toStatementDateTime=2024-01-01T00:00:00ZGet Statements by Account ID
  • GETGet Statements/accounts/:accountId/statements/:statementIdGet Statements by Account ID and Statement ID
  • GETGet Statements/accounts/:accountId/statements/:statementId/fileGet Statement PDF File by Account ID and Statement ID

Transactions

  • GETGet Transactions/accounts/:accountId/statements/:statementId/transactionsGet Transactions by Account ID and Statement ID
  • GETGet Transactions/accounts/:accountId/transactions?fromBookingDateTime=2024-01-01T00:00:00Z&toBookingDateTime=2024-01-01T00:00:00ZGet Transactions by Account ID

Sandbox

  • PUTImport Sandbox/sandboxImport Sandbox
  • POSTCreate Sandbox/sandboxCreate Sandbox
  • GETExport Sandbox/sandbox/:sandboxIdExport Sandbox
  • DELETEDelete Sandbox/sandbox/:sandboxIdDelete Sandbox

API details

Base URL
https://apis.nbg.gr/sandbox/uk.openbanking.accountinfo/oauth2/v3.1.5
https://services.nbg.gr/apis/open-banking/v3.1.5/aisp
Authentication
OAuth 2.0 (authorization code flow) with 2 scopes
OAuth 2.0 (client credentials flow) with 2 scopes
An API key in the Client-Id header
Operations
21 operations on 18 pathsGET 16POST 2DELETE 2PUT 1
Main resources
Sandbox 4AccountAccess 3Parties 3Statements 3Accounts 2Transactions 2Balances 1Beneficiaries 1ScheduledPayments 1StandingOrders 1
Response formats
application/json application/json; charset=utf-8 application/pdf
Description format
OpenAPI 3.0.1, API version v3.1.5
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Account and Transaction API Specification - UK in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Account and Transaction API Specification - UK collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create Account Access Consents” (POST /account-access-consents), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Account and Transaction API Specification - UK?

Functionality at a glance The NBG "UK OPB - Account and Transaction v3.1.5" API follows the [UK Open Banking Specification… It is listed under Finance & banking and has 21 endpoints.

Who publishes the Account and Transaction API Specification - UK?

It is listed from Nbg's public API description (an OpenAPI document), not published by Nbg on Swastik Codes. Anyone who controls nbg.gr can claim the profile by adding a DNS TXT record.

What is the base URL of the Account and Transaction API Specification - UK?

Its description lists 2 base URLs: https://apis.nbg.gr/sandbox/uk.openbanking.accountinfo/oauth2/v3.1.5, https://services.nbg.gr/apis/open-banking/v3.1.5/aisp. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Account and Transaction API Specification - UK?

It accepts 3 methods: OAuth 2.0 (authorization code flow) with 2 scopes; OAuth 2.0 (client credentials flow) with 2 scopes; an API key in the Client-Id header.

How many endpoints does the Account and Transaction API Specification - UK have?

21 operations on 18 paths (16 GET, 2 POST, 2 DELETE, 1 PUT). The largest groups are Sandbox, AccountAccess, Parties, Statements.

Is forking the Account and Transaction API Specification - UK free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.