NAV Navigation
Java Javascript Python

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:

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

This call returns a list of available connectors, either all or for the specified country.

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

Get authorization data such as authorization URL

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

Requests new access token for retrieving data on behalf of the authenticated user.

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

ValueDescription
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

This method is used to retrieve current values of access, refresh and id tokens used for accessing AIS and PIS APIs.

Returned value

Data type: Token

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

parseRedirectUrl

Parsing of redirect url during authorization

During authorization process user is redirected to a redirect url specified by TPP, where query/fragment parameters are added to the redirect url. This function parses those parameters.

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

Set extra PSU headers such as PSU-IP-Address

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)

Description

This call returns all payment accounts that are relevant the PSU on behalf of whom the AISP is connected.

Prerequisites

  • Valid PSU access token shall be set in the connector.
  • For ASPSPs requiring PSU consent for listing the accounts, consent ID shall be set in the connector.

Business flow

The TPP sends a request to the ASPSP for retrieving the list of the PSU payment accounts. The ASPSP computes the relevant PSU accounts and builds the answer as an accounts list. Each payment account will be provided with its characteristics returned by ASPSP, which may vary between ASPSPs and depending on the consent given by the PSU.

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.

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)

Description

This call returns a set of balances for a given PSU account that is specified by the AISP through an account resource identification.
  • ASPSPs provide at least the accounting balance on the account.
  • ASPSPs can provide other balance restitutions, e.g. instant balance, as well, if possible.
  • Actually, from the PSD2 perspective, any other balances that are provided through the Web-Banking service of the ASPSP must also be provided by this ASPSP through the API.

Prerequisites

  • Valid PSU access token shall be set in the connector.
  • Consent ID shall be set in the connector.
  • The TPP has previously retrieved the list of available accounts for the PSU.

Business flow

The AISP requests the ASPSP on one of the PSU’s accounts.
The ASPSP answers by providing a list of balances on this account.

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.

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)

Description

This call returns transactions for an account for a given PSU account that is specified by the AISP through an account resource identification. The request may use some filter parameter in order to restrict the query.

Prerequisites

  • Valid PSU access token shall be set in the connector.
  • Consent ID shall be set in the connector.
  • The TPP has previously retrieved the list of available accounts for the PSU.

Business flow

The AISP requests the ASPSP on one of the PSU’s accounts. It may specify some selection criteria. The ASPSP answers by a set of transactions that matches the query.

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

ValueDescription
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)

Description

This call requests ASPSP to set the consent of an authenticated PSU. In the mixed detailed consent on accounts
  • the AISP captures the consent of the PSU
  • then it forwards this consent to the ASPSP
This consent replaces any prior consent that was previously sent by the AISP.

Prerequisites

  • Valid PSU access token shall be set in the connector.
  • For ASPSPs allowing consent to be give only for specified accounts, the list of accounts shall be retrieved.

Business flow

The PSU specifies to the AISP which of his/her accounts will be accessible and which functionalities should be available. The AISP forwards these settings to the ASPSP.

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
ResponseValidationException 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)

Description

This call returns the consent current being used by the ASPSP connector, i.e. either explicitly set when the connector is initialized or as side effect produced by `getAuth` call.

Returned value

Data type: Consent

Current consent used for accessing AIS APIs.

deleteConsent

Deletes consent (AISP)

Description

Revokes PSU consent by specified consent ID. After the consent is revoked, it becomes invalid and can not be used for futher API requests.

Business flow

The PSU signals that he/she wants to revoke his consent for TPP to access account information. The TPP makes a request to the ASPSP to revoke PSU consent. The consent becomes invalid and its ID can not be used for consequent calls.

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
  }
}, null, null, null);

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")), null, null, null);

Payment request initiation (PISP)

Description

The following use cases can be applied:
  • payment request on behalf of a merchant
  • transfer request on behalf of the account's owner
  • standing-order request on behalf of the account's owner

Data content

A payment request or a transfer request might embed several payment instructions having
  • one single execution date or multiple execution dates,
  • one single beneficiary or multiple beneficiaries.
A standing order request must embed one single payment instruction and must address one single beneficiary.

Business flow

Payment Request use case

The PISP forwards a payment request on behalf of a merchant.
The PSU buys some goods or services on an e-commerce website held by a merchant. Among other payment method, the merchant suggests the use of a PISP service. As there is obviously a contract between the merchant and the PISP, there is no need of such a contract between the PSU and this PISP to initiate the process.
Case of the PSU that chooses to use the PISP service:
  • The merchant forwards the requested payment characteristics to the PISP and redirects the PSU to the PISP portal.
  • The PISP requests from the PSU which ASPSP will be used.
  • The PISP prepares the Payment Request and sends this request to the ASPSP.
  • The Request can embed several payment instructions having different requested execution date.
  • The beneficiary, as being the merchant, is set at the payment level.

Transfer Request use case

The PISP forwards a transfer request on behalf of the owner of the account.
  • The PSU provides the PISP with all information needed for the transfer.
  • The PISP prepares the Transfer Request and sends this request to the relevant ASPSP that holds the debtor account.
  • The Request can embed several payment instructions having different beneficiaries.
  • The requested execution date, as being the same for all instructions, is set at the payment level.

Standing Order Request use case

The PISP forwards a Standing Order request on behalf of the owner of the account.
  • The PSU provides the PISP with all information needed for the Standing Order.
  • The PISP prepares the Standing Order Request and sends this request to the relevant ASPSP that holds the debtor account.
  • The Request embeds one single payment instruction with
    • The requested execution date of the first occurrence
    • The requested execution frequency of the payment in order to compute further execution dates
    • An execution rule to handle cases when the computed execution dates cannot be processed (e.g. bank holydays)
    • An optional end date for closing the standing Order

Authentication flows for all use cases

As the request posted by the PISP to the ASPSP needs a PSU authentication before execution, this request will include:
  • The specification of the authentication approaches that are supported by both the PISP and the ASPSP (any combination of "REDIRECT", "EMBEDDED" and "DECOUPLED" values).
  • In case of possible REDIRECT or DECOUPLED authentication approach, one or two callback URLs will be passed to the ASPSP at the finalisation of the authentication and consent process. The URLs are set in the connector settings.
  • In case of possible "EMBEDDED" or "DECOUPLED" approaches, the PSU identifier that can be processed by the ASPSP for PSU recognition must have been set within the [debtor] structure.
When the ASPSP accepts the request and answers to the PISP embeds:
  • A resource identification of the accepted request that can be further used to retrieve the request and its status information.
  • The specification of the chosen authentication approach taking into account both the PISP and the PSU capabilities.
  • In case of chosen REDIRECT authentication approach, the URL to be used by the PISP for redirecting the PSU in order to perform a authentication.
