Introduction

Welcome to Enable Banking SDK developer documentation!

We are happy that you are interested our solution and hope that in this documentation you'll be able to find all information you need when using our SDK. If not, feel free to contact us at hello@enablebanking.com.

Get started by cloning our sample repository

$ git clone https://github.com/enablebanking/OpenBankingJavaExamples

$ git clone https://github.com/enablebanking/OpenBankingJSExamples

$ git clone https://github.com/enablebanking/OpenBankingPythonExamples

Enable Banking SDK provides native Java, Javascript and Python libraries for connecting directly from your code to a number of Open Banking APIs without intermediate aggregation services. The libraries provide unified interface for interacting with multiple ASPSPs (banks), harmonize data and implement all cryptographic functionality needed for interaction with PSD2 APIs, such as mTLS connection using eIDAS QWAC and request signing using eIDAS QSeal certificate.

It's the easiest to get started with the SDK by using our code samples. The complete code samples for Java, Javascript and Python are available under our Github account: https://github.com/enablebanking.

For starting you need to have a developer license, which you can order on our website. You will get your developer SDK, which is connected Open Banking API sandboxes.

For production usage please contact us via e-mail.

User guide

Authorization and user token refresh

This section describes a basic authorization flow and access token refreshing flow (if it is supported by an ASPSP).

In order to execute this flow correctly for a specific ASPSP (bank) connector, one should obtain connector's meta information and build your flow according to that information.

Below is the basic example of how such flow can be implemented.

0. Import library and choose connector

import com.enablebanking.ApiClient;
import com.enablebanking.api.AuthApi;
import com.enablebanking.api.MetaApi;
import com.enablebanking.model.*;

// Initializing meta interface.
MetaApi metaApi = new MetaApi(new ApiClient());

// Getting connectors for a country.
HalConnectors connectors = metaApi.getConnectors("FI");

// Finding meta data for a desired connector
Connector connectorMeta = null;
for (Connector conn : connectors.getConnectors()) {
    if (conn.getName().equals('Sample')) {
        connectorMeta = conn;
        break;
    }
}

const enablebanking = require('enablebanking');

// Initializing meta interface.
const metaApi = new enablebanking.MetaApi(new enablebanking.ApiClient());

// Getting connectors for a country.
const connectors = await metaApi.getConnectors({country: 'FI'});

// Finding meta data for a desired connector
let connectorMeta;
for (const conn of connectors.connectors) {
    if (conn.name == 'Sample') {
      connectorMeta = conn;
      break;
    }
  }

import enablebanking

// Initializing meta interface.
meta_api = enablebanking.MetaApi(enablebanking.ApiClient())

// Getting connectors for a country.
connectors_info = meta_api.get_connectors(country='FI')

// Finding meta data for a desired connector
connector_meta = None
for conn in .connectors:
    if conn.name == 'Sample':
        connector_meta = conn
        break

First of all we are getting the list of connectors for a country and choosing one connector, which we are going to used. In real-world case a list of banks accessed with the connectors, shall be shown to a user for making a choise. In the code sample we are just using 'Sample'.

1. Initialize API client and authentication interface

// Initializing settings; connector settings class to be replaced with a real one.
ConnectorSettings settings = new SampleConnectorSettings()
    // other settings, including callback redirect URI, to be set here
    .sandbox(true);

// Creating client instance.
ApiClient apiClient = new ApiClient(settings);

// Initializing authentication interface.
AuthApi authApi = new AuthApi(apiClient);

// Creating client instance; connector name to be replaced with a real one.
const apiClient = new enablebanking.ApiClient('Sample', {
  sandbox: true,
  /* other settings, including callback redirect URI, to be set here */
});

// Initializing authentication interface.
const authApi = new enablebanking.AuthApi(apiClient);

// Creating client instance; connector name to be replaced with a real one.
api_client = enablebanking.ApiClient(
    "Sample",
    {
        "sandbox": True,
        # other settings, including callback redirect URI, to be set here
    })

// Initializing authentication interface.
auth_api = enablebanking.AuthApi(api_client)

After the choise has been made, we need to initialize API client for the chosen connector and create the authentication interface.

Connector settings (i.e. set of parameters used when initializing API client) differ from one connector to another. Description of settings for every connector can be found here.

2. Initiate user authentication

// Checking if user ID is required when initiating user authentication.
String userId = null;
if (connectorMeta.getAuthInfo().get(0).getInfo().isUserIdRequired()) {
    // Setting userId; in real case it is coming from a user.
    userId = "someUserId";
}

// Checking if user consent can be received while user authentication.
Access access = null;
if (connectorMeta.getAuthInfo().get(0).getInfo().isAccess()) {
    // Initializing access, i.e. scope of access, which user needs to consent with.
    access = new Access(/* user consent parameters */);
}

// Initiating user authentication
Auth auth = authApi.getAuth(
    "test", // state returned to callback redirect URI
    userId,
    access);

// Sending user to this URL for authentication
String authUrl = auth.url;

// Checking if user ID is required when initiating user authentication.
let userId;
if (connectorMeta.authInfo[0].info.userIdRequired) {
  // Setting userId; in real case it is coming from a user.
  userId = "someUserId";
}

// Checking if user consent can be received while user authentication.
let access;
if (connectorMeta.authInfo[0].info.access) {
  // Initializing access, i.e. scope of access, which user needs to consent with.
  access = new Access(/* user consent parameters */);
}

// Initiating user authentication
const auth = await authApi.getAuth({
  state: 'test', // state returned to callback redirect URI
  access: access,
  userId: userId
});

// Sending user to this URL for authentication
const authUrl = auth.url;

# Checking if user ID is required when initiating user authentication.
user_id = None
if connector_meta.auth_info[0].info.user_id_required:
    # Setting userId; in real case it is coming from a user.
    user_id = "some_user_id"

# Checking if user consent can be received while user authentication.
access = None
if connector_meta.auth_info[0].info.access:
    # Initializing access, i.e. scope of access, which user needs to consent with.
    access = enablebanking.Access(
        # user consent parameters
    )

# Initiating user authentication
auth = auth_api.get_auth(
    state='test', # state returned to callback redirect URI
    user_id=user_id,
    access=access)

# Sending user to this URL for authentication
url = auth.url

Some connectors require user ID to be set when initiating user authentication. This information is available in connector meta and user ID shall be requested from a user.

Also scope of access, which user needs to consent with, shall be set. It will be used if user consent can be received while user authentication. If not, modify consents shall be used later on. By default widest possible scope will be requested.

And after the parameters are set, user authentication shall be initiated.

3. Obtain authorization code and get an access token

// Extracting data from the URL where user was redirected to after authentication.
AuthRedirect redirectInfo = authApi.parseRedirectUrl("https://your.domain/callback");

// Obtaining user access token (and possibly refresh token as well).
Token token = authApi.makeToken(
    "authorization_code", // grant type
    redirectInfo.code, // authorization code
    auth.env // authentication environment
);

// Extracting data from the URL where user was redirected to after authentication.
AuthRedirect redirectInfo = authApi.parseRedirectUrl('https://your.domain/callback');

// Obtaining user access token (and possibly refresh token as well).
const token = await authApi.makeToken(
  'authorization_code', // grant type
  redirectInfo.code, // authorization code
  auth.env // authentication environment
)

# Extracting data from the URL where user was redirected to after authentication.
redirect_info = auth_api.parse_redirect_url("https://your.domain/callback")

# Obtaining user access token (and possibly refresh token as well).
token = auth_api.make_token(
    "authorization_code",  # grant type
    code,  # authorization code
    auth.env)

After the user has authenticated (and is redirected back to the desired URL), we are parsing this callback redirect URL to obtain an authorization code and other data.

The authorization code is to be used when making user access token. Along with the access token, returned Token data structure contains lifetime of the access token in seconds and refresh token (if it is supported).

4. Refresh access token (when needed)

Token refreshedToken = null;
if (connectorMeta.isRefreshToken()) {
    refreshedToken = authApi.makeToken(
        "refresh_token",  // grant type
        token.getRefreshToken(),  // refresh token
        null // environment is not needed for token refresh
    );
}

let refreshedToken;
if (connectorMeta.refreshToken) {
  refreshedToken = authApi.makeToken(
    "refresh_token", // grant type
    token.refresh_token // refresh token
  );
}

refreshed_token = None
if connector_meta.refresh_token:
    refreshed_token = auth_api.make_token(
        "refresh_token",
        token.refresh_token
    )

When supported, refresh token can be used for obtaining new user access token.

Information on whether refresh tokens are supported by a connector can be seen in the connector meta.

SDK reference

Select a language for code samples from the tabs above or the mobile navigation menu.

enable:Banking SDK consists of 4 interfaces:

• Meta provides information about available connectors;
• Auth provides PSU (bank user) authentication and token creation functionality;
• AISP provides functions for accessing account information, such as transactions and balances, on behalf of a PSU;
• PISP provides functions for initiating and conforming payment requests.

The same calls and data structures are used for interacting with different ASPSPs (banks). In order to use each of the interfaces corresponding instance needs to be created. When instantiating any of the interfaces except Meta, ASPSP connector name and settings need to be supplied. The settings differ from one connector to another (although many of them have the same properties) and are described in the Connectors section of the documentation.

enable:Banking SDK interfaces are based on STET PSD2 specification, but have been modified and extended in order to support usage scenarious beyond the original specification.

License: LicenseRef-LICENSE

Meta API

getConnectors

Code samples

const enablebanking = require('enablebanking');

const metaApi = new enablebanking.MetaApi(new enablebanking.ApiClient());

const connectors = await metaApi.getConnectors({
  country: 'FI' // requesting connectors for Finland
});

import enablebanking

meta_api = enablebanking.MetaApi(enablebanking.ApiClient())

connectors = meta_api.get_connectors(
    country='FI') # requesting connectors for Finland

import com.enablebanking.*;
import com.enablebanking.model.*;
import com.enablebanking.api.MetaApi;

MetaApi metaApi = new MetaApi(new ApiClient());

HalConnectors connectors = metaApi.getConnectors("FI"); // connectors for Finland

Retrieval of the available connectors

Parameters

Name	Type	Required	Description
country	string	false	Country ISO 3166-1 alpha-2 code

Returned value

Data type: HalConnectors

List of connectors

Auth API

getAuth

Code samples

const enablebanking = require('enablebanking');

const authApi = new enablebanking.AuthApi(
  new enablebanking.ApiClient('ConnectorName', { /* Connector settings */ }));

const { url } = await authApi.getAuth(
  {
    state: 'test' // state to pass to redirect URL
  });

import enablebanking