In case the PSU neither gives nor denies his/her consent, the request will expire and is then rejected to the PISP. The expiration delay is specified by each ASPSP.

Redirect authentication approach

When the authentication approach within the ASPSP answer is set to "REDIRECT":
  • The PISP redirects the PSU to the ASPSP which authenticates the PSU.
  • The ASPSP asks the PSU to give (or deny) his/her consent to the payment request
  • The PSU chooses or confirms which of his/her accounts shall be used by the ASPSP for the future credit transfer.
  • The ASPSP is then able to initiate the subsequent credit transfer.
  • The ASPSP redirects the PSU to the PISP using one of the callback URLs.

Decoupled authentication approach

When the authentication approach is "DECOUPLED":
  • Based on the PSU identifier provided within the payment request by the PISP, the ASPSP gives the PSU with the payment request details and challenges the PSU for a Strong Customer Authentication on a decoupled device or application.
  • The PSU chooses or confirms which of his/her accounts shall be used by the ASPSP for the future credit transfer.
  • The ASPSP is then able to initiate the subsequent credit transfer.
  • The ASPSP notifies the PISP about the finalisation of the authentication and consent process by using one of the callback URLs.

Embedded authentication approach

When the authentication approach within the ASPSP answers is set to "EMBEDDED":
  • The TPP informs the PSU that a challenge is needed for completing the Payment Request processing. This challenge will be one of the following:
    • A One-Time-Password sent by the ASPSP to the PSU on a separate device or application.
    • A response computed by a specific device on base of a challenge sent by the ASPSP to the PSU on a separate device or application.
  • The PSU unlocks the device or application through a "knowledge factor" and/or an "inherence factor" (biometric), retrieves the payment request details and processes the data sent by the ASPSP.
  • The PSU might choose to confirm which of his/her accounts shall be used by the ASPSP for the future credit transfer when the device or application allows it.
  • When agreeing the payment request, the PSU enters the resulting authentication factor through the PISP interface.
  • The PISP shall confirm the payment request using the authentication factor received from the PSU.

Parameters

Name Type Required Description
paymentType string true Payment type. Can be either SEPA, INST_SEPA, DOMESTIC or CROSSBORDER
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
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)

Description

The following use cases can be applied:
  • retrieval of a payment request on behalf of a merchant
  • retrieval of a transfer request on behalf of the account's owner
  • retrieval of a standing-order request on behalf of the account's owner
The PISP has sent a payment request.
The ASPSP has registered the request, updated if necessary the relevant identifiers in order to avoid duplicates and returned the updated request.
The PISP gets the request that might have been updated with the resource identifiers, the status of the payment/transfer request and the status of the subsequent credit transfer.

Prerequisites

  • The TPP has previously posted a payment request which has been accepted by the ASPSP.

Business flow

The PISP asks to retrieve the payment/transfer request that has been accepted by the ASPSP. The PISP uses the payment request identifier provided by the ASPSP in response to the payment request.
The ASPSP returns the previously accepted payment/transfer request, which is enriched with:
  • The resource identifiers given by the ASPSP
  • The status information of the Payment Request and of the subsequent credit transfer

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.

makePaymentRequestConfirmation

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

Description

The PISP confirms one of the following requests
  • payment request on behalf of a merchant
  • transfer request on behalf of the account's owner
  • standing-order request on behalf of the account's owner
The ASPSP answers with a status of the relevant request and the subsequent Credit Transfer.

Prerequisites

  • The TPP has previously set a request which has been accepted by the ASPSP.
  • The TPP has retrieved the accpeted request in order to get the relevant resource IDs.
  • The TPP provided the PSU necessary information and means for SCA required before the confirmation.

Business flow

Once the PSU has been authenticated, it is the due to the PISP to confirm the Request to the ASPSP in order to complete the process flow.
In REDIRECT and DECOUPLED approach, this confirmation is not a prerequisite to the execution of the Credit Transfer.

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)

Description

The CBPII can ask an ASPSP to check if a given amount can be covered by the liquidity that is available on a PSU cash account or payment card.

Business flow

The CBPII requests the ASPSP for a payment coverage check against either a bank account or a card primary identifier.
The ASPSP answers with a structure embedding the original request and the result as a Boolean.

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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.

allAccountIds

[GenericIdentification]

false

All account identifiers provided by ASPSPs (including primary identifier available in the accountId field)

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

Enumerated Values

usage

ValueDescription

PRIV

private personal account

ORGA

professional account

cashAccountType

ValueDescription

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

ValueDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

type

string

false

Type of the auth data item

value

string

false

Value of auth data item

Enumerated Values

type

ValueDescription

otpIndex

AuthInfo

Information about usage of getAuth method

Fields

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

error_description

string

false

error description

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

ValueDescription

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

NameTypeRequiredDescription

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

ValueDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

Base type

boolean

Brand

Information about ASPSP end-user recognizable brand

Fields

NameTypeRequiredDescription

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

ValueDescription

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

ValueDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

name

string

true

Name of the connector

environments

[string]

true

List of supported environments (sandbox/production)

countries

[string]

true

List of supported countries

languages

[string]

false

List of supported languages

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

NameTypeRequiredDescription

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)

User consent

NameTypeRequiredDescription

consentStatus

string

false

none

consentId

string

false

none

_links

ConsentLinks

false

none

ContactDetails

Contact details of a person.

Fields

NameTypeRequiredDescription

emailAddress

string

false

Email address of a person

phoneNumber

string

false

Phone number of a person

CountryAuthInfo

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

Fields

NameTypeRequiredDescription

country

string

true

Country ISO 3166-1 alpha-2 code

method

string

false

Authentication method

defaultMethod

boolean

true

Flag showing whether this authentication method will be chosen if the method parameter is not explicitly set when getAuth is called If this flag is set for more than one authentication methods, then the method parameter must be explicitly set when getAuth is called.

title

string

false

Authentication method human readable name

info

AuthInfo

true

Information about usage of getAuth method

approach

AuthenticationApproach

true

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

CountryAuthMethods

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

Fields

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

country

string

true

Country ISO 3166-1 alpha-2 code

paymentTypes

[PaymentTypeInfo]

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

NameTypeRequiredDescription

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

Payment instruction to transfer instructed amount of money to the specified beneficiary.

Fields

NameTypeRequiredDescription

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

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.

regulatoryReporting

[RegulatoryReporting]

false

[Information needed due to regulatory and statutory requirements.]

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.

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

CurrencyCodeEnum

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

Enumerated Values

ValueDescription

AED

United Arab Emirates dirham

AFN

Afghan afghani

ALL

Albanian lek

AMD

Armenian dram

ANG

Netherlands Antillean guilder

AOA

Angolan kwanza

ARS

Argentine peso

AUD

Australian dollar

AWG

Aruban florin

AZN

Azerbaijani manat

BAM

Bosnia and Herzegovina convertible mark

BBD

Barbados dollar

BDT

Bangladeshi taka

BGN

Bulgarian lev

BHD

Bahraini dinar

BIF

Burundian franc

BMD

Bermudian dollar

BND

Brunei dollar

BOB

Boliviano

BOV

Bolivian Mvdol (funds code)

BRL

Brazilian real

BSD

Bahamian dollar

BTN

Bhutanese ngultrum

BWP

Botswana pula

BYN

Belarusian ruble

BZD

Belize dollar

CAD

Canadian dollar

CDF

Congolese franc

CHE

WIR euro (complementary currency)

CHF

Swiss franc

CHW

WIR franc (complementary currency)

CLF

Unidad de Fomento (funds code)

CLP

Chilean peso

CNY

Chinese yuan

COP

Colombian peso

COU

Unidad de Valor Real

CRC

Costa Rican colon

CUC

Cuban convertible peso

CUP

Cuban peso

CVE

Cape Verdean escudo

CZK

Czech koruna

DJF

Djiboutian franc

DKK

Danish krone

DOP

Dominican peso

DZD

Algerian dinar

EGP

Egyptian pound

ERN

Eritrean nakfa

ETB

Ethiopian birr

EUR

Euro

FJD

Fiji dollar

FKP

Falkland Islands pound

GBP

Pound sterling

GEL

Georgian lari

GHS

Ghanaian cedi

GIP

Gibraltar pound

GMD

Gambian dalasi

GNF

Guinean franc

GTQ

Guatemalan quetzal

GYD

Guyanese dollar

HKD

Hong Kong dollar

HNL

Honduran lempira

HRK

Croatian kuna

HTG

Haitian gourde

HUF

Hungarian forint

IDR

Indonesian rupiah

ILS

Israeli new shekel

INR

Indian rupee

IQD

Iraqi dinar

IRR

Iranian rial

ISK

Icelandic króna

JMD

Jamaican dollar

JOD

Jordanian dinar

JPY

Japanese yen

KES

Kenyan shilling

KGS

Kyrgyzstani som

KHR

Cambodian riel

KMF

Comoro franc

KPW

North Korean won

KRW

South Korean won

KWD

Kuwaiti dinar

KYD

Cayman Islands dollar

KZT

Kazakhstani tenge

LAK

Lao kip

LBP

Lebanese pound

LKR

Sri Lankan rupee

LRD

Liberian dollar

LSL

Lesotho loti

LYD

Libyan dinar

MAD

Moroccan dirham

MDL

Moldovan leu

MGA

Malagasy ariary

MKD

Macedonian denar

MMK

Myanmar kyat

MNT

Mongolian tögrög

MOP

Macanese pataca

MRU

Mauritanian ouguiya

MUR

Mauritian rupee

MVR

Maldivian rufiyaa

MWK

Malawian kwacha

MXN

Mexican peso

MXV

Mexican Unidad de

MYR

Malaysian ringgit

MZN

Mozambican metical

NAD

Namibian dollar

NGN

Nigerian naira

NIO

Nicaraguan córdoba

NOK

Norwegian krone

NPR

Nepalese rupee

NZD

New Zealand dollar

OMR

Omani rial

PAB

Panamanian balboa

PEN

Peruvian sol

PGK

Papua New Guinean kina

PHP

Philippine peso

PKR

Pakistani rupee

PLN

Polish złoty

PYG

Paraguayan guaraní

QAR

Qatari riyal

RON

Romanian leu

RSD

Serbian dinar

RUB

Russian ruble

RWF

Rwandan franc

SAR

Saudi riyal

SBD

Solomon Islands dollar

SCR

Seychelles rupee

SDG

Sudanese pound

SEK

Swedish krona/kronor

SGD

Singapore dollar

SHP

Saint Helena pound

SLL

Sierra Leonean leone

SOS

Somali shilling

SRD

Surinamese dollar

SSP

South Sudanese pound

STN

São Tomé and Príncipe dobra

SVC

Salvadoran colón

SYP

Syrian pound

SZL

Swazi lilangeni

THB

Thai baht

TJS

Tajikistani somoni

TMT

Turkmenistan manat

TND

Tunisian dinar

TOP

Tongan paʻanga

TRY

Turkish lira

TTD

Trinidad and Tobago dollar

TWD

New Taiwan dollar

TZS

Tanzanian shilling

UAH

Ukrainian hryvnia

UGX

Ugandan shilling

USD

United States dollar

USN

United States dollar (next day) (funds code) United States

UYI

Uruguay Peso en Unidades Indexadas (URUIURUI) (funds code)

UYU

Uruguayan peso

UYW

Unidad previsional

UZS

Uzbekistan som

VES

Venezuelan bolívar soberano

VND

Vietnamese đồng

VUV

Vanuatu vatu

WST

Samoan tala

XAF

CFA franc BEAC

XCD

East Caribbean dollar

XOF

CFA franc BCEAO

XPF

CFP franc (franc Pacifique)

YER

Yemeni rial

ZAR

South African rand

ZMW

Zambian kwacha

ZWL

Zimbabwean dollar

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

NameTypeRequiredDescription

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

ValueDescription

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

ValueDescription

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

NameTypeRequiredDescription

bicFi

string

false

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

ValueDescription

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

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

NameTypeRequiredDescription

identification

string

true

API Identifier

schemeName

SchemeName

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

HalAccounts

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

Fields

NameTypeRequiredDescription

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

HalBalances

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

Fields

NameTypeRequiredDescription

balances

[BalanceResource]

true

List of account balances

HalBeneficiaries

HYPERMEDIA structure used for returning the list of the whitelisted beneficiaries

Fields

NameTypeRequiredDescription

beneficiaries

[Beneficiary]

true

List of trusted beneficiaries

HalConnectors

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

Fields

NameTypeRequiredDescription

connectors

[Connector]

true

List of connectors

HalPaymentCoverageReport

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

Fields

NameTypeRequiredDescription

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

HalPaymentRequest

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

Fields

NameTypeRequiredDescription

paymentRequestResourceId

ResourceId

false

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

paymentInformationStatus

PaymentInformationStatusCode

true

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".

_links

PaymentRequestLinks

false

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

NameTypeRequiredDescription

paymentRequestResourceId

ResourceId

false

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

_links

PaymentRequestResourceCreationLinks

false

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

authData

[AuthDataItem]

false

[structure used for returning auth parameters to be passed to user]

HalTransactions

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