auth_api = enablebanking.AuthApi(enablebanking.ApiClient(
    'ConnectorName',
    {
      # Connector settings
    })

url = auth_api.get_auth(
    state='test', # state to pass to redirect URL
).url

import com.enablebanking.ApiClient;
import com.enablebanking.model.*;
import com.enablebanking.api.AuthApi;

// To be replaced with real connector settings class and set properties
ConnectorSettings connectorSettings = new SomeBankConnectorSettings();

AuthApi authApi = new AuthApi(new ApiClient(connectorSettings));

String url = authApi.getAuth(
    "test", // state to pass to redirect URL
    null,  // user id
    null, // password
    null // not passing access request (bank's defaults will be used)
).url;

Request Authorization Data

Parameters

Name	Type	Required	Description
state	string	false	Arbitrary String to be returned from to redirect URI
credentials	array[string]	false	Array of user credentials which are required to log in to the bank (e.g. user ID, password, phone number etc)
method	string	false	Authentication method
access	Access	false	Request for access to account information

Detailed descriptions

access: Request for access to account information This parameter should be set to override defaults for the banks, which allow PSUs to give consent for account information sharing right after authentication.

Returned value

Data type: Auth

Authorization Data

Exceptions

Data type	Description
HttpException	Raised when ASPSP API responses with unspecified error.

makeToken

Code samples

const enablebanking = require('enablebanking');

const authApi = new enablebanking.AuthApi(
  new enablebanking.ApiClient('ConnectorName', { /* Connector settings */ }));

const token = await authApi.makeToken(
  'authorization_code', // grant type, MUST be set to "authorization_code"
  'so43ls-3ldg03sd-hl4saa3l2sl5czfhl3'); // The code received in the query string when redirected from authorization

import enablebanking

auth_api = enablebanking.AuthApi(enablebanking.ApiClient(
    'ConnectorName',
    {
      # Connector settings
    })

token = auth_api.make_token(
    'authorization_code', # grant type, MUST be set to "authorization_code"
    'so43ls-3ldg03sd-hl4saa3l2sl5czfhl3') # The code received in the query string when redirected from authorization

import com.enablebanking.ApiClient;
import com.enablebanking.model.*;
import com.enablebanking.api.AuthApi;

// To be replaced with real connector settings class and set properties
ConnectorSettings connectorSettings = new SomeBankConnectorSettings();

AuthApi authApi = new AuthApi(new ApiClient(connectorSettings));

Token token = authApi.makeToken(
    "authorization_code", // grant type, MUST be set to "authorization_code"
    "so43ls-3ldg03sd-hl4saa3l2sl5czfhl3" // The code received in the query string when redirected from authorization
);

Request Access Token

Parameters

Name	Type	Required	Description
grant_type	string	true	Value should be set to authorization_code or refresh_token depending on what
code	string	false	Value of either the code received in the query string when redirected from
auth_env	string	false	Additional environment data for makeToken. This parameter is only required for some connectors.

Detailed descriptions

grant_type: Value should be set to authorization_code or refresh_token depending on what passed to code parameter.

code: Value of either the code received in the query string when redirected from authorization page or the refresh token used for renewing access token.

Enumerated Values

grant_type

Value	Description
authorization_code	Used to exchange an authorization code for an access token. After the user returns to the client via the redirect URL, the application will get the authorization code from the URL and use it to request an access token.
refresh_token	Used to exchange a refresh token for an access token when the access token has expired. This allows clients to continue to have a valid access token without further interaction with the user. Please note that refresh token is likely to be changed when calling `makeToken` with `refresh_token` grant type.

Returned value

Data type: Token

Authorisation token (Bearer)

Exceptions

Data type	Description
HttpException	Raised when ASPSP API responses with unspecified error.

getCurrentToken

Code samples

const enablebanking = require('enablebanking');

const authApi = new enablebanking.AuthApi(
  new enablebanking.ApiClient('ConnectorName', { /* Connector settings */ }));

const token = await authApi.getCurrentToken();

import enablebanking

auth_api = enablebanking.AuthApi(enablebanking.ApiClient(
    'ConnectorName',
    {
      # Connector settings
    })

token = auth_api.get_current_token()

import com.enablebanking.ApiClient;
import com.enablebanking.model.*;
import com.enablebanking.api.AuthApi;

// To be replaced with real connector settings class and set properties
ConnectorSettings connectorSettings = new SomeBankConnectorSettings();

AuthApi authApi = new AuthApi(new ApiClient(connectorSettings));

Token token = authApi.getCurrentToken();

Get current token data

Returned value

Data type: Token

Current token. Values for some fields might be missing if not used.

parseRedirectUrl

Parsing of redirect url during authorization

Parameters

Name	Type	Required	Description
redirectUrl	string	true	Redirect url

Returned value

Data type: AuthRedirect

Structured data extracted from redirect URL

setClientInfo

Set extra PSU headers

Parameters

Name	Type	Required	Description
clientInfo	ClientInfo	false	ClientInfo object with PSU headers

Returned value

Data type: None

Client Info was successfully set.

AISP API

getAccounts

Code samples

const enablebanking = require('enablebanking');

const aispApi = new enablebanking.AISPApi(
  new enablebanking.ApiClient('ConnectorName', { /* Connector settings */ }));

const accounts = await aispApi.getAccounts();

import enablebanking

aisp_api = enablebanking.AISPApi(enablebanking.ApiClient(
    'ConnectorName',
    {
      # Connector settings
    }))

accounts = aisp_api.get_accounts()

import com.enablebanking.ApiClient;
import com.enablebanking.api.AispApi;
import com.enablebanking.model.*;

// To be replaced with real connector settings class and set properties
ConnectorSettings connectorSettings = new SomeBankConnectorSettings();

AispApi aispApi = new AispApi(new ApiClient(connectorSettings));

HalAccounts accounts = aispApi.getAccounts();

Retrieval of the PSU accounts (AISP)

Returned value

Data type: HalAccounts

Returned value consists of the list of the accounts that have been made available to the AISP by the PSU and HYPERMEDIA links to the related resources provided by ASPSP through the API.

Exceptions

Data type	Description
HttpException	Raised when ASPSP API responses with unspecified error.
DataRetrievalException	Raised when unable to retrieve data requested from ASPSP API.
InsufficientScopeException	Raised when consent given by the PSU does not allow to retrieve requested data.
InvalidResponseSignatureException	none

getAccountBalances

Code samples

const enablebanking = require('enablebanking');

const aispApi = new enablebanking.AISPApi(
  new enablebanking.ApiClient('ConnectorName', { /* Connector settings */ }));

const balances = await aispApi.getAccountBalances('203059694928560295396833');

import enablebanking

aisp_api = enablebanking.AISPApi(enablebanking.ApiClient(
    'ConnectorName',
    {
      # Connector settings
    }))

balances = aisp_api.get_account_balances('203059694928560295396833')

import com.enablebanking.ApiClient;
import com.enablebanking.api.AispApi;
import com.enablebanking.model.*;

// To be replaced with real connector settings class and set properties
ConnectorSettings connectorSettings = new SomeBankConnectorSettings();

AispApi aispApi = new AispApi(new ApiClient(connectorSettings));

HalBalances balances = aispApi.getAccountBalances("203059694928560295396833")

Retrieval of an account balances report (AISP)

Parameters

Name	Type	Required	Description
accountResourceId	string	true	Identification of account resource to fetch

Returned value

Data type: HalBalances

Returned value consists of the list of account balances and HYPERMEDIA links to the related resources provided by ASPSP through the API.

Exceptions

Data type	Description
HttpException	Raised when ASPSP API responses with unspecified error.
DataRetrievalException	Raised when unable to retrieve data requested from ASPSP API.
InsufficientScopeException	Raised when consent given by the PSU does not allow to retrieve requested data.
InvalidResponseSignatureException	none

getAccountTransactions

Code samples

const enablebanking = require('enablebanking');

const aispApi = new enablebanking.AISPApi(
  new enablebanking.ApiClient('ConnectorName', { /* Connector settings */ }));

const transactions = await aispApi.getAccountTransactions('203059694928560295396833');

import enablebanking

aisp_api = enablebanking.AISPApi(enablebanking.ApiClient(
    'ConnectorName',
    {
      # Connector settings
    }))

transactions = aisp_api.get_account_transactions('203059694928560295396833')

import com.enablebanking.ApiClient;
import com.enablebanking.api.AispApi;
import com.enablebanking.model.*;

// To be replaced with real connector settings class and set properties
ConnectorSettings connectorSettings = new SomeBankConnectorSettings();

AispApi aispApi = new AispApi(new ApiClient(connectorSettings));

HalTransactions transactions = aispApi.getAccountTransactions("203059694928560295396833");

Retrieval of an account transaction set (AISP)

Parameters

Name	Type	Required	Description
accountResourceId	string	true	Identification of account resource to fetch
dateFrom	string(date-time)	false	Inclusive minimal imputation date of the transactions.
dateTo	string(date-time)	false	Exclusive maximal imputation date of the transactions.
continuationKey	string	false	Specifies the value on which the result has to be computed.
transactionStatus	TransactionStatus	false	Transactions having a transactionStatus equal to this parameter are included within the result.

Detailed descriptions

dateFrom: Inclusive minimal imputation date of the transactions.

Transactions having an imputation date equal to this parameter are included within the result.

dateTo: Exclusive maximal imputation date of the transactions.

Transactions having an imputation date equal to this parameter are not included within the result.

continuationKey: Specifies the value on which the result has to be computed.

Enumerated Values

transactionStatus

Value	Description
BOOK	(ISO20022 ClosingBooked) Accounted transaction
CNCL	Cancelled transaction
HOLD	Account hold
OTHR	Transaction with unknown status or not fitting the other options
PDNG	(ISO20022 Expected) Instant Balance Transaction
RJCT	Rejected transaction
SCHD	Scheduled transaction

Returned value

Data type: HalTransactions

Complete transactions response

Exceptions

Data type	Description
HttpException	Raised when ASPSP API responses with unspecified error.
DataRetrievalException	Raised when unable to retrieve data requested from ASPSP API.
InsufficientScopeException	Raised when consent given by the PSU does not allow to retrieve requested data.
TransactionPeriodException	Raised when wrong or invalid account transactions period is requested.
InvalidResponseSignatureException	none

modifyConsents

Code samples

const enablebanking = require('enablebanking');

const aispApi = new enablebanking.AISPApi(
  new enablebanking.ApiClient('ConnectorName', { /* Connector settings */ }));

const consent = await aispApi.modifyConsents({
  access: {
    balances: ['203059694928560295396833'],
    transactions: [],
    trustedBeneficiaries: false,
    psuIdentity: true
  }
});

import enablebanking

aisp_api = enablebanking.AISPApi(enablebanking.ApiClient(
    'ConnectorName',
    {
      # Connector settings
    }))

consent = aisp_api.modify_consents(
    access=enablebanking.Access(
        # default access to balances
        balances=enablebanking.BalancesAccess(),
        # default access to transactions
        transactions=enablebanking.TransacrionsAccess(),
        trusted_beneficiaries=False,
        psu_identity=True,
    ),
)

import com.enablebanking.ApiClient;
import com.enablebanking.api.AispApi;
import com.enablebanking.model.*;

// To be replaced with real connector settings class and set properties
ConnectorSettings connectorSettings = new SomeBankConnectorSettings();

AispApi aispApi = new AispApi(new ApiClient(connectorSettings));

Consent consent = aispApi.modifyConsents(
  new Access()
    .balances(new BalancesAccess()) // default access to balances
    .transactions(new TransactionsAccess()) // default access to transactions
    .trustedBeneficiaries(false)
    .psuIdentity(true));

Forwarding the PSU consent (AISP)

Parameters

Name	Type	Required	Description
access	Access	false	List of consents granted to the AISP by the PSU.

Returned value

Data type: Consent

Created or modified consent

Exceptions

Data type	Description
HttpException	Raised when ASPSP API responses with unspecified error.

getCurrentConsent

Code samples

const enablebanking = require('enablebanking');

const aispApi = new enablebanking.AISPApi(
  new enablebanking.ApiClient('ConnectorName', { /* Connector settings */ }));

const consent = await aispApi.getCurrentConsent();

import enablebanking

aisp_api = enablebanking.AISPApi(enablebanking.ApiClient(
    'ConnectorName',
    {
      # Connector settings
    }))

consent = aisp_api.get_current_consent()

import com.enablebanking.ApiClient;
import com.enablebanking.api.AispApi;
import com.enablebanking.model.*;

// To be replaced with real connector settings class and set properties
ConnectorSettings connectorSettings = new SomeBankConnectorSettings();

AispApi aispApi = new AispApi(new ApiClient(connectorSettings));

Consent consent = aispApi.getCurrentConsent();

Returns current consent (AISP)

Returned value

Data type: Consent

Current consent used for accessing AIS APIs.

deleteConsent

Deletes consent (AISP)

Parameters

Name	Type	Required	Description
consentId	string	true	Identification of consent to fetch

Returned value

Data type: None

Consent successfully revoked

PISP API

makePaymentRequest

Code samples

const enablebanking = require('enablebanking');

const pispApi = new enablebanking.PISPApi(
  new enablebanking.ApiClient('ConnectorName', { /* Connector settings */ }));

// Making payment request with credit transafer transaction of one element
const requestCreation = await pispApi.makePaymentRequest({
  creditTransferTransaction: [{
    instructedAmount: {
      amount: '12.25', // amount
      currency: 'EUR' // currency code
    },
    beneficiary: {
      creditor: {
        name: 'Creditor Name' // payee (merchant) name
      },
      creditorAccount: {
        iban: 'FI4966010005485495' // payee account number
      }
    }
  }],
  debtor: {
    name: 'Debtor Name' // payer (account holder) name
  },
  debtorAccount: {
    iban: 'FI3839390001384700' // payer account number
  }
});

import enablebanking

pisp_api = enablebanking.PISPApi(enablebanking.ApiClient(
    'ConnectorName',
    {
      # Connector settings
    }))

# Making payment request with credit transafer transaction of one element
request_creation = pisp_api.make_payment_request(
    enablebanking.PaymentRequestResource(
        credit_transfer_transaction=[
            enablebanking.CreditTransferTransaction(
                instructed_amount=enablebanking.AmountType(
                    amount='12.25', # amount
                    currency='EUR'), # currency code
                beneficiary=enablebanking.Beneficiary(
                    creditor=enablebanking.PartyIdentification(
                        name='Creditor Name'), # payee (merchant) name
                    creditor_account=enablebanking.AccountIdentification(
                        iban='FI4966010005485495'), # payee account number
                ),
            ),
        ],
        debtor=enablebanking.PartyIdentification(
            name='Debtor Name'), # payer (account holder) name
        debtor_account=enablebanking.AccountIdentification(
            iban='FI3839390001384700'), # payer account number
    ))

import java.math.BigDecimal;
import java.util.Arrays;

import com.enablebanking.ApiClient;
import com.enablebanking.api.PispApi;
import com.enablebanking.model.*;

// To be replaced with real connector settings class and set properties
ConnectorSettings connectorSettings = new SomeBankConnectorSettings();

PispApi pispApi = new PispApi(new ApiClient(connectorSettings));

// Making payment request with credit transafer transaction of one element
HalPaymentRequestCreation requestCreation = pispApi.makePaymentRequest(
  new PaymentRequestResource()
    .creditTransferTransaction(Arrays.asList(
      new CreditTransferTransaction()
        .instructedAmount(
          new AmountType()
            .currency("EUR")
            .amount(new BigDecimal("12.25")))
        .beneficiary(
          new Beneficiary()
            .creditor(
              new PartyIdentification()
                .name("Creditor Name"))
            .creditorAccount(
              new AccountIdentification()
                .iban("FI4966010005485495")))))
    .debtor(
      new PartyIdentification()
        .name("Debtor Name"))
    .debtorAccount(
      new AccountIdentification()
        .iban("FI3839390001384700")));

Payment request initiation (PISP)

Parameters

Name	Type	Required	Description
state	string	false	Arbitrary String to be returned from to redirect URI
paymentRequest	PaymentRequestResource	true	ISO20022 based payment Initiation Request

Returned value

Data type: HalPaymentRequestCreation

The request has been created as a resource. The ASPSP must authenticate the PSU.

Exceptions

Data type	Description
HttpException	Raised when ASPSP API responses with unspecified error.

getPaymentRequest

Retrieval of a payment request (PISP)

Parameters

Name	Type	Required	Description
paymentRequestResourceId	string	true	Identification of the Payment Request Resource

Returned value

Data type: HalPaymentRequest

Retrieval of the previously posted Payment Request

Exceptions

Data type	Description
HttpException	Raised when ASPSP API responses with unspecified error.

modifyPaymentRequest

Modification of a payment/transfer request (PISP)

Parameters

Name	Type	Required	Description
paymentRequestResourceId	string	true	Identification of the Payment Request Resource
paymentRequest	PaymentRequestResource	true	ISO20022 based payment Initiation Request

Returned value

Data type: HalPaymentRequestCreation

The modification request has been saved. The ASPSP must authenticate the PSU before committing the update.

Exceptions

Data type	Description
HttpException	Raised when ASPSP API responses with unspecified error.

makePaymentRequestConfirmation

Confirmation of a payment request or a modification request (PISP)

Parameters

Name	Type	Required	Description
paymentRequestResourceId	string	true	Identification of the Payment Request Resource
confirmation	PaymentRequestConfirmation	false	Data needed for confirmation of the Payment Request, especially in EMBEDDED approach

Detailed descriptions

confirmation: Data needed for confirmation of the Payment Request, especially in EMBEDDED approach

Returned value

Data type: HalPaymentRequest

retrieval of the Payment Request enriched with the status report

Exceptions

Data type	Description
HttpException	Raised when ASPSP API responses with unspecified error.

CBPII API

makeFundsConfirmation

Payment coverage check request (CBPII)

Parameters

Name	Type	Required	Description
paymentCoverage	PaymentCoverageRequestResource	true	parameters of a payment coverage request

Returned value

Data type: HalPaymentCoverageReport

payment coverage request

Data types

Access

Requested access services.

Fields

Name	Type	Required	Description
accounts	[AccountIdentification]	false	List of accounts access to which is requested. If not set behaviour depends on the bank: some banks allow users to choose list of accessible accounts through their access consent UI, while other may provide access to all accounts or just access to the list of accounts.
balances	BalancesAccess	false	Defines how balance information is going to be accessed. If not set balances are not explicitly requested
transactions	TransactionsAccess	false	Defines how transactions are going to be accessed. If not set transactions are not explicitly requested
trustedBeneficiaries	boolean	false	Indicator that access to the trusted beneficiaries list was granted or not to the AISP by the PSU true: the access was granted false: the access was not granted
psuIdentity	boolean	false	Indicator that access to the PSU identity, first name and last name, was granted or not to the AISP by the PSU true: the access was granted false: the access was not granted
accountDetails	boolean	false	Indicates if access to account details if explicitly requested
recurringIndicator	boolean	false	true: the consent is for recurring access to the account data. false: the consent is for one access to the account data.
frequencyPerDay	integer	false	This field indicates the requested maximum frequency for an access without PSU involvement per day. For a one-off access, this attribute is set to "1". The frequency needs to be greater equal to one.
validUntil	string(date-time)	false	This parameter is requesting a valid until date for the requested consent. The content is the local ASPSP date in ISO-Date Format, e.g. 2017-10-30. Future dates might get adjusted by ASPSP.

AccountIdentification

Unique and unambiguous identification for the account between the account owner and the account servicer.

Fields

Name	Type	Required	Description
iban	string	false	ISO20022: International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer. Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 "Banking and related financial services - International Bank Account Number (IBAN)" version 1997-10-01, or later revisions.
other	GenericIdentification	false	ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support.

AccountResource

PSU account that is made available to the TPP

Fields

Name	Type	Required	Description
resourceId	ResourceId	false	Identifier assigned by the ASPSP for further use of the created resource through API calls
accountServicer	FinancialInstitutionIdentification	false	ISO20022: Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.
accountId	AccountIdentification	false	Unique and unambiguous identification for the account between the account owner and the account servicer.
name	string	true	Account holder(s) name
details	string	false	Account description set by PSU or provided by ASPSP
linkedAccount	string	false	Case of a set of pending card transactions, the APSP will provide the relevant cash account the card is set up on.
usage	string	false	Specifies the usage of the account
cashAccountType	string	true	Specifies the type of the account
product	string	false	Product Name of the Bank for this account, proprietary definition
currency	CurrencyCode	true	Currency used for the account
creditLimit	AmountType	false	ISO20022: structure aiming to carry either an instructed amount or equivalent amount. Both structures embed the amount and the currency to be used. API: only instructed amount can be used
balances	[BalanceResource]	false	list of balances provided by the ASPSP
psuStatus	string	false	Relationship between the PSU and the account - Account Holder - Co-account Holder - Attorney
_links	AccountLinks	true	links that can be used for further navigation when browsing Account Information at one account level

Enumerated Values

usage

Value	Description
PRIV	private personal account
ORGA	professional account

cashAccountType

Value	Description
CACC	Account used to post debits and credits when no specific account has been nominated
CASH	Account used for the payment of cash
CARD	List of card based transactions (non ISO 20022)
LOAN	Loan account

AddressType

ISO20022: Identifies the nature of the postal address.

Base type

string

Enumerated Values

Value	Description
Business	—
Correspondence	—
DeliveryTo	—
MailTo	—
POBox	—
Postal	—
Residential	—
Statement	—

AmountType

ISO20022: structure aiming to carry either an instructed amount or equivalent amount. Both structures embed the amount and the currency to be used.

API: only instructed amount can be used

Fields

Name	Type	Required	Description
currency	CurrencyCode	true	Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
amount	string(number)	true	ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

Auth

Fields

Name	Type	Required	Description
url	string	false	URL for authorization. Used for REDIRECT authorization flow
env	string	false	Additional authorization environment data. To be passed to makeToken.
authData	[AuthDataItem]	false	[structure used for returning auth parameters to be passed to user]

AuthDataItem

structure used for returning auth parameters to be passed to user

Fields

Name	Type	Required	Description
type	string	false	Type of the auth data item
value	string	false	Value of auth data item

Enumerated Values

type

Value	Description
otpIndex	—

AuthInfo

Information about usage of getAuth method

Fields

Name	Type	Required	Description
access	boolean	true	Shows if access parameter is supported in getAuth method
credentials	[Credential]	false	Shows necessary credentials needed to provide in getAuth method. null if not required.
authData	boolean	false	Shows if authData is returned in getAuth response
brands	[Brand]	false	List of brands used by the ASPSP (in a certain country)

AuthRedirect

structure used for returning parameters of redirect url

Fields

Name	Type	Required	Description
code	string	false	redirect code received from a bank
id_token	string	false	Id of token received from a bank
state	string	false	state specified by TPP
error	string	false	error message

AuthenticationApproach

The ASPSP, based on the authentication approaches proposed by the PISP, choose the one that it can processed, in respect with the preferences and constraints of the PSU and indicates in this field which approach has been chosen

Base type

string

Enumerated Values

Value	Description
REDIRECT	the PSU is redirected by the TPP to the ASPSP which processes identification and authentication
DECOUPLED	the TPP identifies the PSU and forwards the identification to the ASPSP which processes the authentication through a decoupled device
EMBEDDED	the TPP identifies the PSU and forwards the identification to the ASPSP which starts the authentication. The TPP forwards one authentication factor of the PSU (e.g. OTP or response to a challenge)

BalanceResource

Structure of an account balance

Fields

Name	Type	Required	Description
name	string	true	Label of the balance
balanceAmount	AmountType	true	ISO20022: structure aiming to carry either an instructed amount or equivalent amount. Both structures embed the amount and the currency to be used. API: only instructed amount can be used
balanceType	BalanceStatus	true	Type of balance
lastChangeDateTime	string(date-time)	false	Timestamp of the last change of the balance amount
referenceDate	string(date)	false	Reference date for the balance
lastCommittedTransaction	string	false	Identification of the last committed transaction. This is actually useful for instant balance.

BalanceStatus

Type of balance

Base type

string

Enumerated Values

Value	Description
CLBD	(ISO20022 ClosingBooked) Accounting Balance
FWAV	(ISO20022 ForwardAvailable) Balance of money that is at the disposal of the account owner on the date specified
ITAV	(ISO20022 InterimAvailable) Available balance calculated in the course of the day
ITBD	(ISO20022 InterimBooked) Booked balance calculated in the course of the day
OTHR	Other Balance
VALU	Value-date balance
XPCD	(ISO20022 Expected) Instant Balance

BalancesAccess

Defines what access to blanaces is requested

Fields

Name	Type	Required	Description
statuses	[BalanceStatus]	false	List of balance statuses, which are going to be accessed

BankTransactionCode

ISO20022: Allows the account servicer to correctly report a transaction, which in its turn will help account owners to perform their cash management and reconciliation operations.

Fields

Name	Type	Required	Description
description	string	false	Transaction type description
code	string	false	ISO20022: Specifies the family of a transaction within the domain
subCode	string	false	ISO20022: Specifies the sub-product family of a transaction within a specific family

Beneficiary

Specification of a beneficiary

Fields

Name	Type	Required	Description
id	string	false	Id of the beneficiary
isTrusted	boolean	false	The ASPSP having not implemented the trusted beneficiaries list must not set this flag. Otherwise, the ASPSP indicates whether or not the beneficiary has been registered by the PSU within the trusted beneficiaries list. true: the beneficiary is actually a trusted beneficiary (when set by ASPSP) false: the beneficiary is not a trusted beneficiary The PISP may set this flag to "true" to indicate that the PSU considers the beneficiary as trusted and to be inserted within the trusted beneficiaries list, as far as this feature was implemented by the ASPSP. true: the beneficiary should be registered as a trusted beneficiary (when set by PISP)
creditorAgent	FinancialInstitutionIdentification	false	ISO20022: Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.
creditor	PartyIdentification	false	API : Description of a Party which can be either a person or an organization.
creditorAccount	AccountIdentification	true	Unique and unambiguous identification for the account between the account owner and the account servicer.
creditorCurrency	string	false	Creditor account currency code

BookingInformation

indicator that the payment can be immediately booked or not

• true: payment is booked
• false: payment is not booked

Base type

boolean

Brand

Information about ASPSP end-user recognizable brand

Fields

Name	Type	Required	Description
name	string	true	End-customer facing name
logos	[Logo]	false	List of available logos

CategoryPurposeCode

ISO20022: Specifies the high level purpose of the instruction based on a set of pre-defined categories. This is used by the initiating party to provide information concerning the processing of the payment. It is likely to trigger special processing by any of the agents involved in the payment chain.

Base type

string

Enumerated Values

Value	Description
BONU	BonusPayment Transaction is the payment of a bonus.
CASH	CashManagementTransfer Transaction is a general cash management instruction.
CBLK	Card Bulk Clearing A Service that is settling money for a bulk of card transactions, while referring to a specific transaction file or other information like terminal ID, card acceptor ID or other transaction details.
CCRD	Credit Card Payment Transaction is related to a payment of credit card.
CORT	TradeSettlementPayment Transaction is related to settlement of a trade, eg a foreign exchange deal or a securities transaction.
DCRD	Debit Card Payment Transaction is related to a payment of debit card.
DIVI	Dividend Transaction is the payment of dividends.
DVPM	DeliverAgainstPayment Code used to pre-advise the account servicer of a forthcoming deliver against payment instruction.
EPAY	Epayment Transaction is related to ePayment.
FCOL	Fee Collection A Service that is settling card transaction related fees between two parties.
GOVT	GovernmentPayment Transaction is a payment to or from a government department.
HEDG	Hedging Transaction is related to the payment of a hedging operation.
ICCP	Irrevocable Credit Card Payment Transaction is reimbursement of credit card payment.
IDCP	Irrevocable Debit Card Payment Transaction is reimbursement of debit card payment.
INTC	IntraCompanyPayment Transaction is an intra-company payment, ie, a payment between two companies belonging to the same group.
INTE	Interest Transaction is the payment of interest.
LOAN	Loan Transaction is related to the transfer of a loan to a borrower.
MP2B	Commercial Mobile P2B Payment
MP2P	Consumer Mobile P2P Payment
OTHR	OtherPayment Other payment purpose.
PENS	PensionPayment Transaction is the payment of pension.
RPRE	Represented Collection used to re-present previously reversed or returned direct debit transactions.
RRCT	ReimbursementReceivedCreditTransfer Transaction is related to a reimbursement for commercial reasons of a correctly received credit transfer.
RVPM	ReceiveAgainstPayment Code used to pre-advise the account servicer of a forthcoming receive against payment instruction.
SALA	SalaryPayment Transaction is the payment of salaries.
SECU	Securities Transaction is the payment of securities.
SSBE	SocialSecurityBenefit Transaction is a social security benefit, ie payment made by a government to support individuals.
SUPP	SupplierPayment Transaction is related to a payment to a supplier.
TAXS	TaxPayment Transaction is the payment of taxes.
TRAD	Trade Transaction is related to the payment of a trade finance transaction.
TREA	TreasuryPayment Transaction is related to treasury operations. E.g. financial contract settlement.
VATX	ValueAddedTaxPayment Transaction is the payment of value added tax.
WHLD	WithHolding Transaction is the payment of withholding tax.

ChargeBearerCode

ISO20022: Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

Base type

string

Enumerated Values

Value	Description
SLEV	Service level. Charges are to be applied following the rules agreed in the service level and/or scheme.
SHAR	Shared.
DEBT	The Payer (sender of the payment) will bear all of the payment transaction fees.
CRED	The Payee (recipient of the payment) will incur all of the payment transaction fees.

ClearingSystemMemberIdentification

ISO20022: Information used to identify a member within a clearing system. API: to be used for some specific international credit transfers in order to identify the beneficiary bank

Fields

Name	Type	Required	Description
clearingSystemId	string	false	ISO20022: Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.
memberId	string	false	ISO20022: Identification of a member of a clearing system.

ClientInfo

Client Data.

Fields

Name	Type	Required	Description
psuIpAddress	string	false	IP address used by the PSU's terminal when connecting to the TPP
psuIpPort	string	false	IP port used by the PSU's terminal when connecting to the TPP
psuHttpMethod	string	false	Http method for the most relevant PSU’s terminal request to the TTP
psuDate	string	false	Timestamp of the most relevant PSU’s terminal request to the TTP
psuUserAgent	string	false	"User-Agent" header field sent by the PSU terminal when connecting to the TPP
psuReferer	string	false	"Referer" header field sent by the PSU terminal when connecting to the TPP. Notice that an initial typo in RFC 1945 specifies that "referer" (incorrect spelling) is to be used. The correct spelling "referrer" can be used but might not be understood.
psuAccept	string	false	"Accept" header field sent by the PSU terminal when connecting to the TPP
psuAcceptCharset	string	false	"Accept-Charset" header field sent by the PSU terminal when connecting to the TPP
psuAcceptEncoding	string	false	"Accept-Encoding" header field sent by the PSU terminal when connecting to the TPP
psuAcceptLanguage	string	false	"Accept-Language" header field sent by the PSU terminal when connecting to the TPP
psuGeoLocation	string	false	Geographical location of the PSU as provided by the PSU mobile terminal if any to the TPP
psuDeviceId	string	false	UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of installation identification this ID need to be unaltered until removal from device.
psuLastLoggedTime	string	false	The time when the PSU last logged in with the TPP.

Connector

Information about the connector used for interaction with ASPSPs

Fields

Name	Type	Required	Description
name	string	true	Name of the connector
environments	[string]	true	List of supported environments (sandbox/production)
countries	[string]	true	List of supported countries supported
scopes	[string]	true	List of supported APIs (aisp/pisp) supported
modifyConsentsInfo	[CountryModifyConsentsInfo]	true	Details about usage of modifyConsents method by country
authInfo	[CountryAuthInfo]	true	Details about usage of getAuth method by country
transactionsInfo	[TransactionsInfo]	false	Details about usage and limitations of getAccountTransactions method by country and psuType
consentRevocation	boolean	true	Flag showing if the consent revocation is supported in the connector
refreshToken	boolean	true	Flag showing if the refresh_token grant type is supported in the connector
payments	[CountryPaymentTypes]	true	Supported payment types by country
aspspIds	[string]	true	List of all ASPSP IDs supported in the connector
requiredPsuHeaders	[string]	true	List of required PSU headers
psuTypes	[string]	true	List of supported PSU types (personal/business)
authMethods	[CountryAuthMethods]	true	List of supported authentication methods by country

ConnectorSettings

Base settings for all connectors

Fields

Name	Type	Required	Description
sandbox	boolean	true	Defines whether connect to sandbox or production APIs
consentId	string	true	User consent identifier
accessToken	string	true	User access token
redirectUri	string	true	URI where clients are redirected to after giving consent.
connector	string	true	Connector identifier (discriminator)

ConnectorsLinks

links that can be used for further navigation when browsing connector information

Fields

Name	Type	Required	Description
self	GenericLink	true	hypertext reference

Consent

User consent

Fields

Name	Type	Required	Description
consentStatus	string	false	none
consentId	string	false	none
_links	ConsentLinks	false	none

CoopPankConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
xApiKey	string	true	API client key (obtained in developer portal)
country	string	true	Bank`s country
certPath	string	false	Path to QWAC certificate in PEM format
keyPath	string	false	Path to QWAC certificate private key in PEM format
nokRedirectUri	string	false	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

CoreException

Base Exception class in SDK, raised for unexpected exceptions.

Fields

Name	Type	Required	Description
code	integer(int32)	true	Error code
message	string	true	Error description

CountryAuthInfo

Auxiliary data structure binding information about usage of getAuth method to a country and authentication method

Fields

Name	Type	Required	Description
country	string	true	Country ISO 3166-1 alpha-2 code
method	string	false	Authentication method
title	string	false	Authentication method human readable name
info	AuthInfo	true	Information about usage of getAuth method

CountryAuthMethods

Auxiliary data structure binding information about usage of getAuthMethods method to a country

Fields

Name	Type	Required	Description
country	string	true	Country ISO 3166-1 alpha-2 code
info	[string]	true	Information about available auth methods

CountryModifyConsentsInfo

Auxiliary data structure binding information about usage of modifyConsents method to a country

Fields

Name	Type	Required	Description
country	string	true	Country ISO 3166-1 alpha-2 code
info	ModifyConsentsInfo	true	Information about usage of modifyConsents method

CountryPaymentTypes

Auxiliary data structure containing binding information about supported payment types to a country

Fields

Name	Type	Required	Description
country	string	true	Country ISO 3166-1 alpha-2 code
paymentTypes	[PaymentTypeInformation]	true	List of payment types for the country

CreationDateTime

ISO20022: Date and time at which a (group of) payment instruction(s) was created by the instructing party.

Base type

string(date-time)

Credential

User credentials to provide in getAuth call

Fields

Name	Type	Required	Description
name	string	true	Name of user credential. (userId, password, companyId, phoneNumber, personalCode, etc)
title	string	true	Human readable and formatted name of user credential. (User ID, Password, Company ID, Phone Number, Personal Code, etc)
required	boolean	true	Shows if it is necessary to provide credential in getAuth method
description	string	false	Description of the field.
template	string	false	Shows required format for the credential (if any)

CreditTransferTransaction

ISO20022: Payment processes required to transfer cash from the debtor to the creditor. API:

Fields

Name	Type	Required	Description
paymentId	PaymentIdentification	false	ISO20022: Set of elements used to reference a payment instruction.
requestedExecutionDate	RequestedExecutionDate	false	ISO20022: Date at which the initiating party requests the clearing agent to process the payment. API: This date can be used in the following cases: - the single requested execution date for a payment having several instructions. In this case, this field must be set at the payment level. - the requested execution date for a given instruction within a payment. In this case, this field must be set at each instruction level. - The first date of execution for a standing order. When the payment cannot be processed at this date, the ASPSP is allowed to shift the applied execution date to the next possible execution date for non-standing orders. For standing orders, the [executionRule] parameter helps to compute the execution date to be applied.
endDate	EndDate	false	The last applicable day of execution for a given standing order. If not given, the standing order is considered as endless.
executionRule	ExecutionRule	false	Execution date shifting rule for standing orders This data attribute defines the behaviour when recurring payment dates falls on a weekend or bank holiday. The payment is then executed either the "preceding" or "following" working day. ASPSP might reject the request due to the communicated value, if rules in Online-Banking are not supporting this execution rule.
frequency	FrequencyCode	false	Frequency rule for standing orders. The following codes from the "EventFrequency7Code" of ISO 20022 are supported. However, each ASPSP might restrict these values into a subset.
instructedAmount	AmountType	true	ISO20022: structure aiming to carry either an instructed amount or equivalent amount. Both structures embed the amount and the currency to be used. API: only instructed amount can be used
exchangeRateInformation	ExchangeRate	false	Provides details on the currency exchange rate and contract.
ultimateDebtor	PartyIdentification	false	API : Description of a Party which can be either a person or an organization.
beneficiary	Beneficiary	true	Specification of a beneficiary
ultimateCreditor	PartyIdentification	false	API : Description of a Party which can be either a person or an organization.
regulatoryReportingCodes	RegulatoryReportingCodes	false	List of needed regulatory reporting codes for international payments
remittanceInformation	UnstructuredRemittanceInformation	false	Payment details. For credit transfers may contain free text, reference number or both at the same time (in case Extended Remittance Information is supported). When it is known that remittance information contains a reference number (either based on ISO 11649 or a local scheme), the reference number is also available via the referenceNumber field of the Transaction data structure.
transactionStatus	TransactionIndividualStatusCode	false	ISO20022: Specifies the status of the payment information group.
statusReasonInformation	StatusReasonInformation	false	ISO20022: Provides detailed information on the status reason. Can only be used in status equal to "RJCT".

CurrencyCode

Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

Base type

string

EndDate

The last applicable day of execution for a given standing order. If not given, the standing order is considered as endless.

Base type

string(date-time)

ExchangeRate

Provides details on the currency exchange rate and contract.

Fields

Name	Type	Required	Description
unitCurrency	CurrencyCode	false	Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
exchangeRate	string(number)	false	The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
rateType	string	false	none
contractIdentification	string	false	Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

Enumerated Values

rateType

Value	Description
SPOT	Spot – Exchange rate applied is the spot rate.
SALE	Sale – Exchange rate applied is the market rate at the time of the sale.
AGRD	Agreed – Exchange rate applied is the rate agreed between the parties.

ExecutionRule

Execution date shifting rule for standing orders This data attribute defines the behaviour when recurring payment dates falls on a weekend or bank holiday. The payment is then executed either the "preceding" or "following" working day. ASPSP might reject the request due to the communicated value, if rules in Online-Banking are not supporting this execution rule.

Base type

string

Enumerated Values

Value	Description
FWNG	following
PREC	preceding

FinancialInstitutionIdentification

ISO20022: Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.

Fields

Name	Type	Required	Description
bicFi	string	true	ISO20022: Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)".
clearingSystemMemberId	ClearingSystemMemberIdentification	false	ISO20022: Information used to identify a member within a clearing system. API: to be used for some specific international credit transfers in order to identify the beneficiary bank
name	string	false	Name of the financial institution
postalAddress	PostalAddress	false	ISO20022 : Information that locates and identifies a specific address, as defined by postal services.

FrequencyCode

Frequency rule for standing orders. The following codes from the "EventFrequency7Code" of ISO 20022 are supported. However, each ASPSP might restrict these values into a subset.

Base type

string

Enumerated Values

Value	Description
DAIL	Daily
WEEK	Weekly
TOWK	EveryTwoWeeks
MNTH	Monthly
TOMN	EveryTwoMonths
QUTR	Quarterly
SEMI	SemiAnnual
YEAR	Annual

FundsAvailabilityInformation

indicator that the payment can be covered or not by the funds available on the relevant account

• true: payment is covered
• false: payment is not covered

Base type

boolean

GenericIdentification

ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support.

Fields

Name	Type	Required	Description
identification	string	true	API Identifier
schemeName	string	true	Name of the identification scheme. Partially based on ISO20022 external code list
issuer	string	false	ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties

Enumerated Values

schemeName

Value	Description
CHID	Clearing Identification Number
GS1G	GS1GLNIdentifier
DUNS	Data Universal Numbering System
BANK	BankPartyIdentification. Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client.
TXID	TaxIdentificationNumber
CUST	CorporateCustomerNumber
EMPL	EmployerIdentificationNumber
OTHC	OtherCorporate. Handelsbanken-specific code
DRLC	DriversLicenseNumber
CUSI	CustomerIdentificationNumberIndividual. Handelsbanken-specific code
SOSE	SocialSecurityNumber
ARNU	AlienRegistrationNumber
CCPT	PassportNumber
TXII	TaxIdentificationNumberIndividual. Handelsbanken-specific code
EMPI	EmployeeIdentificationNumberIndividual. Handelsbanken-specific code
OTHI	OtherIndividual. Handelsbanken-specific code
COID	CountryIdentificationCode. Country authority given organisation identification (e.g., corporate registration number)
SREN	The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France.
SRET	The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity.
NIDN	NationalIdentityNumber. Number assigned by an authority to identify the national identity number of a person.
OAUT	OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU
CPAN	Card PAN
BBAN	Basic Bank Account Number. Represents a country-specific bank account number.
BG	Swedish BankGiro account number. Used in domestic swedish giro payments
PG	Swedish PlusGiro account number. Used in domestic swedish giro payments

HalAccounts

HYPERMEDIA structure used for returning the list of the available accounts to the AISP

Fields

Name	Type	Required	Description
connectedPsu	string	false	Last name and first name that has granted access to the AISP on the accounts data This information can be retrieved based on the PSU's authentication that occurred during the OAUTH2 access token initialisation.
accounts	[AccountResource]	true	List of PSU account that are made available to the TPP
_links	AccountsLinks	true	Links that can be used for further navigation when browsing Account Information at top level

HalBalances

HYPERMEDIA structure used for returning the list of the relevant balances for a given account to the AISP

Fields

Name	Type	Required	Description
balances	[BalanceResource]	true	List of account balances
_links	BalancesLinks	true	links that can be used for further navigation when browsing Account Information at one account level

HalBeneficiaries

HYPERMEDIA structure used for returning the list of the whitelisted beneficiaries

Fields

Name	Type	Required	Description
beneficiaries	[Beneficiary]	true	List of trusted beneficiaries
_links	BeneficiariesLinks	true	links that can be used for further navigation when browsing Account Information at one account level

HalConnectors

HYPERMEDIA structure used for returning the list of the connectors for given countries

Fields

Name	Type	Required	Description
connectors	[Connector]	true	List of connectors
_links	ConnectorsLinks	false	links that can be used for further navigation when browsing connector information

HalPaymentCoverageReport

HYPERMEDIA structure used for returning the payment coverage report to the CBPII

Fields

Name	Type	Required	Description
request	PaymentCoverageRequestResource	true	Payment coverage request structure. The request must rely either on a cash account or a payment card.
result	boolean	true	Result of the coverage check : true: the payment can be covered false: the payment cannot be covered
_links	PaymentCoverageReportLinks	true	links that can be used for further navigation to post another coverage request.

HalPaymentRequest

HYPERMEDIA structure used for returning the original Payment Request to the PISP

Fields

Name	Type	Required	Description
paymentRequest	PaymentRequestResource	true	ISO20022: The PaymentRequestResource message is sent by the Creditor sending party to the Debtor receiving party, directly or through agents. It is used by a Creditor to request movement of funds from the debtor account to a creditor. API: Information about the creditor (Id, account and agent) might be placed either at payment level or at instruction level. Thus multi-beneficiary payments can be handled. The requested execution date can be placed either at payment level when all instructions are requested to be executed at the same date or at instruction level. The latest case includes: - multiple instructions having different requested execution dates - standing orders settings
_links	PaymentRequestLinks	true	links that can be used for further navigation when having post a Payment Request in order to get the relevant status report.

HalPaymentRequestCreation

data forwarded by the ASPSP to the PISP after creation of the Payment Request resource creation

Fields

Name	Type	Required	Description
paymentRequestResourceId	ResourceId	false	Identifier assigned by the ASPSP for further use of the created resource through API calls
appliedAuthenticationApproach	AuthenticationApproach	false	The ASPSP, based on the authentication approaches proposed by the PISP, choose the one that it can processed, in respect with the preferences and constraints of the PSU and indicates in this field which approach has been chosen
_links	PaymentRequestResourceCreationLinks	false	Links that can be used for further navigation, especially in REDIRECT approach

HalTransactions

HYPERMEDIA structure used for returning the list of the transactions for a given account to the AISP

Fields

Name	Type	Required	Description
transactions	[Transaction]	true	List of transactions
continuationKey	string	false	Value to be passed to getAccountTransactions to retrieve next page of transactions. Null if there are no more pages. Only valid in current session.
_links	TransactionsLinks	true	links that can be used for further navigation when browsing Account Information at one account level

HttpException

Code samples

import com.enablebanking.ApiClient;
import com.enablebanking.api.AuthApi;
import com.enablebanking.model.*;

// To be replaced with real connector settings class and set properties
ConnectorSettings connectorSettings = new SomeBankConnectorSettings();

AuthApi authApi = new AuthApi(new ApiClient(connectorSettings));
try {
  Auth auth = authApi.getAuth("state", null, null, null);  // Let's say Unexpected HTTP exception occured
} catch (HttpException e) {
  List> headers = httpException.getResponseHeaders();
  String body = httpException.getResponseBody();
  int code = httpException.getCode();
}

This exception is raised when ASPSP API responses with unspecified error. Base exception for HTTP related errors

Base type

CoreException

Fields

Name	Type	Required	Description
responseHeaders	[object]	true	Headers of http response
responseBody	string	true	Body of http response

InvalidCredentialsException

This exception is raised when ASPSP API response shows that provided credentials are invalid.

Base type

ResponseValidationException

Fields

Name	Type	Required	Description
errorDescription	string	false	User-friendly error message

InvalidResponseIdException

This exception is raised when ASPSP API response id does not match request id in.

Base type

ResponseValidationException

Fields

Name	Type	Required	Description
requestId	string	true	Request id

InvalidResponseSignatureException

This exception is raised when ASPSP API response signature verification failed.

Base type

ResponseValidationException

Fields

Name	Type	Required	Description
jws	string	true	JSON web signature

LocalInstrumentCode

ISO20022: User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.

Base type

string

Logo

ASPSP logo, which can be used for showing to an end-user

Fields

Name	Type	Required	Description
url	string	true	Logo URL

MeridianBankConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
xApiKey	string	true	API client key (obtained in developer portal)
country	string	true	Bank`s country
certPath	string	false	Path to QWAC certificate in PEM format
keyPath	string	false	Path to QWAC certificate private key in PEM format
nokRedirectUri	string	false	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

ModifyConsentsInfo

Information about usage of modifyConsents method

Fields

Name	Type	Required	Description
beforeAccounts	boolean	true	Shows if modifyConsents needs to be called for getting list of accounts (before getAccounts method)
extendsDetails	boolean	true	Shows if bank returns extended information about accounts from method getAccounts after user consent is received (meaning modifyConsents is called). This "additional information" may differ from bank to bank and is not specified
accountsRequired	boolean	true	Shows if accounts field has to be filled in for getting account details If true then modifyConsents needs to be called with accounts list in Access model before calling getAccountTransactions or getAccountBalances

PartyIdentification

API : Description of a Party which can be either a person or an organization.

Fields

Name	Type	Required	Description
name	string	false	ISO20022: Name by which a party is known and which is usually used to identify that party.
postalAddress	PostalAddress	false	ISO20022 : Information that locates and identifies a specific address, as defined by postal services.
organisationId	GenericIdentification	false	Unique and unambiguous way to identify an organisation.
privateId	GenericIdentification	false	Unique and unambiguous identification of a person.

PaymentCoverageRequestResource

Payment coverage request structure. The request must rely either on a cash account or a payment card.

Fields

Name	Type	Required	Description
paymentCoverageRequestId	string	true	Identification of the payment Coverage Request
payee	string	false	The merchant where the card is accepted as information to the PSU.
instructedAmount	AmountType	true	ISO20022: structure aiming to carry either an instructed amount or equivalent amount. Both structures embed the amount and the currency to be used. API: only instructed amount can be used
accountId	AccountIdentification	true	Unique and unambiguous identification for the account between the account owner and the account servicer.

PaymentIdentification

ISO20022: Set of elements used to reference a payment instruction.

Fields

Name	Type	Required	Description
resourceId	ResourceId	false	Identifier assigned by the ASPSP for further use of the created resource through API calls
instructionId	string	false	ISO20022: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. API: Unique identification shared between the PISP and the ASPSP
endToEndId	string	false	ISO20022: Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. API: Unique identification shared between the merchant and the PSU

PaymentInformationId

ISO20022 : Reference assigned by a sending party to unambiguously identify the payment information block within the message.

Base type

string

PaymentInformationStatusCode

ISO20022: Specifies the status of the payment information.

Base type

string

Enumerated Values

Value	Description
ACCP	AcceptedCustomerProfile. Preceding check of technical validation was successful. Customer profile check was also successful.
ACSC	AcceptedSettlementCompleted. Settlement on the debtor's account has been completed.
ACSP	AcceptedSettlementInProcess. All preceding checks such as technical validation and customer profile were successful. Dynamic risk assessment is now also successful and therefore the Payment Request has been accepted for execution.
ACTC	AcceptedTechnicalValidation. Authentication and syntactical and semantical validation are successful.
ACWC	AcceptedWithChange. Instruction is accepted but a change will be made, such as date or remittance not sent.
ACWP	AcceptedWithoutPosting. Payment instruction included in the credit transfer is accepted without being posted to the creditor customer’s account.
PART	PartiallyAccepted. A number of transactions have been accepted, whereas another number of transactions have not yet achieved 'accepted' status.
RCVD	Received. Payment initiation has been received by the receiving agent.
PDNG	Pending. Payment request or individual transaction included in the Payment Request is pending. Further checks and status update will be performed.
RJCT	Rejected. Payment request has been rejected.

PaymentRequestConfirmation

Contains data for confirmation of payment request

Fields

Name	Type	Required	Description
psuAuthenticationFactor	string	false	Authentication factor forwarded by the TPP to the ASPSP in order to fulfil the strong customer authentication process
paymentRequest	PaymentRequestResource	false	Original payment request used to initiate the payment

PaymentRequestResource

ISO20022: The PaymentRequestResource message is sent by the Creditor sending party to the Debtor receiving party, directly or through agents. It is used by a Creditor to request movement of funds from the debtor account to a creditor. API: Information about the creditor (Id, account and agent) might be placed either at payment level or at instruction level. Thus multi-beneficiary payments can be handled. The requested execution date can be placed either at payment level when all instructions are requested to be executed at the same date or at instruction level. The latest case includes:

• multiple instructions having different requested execution dates
• standing orders settings

Fields

Name	Type	Required	Description
resourceId	ResourceId	false	Identifier assigned by the ASPSP for further use of the created resource through API calls
paymentInformationId	PaymentInformationId	false	ISO20022 : Reference assigned by a sending party to unambiguously identify the payment information block within the message.
creationDateTime	CreationDateTime	false	ISO20022: Date and time at which a (group of) payment instruction(s) was created by the instructing party.
initiatingParty	PartyIdentification	false	API : Description of a Party which can be either a person or an organization.
paymentTypeInformation	PaymentTypeInformation	false	ISO20022: Set of elements used to further specify the type of transaction.
debtor	PartyIdentification	false	API : Description of a Party which can be either a person or an organization.
debtorAccount	AccountIdentification	false	Unique and unambiguous identification for the account between the account owner and the account servicer.
debtorAgent	FinancialInstitutionIdentification	false	ISO20022: Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.
debtorCurrency	string	false	Debtor account currency code
purpose	PurposeCode	false	ISO20022: Underlying reason for the payment transaction, as published in an external purpose code list.
chargeBearer	ChargeBearerCode	false	ISO20022: Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
paymentInformationStatus	PaymentInformationStatusCode	false	ISO20022: Specifies the status of the payment information.
statusReasonInformation	StatusReasonInformation	false	ISO20022: Provides detailed information on the status reason. Can only be used in status equal to "RJCT".
fundsAvailability	FundsAvailabilityInformation	false	indicator that the payment can be covered or not by the funds available on the relevant account - true: payment is covered - false: payment is not covered
booking	BookingInformation	false	indicator that the payment can be immediately booked or not - true: payment is booked - false: payment is not booked
creditTransferTransaction	[CreditTransferTransaction]	true	ISO20022: Payment processes required to transfer cash from the debtor to the creditor. API: Each ASPSP will specify a maxItems value for this field taking into accounts its specificities about payment request handling

PaymentTypeInformation

ISO20022: Set of elements used to further specify the type of transaction.

Fields

Name	Type	Required	Description
instructionPriority	PriorityCode	false	ISO20022: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
serviceLevel	ServiceLevelCode	false	ISO20022: Agreement under which or rules under which the transaction should be processed. Specifies a pre-agreed service or level of service between the parties, as published in an external service level code list.
categoryPurpose	CategoryPurposeCode	false	ISO20022: Specifies the high level purpose of the instruction based on a set of pre-defined categories. This is used by the initiating party to provide information concerning the processing of the payment. It is likely to trigger special processing by any of the agents involved in the payment chain.
localInstrument	LocalInstrumentCode	false	ISO20022: User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.

PostalAddress

ISO20022 : Information that locates and identifies a specific address, as defined by postal services.

Fields

Name	Type	Required	Description
addressType	AddressType	false	ISO20022: Identifies the nature of the postal address.
department	string	false	Identification of a division of a large organisation or building.
subDepartment	string	false	Identification of a sub-division of a large organisation or building.
streetName	string	false	Name of a street or thoroughfare.
buildingNumber	string	false	Number that identifies the position of a building on a street.
postCode	string	false	Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
townName	string	false	Name of a built-up area, with defined boundaries, and a local government.
countrySubDivision	string	false	Identifies a subdivision of a country such as state, region, county.
country	string	true	ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.
addressLine	[string]	false	Unstructured address. The two lines must embed zip code and town name

PriorityCode

ISO20022: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.

Base type

string

Enumerated Values

Value	Description
HIGH	High priority
NORM	Normal priority
EXPR	Express priority. Polish-specific priority code

PrivatBankConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
xApiKey	string	true	API client key (obtained in developer portal)
country	string	true	Bank`s country
certPath	string	false	Path to QWAC certificate in PEM format
keyPath	string	false	Path to QWAC certificate private key in PEM format
nokRedirectUri	string	false	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

PurposeCode

ISO20022: Underlying reason for the payment transaction, as published in an external purpose code list.

Base type

string

Enumerated Values

Value	Description
ACCT	Funds moved between 2 accounts of same account holder at the same bank.
CASH	general cash management instruction, may be used for Transfer Initiation.
COMC	Transaction is related to a payment of commercial credit or debit.
CPKC	General Carpark Charges Transaction is related to carpark charges.
TRPT	Transport RoadPricing Transaction is for the payment to top-up pre-paid card and electronic road pricing for the purpose of transportation.

RegulatoryReportingCode

Information needed due to regulatory and statutory requirements. Economical codes to be used are provided by the National Competent Authority

Base type

string

RegulatoryReportingCodes

List of needed regulatory reporting codes for international payments

Base type

[RegulatoryReportingCode]

RequestedExecutionDate

ISO20022: Date at which the initiating party requests the clearing agent to process the payment. API: This date can be used in the following cases:

• the single requested execution date for a payment having several instructions. In this case, this field must be set at the payment level.
• the requested execution date for a given instruction within a payment. In this case, this field must be set at each instruction level.
• The first date of execution for a standing order. When the payment cannot be processed at this date, the ASPSP is allowed to shift the applied execution date to the next possible execution date for non-standing orders. For standing orders, the [executionRule] parameter helps to compute the execution date to be applied.

Base type

string(date-time)

ResourceId

Identifier assigned by the ASPSP for further use of the created resource through API calls

Base type

string

ServiceLevelCode

ISO20022: Agreement under which or rules under which the transaction should be processed. Specifies a pre-agreed service or level of service between the parties, as published in an external service level code list.

Base type

string

Enumerated Values

Value	Description
BKTR	Book Transaction – Payment through internal book transfer.
G001	TrackedCustomerCreditTransfer – Tracked Customer Credit Transfer
G002	TrackedStopAndRecall – Tracked Stop and Recall
G003	TrackedCorporateTransfer – Tracked Corporate Transfer
G004	TrackedFinancialInstitutionTransfer – Tracked Financial Institution Transfer
NUGP	Non-urgent Priority Payment – Payment must be executed as a non-urgent transaction with priority settlement.
NURG	Non-urgent Payment – Payment must be executed as a non-urgent transaction, which is typically identified as an ACH or low value transaction.
PRPT	EBAPriorityService – Transaction must be processed according to the EBA Priority Service.
SDVA	SameDayValue – Payment must be executed with same day value to the creditor.
SEPA	SingleEuroPaymentsArea – Payment must be executed following the Single Euro Payments Area scheme.
SVDE	Domestic Cheque Clearing and Settlement – Payment execution following the cheque agreement and traveller cheque agreement of the German Banking Industry Committee (Die Deutsche Kreditwirtschaft - DK) and Deutsche Bundesbank – Scheck Verrechnung Deutschland
URGP	Urgent Payment – Payment must be executed as an urgent transaction cleared through a real-time gross settlement system, which is typically identified as a wire or high value transaction.
URNS	Urgent Payment Net Settlement – Payment must be executed as an urgent transaction cleared through a real-time net settlement system, which is typically identified as a wire or high value transaction.

SignetBankConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
xApiKey	string	true	API client key (obtained in developer portal)
country	string	true	Bank`s country
certPath	string	false	Path to QWAC certificate in PEM format
keyPath	string	false	Path to QWAC certificate private key in PEM format
nokRedirectUri	string	false	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

StatusReasonInformation

ISO20022: Provides detailed information on the status reason. Can only be used in status equal to "RJCT".

Base type

string

Enumerated Values

Value	Description
AC01	IncorectAccountNumber. the account number is either invalid or does not exist
AC04	ClosedAccountNumber. the account is closed and cannot be used
AC06	BlockedAccount. the account is blocked and cannot be used
AG01	Transaction forbidden. Transaction forbidden on this type of account
CH03	RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture. The requested execution date is too far in the future
CUST	RequestedByCustomer. The reject is due to the debtor (refusal or lack of liquidity)
DS02	OrderCancelled. An authorized user has cancelled the order
FF01	InvalidFileFormat. The reject is due to the original Payment Request which is invalid (syntax, structure or values)
FRAD	FraudulentOriginated. the Payment Request is considered as fraudulent
MS03	NotSpecifiedReasonAgentGenerated. No reason specified by the ASPSP
NOAS	NoAnswerFromCustomer. The PSU has neither accepted nor rejected the Payment Request and a time-out has occurred
RR01	MissingDebtorAccountOrIdentification. The Debtor account and/or Identification are missing or inconsistent
RR03	MissingCreditorNameOrAddress. Specification of the creditor’s name and/or address needed for regulatory requirements is insufficient or missing.
RR04	RegulatoryReason. Reject from regulatory reason
RR12	InvalidPartyID. Invalid or missing identification required within a particular country or payment type.

Token

Fields

Name	Type	Required	Description
access_token	string	false	The access token value
expires_in	integer(int32)	false	The lifetime in seconds of the access token
refresh_token	string	false	The refresh token value
scope	string	false	Scopes of the token

Transaction

structure of a transaction

Fields

Name	Type	Required	Description
resourceId	ResourceId	false	Identifier assigned by the ASPSP for further use of the created resource through API calls
entryReference	string	false	Unique transaction identifier provided by ASPSP. This identifier is both unique and immutable and can be used for matching transactions across multiple PSU authentication sessions. Usually the same identifier is available for transactions in ASPSP's online/mobile interface and is called archive ID or similarly.
transactionAmount	AmountType	true	ISO20022: structure aiming to carry either an instructed amount or equivalent amount. Both structures embed the amount and the currency to be used. API: only instructed amount can be used
creditor	PartyIdentification	false	API : Description of a Party which can be either a person or an organization.
creditorAccount	AccountIdentification	false	Unique and unambiguous identification for the account between the account owner and the account servicer.
debtor	PartyIdentification	false	API : Description of a Party which can be either a person or an organization.
debtorAccount	AccountIdentification	false	Unique and unambiguous identification for the account between the account owner and the account servicer.
bankTransactionCode	BankTransactionCode	false	ISO20022: Allows the account servicer to correctly report a transaction, which in its turn will help account owners to perform their cash management and reconciliation operations.
creditDebitIndicator	string	true	Accounting flow of the transaction
status	TransactionStatus	true	Type of Transaction
bookingDate	string(date)	false	Booking date of the transaction on the account
valueDate	string(date)	false	Value date of the transaction on the account
transactionDate	string(date)	false	Date used for specific purposes: for card transaction: date of the transaction for credit transfer: acquiring date of the transaction for direct debit: receiving date of the transaction
balanceAfterTransaction	AmountType	false	ISO20022: structure aiming to carry either an instructed amount or equivalent amount. Both structures embed the amount and the currency to be used. API: only instructed amount can be used
referenceNumber	string	false	Credit transfer reference number (also known as the creditor reference or the structured creditor reference). The value is set when it is known that the transaction data contains a reference number (in either ISO 11649 or a local format).
remittanceInformation	UnstructuredRemittanceInformation	false	Payment details. For credit transfers may contain free text, reference number or both at the same time (in case Extended Remittance Information is supported). When it is known that remittance information contains a reference number (either based on ISO 11649 or a local scheme), the reference number is also available via the referenceNumber field of the Transaction data structure.
merchantCategoryCode	string	false	Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction

Enumerated Values

creditDebitIndicator

Value	Description
CRDT	Credit type transaction
DBIT	Debit type transaction

TransactionIndividualStatusCode

ISO20022: Specifies the status of the payment information group.

Base type

string

Enumerated Values

Value	Description
RCVD	Payment request or individual transaction included in the Payment Request has been received by the receiving agent.
RJCT	Payment request or individual transaction included in the Payment Request has been rejected.
PDNG	Pending. Payment request or individual transaction included in the Payment Request is pending. Further checks and status update will be performed.
ACSP	All preceding checks such as technical validation and customer profile were successful and therefore the Payment Request has been accepted for execution.
ACSC	Settlement on the debtor's account has been completed.

TransactionStatus

Type of Transaction

Base type

string

Enumerated Values

Value	Description
BOOK	(ISO20022 ClosingBooked) Accounted transaction
CNCL	Cancelled transaction
HOLD	Account hold
OTHR	Transaction with unknown status or not fitting the other options
PDNG	(ISO20022 Expected) Instant Balance Transaction
RJCT	Rejected transaction
SCHD	Scheduled transaction

TransactionsAccess

Defines what access to transactions is requested

Fields

Name	Type	Required	Description
statuses	[TransactionStatus]	false	List of transaction statuses, which are going to be accessed
details	boolean	false	Indicator that access to transaction details is requested
limitDays	integer	false	Number of days in the past to access transactions

TransactionsFetchingException

This exception is raised when ASPSP API responses with error related to transactions fetching

Base type

CoreException

Fields

Name	Type	Required	Description
retry	string	true	Flag showing whether it is possible to retry the request
continuationKey	string	false	Continuation key to provide in the following requests
scaRedirect	string	false	If additional SCA is required, then this field contains link

TransactionsInfo

Meta information about usage and limitations of getAccountTransactions method

Fields

Name	Type	Required	Description
country	string	true	Country ISO 3166-1 alpha-2 code. Country to which transactions information applies.
psuType	string	true	PSU Type (personal/business). PSU type to which transactions information applies.
scaRequired	boolean	false	Flag showing whether dedicated SCA Required to fetch transactions
oneOff	boolean	false	Flag showing whether limitations is applicable to a one-off fetching
description	string	false	Any additional information related to transactions fetching
dateLimit	string(date)	false	If set then transactions are available up to a specified date
daysPastLimit	int	false	Limit of days in the past for which transactions are available
daysSingleRequestLimit	int	false	Limit of days in a single request for which transactions are available (interval between dateTo and dateFrom)
entriesLimit	int	false	Limit of transaction entries which can be looked in the past
entriesSingleRequestLimit	int	false	Limit of transaction entries which can be returned in a single request

UnstructuredRemittanceInformation

Payment details. For credit transfers may contain free text, reference number or both at the same time (in case Extended Remittance Information is supported). When it is known that remittance information contains a reference number (either based on ISO 11649 or a local scheme), the reference number is also available via the referenceNumber field of the Transaction data structure.

Fields

Name	Type	Required	Description
remittanceLine	string	false	Relevant information to the transaction

HAL

AccountLinks

links that can be used for further navigation when browsing Account Information at one account level

Fields

Name	Type	Required	Description
balances	GenericLink	false	link to the balances of a given account
transactions	GenericLink	false	link to the transactions of a given account

AccountsLinks

Links that can be used for further navigation when browsing Account Information at top level

Fields

Name	Type	Required	Description
self	GenericLink	true	link to the list of all available accounts
beneficiaries	GenericLink	false	hypertext reference
first	GenericLink	false	hypertext reference
last	GenericLink	false	hypertext reference
next	GenericLink	false	hypertext reference
prev	GenericLink	false	hypertext reference

BalancesLinks

links that can be used for further navigation when browsing Account Information at one account level

Fields

Name	Type	Required	Description
self	GenericLink	true	link to the balances of a given account
parent-list	GenericLink	false	link to the list of all available accounts
transactions	GenericLink	false	link to the transactions of a given account

BeneficiariesLinks

links that can be used for further navigation when browsing Account Information at one account level

Fields

Name	Type	Required	Description
self	GenericLink	true	link to the beneficiaries
parent-list	GenericLink	false	link to the list of all available accounts
first	GenericLink	false	link to the first page of the beneficiaries result
last	GenericLink	false	link to the last page of the beneficiaries result
next	GenericLink	false	link to the next page of the beneficiaries result
prev	GenericLink	false	link to the previous page of the beneficiaries result

ConsentLinks

Fields

Name	Type	Required	Description
redirect	GenericLink	false	hypertext reference
self	GenericLink	false	hypertext reference
status	GenericLink	false	hypertext reference

GenericLink

hypertext reference

Fields

Name	Type	Required	Description
href	string	true	URI to be used
templated	boolean	false	specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false

PaymentCoverageReportLinks

links that can be used for further navigation to post another coverage request.

Fields

Name	Type	Required	Description
self	GenericLink	true	hypertext reference

PaymentRequestLinks

links that can be used for further navigation when having post a Payment Request in order to get the relevant status report.

Fields

Name	Type	Required	Description
self	GenericLink	false	hypertext reference
confirmation	GenericLink	false	This link shall not been provided when the confirmation has already been posted.

PaymentRequestResourceCreationLinks

Links that can be used for further navigation, especially in REDIRECT approach

Fields

Name	Type	Required	Description
consentApproval	GenericLink	false	URL to be used by the PISP in order to start the ASPSP authentication and consent management process
confirmation	GenericLink	false	Link to the payment confirmation API endpoint

TransactionsLinks

links that can be used for further navigation when browsing Account Information at one account level

Fields

Name	Type	Required	Description
self	GenericLink	true	link to the transactions of a given account
parent-list	GenericLink	false	link to the list of all available accounts
balances	GenericLink	false	link to the balances of a given account
first	GenericLink	false	link to the first page of the transactions result
last	GenericLink	false	link to the last page of the transactions result
next	GenericLink	false	link to the next page of the transactions result
prev	GenericLink	false	link to the previous page of the transactions result

Exceptions

AuthorizationCancelledException

This exception is raised when authorization was cancelled either by ASPSP or by user.

Base type

HttpException

DataRetrievalException

This exception is raised when unable to retrieve data requested from ASPSP API.

Base type

HttpException

InsufficientScopeException

This exception is raised when consent given by the PSU does not allow to retrieve
requested data.

Base type

DataRetrievalException

MakeTokenException

This exception is raised when ASPSP API is not ready yet. Flag retry shows if it is required to retry method call.

Base type

CoreException

ModelValidationException

Code samples

import com.enablebanking.ApiClient;
import com.enablebanking.api.PispApi;
import com.enablebanking.model.*;

PispApi pispApi = new PispApi(apiClient);

PaymentRequestResource prr = new PaymentRequestResource()
        .creditTransferTransaction(Arrays.asList(
                new CreditTransferTransaction()
                        .instructedAmount(new AmountType()
                                .currency("EUR")
                                .amount(new BigDecimal("1.25")))
                        .frequency(FrequencyCode.DAIL)
                        .beneficiary(
                                new Beneficiary()
                                        .creditor(
                                                new PartyIdentification()
                                                        .name("Creditor name")
                                                        .postalAddress(
                                                                new PostalAddress()
                                                                        .addressLine(Arrays.asList(
                                                                                "Creditor Name ",
                                                                                "Creditor Address 1",
                                                                                "Creditor Address 2"))
                                                                        .country("RO")))
                                        .creditorAccount(new AccountIdentification()
                                                .iban("Some iban")))
        .paymentTypeInformation(new PaymentTypeInformation()
                .instructionPriority(PriorityCode.NORM)
                .serviceLevel(ServiceLevelCode.SEPA)
                .categoryPurpose(CategoryPurposeCode.CASH))
        .debtor(new PartyIdentification()
                .name("Debtor name")
                .postalAddress(new PostalAddress()
                        .addressLine(Arrays.asList(
                                "Debtor Name",
                                "Debtor Address 1",
                                "Debtor Address 2"))
                        .country("PL")))
        .debtorAccount(new AccountIdentification().iban("Some Iban")); // Remittance information required but not set
try {
  PaymentRequestResource prr =  pispApi.makePaymentRequest(prr);
} catch (ModelValidationException e) {
  String key = e.getKey(); // "remittanceInformation"
  String path = e.getPath() // "paymentRequestResource.creditTransferTransaction.remittanceInformation"
}

This exception is raised when model validation failed.

Base type

ValidationException

Fields

Name	Type	Required	Description
key	string	true	Reference to a field
path	string	true	Path to a field

NotImplementedException

This exception is raised when called method is not implemented in SDK(either not supported by ASPSP API or integration is not ready yet).

Base type

CoreException

ParameterValidationException

Code samples

import com.enablebanking.ApiClient;
import com.enablebanking.api.AuthApi;
import com.enablebanking.model.*;

// To be replaced with real connector settings class and set properties
ConnectorSettings connectorSettings = new SomeBankConnectorSettings();

AuthApi authApi = new AuthApi(new ApiClient(connectorSettings));
try {
  Auth auth = authApi.getAuth("state", null, null, null); // userId (2nd parameter) is required but not set
} catch (ParameterValidationError e) {
  String key = e.getKey(); // "userId"
}

This exception is raised when function parameter validation failed. Key attribute is reference to parameter.

Base type

ValidationException

Fields

Name	Type	Required	Description
key	string	true	Reference to a parameter

ResourceNotFoundException

This exception is raised when unable to load certificate/private key from path.

Base type

CoreException

ResponseValidationException

This exception is raised when ASPSP API response validation failed.

Base type

ValidationException

Fields

Name	Type	Required	Description
responseHeaders	[object]	true	Headers of http response
responseBody	string	true	Body of http response

TransactionPeriodException

This exception is raised when wrong or invalid account transactions period is requested.

Base type

DataRetrievalException

UnauthorizedException

This exception is raised when unauthorized to retrieve data requested from ASPSP API (e.g. access token expired).

Base type

HttpException

ValidationException

Base class for validation related exceptions.

Base type

CoreException

Connectors

ABNAMROConnectorSettings

Settings for initializing ApiClient for ABN AMRO (NL)
Credentials can obtained at ABN AMRO (NL) Developer Portal

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank country. Possilbe values: NL – Netherlands BE – Belgium GE - Germany UK - United Kingdom
brand	string	true	Denotes the bank where the account is held. If omitted, ABN AMRO account in NL or commercial ABN AMRO account in BE, GB, or DE will be used. Other possible values: ABN AMRO Belgium Private Banking, ABN AMRO Belgium Independent Asset Manager
clientId	string	true	API client ID (obtained from ABN AMRO Developer Portal)
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
apiKey	string	true	API key

AXAConnectorSettings

Settings for initializing ApiClient for AXA Bank Connector.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
clientId	string	true	NCA id obtained from QWAC certificate. Use "VALID_CLIENT_ID" value for sandbox

AafjordSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.AafjordSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new AafjordSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Åfjord Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

AasenSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.AasenSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new AasenSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Aasen Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

AktiaConnectorSettings

Settings for initializing ApiClient for Aktia (Finland).

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained from Aktia Developer Portal)
clientSecret	string	true	API client secret (obtained from Aktia Developer Portal)
sandboxPaymentId	string	false	ID of the payment request used in sandbox (sandbox only)
sandboxSafeguard	boolean	false	Flag whether to fix malformed sandbox data or not (sandbox only)

AktiaContingencyConnectorSettings

Settings for initializing ApiClient for Aktia Contingency API (Finland).

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
authorizationHeader	string	true	Authorization header obtained from Aktia onboarding(without "Basic")

AlandsbankenConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.AlandsbankenConnectorSettings;

ApiClient apiClient = new ApiClient(
  new AlandsbankenConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("put-your-client-id-here")
    .xApiKey("put-your-x-api-key-here")
    .certPath("path/to/qwac-crt.pem")
    .keyPath("path/to/qwac-key.pem")
    .signKeyPath("path/to/qseal-crt.pem")
    .signPubKeySerial("qseal-cert-public-serial-here")
    .sandbox(true));

Settings for initializing ApiClient for Ålandsbanken (Finland).
Credentials can obtained at Open Banking Market operated by Crosskey Banking Solutions.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank country (only clients from the specified will be able to authenticate). Possilbe values: FI – Finland SE – Sweden
clientId	string	true	API client ID (obtained at Open Banking Market)
xApiKey	string	true	API client key (obtained at Open Banking Market)
certPath	string	true	Path to QWAC certificate in PEM format. Test certificate (for accessing sandbox environment) can be downloaded from Open Banking Market.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signKeyPath	string	true	Path to QSeal certificate in PEM format. Test certificate (for accessing sandbox environment) can be downloaded from Open Banking Market.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath. The serial must be presented as a decimal string. The following command can be use for extracting it from QSeal certificate in PEM format: echo "obase=10; ibase=16; `openssl x509 -in qseal-crt.pem -serial -noout | awk -F "=" '{print $2}'`" | bc

AliorConnectorSettings

Settings for initializing ApiClient for Alior Bank (Poland).
Credentials can obtained at Alior Developer Portal

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained from Alior Developer Portal)
clientSecret	string	true	API client secret (obtained from Alior Developer Portal)
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signFingerprint	string	true	Fingerprint of the QSeal certificate (base64 encoded with padding)
signCertUrl	string	true	Public URL where QSeal certificate can be found

AlmBrandConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.AlmBrandConnectorSettings;

ApiClient apiClient = new ApiClient(
  new AlmBrandConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("put-your-client-id-here")
    .certPath("path/to/qwac-crt.pem")
    .keyPath("path/to/qwac-key.pem")
    .xApiKey("x-api-key")
    .sandbox(true));

Settings for initializing ApiClient for AlmBrand
Credentials can obtained at BankData Developer Site

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained at Open Banking Market)
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
xApiKey	string	true	API client key (obtained from BankData Developer Portal)

AndebuSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.AndebuSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new AndebuSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Andebu Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

AndelskassenFaelleskassenConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

ArbejdernesLandsbankConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

ArendalOgOmegnsSparekasseConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.ArendalOgOmegnsSparekasseConnectorSettings;

ApiClient apiClient = new ApiClient(
  new ArendalOgOmegnsSparekasseConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Arendal og Omegns Sparekasse.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

AskimOgSpydebergSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.AskimOgSpydebergSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new AskimOgSpydebergSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Askim og Spydeberg Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

AurlandSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.AurlandSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new AurlandSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Aurland Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

AurskogSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.AurskogSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new AurskogSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Aurskog Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

BIBConnectorSettings

Settings for initializiong ApiClient for [Baltic International Bank] (https://www.bib.eu/)
Credentials can be obtained at Baltic International Developer Portal

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank`s country
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signCertPath	string	true	Path to QSEAL public certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

BILDanmarkConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

BNBankConnectorSettings

Settings for initializing ApiClient for BN Bank

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
business	boolean	true	Account type to access to. If true business, if false personal.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

BNGConnectorSettings

Settings for initializing ApiClient for BNG Bank (Netherlands).

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained from BNG Bank Developer Portal)
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signCertPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signKeyPath	string	true	Path to QSeal private key in PEM format

BNPParibasFortisConnectorSettings

Settings for initializing ApiClient for BNP Paribas Fortis (Belgium).
Credentials can obtained at BNP Paribas Fortis Developer Portal

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained from BNP Paribas Fortis Developer Portal)
clientSecret	string	true	API client secret (obtained from BNP Paribas Fortis Developer Portal)
brand	string	false	Bank brand. Allowed values are "BNP Paribas Fortis", "Hello Bank" and "Fintro"

BNPParibasPolandConnectorSettings

Settings for initializing ApiClient for BNP Paribas Bank Polska (Poland).
Credentials can obtained at BNP Paribas Poland Developer Portal

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained from BNP Paribas Poland Developer Portal)
clientSecret	string	true	API client secret (obtained from BNP Paribas Poland Developer Portal)
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signFingerprint	string	true	Fingerprint of the QSeal certificate (base64 encoded without padding)
signCertUrl	string	true	Public URL where QSeal certificate can be found
tppId	string	true	ID assigned to the TPP by an authority (format: PSDXX-YYYY-ZZZZZZZZ)

Bank2ConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.Bank2ConnectorSettings;

ApiClient apiClient = new ApiClient(
  new Bank2ConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Bank2.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

BankNordikDenmarkConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BankNordikDenmarkConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BankNordikDenmarkConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for BankNordik Denmark.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

BankNordikFaroeIslandsConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BankNordikFaroeIslandsConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BankNordikFaroeIslandsConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for BankNordik Faroe Islands.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

BanxeConnectorSettings

Settings for initializing ApiClient for Banxe (LT)
Credentials can obtained at Banxe (LT) Developer Portal

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained from Banxe Developer Portal ("Key"))
clientSecret	string	true	API client secret (obtained from Banxe Developer Portal ("Secret"))

BasisbankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BasisbankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BasisbankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Basisbank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

BelfiusConnectorSettings

Settings for initializing ApiClient for Belfius (BE)
Credentials can obtained at Belfius (BE) Developer Portal

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained from Belfius Developer Portal)
language	string	true	Language of authentication user interface. The default language is en

BergSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BergSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BergSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Berg Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

BetriFOConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BetriFOConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BetriFOConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Betri (FO).
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

BienSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BienSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BienSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Bien Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

BirkenesSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BirkenesSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BirkenesSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Birkenes Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

BjugnSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BjugnSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BjugnSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Bjugn Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

BlakerSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BlakerSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BlakerSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Blaker Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

BorbjergSparekasseConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BorbjergSparekasseConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BorbjergSparekasseConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Borbjerg Sparekasse.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

BrabankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BrabankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BrabankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Brabank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

BrabankSverigeConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BrabankSverigeConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BrabankSverigeConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Brabank Sverige.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

BroagerSparekasseConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BroagerSparekasseConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BroagerSparekasseConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Broager Sparekasse.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

CitadeleConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	false	Bank`s country
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
nokRedirectUri	string	false	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.
sandboxConsentId	string	false	Static consent id with approved status used in sandbox

CoopBankDenmarkConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SydbankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SydbankConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("put-your-client-id-here")
    .certPath("path/to/qwac-crt.pem")
    .keyPath("path/to/qwac-key.pem")
    .xApiKey("x-api-key")
    .sandbox(true));

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

CulturaConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.CulturaConnectorSettings;

ApiClient apiClient = new ApiClient(
  new CulturaConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Cultura.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

DNBConnectorSettings

Settings for initializing ApiClient for DNB Bank (Norway).

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to a QWAC public certificate
keyPath	string	true	Path to a QWAC private key
nokRedirectUri	string	false	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

DanskeAndelskassersBankConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

DanskeBankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.DanskeBankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new DanskeBankConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("put-your-client-id-here")
    .certPath("path/to/qwac-crt.pem")
    .keyPath("path/to/qwac-key.pem")
    .signKeyPath("path/to/qseal-crt.pem")
    .signPubKeySerial("qseal-cert-public-serial-here")
    .sandbox(true));

Settings for initializing ApiClient for DanskeBank
Credentials can obtained at Danske Bank Developer Site

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	false	Bank country (only clients from the specified will be able to authenticate). Possilbe values: FI – Finland DK – Denmark NO – Norway SE – Sweden
business	boolean	false	Account type to access to. If true business, if false personal.
clientId	string	true	API client ID (obtained at Open Banking Market)
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signKeyPath	string	true	Path to QSeal certificate in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath. The serial must be presented as a decimal string. The following command can be use for extracting it from QSeal certificate in PEM format: echo "obase=10; ibase=16; `openssl x509 -in qseal-crt.pem -serial -noout | awk -F "=" '{print $2}'`" | bc

DenJyskeSparekasseConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

DenLilleBikubeConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.DenLilleBikubeConnectorSettings;

ApiClient apiClient = new ApiClient(
  new DenLilleBikubeConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Den Lille Bikube.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

DjurslandsBankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.DjurslandsBankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new DjurslandsBankConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("put-your-client-id-here")
    .certPath("path/to/qwac-crt.pem")
    .keyPath("path/to/qwac-key.pem")
    .xApiKey("x-api-key")
    .sandbox(true));

Settings for initializing ApiClient for DjurslandsBank
Credentials can obtained at BankData Developer Site

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained at Open Banking Market)
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
xApiKey	string	true	API client key (obtained from BankData Developer Portal)

DragsholmSparekasseConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.DragsholmSparekasseConnectorSettings;

ApiClient apiClient = new ApiClient(
  new DragsholmSparekasseConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Dragsholm Sparekasse.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

DrangedalSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.DrangedalSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new DrangedalSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Drangedal Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

DronninglundSparekasseConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.DronninglundSparekasseConnectorSettings;

ApiClient apiClient = new ApiClient(
  new DronninglundSparekasseConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Dronninglund Sparekasse.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

EasybankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.EasybankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new EasybankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Easybank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

EidsbergSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.EidsbergSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new EidsbergSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Eidsberg Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

EikaKredittbankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.EikaKredittbankASConnectorSettings;

ApiClient apiClient = new ApiClient(
  new EikaKredittbankASConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Eika Kredittbank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

EkobankenMedlemsbankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.EkobankenMedlemsbankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new EkobankenMedlemsbankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Ekobanken Medlemsbank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

EtneSparebankConnectorSettings

Settings for initializing ApiClient for Etne Sparebank

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
business	boolean	true	Account type to access to. If true business, if false personal.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

EtnedalSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.EtnedalSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new EtnedalSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Etnedal Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

EvjeOgHornnesSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.EvjeOgHornnesSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new EvjeOgHornnesSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Evje og Hornnes Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

FacitBankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.FacitBankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new FacitBankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Facit bank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

FacitbankNOConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.FacitbankNOConnectorSettings;

ApiClient apiClient = new ApiClient(
  new FacitbankNOConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Facitbank NO.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

FanaSparebankConnectorSettings

Settings for initializing ApiClient for Fana Sparebank

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
business	boolean	true	Account type to access to. If true business, if false personal.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

FanoeSparekasseConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.FanoeSparekasseConnectorSettings;

ApiClient apiClient = new ApiClient(
  new FanoeSparekasseConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Fanø Sparekasse.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

FasterAndelskasseConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

FlekkefjordSparebankConnectorSettings

Settings for initializing ApiClient for Flekkefjord Sparebank

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
business	boolean	true	Account type to access to. If true business, if false personal.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

FolkesparekassenConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.FolkesparekassenConnectorSettings;

ApiClient apiClient = new ApiClient(
  new FolkesparekassenConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Folkesparekassen.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

ForbrugsforeningenConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.ForbrugsforeningenConnectorSettings;

ApiClient apiClient = new ApiClient(
  new ForbrugsforeningenConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Forbrugsforeningen.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

FornebubankenConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.FornebubankenConnectorSettings;

ApiClient apiClient = new ApiClient(
  new FornebubankenConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Fornebubanken.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

FroesSparekasseConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.FroesSparekasseConnectorSettings;

ApiClient apiClient = new ApiClient(
  new FroesSparekasseConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Frøs Sparekasse.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

FrorupAndelskasseConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

FroslevMollerupSparekasseConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

FynskeBankConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

GildeskaalSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.GildeskaalSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new GildeskaalSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Gildeskål Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

GrongSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.GrongSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new GrongSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Grong Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

GrueSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.GrueSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new GrueSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Grue Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

HaltdalenSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.HaltdalenSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new HaltdalenSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Haltdalen Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

HandelsbankenBusinessConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank`s country
clientId	string	true	API client id (obtained from Handelsbanken developer portal)
certPath	string	true	Path to a QWAC public certificate
keyPath	string	true	Path to a QWAC private key

HandelsbankenConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank`s country
clientId	string	true	API client id (obtained from Handelsbanken developer portal)
certPath	string	true	Path to a QWAC public certificate
keyPath	string	true	Path to a QWAC private key

HandelsbankenDenmarkConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

HandelsbankenNorwayConnectorSettings

Settings for initializing ApiClient for Handelsbanken Norway

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
business	boolean	true	Account type to access to. If true business, if false personal.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

HaugesundSparebankConnectorSettings

Settings for initializing ApiClient for Haugesund Sparebank

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
business	boolean	true	Account type to access to. If true business, if false personal.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

HegraSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.HegraSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new HegraSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Hegra Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

HemneSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.HemneSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new HemneSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Hemne Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

HjartdalOgGransheradSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.HjartdalOgGransheradSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new HjartdalOgGransheradSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Hjartdal og Gransherad Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

HjelmelandSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.HjelmelandSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new HjelmelandSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Hjelmeland Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

HoelandOgSetskogSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.HoelandOgSetskogSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new HoelandOgSetskogSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Høland og Setskog Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

HoenefossSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.HoenefossSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new HoenefossSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Hønefoss Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

HolviConnectorSettings

Settings for initializing ApiClient for Holvi (Finland).

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained from Holvi onboarding)
clientSecret	string	true	API client secret (obtained from Holvi onboarding)
signKeyPath	string	true	Path to QSeal certificate in PEM format

HvidbjergBankConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

ICABankenConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.ICABankenConnectorSettings;

ApiClient apiClient = new ApiClient(
  new ICABankenConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .certPath("path/to/qwac-crt.pem")
    .keyPath("path/to/qwac-key.pem")
    .sandbox(true));

Settings for initializing ApiClient for ICA Banken.
Credentials can obtained at ICA Banken Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained from ICA Developer Portal)
clientSecret	string	true	API client secret (obtained from ICA Developer Portal)
certPath	string	false	Path to QWAC certificate in PEM format.
keyPath	string	false	Path to QWAC certificate in PEM format.

INGConnectorSettings

Settings for initializing ApiClient for ING Bank (Poland).
Credentials can obtained at ING Developer Portal

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Two-letter country code
clientId	string	true	API client ID (obtained from ING Developer Portal)
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC private key in PEM format
signCertPath	string	true	Path to QSeal certificate in PEM format
signKeyPath	string	true	Path to QSeal private key in PEM format
signPubKeySerial	string	true	Serial number of a QSeal certificate from signKeyPath field

INGPolandConnectorSettings

Settings for initializing ApiClient for ING Silesian Bank (Poland).
Credentials can obtained at ING Silesian Developer Portal

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained from ING Silesian Developer Portal)
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signFingerprint	string	true	Fingerprint of the QSeal certificate (base64 encoded without padding)
signCertUrl	string	true	Public URL where QSeal certificate can be found
tppId	string	true	ID assigned to the TPP by an authority (format: PSDXX-YYYY-ZZZZZZZZ)

IkanoBankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.IkanoBankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new IkanoBankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Ikano Bank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

IndreSognSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.IndreSognSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new IndreSognSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Indre Sogn Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

JAKAndelskasseOesterVraaConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.JAKAndelskasseOesterVraaConnectorSettings;

ApiClient apiClient = new ApiClient(
  new JAKAndelskasseOesterVraaConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for J.A.K Andelskasse Øster Vrå.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

JAKMedlemsbankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.JAKMedlemsbankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new JAKMedlemsbankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for JAK Medlemsbank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

JaerenSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.JaerenSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new JaerenSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Jæren Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

JbfConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.JbfConnectorSettings;

ApiClient apiClient = new ApiClient(
  new JbfConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Jernbanepersonellets Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

JutlanderBankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.JutlanderBankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new JutlanderBankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Jutlander Bank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

JyskeBankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.JyskeBankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new JyskeBankConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("put-your-client-id-here")
    .certPath("path/to/qwac-crt.pem")
    .keyPath("path/to/qwac-key.pem")
    .xApiKey("x-api-key")
    .sandbox(true));

Settings for initializing ApiClient for JyskeBank
Credentials can obtained at BankData Developer Site

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained at Open Banking Market)
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
xApiKey	string	true	API client key (obtained from BankData Developer Portal)

KBCConnectorSettings

Settings for initializing ApiClient for KBC/CBC Bank
Credentials can obtained at KBC Developer Portla

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained from the QWAC certificate)
clientSecret	string	true	API client secret (obtained from the QWAC certificate)
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.

KIRConnectorSettings

Setting for the connector to PolishAPI implementation provided by KIR.
Originally implemented for openbankinghackathon.pl
Sandbox only

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
origin	string	true	API origin (scheme://domain:port)
clientId	string	true	TPP ID to be put here. KIR sandbox certificates use PSDPL-KNF-1234567890
certPath	string	true	Path to sandbox QWAC certificate
keyPath	string	true	Path to sandbox key used for QWAC
signKeyPath	string	false	Path to sandbox key used for QSeal certificate. If not set request signing will be skipped
signSubjectKeyIdentifier	string	false	Subject Key Identifier (2.5.29.14) field of QSeal certificate as hex string
signFingerprint	string	false	Fingerprint of the QSeal certificate (base64 encoded without padding)
signCertUrl	string	false	Public URL where QSeal certificate can be found

KLPBankenConnectorSettings

Settings for initializing ApiClient for KLP Banken

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
business	boolean	true	Account type to access to. If true business, if false personal.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

KlimSparekasseConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.KlimSparekasseConnectorSettings;

ApiClient apiClient = new ApiClient(
  new KlimSparekasseConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Klim Sparekasse.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

KomplettConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	none
xApiKey	string	true	none
certPath	string	true	none
keyPath	string	true	none
signKeyPath	string	true	none
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath. The serial must be presented as a decimal string. The following command can be use for extracting it from QSeal certificate in PEM format: echo "obase=10; ibase=16; `openssl x509 -in qseal-crt.pem -serial -noout | awk -F "=" '{print $2}'`" | bc

KreditbankenConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.KreditbankenConnectorSettings;

ApiClient apiClient = new ApiClient(
  new KreditbankenConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("put-your-client-id-here")
    .certPath("path/to/qwac-crt.pem")
    .keyPath("path/to/qwac-key.pem")
    .xApiKey("x-api-key")
    .sandbox(true));

Settings for initializing ApiClient for Kreditbanken
Credentials can obtained at BankData Developer Site

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained at Open Banking Market)
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
xApiKey	string	true	API client key (obtained from BankData Developer Portal)

KvinesdalSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.KvinesdalSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new KvinesdalSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Kvinesdal Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

LHVConnectorSettings

Settings for initializing ApiClient for LHV (Estonia).

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
clientId	string	true	TPP ID (extracted from certificate, for example PSDEE-LHVTEST-01AAA)

LaanAndSparBankDKConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.LaanAndSparBankDKConnectorSettings;

ApiClient apiClient = new ApiClient(
  new LaanAndSparBankDKConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Lån & Spar Bank DK.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

LaanAndSparBankSEConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.LaanAndSparBankSEConnectorSettings;

ApiClient apiClient = new ApiClient(
  new LaanAndSparBankSEConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Lån & Spar Bank SE.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

LaegernesBankConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

LandbobankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.LandbobankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new LandbobankConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("put-your-client-id-here")
    .certPath("path/to/qwac-crt.pem")
    .keyPath("path/to/qwac-key.pem")
    .xApiKey("x-api-key")
    .sandbox(true));

Settings for initializing ApiClient for Landbobank
Credentials can obtained at BankData Developer Site

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained at Open Banking Market)
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
xApiKey	string	true	API client key (obtained from BankData Developer Portal)

LandkredittBankConnectorSettings

Settings for initializing ApiClient for Landkreditt Bank

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
business	boolean	true	Account type to access to. If true business, if false personal.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

LangaaSparekasseConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.LangaaSparekasseConnectorSettings;

ApiClient apiClient = new ApiClient(
  new LangaaSparekasseConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Langå Sparekasse.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

LansforsakringarConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.LansforsakringarConnectorSettings;

ApiClient apiClient = new ApiClient(
  new LansforsakringarConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .certPath("path/to/qwac-crt.pem")
    .keyPath("path/to/qwac-key.pem")
    .sandbox(true));

Settings for initializing ApiClient for Lansforsakringar.
Credentials can obtained at Lansforsakringar Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained from ICA Developer Portal)
clientSecret	string	true	API client secret (obtained from ICA Developer Portal)
certPath	string	false	Path to QWAC certificate in PEM format. Optional in sandbox, but required in production.
keyPath	string	false	Path to QWAC certificate private key in PEM format. Optional in sandbox, but required in production.
nokRedirectUri	string	false	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. Required for production.

LarvikbankenConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.LarvikbankenConnectorSettings;

ApiClient apiClient = new ApiClient(
  new LarvikbankenConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Larvikbanken.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

LillesandsSparebankConnectorSettings

Settings for initializing ApiClient for Lillesands Sparebank

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
business	boolean	true	Account type to access to. If true business, if false personal.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

LillestroemSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.LillestroemSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new LillestroemSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Lillestrøm Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

LollandsBankConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

LuminorConnectorSettings

Settings for initializing ApiClient for Luminor Estonia, Luminor Latvia, Luminor Lithuania.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID
clientSecret	string	true	API client secret
companyName	string	true	Company name displayed to the PSU during authorization

LuminorFallbackConnectorSettings

Settings for initializing ApiClient for Luminor Estonia, Luminor Latvia, Luminor Lithuania Fallback API.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank country (only clients from the specified will be able to authenticate). Possilbe values: EE, LT, LV
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format

LusterSparebankConnectorSettings

Settings for initializing ApiClient for Luster Sparebank

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
business	boolean	true	Account type to access to. If true business, if false personal.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

MajBankConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

MaritimeOgMerchantBankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.MaritimeOgMerchantBankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new MaritimeOgMerchantBankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Maritime og Merchant Bank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

MarkerSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.MarkerSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new MarkerSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Marker Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

MedicinosBankasConnectorSettings

Settings for initializiong ApiClient for [Medicinos Bankas] (https://www.medbank.lt/)
Credentials can be obtained at Medicinos Bankas Developer Portal

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signCertPath	string	true	Path to QSEAL public certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

MelhusSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.MelhusSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new MelhusSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Melhus Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

MerkurAndelskasseConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

MiddelfartSparekasseConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.MiddelfartSparekasseConnectorSettings;

ApiClient apiClient = new ApiClient(
  new MiddelfartSparekasseConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Middelfart Sparekasse.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

MockASPSPConnectorSettings

Settings for initializing ApiClient for MockASPSP Connector. - country

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank country (only clients from the specified will be able to authenticate). Possilbe values: FI – Finland SE – Sweden

MonsBankConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

MyBankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.MyBankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new MyBankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for MyBank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

NaeringsbankenConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.NaeringsbankenConnectorSettings;

ApiClient apiClient = new ApiClient(
  new NaeringsbankenConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Næringsbanken.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

NidarosSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.NidarosSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new NidarosSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Nidaros Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

NoerreNebelSparekasseConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.NoerreNebelSparekasseConnectorSettings;

ApiClient apiClient = new ApiClient(
  new NoerreNebelSparekasseConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Nørre Nebel Sparekasse.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

NordeaBusinessConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.NordeaBusinessConnectorSettings;

ApiClient apiClient = new ApiClient(
  new NordeaBusinessConnectorSettings()
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .signKeyPath("path/to/qseal-key.pem")
    .country("FI")
    .language("fi")
    .redirectUri("https://your-redirect-uri")
    .sandbox(true));

Settings for initializing ApiClient for Nordea (all countries).
Credentials can obtained at Nordea Developer Portal

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank country (only clients from the specified will be able to authenticate). Possilbe values: FI - Finland
clientId	string	true	API client ID (obtained from Nordea Developer Portal)
clientSecret	string	true	API client secret (obtained from Nordea Developer Portal)
signKeyPath	string	true	Path to Qseal private key in PEM format. Private key in PEM format can be extracted from test certificate from Nordea Developer Portal (provided in PKCS12 format) using openssl utility: openssl pkcs12 -in source.p12 -out key.pem -nocerts -nodes
language	string	false	Language of authentication user interface. If country is FI, the default language is fi

NordeaConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.NordeaConnectorSettings;

ApiClient apiClient = new ApiClient(
  new NordeaConnectorSettings()
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .signKeyPath("path/to/qseal-key.pem")
    .country("FI")
    .language("fi")
    .redirectUri("https://your-redirect-uri")
    .sandbox(true));

Settings for initializing ApiClient for Nordea (all countries).
Credentials can obtained at Nordea Developer Portal

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank country (only clients from the specified will be able to authenticate). Possilbe values: FI - Finland
clientId	string	true	API client ID (obtained from Nordea Developer Portal)
clientSecret	string	true	API client secret (obtained from Nordea Developer Portal)
signKeyPath	string	true	Path to Qseal private key in PEM format. Private key in PEM format can be extracted from test certificate from Nordea Developer Portal (provided in PKCS12 format) using openssl utility: openssl pkcs12 -in source.p12 -out key.pem -nocerts -nodes
language	string	false	Language of authentication user interface. If country is FI, the default language is fi

NordeaDirectConnectorSettings

Settings for initializing ApiClient for Nordea Direct

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

NordfynsBankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.NordfynsBankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new NordfynsBankConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("put-your-client-id-here")
    .certPath("path/to/qwac-crt.pem")
    .keyPath("path/to/qwac-key.pem")
    .xApiKey("x-api-key")
    .sandbox(true));

Settings for initializing ApiClient for NordfynsBank
Credentials can obtained at BankData Developer Site

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained at Open Banking Market)
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
xApiKey	string	true	API client key (obtained from BankData Developer Portal)

NordicCorporateBankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.NordicCorporateBankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new NordicCorporateBankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Nordic Corporate Bank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

NordoyarSparikassiConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.NordoyarSparikassiConnectorSettings;

ApiClient apiClient = new ApiClient(
  new NordoyarSparikassiConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Nordoyar Sparikassi.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

NykreditBankConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

OBOSBankenConnectorSettings

Settings for initializing ApiClient for OBOS Banken

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
business	boolean	true	Account type to access to. If true business, if false personal.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

OKQ8BankConnectorSettings

Settings for initializing ApiClient for OKQ8 Bank

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

OPConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
apiKey	string	true	API key
clientId	string	true	Client id
clientSecret	string	true	Client secret
certPath	string	true	Path to a QWAC
keyPath	string	true	Path to a QWAC private key
signKeyPath	string	true	Path to a public QSEAL certificate
signPubKeySerial	string	true	Public QSEAL certificate serial number

OdalSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.OdalSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new OdalSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Odal Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

OerlandSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.OerlandSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new OerlandSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Ørland Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

OerskogSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.OerskogSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new OerskogSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Ørskog Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

OestreAgderSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.OestreAgderSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new OestreAgderSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Østre Agder Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

OfotenSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.OfotenSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new OfotenSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Ofoten Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

OikosAndelskasseConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.OikosAndelskasseConnectorSettings;

ApiClient apiClient = new ApiClient(
  new OikosAndelskasseConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Oikos Andelskasse.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

OmaSpConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained from Samlink Developer Portal)
clientSecret	string	false	API client secret (sandbox client secret obtained from Samlink Developer Portal, not used in production)
signKeyPath	string	false	Path to sandbox key used for QSeal certificate. Required for production, not used in sandbox.
signPubKeySerial	string	false	Public serial key of the QSeal certificate located in signKeyPath (not used in sandbox, required for production)
signCertPath	string	false	Path to QSEAL public certificate in PEM format. Required for production, not used in sandbox.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from Samlink Developer Portal, "Ocp-Apim-Subscription-Key" in sandbox, "Api Key" in production)

OppdalsbankenConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.OppdalsbankenConnectorSettings;

ApiClient apiClient = new ApiClient(
  new OppdalsbankenConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Oppdalsbanken.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

OrklaSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.OrklaSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new OrklaSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Orkla Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

PKOConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.PKOConnectorSettings;

ApiClient apiClient = new ApiClient(
  new PKOConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("put-your-client-id-here")
    .certPath("path/to/qwac-crt.pem")
    .keyPath("path/to/qwac-key.pem")
    .signKeyPath("path/to/qseal-key.pem")
    .signPubKeySerial("qseal-cert-serial")
    .signFingerprint("qseal-cert-fingerprint")
    .signCertUrl("qseal-cert-public-url")
    .tppId("your-tpp-id")
    .sandbox(true));

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	none
certPath	string	true	none
keyPath	string	true	none
signKeyPath	string	true	none
signPubKeySerial	string	true	none
signFingerprint	string	true	none
signCertUrl	string	true	none
tppId	string	true	none

POPPankkiConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained from Samlink Developer Portal)
clientSecret	string	false	API client secret (sandbox client secret obtained from Samlink Developer Portal, not used in production)
signKeyPath	string	false	Path to sandbox key used for QSeal certificate. Required for production, not used in sandbox.
signPubKeySerial	string	false	Public serial key of the QSeal certificate located in signKeyPath (not used in sandbox, required for production)
signCertPath	string	false	Path to QSEAL public certificate in PEM format. Required for production, not used in sandbox.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from Samlink Developer Portal, "Ocp-Apim-Subscription-Key" in sandbox, "Api Key" in production)

ParetoBankConnectorSettings

Settings for initializing ApiClient for Pareto Bank

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
business	boolean	true	Account type to access to. If true business, if false personal.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

PekaoConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.PekaoConnectorSettings;

ApiClient apiClient = new ApiClient(
  new PekaoConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .certPath("path/to/qwac-crt.pem")
    .keyPath("path/to/qwac-key.pem")
    .signKeyPath("path/to/qseal-key.pem")
    .signPubKeySerial("qseal-cert-serial")
    .signFingerprint("qseal-cert-fingerprint")
    .signCertUrl("qseal-cert-public-url")
    .sandbox(true));

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	none
clientSecret	string	true	none
certPath	string	true	none
keyPath	string	true	none
signKeyPath	string	true	none
signPubKeySerial	string	true	none
signFingerprint	string	true	none
signCertUrl	string	true	none
serverSignCertPath	string	false	Path/URI for a server public pem certificate which is used for verification of a signature in a response received from a server.
serverSignCertThumbprint	string	false	Thimbprint of a server signature pem certificate provided in the serverSignCertPath parameter

PenSamConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

RabobankConnectorSettings

Settings for initializing ApiClient for Rabobank (NL)
Credentials can obtained at Rabobank (NL) Developer Portal

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained from Rabobank Developer Portal)
clientSecret	string	true	API client secret (obtained from Rabobank Developer Portal)
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signCertPath	string	true	Path to QSeal certificate in PEM format
signKeyPath	string	true	Path to QSeal certificate private key in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

ResursConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.ResursConnectorSettings;

ApiClient apiClient = new ApiClient(
  new ResursConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("put-your-client-id-here")
    .xApiKey("put-your-x-api-key-here")
    .certPath("path/to/qwac-crt.pem")
    .keyPath("path/to/qwac-key.pem")
    .signKeyPath("path/to/qseal-crt.pem")
    .signPubKeySerial("qseal-cert-public-serial-here")
    .sandbox(true));

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank country (only clients from the specified will be able to authenticate). Possilbe values: DK - Denmark FI – Finland NO - Norway SE – Sweden
clientId	string	true	API client ID (obtained at Open Banking Market)
xApiKey	string	true	API client key (obtained at Open Banking Market)
certPath	string	true	Path to QWAC certificate in PEM format. Test certificate (for accessing sandbox environment) can be downloaded from Open Banking Market.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signKeyPath	string	true	Path to QSeal certificate in PEM format. Test certificate (for accessing sandbox environment) can be downloaded from Open Banking Market.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath. The serial must be presented as a decimal string. The following command can be use for extracting it from QSeal certificate in PEM format: echo "obase=10; ibase=16; `openssl x509 -in qseal-crt.pem -serial -noout | awk -F "=" '{print $2}'`" | bc

RevolutConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank`s country
clientId	string	true	API client ID (obtained from Revolut Developer Portal)
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

RindalSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.RindalSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new RindalSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Rindal Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

RiseFlemloeseSparekasseConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.RiseFlemloeseSparekasseConnectorSettings;

ApiClient apiClient = new ApiClient(
  new RiseFlemloeseSparekasseConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Rise Flemløse Sparekasse.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

RoendeSparekasseConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.RoendeSparekasseConnectorSettings;

ApiClient apiClient = new ApiClient(
  new RoendeSparekasseConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Rønde Sparekasse.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

RoerosBankenConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.RoerosBankenConnectorSettings;

ApiClient apiClient = new ApiClient(
  new RoerosBankenConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for RørosBanken.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

RomsdalSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.RomsdalSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new RomsdalSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Romsdal Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

SBABConnectorSettings

Settings for initializing ApiClient for SBAB.
Credentials can obtained at SBAB Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	false	Path to QWAC certificate in PEM format. Required for sandbox and production.
keyPath	string	false	Path to QWAC certificate private key in PEM format. Required for production.

SDCConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SDCConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SDCConnectorSettings()
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for SDC (sandbox only version).
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank country (only clients from the specified will be able to authenticate). Possilbe values: NO – Norway SE – Sweden DK – Denmark
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	false	Path to QWAC certificate in PEM format.
keyPath	string	false	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

SEBConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SEBConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SPankkiConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .certPath("path/to/qwac-crt.pem")
    .keyPath("path/to/qwac-key.pem")
    .clientId("put-your-client-id-here")
    .country("EE")
    .sandbox(true));

Settings for initializing ApiClient for SEB Estonia, SEB Latvia and SEB Lithuania.
Credentials can obtained at SEB Developer Portal for Baltic countries.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank country (only clients from the specified will be able to authenticate). Possilbe values: EE - Estonia LV - Latvia LT - Lithuania
business	boolean	false	Account type to access to. If true business, if false personal.
certPath	string	true	Path to QWAC certificate in PEM format. Test certificate (for accessing sandbox environment) can be downloaded from SEB Developer Portal.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
clientId	string	true	API client ID (obtained from SEB Developer Portal)

SEBDenmarkConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

SEBSwedenBusinessConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SEBSwedenBusinessConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SEBSwedenBusinessConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .certPath("path/to/qwac-crt.pem")
    .keyPath("path/to/qwac-key.pem")
    .sandbox(true));

Settings for initializing ApiClient for SEB Sweden (for business users).
Credentials can obtained at SEB Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained from SEB Developer Portal), corporate entry to be used in production
clientSecret	string	true	API client secret (obtained from SEB Developer Portal), corporate entry to be used in production
certPath	string	true	Path to QWAC certificate in PEM format. Test certificate (for accessing sandbox environment) is available here: https://github.com/sebgroup/openbanking/tree/master/psd2testcertificates
keyPath	string	true	Path to QWAC certificate private key in PEM format.

SEBSwedenConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SEBSwedenConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SEBSwedenConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .certPath("path/to/qwac-crt.pem")
    .keyPath("path/to/qwac-key.pem")
    .sandbox(true));

Settings for initializing ApiClient for SEB Sweden.
Credentials can obtained at SEB Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained from SEB Developer Portal)
clientSecret	string	true	API client secret (obtained from SEB Developer Portal)
certPath	string	true	Path to QWAC certificate in PEM format. Test certificate (for accessing sandbox environment) is available here: https://github.com/sebgroup/openbanking/tree/master/psd2testcertificates
keyPath	string	true	Path to QWAC certificate private key in PEM format.

SPankkiConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SPankkiConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SPankkiConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("put-your-client-id-here")
    .xApiKey("put-your-x-api-key-here")
    .certPath("path/to/qwac-crt.pem")
    .keyPath("path/to/qwac-key.pem")
    .signKeyPath("path/to/qseal-crt.pem")
    .signPubKeySerial("qseal-cert-public-serial-here")
    .sandbox(true));

Settings for initializing ApiClient for S-Pankki (Finland).
Credentials can obtained at Open Banking Market
operated by Crosskey Banking Solutions.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained at Open Banking Market)
xApiKey	string	true	API client key (obtained at Open Banking Market)
certPath	string	true	Path to QWAC certificate in PEM format. Test certificate (for accessing sandbox environment) can be downloaded from Open Banking Market.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signKeyPath	string	true	Path to QSeal certificate in PEM format. Test certificate (for accessing sandbox environment) can be downloaded from Open Banking Market.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath. The serial must be presented as a decimal string. The following command can be use for extracting it from QSeal certificate in PEM format: echo "obase=10; ibase=16; `openssl x509 -in qseal-crt.pem -serial -noout | awk -F "=" '{print $2}'`" | bc

SaastopankkiConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (sandbox client id obtained from Samlink Developer Portal, for production equals organizationIdentifier from eIDAS QSEAL certificate subject)
clientSecret	string	false	API client secret (sandbox client secret obtained from Samlink Developer Portal, not used in production)
signKeyPath	string	false	Path to sandbox key used for QSeal certificate. Required for production, not used in sandbox.
signPubKeySerial	string	false	Public serial key of the QSeal certificate located in signKeyPath (not used in sandbox, required for production)
signCertPath	string	false	Path to QSEAL public certificate in PEM format. Required for production, not used in sandbox.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from Samlink Developer Portal, "Ocp-Apim-Subscription-Key" in sandbox, "Api Key" in production)

SallingBankConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

SandnesSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SandnesSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SandnesSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Sandnes Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

SantanderConsumerBankNorwayConnectorSettings

Settings for initializing ApiClient for Santander Consumer Bank (NO)
Credentials can obtained at Santander Consumer Bank (NO) Developer Portal

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained from Santander Consumer Bank (NO) Developer Portal)
clientSecret	string	true	API client secret (obtained from Santander Consumer Bank (NO) Developer Portal)
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format

SbankenConnectorSettings

Settings for initializing ApiClient for Sbanken

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
business	boolean	true	Account type to access to. If true business, if false personal.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

SelbuSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SelbuSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SelbuSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Selbu Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

SiauliuBankasConnectorSettings

Settings for initializiong ApiClient for [Šiaulių Bankas] (https://sb.lt/)
Credentials can be obtained at Šiaulių Bankas Developer Portal

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signCertPath	string	true	Path to QSEAL public certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
postbackUri	string	false	URL to receive a post request with list of accounts in the request body

SkagerrakSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SkagerrakSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SkagerrakSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Skagerrak Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

SkandiaConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SkandiaConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SkandiaConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Skandia.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

SkjernBankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SkjernBankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SkjernBankConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("put-your-client-id-here")
    .certPath("path/to/qwac-crt.pem")
    .keyPath("path/to/qwac-key.pem")
    .xApiKey("x-api-key")
    .sandbox(true));

Settings for initializing ApiClient for SkjernBank
Credentials can obtained at BankData Developer Site

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained at Open Banking Market)
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
xApiKey	string	true	API client key (obtained from BankData Developer Portal)

SkudenesAakraSparebankConnectorSettings

Settings for initializing ApiClient for Skudenes & Aakra Sparebank

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
business	boolean	true	Account type to access to. If true business, if false personal.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

SkueSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SkueSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SkueSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Skue Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

SoenderhaaHoerstedSparekasseConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SoenderhaaHoerstedSparekasseConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SoenderhaaHoerstedSparekasseConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Sønderhå - Hørsted Sparekasse.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

SogneOgGreipstadSparebankConnectorSettings

Settings for initializing ApiClient for Sogne og Greipstad Sparebank

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
business	boolean	true	Account type to access to. If true business, if false personal.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

SoknedalSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SoknedalSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SoknedalSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Soknedal Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

SparNordBankConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

SparbankenSydConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SparbankenSydConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SparbankenSydConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Sparbanken Syd.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

SpareBank1ConnectorSettings

Settings for initializing ApiClient for Sparebank 1

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
business	boolean	true	Account type to access to. If true business, if false personal.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
brand	string	true	Denotes the bank where the account is held.

Sparebank68NordConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.Sparebank68NordConnectorSettings;

ApiClient apiClient = new ApiClient(
  new Sparebank68NordConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Sparebank 68 Nord.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

SparebankenDINConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SparebankenDINConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SparebankenDINConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Sparebanken DIN.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

SparebankenMoreConnectorSettings

Settings for initializing ApiClient for Sparebanken Møre

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
business	boolean	true	Account type to access to. If true business, if false personal.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

SparebankenNarvikConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SparebankenNarvikConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SparebankenNarvikConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Sparebanken Narvik.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

SparebankenOstConnectorSettings

Settings for initializing ApiClient for Sparebanken Øst

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
business	boolean	true	Account type to access to. If true business, if false personal.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

SparebankenSognOgFjordaneConnectorSettings

Settings for initializing ApiClient for Sparebanken Sogn og Fjordane

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
business	boolean	true	Account type to access to. If true business, if false personal.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

SparekasseBredebroConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SparekasseBredebroConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SparekasseBredebroConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Sparekasse Bredebro.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

SparekassenBallingConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SparekassenBallingConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SparekassenBallingConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Sparekassen Balling.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

SparekassenDjurslandConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SparekassenDjurslandConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SparekassenDjurslandConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Sparekassen Djursland.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

SparekassenKronjyllandConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SparekassenKronjyllandConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SparekassenKronjyllandConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Sparekassen Kronjylland.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

SparekassenSjaellandFynConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SparekassenSjaellandFynConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SparekassenSjaellandFynConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("put-your-client-id-here")
    .certPath("path/to/qwac-crt.pem")
    .keyPath("path/to/qwac-key.pem")
    .xApiKey("x-api-key")
    .sandbox(true));

Settings for initializing ApiClient for Sparekassen Sjælland-Fyn
Credentials can obtained at BankData Developer Site

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained at Open Banking Market)
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
xApiKey	string	true	API client key (obtained from BankData Developer Portal)

SparekassenThyConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SparekassenThyConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SparekassenThyConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Sparekassen Thy.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

SparekassenVendsysselConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SparekassenVendsysselConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SparekassenVendsysselConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Sparekassen Vendsyssel.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

SpareskillingsbankenConnectorSettings

Settings for initializing ApiClient for Spareskillingsbanken

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
business	boolean	true	Account type to access to. If true business, if false personal.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

StadilSparekasseConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.StadilSparekasseConnectorSettings;

ApiClient apiClient = new ApiClient(
  new StadilSparekasseConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Stadil Sparekasse.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

StadsbygdSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.StadsbygdSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new StadsbygdSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Stadsbygd Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

StorebrandConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.StorebrandConnectorSettings;

ApiClient apiClient = new ApiClient(
  new StorebrandConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Storebrand.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

StroemmenSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.StroemmenSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new StroemmenSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Strømmen Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

SuduroyarSparikassiConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SuduroyarSparikassiConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SuduroyarSparikassiConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Suðuroyar Sparikassi.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

SunndalSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SunndalSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SunndalSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Sunndal Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

SurnadalSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SurnadalSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SurnadalSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Surnadal Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

SwedbankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SwedbankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SwedbankConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .country("SE")
    .redirectUri("scheme://uri/to/redirect/after/payment")
    .sandbox(true));

Settings for initializing ApiClient for Swedbank (all countries except Norway).
Credentials can obtained at Swedbank Developer Portal

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank country (only clients from the specified will be able to authenticate). Possilbe values: EE – Estonia LT – Lithuania LV – Latvia SE – Sweden
certPath	string	false	Path to QWAC certificate in PEM format. Required for production.
keyPath	string	false	Path to QWAC certificate private key in PEM format. Required for production.
clientId	string	true	API client ID (obtained at the developer portal)
clientSecret	string	true	API client secret (obtained at the developer portal)
brand	string	false	Name of Swedbank cooperating Savings Bank (e.g. Bergslagens Sparbank). If not set defaults to Swedbank.

SwedbankDenmarkConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

SwedbankNorgeConnectorSettings

Settings for initializing ApiClient for Swedbank Norge

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
business	boolean	true	Account type to access to. If true business, if false personal.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

SydbankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SydbankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SydbankConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("put-your-client-id-here")
    .certPath("path/to/qwac-crt.pem")
    .keyPath("path/to/qwac-key.pem")
    .xApiKey("x-api-key")
    .sandbox(true));

Settings for initializing ApiClient for Sydbank
Credentials can obtained at BankData Developer Site

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained at Open Banking Market)
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
xApiKey	string	true	API client key (obtained from BankData Developer Portal)

TinnSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.TinnSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new TinnSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Tinn Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

TolgaOsSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.TolgaOsSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new TolgaOsSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Tolga-Os Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

TotalbankenConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

TotensSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.TotensSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new TotensSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Totens Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

TroegstadSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.TroegstadSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new TroegstadSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Trøgstad Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

TysnesSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.TysnesSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new TysnesSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Tysnes Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

ValdresSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.ValdresSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new ValdresSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Valdres Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

ValleSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.ValleSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new ValleSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Valle Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

VestjyskBankConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signKeyPath	string	true	Path to QSeal certificate in PEM format
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath
signCertPath	string	true	Path to QSEAL public certificate in PEM format
nokRedirectUri	string	true	URI of the TPP, where the transaction flow shall be redirected instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.

VikSparebankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.VikSparebankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new VikSparebankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Vik Sparebank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

VolvofinansConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.VolvofinansConnectorSettings;

ApiClient apiClient = new ApiClient(
  new VolvofinansConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .xApiKey("x-api-key")
    .sandbox(true));

Settings for initializing ApiClient for Sydbank
Credentials can obtained at Volvofinans Developer Site

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained from Volvofinans Developer Portal)
clientSecret	string	true	API client secret (obtained from Volvofinans Developer Portal)
xApiKey	string	true	API client key (obtained from Volvofinans Developer Portal)

VossSparebankConnectorSettings

Settings for initializing ApiClient for Voss Sparebank

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
business	boolean	true	Account type to access to. If true business, if false personal.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

VossVekselOgLandmandsbankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.VossVekselOgLandmandsbankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new VossVekselOgLandmandsbankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .ocpApimSubscriptionKey("Ocp-Apim-Subscription-Key)
    .sandbox(true));

Settings for initializing ApiClient for Voss Veksel- og Landmandsbank.
Credentials can obtained at SDC Developer Portal.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client reference for the bank that you are calling to obtain data. Issued by SDC to TPP in onboarding process
clientSecret	string	true	Client secret obtained from SDC in onboarding process
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from SDC Developer Portal)

YaConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	none
xApiKey	string	true	none
certPath	string	true	none
keyPath	string	true	none
signKeyPath	string	true	none
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath. The serial must be presented as a decimal string. The following command can be use for extracting it from QSeal certificate in PEM format: echo "obase=10; ibase=16; `openssl x509 -in qseal-crt.pem -serial -noout | awk -F "=" '{print $2}'`" | bc

Connector

SparebankenSorConnectorSettings

Settings for initializing ApiClient for Sparebanken Sør

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
business	boolean	true	Account type to access to. If true business, if false personal.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSeal certificate in PEM format.
signKeyPath	string	true	Path to QSeal private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath

Platform

Java

public abstract class AbstractConnectorSettingsFactory

Base class for connector settings factory, which can be used for creating instances of connector-specific settings classes (derived from ConnectorSettings class)

Code sample

public class SampleConnectorSettingsFactory {
    @Override
    public String getConnectorName() {
        // Returning connector identifier
        return "Nordea";
    }
    @Override
    public Boolean getSandbox() {
        // Returning value of `sandbox` parameter (common for all connectors)
        return true;
    }
    @Override
    public String getAccessToken() {
        // Returning "not set" for `accessToken` parameter (common for all connectors)
        return null;
    }
    @Override
    public String getConsentId() {
        // Returning "not set" for `consentId` parameter (common for all connectors)
        return null;
    }
    @Override
    public String getRedirectUri() {
        // Returning value of `redirectUri` parameter (common for all connectors)
        return "https://redirect-uri";
     }
    public String getClientId() {
        // Returning value of `clientId` parameter (Nordea specific)
        return "api-client-id";
    }
    public String getClientSecret() {
        // Returning value of `clientSecret` parameter (Nordea specific)
        return "api-client-secret";
    }
    public String getCertPath() {
        // Returning value of `certPath` parameter (Nordea specific)
        return "/path/to/qwac/cert";
    }
    public String getKeyPath() {
        // Returning value of `keyPath` parameter (Nordea specific)
        return "/path/to/qwac/key";
    }
}

abstract protected String getConnectorName()

• Returns: Connector identifier

abstract protected Boolean getSandbox()

• Returns: true - sandbox settings, false - production settings

abstract protected String getConsentId()

• Returns: Consent identifier (null if consent is not set)

abstract protected String getSandboxConsentId()

• Returns: Sandbox consent identifier (null if consent is not set)

abstract protected String getAccessToken()

• Returns: User access token (null if access token is not set)

public ConnectorSettings createConnectorSettings()

Creates connector settings for a connector with identifier returned from getConnectorName method. The created connector settings instance will contain data returned by the corresponding methods of the factory. For example, if getConnectorName returns "Nordea" instance of NordeaConnectorSettings class will be created and data like client ID and client secret will be set (corresponding methods including getClientId and getClientSecret must be implemented in the factory, otherwise runtime exception will be thrown).

• Returns: Instance of a connector settings class

---

public abstract class AbstractPlatformExtension

Base class for customazing low-level functionality to the requirements of a target platform

• Package: com.enablebanking

abstract protected PlatformApiResponse makeRequest(PlatformApiRequest request, boolean followRedirects)

Executes API request and returns an object containing response details.

• Parameters:
  • request — Request details including parameters for establishing (M)TLS connection
  • followRedirects. — Specifies if HTTP request should follow redirects
• Returns: Object containing response details

abstract protected String signWithKey(String data, String keyPath, String hashAlgorithm, String cryptoAlgorithm)

Generates signature of the provided data. Signing algorithm is determined by the key

• Parameters:
  • data — String to be signed
  • keyPath — URI of the key used for signing {@code data} parameter
  • hashAlgorithm — Hash algorithm to use (optional). If not provided then SHA256 will be used
  • cryptoAlgorithm — Cryptographic algorithm to use. Default RS used if algorithm is not provided
• Returns: String containing signature

abstract protected boolean verifySignature(String signature, String message, PlatformJWKCertificate cert, String hashAlgorithm, String cryptoAlgorithm)

• Parameters:
  • signature — Base64 urlsafe encoded signature to verify
  • message — Message to verify against
  • cert — Instance of a PlatformJWKCertificate
  • hashAlgorithm — Hash algorithm to use (optional). If not provided then SHA256 will be used
  • cryptoAlgorithm — Cryptographic algorithm to use. Default RS used if algorithm is not provided
• Returns: boolean showing if signature is valid

abstract protected String loadPEM(String path)

Load PEM content.

• Parameters: path — {String} — Path to PEM
• Returns: String – PEM content

---

public class PlatformApiRequest

Internal representation of API request

• Package: com.enablebanking

public PlatformApiRequest(String method, String origin, String path, List<Map.Entry<String, String>> headers, List<Map.Entry<String, String>> query, String body, TlsSettings tls)

Creates instance of the class with all necessary parameters.

• Parameters:
  • method — HTTP method: GET, POST, PUT, etc
  • origin — HTTP origin (i.e. <scheme> "://" <hostname> [ ":" <port> ])
  • path — Path part of a requested URL
  • headers — HTTP headers as a list of key-value pairs
  • query — Query part of a requested URL as a list of key-value pairs
  • body — HTTP body
  • tls — Parameters for establishing (M)TLS connection

public PlatformApiRequest(String method, String origin, String path, List<Map.Entry<String, String>> headers, List<Map.Entry<String, String>> query, String body)

Creates instance of the class with all parameters except (M)TLS settings.

• Parameters:
  • method — HTTP method: GET, POST, PUT, etc
  • origin — HTTP origin (i.e. <scheme> "://" <hostname> [ ":" <port> ])
  • path — Path part of an URL
  • headers — HTTP headers as a list of key-value pairs
  • query — Query part of an URL as a list of key-value pairs
  • body — HTTP body

public String getMethod()

• Returns: HTTP method of the request

public String getOrigin()

• Returns: HTTP origin of the request

public String getPath()

• Returns: Path part of the requested URL

public List<Map.Entry<String, String>> getHeaders()

• Returns: HTTP headers of the request

public List<Map.Entry<String, String>> getQuery()

• Returns: Query part of the requested URL

public String getBody()

• Returns: Body of the request

public TlsSettings getTls()

• Returns: Parameters for establishing (M)TLS connection for the request

public String findHeader(String header)

• Parameters: header — Name of an HTTP header
• Returns: First entry of the HTTP header with a given name or null if not found

---

public class TlsSettings

Internal representation of the parameters used to establish (M)TLS connection

• Package: com.enablebanking

public TlsSettings(String certPath, String keyPath)

Creates instance of the class with all necessary parameters.

• Parameters:
  • certPath — URI for identifying client certificate for MTLS connection
  • keyPath — URI for identifying private key for MTLS client certificate

public String getCertPath()

• Returns: URI for identifying client certificate for MTLS connection

public String getKeyPath()

• Returns: URI for identifying private key for MTLS client certificate

@Override public boolean equals(Object obj)

Checks if this object equals to another.

• Parameters: obj — Object to compare with
• Returns: true when {@code obj} is considered equal to {@code this}, otherwise false

---

public class PlatformApiResponse

Internal representation of API response

• Package: com.enablebanking

public PlatformApiResponse(int statusCode, List<Map.Entry<String, String>> headers, String body)

Creates instance of the class with all necessary parameters.

• Parameters:
  • statusCode — HTTP response code
  • headers — HTTP response headers as list of key-value pairs
  • body — Body of HTTP response

public int getStatusCode()

• Returns: HTTP code of the response

public List<Map.Entry<String, String>> getHeaders()

• Returns: HTTP headers of the response

public String getBody()

• Returns: Body of the response

public String findHeader(String header)

• Parameters: header — Name of an HTTP header
• Returns: First entry of the HTTP header with a given name or null if not found

Changelog

0.8.1

Added

• New connectors: Rabobank NL, ABNAMRO NL, BNG NL, BNPParibasFortis BE (including Fintro and Hello Bank brands), DNB NO, KBC BE (KBC and CBC brands), AXA Bank, Belfius BE
• Added new method in meta connector settings getSupportedPsuTypes which returns array of supported account types (personal, business).
• Support of business accounts for Nordea is moved into separate connector NordeaBusiness.
• TransactionPeriodError which is raised when wrong account transactions period is requested.
• Added fields userIdFormat and userIdDescription to the MetaApi AuthInfo model.
• Added error field to the AuthRedirect model.

Fixed

• Fixes and improvements for production connectors (LHV, Nordea, ICABanken, Citadele, SEBSweden).
• General improvements for exception handling in the SDK.

0.8.0

Added

• Added parameter reference in ParameterValidationException, field and path references in ModelValidationException
• [Java] Added getters for private fields for exceptions.
• [Java] Platform method loadPEM now can load certificates from any filesystem path (previously was loading only from resources).
• Platform method makeRequest now has additional optional argument followRedirects(defaults to true).
• Mock connector MockASPSP designed for testing common AISP flows with two countries - SE (mock decoupled flow with token polling and consent request required before calling getAccounts) and FI (mock redirect flow)
• Production connectors for Revolut, LHV, Citadele, CoopPank, Swedbank LT

Changed

• Internal refactoring of SPankki, Alandsbanken, Resurs, Ya and Komplett connectors.
• Improved production integrations for SEB LT, Handelsbanken SE
• Removed ClientInfoValidationException (replaced with ModelValidationException)

0.7.1

Added

• New platform method loadPEM. It is responsible for loading PEM content into SDK. Overload it if you want to load your certificate from database/certificate storage.

Changed

• [Python] cryptography library version is updated to the latest 3.2.1
• signCertString connector settings is changed to signCertPath(Platform now properly loads its content thanks to new platform method loadPEM)
• Changed interface of Platform.verifySignature: certPath parameter replaced with cert parameter, accepting JWK class instance with two fields ("e" and "n").

Fixed

• Fixed makeToken issue for production Lansforsakringar connector. Added support for refresh token.
• Removed appId connector setting in Handelsbanken connector.

0.7.0

Added

• Production connectors for SBAB, Lansforsakringar.
• Added PSU-GEO-Location validation. Expected input format for this header: comma separated latitude and longitude coordinates without spaces. (Without GEO: prefix.)

Fixed

• Fixed authentication scopes and account transactions negative amount value for SEBSweden connector.
• Nordea appropriate error thrown (Unauthorized) if access token is expired
• Revolut fixed and improved account transaction fields mapping

Changed

• [Python] cryptography library version is updated to 3.1
• Breaking change: Internal improvements of handling Access model. Default values for Access.transactions.statuses and Access.balances.statuses are null. Widest possible consent requested by default.

0.6.6

Added

• ClientInfoValidation error is raised when a required client information is not set before sending requests to ASPSP.
• Production connector for SEB (Baltics)

Fixed

• Using correct value for Access.validUntil in Nordea connector.
• [Javascript] Fixed how core exceptions are rejecting async calls.
• Fixed makeToken issue in decoupled flow for Handelsbanken.

0.6.5

Added

• Revolut domestic payments
• Support for Handelsbanken SE decoupled authentication
• Sweden production connectors for Alandsbanken, DanskeBank, Handelsbanken, SEBSweden

Fixed

• Consent JWT payload for connectors SPankki, Alandsbanken, Resurs, Ya, Komplett

0.6.4

Added

• Parameter brand added to Swedbank connector settings. List of supported brands is available through the connector's meta.

Fixed

• Production API domain changed in DanskeBank connector.

0.6.3

Fixed

• Updated Swedbank connector to use v3 version of api.
• Generation of Date header is fixed in SEB connector.

0.6.2

Added

• Added PS signature algorithm verification in Platform.verifySignature method. Added optional cryptoAlgorithm parameter to Platform.verifySignature method.

Fixed

• Fixed Danske bank jwt signature algorithm and JWT fields
• [Python] Updated dependency library cryptography
• [JavaScript] Updated ApiClient and Platform classes to conform other languages

0.6.1

Added

• Improved exception handling: now there are a lot less CoreExceptions raising. Improved exception messages in many cases.
• Added several new types of exceptions: ParameterValidationException, ModelValidationException, ResourceNotFoundException, InsufficientScopeException, InvalidResponseSignatureException, InvalidResponseIdException.
• Added validation for certificate/key paths.
• Production connectors for Holvi and Aktia Contingency API.
• getAuth returns an additional field for AktiaContingency connector - authData that contains otpIndex of code which user should pass to makeToken.
• Connectors meta authInfo now has two additional fields: passwordRequired and authData. First shows if password is required in getAuth call, and second shows if authData is returned in getAuth.

Fixed

• Fixed transaction fields mapping in Nordea, SPankki, DanskeBank and OP connectors.
• Fixed transaction amount mapping for Berlin Group connectors.
• Fixed incorrect headers in sandbox for POPPankki, OmaSp and Saastopankki connectors.

Changed

• getAuth now has optional parameter password which is required for Holvi and AktiaContingency.

0.6.0

Added

• Added transaction pagination. To get next page of transaction, pass HalTransactions.continuationKey parameter to getAccountTransactions. getAccountTransactions other parameter must be the same as in the original call. continuationKey is null if there are no more pages of transactions or if pagination is not supported by connector.
• Production connectors for Finnish banks: Nordea, OP, POP Pankki, S-Pankki, Ålandsbanken, Resurs Bank, Handelsbanken, Säästöpankki, Oma Säästöpankki, Danske Bank.
• Field brands, containing list of end-user recognizable ASPSP's brands, added into AuthInfo data structure returned within connectors' meta.
• CBPII API containing makeFundsConfirmation method added to support functionality needed for card-based payment instrument issuers.
• New connectors: Banxe, SantanderConsumerBankNorway

Fixed

• Fixed mappings for production connectors.
• Removed sessionDuration from Nordea connector settings, now uses Access.validUntil attribute instead. (passed to getAuth)
• Negative balance amount for banks using Open Banking UK API standard.
• Transaction filtering by date fixed for Alandsbanken, SPankki, Resurs, Danske connectors.
• Fixed setting session validity period (consent) for SPankki, Alandsbanken, Resurs, Danske, OmaSP, POPPankki, Saastopankki and Nordea.

0.5.2

Added

• PSU headers not supported by a connector now will be skipped instead of raising exception.
• [Java] fixed datetime parsing issue in DanskeBank, Alior and Pekao connectors.
• [Javascript] Possibility to initialize ApiClient using settings.
• [Javascript] Platform exposed through enablebanking module object.
• New connectors: AndelskassenFaelleskassen, BILDanmark, CoopBankDenmark, DanskeAndelskassersBank, DenJyskeSparekasse, FasterAndelskasse, FrorupAndelskasse, FroslevMollerupSparekasse, FynskeBank, HandelsbankenDenmark, HvidbjergBank, LaegernesBank, Lansforsakringar, LollandsBank, MajBank, MerkurAndelskasse, MonsBank, NykreditBank, PenSam, SallingBank, SEBDenmark, SparNordBank, SwedbankDenmark, Totalbanken, VestjyskBankArbejdernesLandsbank, Volvofinans.

Fixed

• Several connectors has been fixed (fixes are mostly related to date/time handling).

0.5.1

Added

• [Javascript] Possibility to instantiate model classes with data and support of the native date type.
• [Javascript] Better representation of the errors coming from the connectors.
• Optional parameter cryptoAlgorithm added to platform method signWithKey in all platforms in order to enforce usage of a certain algorithm.
• Support of PS256 signature algorithm added on all platforms.
• [Java] Added new dependency Bouncy Castle (bcprov-jdk15on) to support PS256 signatures.
• New connectors: AlmBrand, Citadele, DjurslandsBank, JyskeBank, Kreditbanken, Landbobank, Luminor, NordfynsBank, Revolut, SDC (NO), SiauliuBankas, SkjernBank, SparekassenSjaellandFyn, Sydbank.

Changed

• Resurs connector now requires country setting and in addition to Finland now supports Denmark, Norway and Sweden.

Fixed

• [Java] JDK 9+ compatibility bug is fixed

0.5.0

Added

• getAuth now returns an additional field Auth.env, which contains additional authentication info to be passed to makeToken.
• makeToken now has a new parameter authEnv (value has to be taken from Auth.env returned from getAuth).
• Field refreshToken in connector meta data, displaying refresh token support.
• Added new fields to display party account's currency: PaymentRequestResource.debtorCurrency and Beneficiary.creditorCurrency
• New connectors: CoopPank, MeridianBank, PrivatBank, SignetBank

Changed

• Breaking change: moved redirectUri to base connector settings and removed it from getAuth, makeToken and modifyConsents parameters. redirectUri is now required parameter for every connector.
• Nordea connector settings field keyPath to signKeyPath in order to maintain consistency for QWAC/QSealC keys naming.

Removed

• Parameters scope and responseType removed from getAuth.
• Nordea connector setting certPath removed as QWAC not supported by Nordea.

0.4.4

Added

• Field requiredPsuHeaders containing array of mandatory PSU headers added to Connector data structure.
• Fields modifyConsentsInfo and authInfo containing additional information about usage modifyConsents and getAuth methods added to Connector data structure.

0.4.3

Added

• Possibility for revoking PSU consent for several banks.
• Field consentRevocation in connector meta data, displaying consent revocation support.
• Auth API now provides setClientInfo method for setting extra PSU headers such as PSU-IP-Address, PSU-IP-Port, PSU-Geo-Location etc.
• [Python] Possibility to initialize ApiClient using a connector module imported from a separate package.

Changed

• psuIpAddress parameter removed from ConnectorSettings classes where it was present. Method setClientInfo shall be used instead.
• [Python] Platform classes require core module reference to be passed as the first argument of the constructor.

Fixed

• [Java] Top-level null deserialization is fixed.
• Payment request is fixed for Handelsbanken connector.

0.4.2

Added

• Auth API provides parseRedirectUrl method for parsing of the parameters returned in the callback URL, which a PSU is redirected to after successful authentication on the ASPSP's website.
• [Python] Possibility to use connectors imported from another packages.
• Fields creditorAccount and debtorAccount added to Transaction data structure to be able to return information about creditor and debtor accounts in the list of transactions when the information is returned by an ASPSP.
• New connectors: DanskeBank, OmaSp and Saastopankki.
• Response signature verification for Pekao bank. If verification is failed then the InvalidResponseSignatureException is raised.

Changed

• Validation of sandbox setting is unified based on meta information (environment field).
• [Python] enablebanking.CoreException is thrown when unable to initialise a connector.

Fixed

• LHV connector fixes and improvements.

0.4.1

Added

• Builders of ConnectorSettings' subclasses now supports any order of parameter chaining.
• Fields aspspIds (list of supported ASPSPs identified by ECB's MFI codes) and environments (sandbox/production) are added to Connector data structure.
• [Python] BrokerPlatform used for generating request signatures and making mTLS connections towards APSPSs through eIDAS broker service.

0.4.0

Added

• Optional parameter hashAlgorithm added to platform method signWithKey in all platforms.
• Connector data structure now has additional payments field containing list of supported payment types (new PaymentTypes data structure is added).

Changed

• Platform method signPKCS1v15usingSHA256 renamed to signWithKey in all platforms.
• Field PaymentRequestResource.paymentTypeInformation is used to identify payment type that is going to be executed.

0.3.1

Added

• Base connector for banks implementing PolishAPI on KIR platform.

Changed

• [Python] Capitalization of request headers removed to be able to support API backend with case-sensitive handling of the headers.
• Added Handelsbanken (AISP) connector for Finland and Sweden
• Updated OP connector. Changed connector settings

0.3.0

Changed

• [Java] UnstructuredRemittanceInformation now uses ArrayList constructor.

• Parameter paymentRequestData of PISP API method makePaymentRequestConfirmation removed and the data is passed inside confirmation parameter (PaymentRequestConfirmation data structure now has an option attribute paymentRequest).

0.2.1

Added

• Added DataRetrievalException and InsufficientScopeException derived from HttpException to represent particular cases.

0.2.0

Added

• [Java] Improved connector settings interface. Added AbstractConnectorSettingsFactory class with a factory method createConnectorSettings to simplify creation of connector settings. ApiClient now has constructors taking ConnectorSettings instance instead of list of settings objects.
• [Java] AbstractPlatformExtension class consisting of signPKCS1v15usingSHA256 and makeRequest methods is added in order to simplify customisation of Java platform. Also added ApiClient constructor taking AbstractPlatformExtension as a parameter.
• Transaction data structure extended with fields bankTransactionCode, creditor and debtor and BankTransactionCode data structure added.
• Value refresh_token is supported for grant_type parameter of makeToken method.

Changed

• [Java] ApiClient constructors accepting settings as a list of objects and JavaPlatform class are changed to protected.
• Changed order of connector settings. Parameters consentId, accessToken and refreshToken are now always required (should be set to null if not present).
• [Java] Standard Java SE 8 date-time classes are used instead of ThreeTen-Backport classes, thus Java SE 6 and 7 support is dropped.
• Field remittanceInformation of Transaction changed to not required (mainly to support credit card transactions, for which remittance info is usually not provided).
• Access data structure changed: balances and transactions fields contain details for requested access and accounts field contains list of accessed account IDs.

Fixed

• Field mapping for Open Banking UK standard is improved.

0.1.x

This version was created before the changelog has been introduced.