Fields

NameTypeRequiredDescription

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.

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

NameTypeRequiredDescription

url

string

true

Logo URL

ModifyConsentsInfo

Information about usage of modifyConsents method

Fields

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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.

contactDetails

ContactDetails

false

Contact details of a person.

PaymentCoverageRequestResource

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

Fields

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

ValueDescription

ACCC

AcceptedCreditSettlementCompleted. Settlement on the creditor's account has been completed.

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.

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.

ACPT

Accepted. Request is accepted.

ACCR

AcceptedCancellationRequest. Cancellation is accepted.

RJCR

RejectedCancellationRequest. Cancellation request is rejected.

PACR

PartiallyAcceptedCancellationRequest. Cancellation is partially accepted..

PDCR

PendingCancellationRequest. Cancellation request is pending.

CNCL

PaymentCancelled. Payment is cancelled.

null

NoCancellationProcess. There is no cancellation process ongoing.

PaymentRequestConfirmation

Contains data for confirmation of payment request

Fields

NameTypeRequiredDescription

psuAuthenticationFactor

string

false

Authentication factor forwarded by the TPP to the ASPSP in order to fulfil the strong customer authentication process

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:

Fields

NameTypeRequiredDescription

paymentInformationId

PaymentInformationId

false

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

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.

creditTransferTransaction

[CreditTransferTransaction]

true

Payment instructions to be executed towards one or multiple beneficiaries in the payment process. Maximum number of transactions depend on the ASPSP and type of the payment taking into accounts its specificities about payment request handling.

PaymentType

Payment type info

Base type

string

Enumerated Values

ValueDescription

SEPA

SEPA credit transfers

INST_SEPA

Instant SEPA credit transfers

CROSSBORDER

Crossborder credit transfers

DOMESTIC

Domestic credit transfers

PaymentTypeInfo

Information about available payment types

Fields

NameTypeRequiredDescription

paymentType

PaymentType

true

Payment type info

currencies

[CurrencyCodeEnum]

false

List of supported currencies

debtorAccountRequired

boolean

false

States if debtor account is required during payment initiation request.

debtorAccountSchemas

[SchemeName]

false

List of supported debtor account schemas

creditorAccountSchemas

[SchemeName]

false

List of supported creditor account schemas

priorityCodes

[PriorityCode]

false

List of supported priority codes

chargeBearerValues

[ChargeBearerCode]

false

List of supported charge bearer codes

creditorCountryRequired

boolean

false

States if creditor country is required

creditorNameRequired

boolean

false

States if creditor name is required

creditorPostalAddressRequired

boolean

false

States if creditor postal address (addressLine and townName) is required

remittanceInformationRequired

boolean

false

States if remittance information is required

debtorCurrencyRequired

boolean

false

States if debtor currency is required

debtorContactEmailRequired

boolean

false

States if debtor's contact email is required when a payment this type is being initiated

debtorContactPhoneRequired

boolean

false

States if debtor's contact phone is required when a payment this type is being initiated

creditorAgentBicFiRequired

boolean

false

States if creditor agent bicFi required

allowedAuthMethods

[string]

false

List of supported auth methods for this payment type

regulatoryReportingCodes

[RegulatoryReportingCode]

false

List of supported codes for regulatory reporting details

regulatoryReportingCodeRequired

boolean

false

States if regulatory reporting shall be provided for credit transfer transactions.

PaymentTypeInformation

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

Fields

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

ValueDescription

HIGH

High priority

NORM

Normal priority

EXPR

Express priority. Polish-specific priority code

PurposeCode

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

Base type

string

Enumerated Values

ValueDescription

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.

RegulatoryAuthority

Entity requiring the regulatory reporting information.

Fields

NameTypeRequiredDescription

country

string

true

Country in which the regulatory authority operates.

name

string

false

Name of the regulatory authority.

RegulatoryReporting

Information needed due to regulatory and statutory requirements.

Fields

NameTypeRequiredDescription

authority

RegulatoryAuthority

false

Regulatory authority to which reporting shall be made.

details

RegulatoryReportingDetails

true

Details to provide on the regulatory reporting information.

RegulatoryReportingCode

Regulatory reporting code made available by a certain regulatory authority.

Fields

NameTypeRequiredDescription

value

string

true

Value of the code, i.e. what needs to be passed as a code when filling in regulatory reporting details.

description

string

false

Regulatory authority to which reporting shall be made.

RegulatoryReportingDetails

Set of elements used to provide details on the regulatory reporting information.

Fields

NameTypeRequiredDescription

amount

AmountType

false

Amount of money to be reported. If not provided the total instructed amount of the transaction is assumed.

code

string

false

A code specifying the nature, purpose, and/or reason for the transaction. Codes to be used depend on the regulatory authority, to which they are being reported.

information

string

false

Additional details that cater for specific domestic regulatory requirements.

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:

Base type

string(date-time)

ResourceId

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

Base type

string

SchemeName

Name of the identification scheme. Partially based on ISO20022 external code list

Base type

string

Enumerated Values

ValueDescription

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.

DRLC

DriversLicenseNumber

SOSE

SocialSecurityNumber

ARNU

AlienRegistrationNumber

CCPT

PassportNumber

OTHI

OtherIndividual

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.

IBAN

International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer.

BG

Swedish BankGiro account number. Used in domestic swedish giro payments

PG

Swedish PlusGiro account number. Used in domestic swedish giro payments

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

ValueDescription

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.

StatusReasonInformation

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

Base type

string

Enumerated Values

ValueDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

ValueDescription

CRDT

Credit type transaction

DBIT

Debit type transaction

TransactionIndividualStatusCode

ISO20022: Specifies the status of the payment information group.

Base type

string

Enumerated Values

ValueDescription

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

ValueDescription

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

NameTypeRequiredDescription

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

TransactionsInfo

Meta information about usage and limitations of getAccountTransactions method

Fields

NameTypeRequiredDescription

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

NameTypeRequiredDescription

remittanceLine

string

false

Relevant information to the transaction

HAL

NameTypeRequiredDescription

redirect

GenericLink

false

hypertext reference

hypertext reference

NameTypeRequiredDescription

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

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

NameTypeRequiredDescription

consentApproval

GenericLink

false

URL to be used by the PISP in order to continue the ASPSP authentication and consent management process

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

NameTypeRequiredDescription

consentApproval

GenericLink

false

URL to be used by the PISP in order to start the ASPSP authentication and consent management process

Exceptions

AuthorizationCancelledException

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

Base type

ResponseValidationException

CoreException

Base Exception class in SDK, raised for unexpected exceptions.

Fields

NameTypeRequiredDescription

code

integer(int32)

true

Error code

message

string

true

Error description

DataRetrievalException

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

Base type

ResponseValidationException

ExpiredConsentException

This exception is raised when ASPSP API response shows that used consent is no longer valid and
cannot be refreshed or restored.
This also raised when both access and refresh (if supported) tokens are expired.

Base type

ResponseValidationException

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

NameTypeRequiredDescription

responseHeaders

[object]

true

Headers of http response

responseBody

string

true

Body of http response

InsufficientScopeException

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

Base type

DataRetrievalException

InvalidCredentialsException

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

Base type

ResponseValidationException

InvalidResponseIdException

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

Base type

ResponseValidationException

Fields

NameTypeRequiredDescription

requestId

string

true

Request id

InvalidResponseSignatureException

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

Base type

ResponseValidationException

Fields

NameTypeRequiredDescription

jws

string

true

JSON web signature

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

key

string

true

Reference to a parameter

PsuActionRequiredException

This exception is raised when ASPSP API response shows that there are additional actions
required from a PSU.
For example, a PSU need to contact their bank customer service to enable necessary
permissions or they need to sign necessary agreements in their online bank.

Base type

ResponseValidationException

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

CoreException

Fields

NameTypeRequiredDescription

responseHeaders

[object]

true

Headers of http response

responseBody

string

true

Body of http response

errorDescription

string

false

User-friendly error message

TransactionPeriodException

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

Base type

DataRetrievalException

TransactionsFetchingException

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

Base type

CoreException

Fields

NameTypeRequiredDescription

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

UnauthorizedException

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

Base type

ResponseValidationException

ValidationException

Base class for validation related exceptions.

Base type

CoreException

Connectors

ABNAMROBusinessConnectorSettings

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

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

country

string

true

Bank country. Possible values:
NL – Netherlands
BE – Belgium
GE - Germany
UK - United Kingdom

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

ABNAMROConnectorSettings

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

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

ASNBankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.ASNBankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new ASNBankConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .certPath("your-cert-path")
    .keyPath("your-key-path")
    .clientId("your-client-id")
    .clientSecret("your-client-secret")
    .sandbox(true);

import enablebanking

connector_settings = enablebanking.ASNBankConnectorSettings(
  cert_path="your-cert-path",
  key_path="your-key-path",
  client_id="your-client-id",
  client_secret="your-client-secret"
)
api_client = ApiClient(connector_settings)

const enablebanking = require('enablebanking');

const CONNECTOR_SETTINGS = {
  sandbox: true,
  consentId: null,
  accessToken: null,
  redirectUri: "https://your-redirect-uri",
  certPath: "your-cert-path",
  keyPath: "your-key-path",
  clientId: "your-client-id",
  clientSecret: "your-client-secret"
}
const apiClient = new enablebanking.ApiClient('ASNBank', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for ASN Bank

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

API client ID.

clientSecret

string

true

API client secret.

AXAConnectorSettings

Settings for initializing ApiClient for AXA Bank Connector.

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

country

string

true

Bank country (only clients from the specified will be able to authenticate). Possilbe values:
FI – Finland
SE – Sweden

language

string

true

Language of authentication user interface.

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

NameTypeRequiredDescription

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

tppId

string

true

ID assigned to the TPP by an authority (format: PSDXX-YYYY-ZZZZZZZZ)

AndbankConnectorSettings

Settings for initializing ApiClient for [Andbank]
Credentials can be obtained at Andbank Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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)

ArgentaConnectorSettings

Settings for initializing ApiClient for Argenta Bank (Poland).
Credentials can obtained at Argenta API Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

API client ID (obtained from the API Portal)

apiSecret

string

true

API secret (obtained from the API Portal)

apiKey

string

true

API key (obtained from the API 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

ArquiaConnectorSettings

Settings for initializing ApiClient for [Arquia]
Credentials can be obtained at Arquia Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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)

BBVAConnectorSettings

Settings for initializing ApiClient for [BBVA]
Credentials can be obtained at BBVA Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

BIBConnectorSettings

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

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

BNPParibasFortisBusinessConnectorSettings

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

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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"

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

BNPParibasFortisConnectorSettings

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

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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"

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

BNPParibasPolandConnectorSettings

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

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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)

BancaMarchConnectorSettings

Settings for initializing ApiClient for [BancaMarch]
Credentials can be obtained at Banca March Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

BancoInversisConnectorSettings

Settings for initializing ApiClient for [Banco Inversis]
Credentials can be obtained at BancoInversis Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

BancoMediolanumConnectorSettings

Settings for initializing ApiClient for [BancoMediolanum]
Credentials can be obtained at Banco Mediolanum Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

BancoPichinchaConnectorSettings

Settings for initializing ApiClient for [BancoPichincha]
Credentials can be obtained at Banco Pichincha Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

BancoSantanderConnectorSettings

Settings for initializing ApiClient for [BancoSantander]
Credentials can be obtained at Banco Santander Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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)

BankNorwegianConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BankNorwegianConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BankNorwegianConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .country("NO")
    .certPath("your-cert-path")
    .keyPath("your-key-path")
    .signKeyPath("your-sign-key-path")
    .signPubKeySerial("your-sign-pub-key-serial")
    .clientId("your-client-id")
    .clientSecret("your-client-secret")
    .sandbox(true);

import enablebanking

connector_settings = enablebanking.BankNorwegianConnectorSettings(
  country="NO",
  cert_path="your-cert-path",
  key_path="your-key-path",
  sign_key_path="your-sign-key-path",
  sign_pub_key_serial="your-sign-pub-key-serial"
  client_id="your-client-id",
  client_secret="your-client-secret"
)
api_client = ApiClient(connector_settings)

const enablebanking = require('enablebanking');

const CONNECTOR_SETTINGS = {
  sandbox: true,
  consentId: null,
  accessToken: null,
  redirectUri: "https://your-redirect-uri",
  country: "NO",
  certPath: "your-cert-path",
  keyPath: "your-key-path",
  signKeyPath: "your-sign-key-path",
  signPubKeySerial: "your-sign-pub-key-serial",
  clientId: "your-client-id",
  clientSecret: "your-client-secret"
}
const apiClient = new enablebanking.ApiClient('BankNorwegian', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for Bank Norwegian

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

country

string

true

Bank country (only clients from the specified will be able to authenticate). Possilbe values:
FI – Finland
SE – Sweden
NO – Norway
DK – Denmark

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 private key in PEM format.

signPubKeySerial

string

true

Public serial key of the QSeal certificate located in signKeyPath

clientId

string

true

API client ID.

clientSecret

string

true

API client secret.

BankiaConnectorSettings

Settings for initializing ApiClient for [Bankia] (https://www.bankia.es)
Credentials can be obtained at Bankia Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

BankinterConnectorSettings

Settings for initializing ApiClient for [Bankinter]
Credentials can be obtained at Bankinter Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

BankoaConnectorSettings

Settings for initializing ApiClient for [Bankoa]
Credentials can be obtained at Bankoa Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

BanxeConnectorSettings

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

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

clientId

string

true

API client ID (obtained from Belfius Developer Portal).

clientSecret

string

false

API client Secret (obtained from Belfius Developer Portal). Required for production, not used in sandbox.

certPath

string

false

Client secret obtained from SDC in onboarding process. Required for production, not used in sandbox.

keyPath

string

false

Path to QWAC certificate in PEM format. Required for production, not used in sandbox.

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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)

BunqConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BunqConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BunqConnectorSettings()
    .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 Bunq.
Credentials can obtained at Bunq Developer Portal.

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

signKeyPath

string

true

Path to QSeal certificate in PEM format

apiKey

string

true

API client key

installationToken

string

true

API installation token

CaixaBankConnectorSettings

Settings for initializing ApiClient for [CaixaBank]
Credentials can be obtained at CaixaBank Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

CajaRuralConnectorSettings

Settings for initializing ApiClient for [CajaRural]
Credentials can be obtained at Caja Rural Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

brand

string

true

Name of rural bank. e.g. (Caja Rural Del Sur, Caixa Rural Benicarlo, etc)

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

CajamarCajaRuralConnectorSettings

Settings for initializing ApiClient for [CajamarCajaRural]
Credentials can be obtained at Cajamar Caja Rural Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

CajasurBancoConnectorSettings

Settings for initializing ApiClient for [CajasurBanco]
Credentials can be obtained at Cajasur Banco Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

CitadeleConnectorSettings

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

ColonyaConnectorSettings

Settings for initializing ApiClient for [Colonya]
Credentials can be obtained at Colonya Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

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

NameTypeRequiredDescription

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.

CoopPankConnectorSettings

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

xApiKey

string

true

API client key (obtained in developer portal)

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.

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

business

boolean

true

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.

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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)

EVOBancoConnectorSettings

Settings for initializing ApiClient for [EVOBanco]
Credentials can be obtained at EVO Banco Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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)

EurocajaRuralConnectorSettings

Settings for initializing ApiClient for [EurocajaRural]
Credentials can be obtained at Eurocaja Rural Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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.

FiareBancaEticaConnectorSettings

Settings for initializing ApiClient for [FiareBancaEtica]
Credentials can be obtained at Fiare Banca Etica Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

FlekkefjordSparebankConnectorSettings

Settings for initializing ApiClient for Flekkefjord Sparebank

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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
Credentials can obtained at ING Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

country

string

true

Two-letter country code

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

NameTypeRequiredDescription

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)

INGWholesaleBankingConnectorSettings

Settings for initializing ApiClient for ING Wholesale Banking Credentials can obtained at ING Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

country

string

true

Two-letter country code

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

IbercajaBancoConnectorSettings

Settings for initializing ApiClient for [IbercajaBanco]
Credentials can be obtained at Ibercaja Banco Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

business

boolean

true

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.

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

NameTypeRequiredDescription

clientId

string

true

API client ID (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.

brand

string

true

Name of brand. If not set defaults to KBC. Allowed values are "KBC", "CBC", "KBC Brussels"

KIRConnectorSettings

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

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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)

KnabConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.KnabConnectorSettings;

ApiClient apiClient = new ApiClient(
  new KnabConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("your-client-id")
    .clientSecret("your-client-secret")
    .certPath("your-cert-path")
    .keyPath("your-key-path")
    .sandbox(true);

import enablebanking

connector_settings = enablebanking.KnabConnectorSettings(
  client_id="your-client-id",
  client_secret="your-client-secret",
  cert_path="your-cert-path",
  key_path="your-key-path"
)
api_client = ApiClient(connector_settings)

const enablebanking = require('enablebanking');

const CONNECTOR_SETTINGS = {
  sandbox: true,
  consentId: null,
  accessToken: null,
  redirectUri: "https://your-redirect-uri",
  clientId: "your-client-id",
  clientSecret: "your-client-secret",
  certPath: "your-cert-path",
  keyPath: "your-key-path"
}
const apiClient = new enablebanking.ApiClient('Knab', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for Knab

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

API client ID.

clientSecret

string

true

API client secret.

certPath

string

true

Path to QWAC certificate in PEM format.

keyPath

string

true

Path to QWAC certificate private key in PEM format.

KomplettConnectorSettings

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

country

string

true

Bank country (only clients from the specified will be able to authenticate)

language

string

true

User interface desired language

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

NameTypeRequiredDescription

business

boolean

true

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.

xApiKey

string

true

API client key (obtained from BankData Developer Portal)

KutxabankConnectorSettings

Settings for initializing ApiClient for [Kutxabank]
Credentials can be obtained at Kutxabank Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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)

LaboralKutxaConnectorSettings

Settings for initializing ApiClient for [LaboralKutxa]
Credentials can be obtained at Laboral Kutxa Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

LaegernesBankConnectorSettings

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

NameTypeRequiredDescription

business

boolean

true

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.

xApiKey

string

true

API client key (obtained from BankData Developer Portal)

LandkredittBankConnectorSettings

Settings for initializing ApiClient for Landkreditt Bank

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

country

string

false

Bank country (only clients from the specified will be able to authenticate). Possilbe values:
EE, LT, LV

certPath

string

false

Path to QWAC certificate in PEM format. Required for production, not used in sandbox.

keyPath

string

false

Path to QWAC certificate private key in PEM format. Required for production, not used in sandbox.

clientId

string

true

API client ID

clientSecret

string

false

API client secret. Required for sandbox, not used in production

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

MBankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.MBankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new MBankConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .business(false)
    .country("your-country")
    .clientId("your-client-id")
    .certPath("your-cert-path")
    .keyPath("your-key-path")
    .signKeyPath("your-sign-key-path")
    .signPubKeySerial("your-sign-pub-key-serial")
    .signFingerprint("your-sign-fingerprint")
    .signCertUrl("your-sign-cert-url")
    .tppId("your-tpp-id")
    .sandbox(true);

import enablebanking

connector_settings = enablebanking.MBankConnectorSettings(
  business=False,
  country="your-country",
  client_id="your-client-id",
  cert_path="your-cert-path",
  key_path="your-key-path",
  sign_key_path="your-sign-key-path",
  sign_pub_key_serial="your-sign-pub-key-serial",
  sign_fingerprint="your-sign-fingerprint",
  sign_cert_url="your-sign-cert-url",
  tpp_idl="your-tpp-id"
)
api_client = ApiClient(connector_settings)

const enablebanking = require('enablebanking');

const CONNECTOR_SETTINGS = {
  sandbox: true,
  consentId: null,
  accessToken: null,
  redirectUri: "https://your-redirect-uri",
  business: false,
  country: "your-country",
  clientId: "your-client-id",
  certPath: "your-cert-path",
  keyPath: "your-key-path",
  signKeyPath: "your-sign-key-path",
  signPubKeySerial: "your-sign-pub-key-serial",
  signFingerprint: "your-sign-fingerprint",
  signCertUrl: "your-sign-cert-url",
  tppId: "your-tpp-id"
}
const apiClient = new enablebanking.ApiClient('MBank', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for mBank

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

country

string

true

Bank`s country, two-letter country code.

business

boolean

true

Account type to access to. If true business, if false personal.

clientId

string

true

API client ID.

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 private key 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

none

tppId

string

false

none

MajBankConnectorSettings

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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 initializing ApiClient for [Medicinos Bankas] (https://www.medbank.lt/)
Credentials can be obtained at Medicinos Bankas Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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)

MeridianBankConnectorSettings

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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.

MerkurAndelskasseConnectorSettings

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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)

MockASPSPBusinessConnectorSettings

Settings for initializing ApiClient for MockASPSP Business Connector. - country

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

country

string

true

Bank country (only clients from the specified will be able to authenticate). Possilbe values:
FI – Finland
SE – Sweden

MockASPSPConnectorSettings

Settings for initializing ApiClient for MockASPSP Connector. - country

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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)

NWBBankConnectorSettings

Settings for initializing ApiClient for NWBBank (Poland).
Credentials can obtained at NWBBank API Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

API client ID (obtained from the API Portal)

apiSecret

string

true

API secret (obtained from the API Portal)

apiKey

string

true

API key (obtained from the API 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

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

country

string

true

Bank country (only clients from the specified will be able to authenticate). Possilbe values:
FI - Finland

language

string

false

Language of authentication user interface. If country is FI, the default language is fi

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

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

NameTypeRequiredDescription

country

string

true

Bank country (only clients from the specified will be able to authenticate). Possilbe values:
FI - Finland

language

string

false

Language of authentication user interface. If country is FI, the default language is fi

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

NordeaCorporateConnectorSettings

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 Corporate (all countries).
Credentials can obtained at Nordea Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

country

string

true

Bank country (only clients from the specified will be able to authenticate). Possilbe values:
FI - Finland

language

string

false

Language of authentication user interface. If country is FI, the default language is fi

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

NordeaDirectConnectorSettings

Settings for initializing ApiClient for Nordea Direct

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

NameTypeRequiredDescription

business

boolean

true

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.

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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)

OpenBankConnectorSettings

Settings for initializing ApiClient for [OpenBank]
Credentials can be obtained at OpenBank Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

PayseraConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.PayseraConnectorSettings;

ApiClient apiClient = new ApiClient(
  new PayseraConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .certPath("your-cert-path")
    .keyPath("your-key-path")
    .clientId("your-client-id")
    .language("your-language")
    .sandbox(true);

import enablebanking

connector_settings = enablebanking.PayseraConnectorSettings(
  cert_path="your-cert-path",
  key_path="your-key-path",
  client_id="your-client-id",
  language="your-language"
)
api_client = ApiClient(connector_settings)

const enablebanking = require('enablebanking');

const CONNECTOR_SETTINGS = {
  sandbox: true,
  consentId: null,
  accessToken: null,
  redirectUri: "https://your-redirect-uri",
  certPath: "your-cert-path",
  keyPath: "your-key-path",
  clientId: "your-client-id",
  language: "your-language"
}
const apiClient = new enablebanking.ApiClient('Paysera', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for Paysera

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

API client ID.

language

string

false

Language of authentication user interface.

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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.

PrivatBankConnectorSettings

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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.

RabobankBEConnectorSettings

Settings for initializing ApiClient for Rabobank (Belgium) (Poland).
Credentials can obtained at Rabobank API Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

API client ID (obtained from the API Portal)

apiSecret

string

true

API secret (obtained from the API Portal)

apiKey

string

true

API key (obtained from the API 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

RabobankConnectorSettings

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

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

RegioBankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.RegioBankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new RegioBankConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .certPath("your-cert-path")
    .keyPath("your-key-path")
    .clientId("your-client-id")
    .clientSecret("your-client-secret")
    .sandbox(true);

import enablebanking

connector_settings = enablebanking.RegioBankConnectorSettings(
  cert_path="your-cert-path",
  key_path="your-key-path",
  client_id="your-client-id",
  client_secret="your-client-secret"
)
api_client = ApiClient(connector_settings)

const enablebanking = require('enablebanking');

const CONNECTOR_SETTINGS = {
  sandbox: true,
  consentId: null,
  accessToken: null,
  redirectUri: "https://your-redirect-uri",
  certPath: "your-cert-path",
  keyPath: "your-key-path",
  clientId: "your-client-id",
  clientSecret: "your-client-secret"
}
const apiClient = new enablebanking.ApiClient('RegioBank', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for Regio Bank

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

API client ID.

clientSecret

string

true

API client secret.

Renta4BancoConnectorSettings

Settings for initializing ApiClient for [Renta4Banco]
Credentials can be obtained at Renta 4 Banco Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

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

NameTypeRequiredDescription

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

language

string

true

User interface desired language

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

country

string

true

Bank country (only clients from the specified will be able to authenticate). Possible 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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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.

SEBKortBankBusinessConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SEBKortBankBusinessConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SEBKortBankBusinessConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .brand("brand")
    .sandbox(true));

Settings for initializing ApiClient for SEBKortBankBusiness.
Credentials can obtained at SEB Developer Portal.

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

Client reference for the bank that you are calling to obtain data. Issued by SEB 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.

brand

string

true

Bank brand. Allowed values are
DK: Eurocard, Jyske Mastercard
FI: Eurocard, OP Corporate Gold Card
NO: Eurocard, DNB Corporate Mastercard
SE: Eurocard, SEB Corporate Card

SEBKortBankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SEBKortBankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SEBKortBankConnectorSettings()
    .certPath("path-to-qwac-cert")
    .keyPath("path-to-qwac-key")
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .brand("brand")
    .sandbox(true));

Settings for initializing ApiClient for SEB Sweden.
Credentials can obtained at SEB Developer Portal.

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

Client reference for the bank that you are calling to obtain data. Issued by SEB 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.

brand

string

true

Bank brand. Allowed values are
DK: Eurocard, GlobeCard Mastercard, Jyske Mastercard, Quintessentially Mastercard, SAS EuroBonus Mastercard
FI: Eurocard, Finnair Plus Mastercard, SAS EuroBonus Mastercard
NO: Circle K EXTRA Mastercard, Esso Mastercard, Eurocard, Finnair Plus Mastercard, GlobeCard Mastercard, Nordic Choice Club Mastercard, SAS EuroBonus Mastercard, SEB Selected, Volvo Mastercard
SE: Circle K EXTRA Mastercard, Eurocard, Finnair, INGO Mastercard, NK Nyckeln Mastercard, Nordic Choice Club, Opel Mastercard, Quintessentially Mastercard, SaabKortet Mastercard, SAS EuroBonus Mastercard, Prio Mastercard, Wallet Mastercard

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")
    .language("sv")
    .sandbox(true));

Settings for initializing ApiClient for SEB Sweden (for business users).
Credentials can obtained at SEB Developer Portal.

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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.

language

string

false

Language of authentication user interface.

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")
    .language("sv")
    .sandbox(true));

Settings for initializing ApiClient for SEB Sweden.
Credentials can obtained at SEB Developer Portal.

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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.

language

string

false

Language of authentication user interface.

SNSBankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SNSBankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SNSBankConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .certPath("your-cert-path")
    .keyPath("your-key-path")
    .clientId("your-client-id")
    .clientSecret("your-client-secret")
    .sandbox(true);

import enablebanking

connector_settings = enablebanking.SNSBankConnectorSettings(
  cert_path="your-cert-path",
  key_path="your-key-path",
  client_id="your-client-id",
  client_secret="your-client-secret"
)
api_client = ApiClient(connector_settings)

const enablebanking = require('enablebanking');

const CONNECTOR_SETTINGS = {
  sandbox: true,
  consentId: null,
  accessToken: null,
  redirectUri: "https://your-redirect-uri",
  certPath: "your-cert-path",
  keyPath: "your-key-path",
  clientId: "your-client-id",
  clientSecret: "your-client-secret"
}
const apiClient = new enablebanking.ApiClient('SNSBank', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for SNS Bank

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

API client ID.

clientSecret

string

true

API client secret.

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

NameTypeRequiredDescription

language

string

true

User interface desired language

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

NameTypeRequiredDescription

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)

SabadellConnectorSettings

Settings for initializing ApiClient for [Banco de Sabadell] (https://www.bancsabadell.com)
Credentials can be obtained at Banco de Sabadell Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

SallingBankConnectorSettings

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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)

SantanderBankPolskaConnectorSettings

Settings for initializing ApiClient for Santander Bank Polska

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

client ID

certPath

string

true

none

keyPath

string

true

none

signKeyPath

string

true

none

signPubKeySerial

string

true

none

signFingerprint

string

false

none

signCertUrl

string

false

none

SantanderConsumerBankNorwayConnectorSettings

Settings for initializing ApiClient for Santander Consumer Bank (NO)
Credentials can obtained at Santander Consumer Bank (NO) Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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)

SelfBankConnectorSettings

Settings for initializing ApiClient for [SelfBank]
Credentials can be obtained at SelfBank Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

SiauliuBankasConnectorSettings

Settings for initializing ApiClient for [Šiaulių Bankas] (https://sb.lt/)
Credentials can be obtained at Šiaulių Bankas Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

SignetBankConnectorSettings

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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.

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

NameTypeRequiredDescription

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")
    .sandbox(true));

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

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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.

signKeyPath

string

true

Path to QSeal certificate in PEM format

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

NameTypeRequiredDescription

business

boolean

true

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.

xApiKey

string

true

API client key (obtained from BankData Developer Portal)

SkudenesAakraSparebankConnectorSettings

Settings for initializing ApiClient for Skudenes & Aakra Sparebank

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

SparebankenSorConnectorSettings

Settings for initializing ApiClient for Sparebanken Sør

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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

SparebankenVestConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SparebankenVestConnectorSettings;

ApiClient apiClient = new ApiClient(
  new SparebankenVestConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .certPath("your-cert-path")
    .keyPath("your-key-path")
    .sandbox(true);

import enablebanking

connector_settings = enablebanking.SparebankenVestConnectorSettings(
  cert_path="your-cert-path",
  key_path="your-key-path"
)
api_client = ApiClient(connector_settings)

const enablebanking = require('enablebanking');

const CONNECTOR_SETTINGS = {
  sandbox: true,
  consentId: null,
  accessToken: null,
  redirectUri: "https://your-redirect-uri",
  certPath: "your-cert-path",
  keyPath: "your-key-path"
}
const apiClient = new enablebanking.ApiClient('SparebankenVest', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for Sparebanken Vest

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

certPath

string

true

Path to QWAC certificate in PEM format.

keyPath

string

true

Path to QWAC certificate private key in PEM format.

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

business

boolean

true

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.

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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)

SwedbankBusinessConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.SwedbankBusinessConnectorSettings;

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 access to business accounts in Swedbank (Sweden and Baltic coutries).
Credentials can obtained at Swedbank Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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 in production.

keyPath

string

false

Path to QWAC certificate private key in PEM format. Required in production.

signKeyPath

string

false

Path to QSeal certificate private key in PEM format. Required for PIS functionality in production.

signPubKeySerial

string

false

Serial Number of the TPPs certificate declared in Developer Portal and CA name.
If CA name contains national characters it should be in base64 encoding.

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.

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 (Sweden and Baltic coutries).
Credentials can obtained at Swedbank Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

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 in production.

keyPath

string

false

Path to QWAC certificate private key in PEM format. Required in production.

signKeyPath

string

false

Path to QSeal certificate private key in PEM format. Required for PIS functionality in production.

signPubKeySerial

string

false

Serial Number of the TPPs certificate declared in Developer Portal and CA name.
If CA name contains national characters it should be in base64 encoding.

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

business

boolean

true

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.

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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)

UnicajaBancoConnectorSettings

Settings for initializing ApiClient for [UnicajaBanco]
Credentials can be obtained at Unicaja Banco Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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

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

NameTypeRequiredDescription

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

NameTypeRequiredDescription

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)

WiZinkConnectorSettings

Settings for initializing ApiClient for [WiZink]
Credentials can be obtained at WiZink Developer Portal

Base type

ConnectorSettings

Fields

NameTypeRequiredDescription

clientId

string

true

Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997

clientSecret

string

true

Client secret obtained in the developer portal

signKeyPath

string

true

Path to QSeal private key 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

certPath

string

false

Path to QWAC certificate in PEM format (production only)

keyPath

string

false

Path to QWAC certificate private key in PEM format (production only)

YaConnectorSettings

Base type

ConnectorSettings

Fields

<
NameTypeRequiredDescription

language

string

true

User interface desired language

clientId

string

true

none