Introduction

Welcome to the documentation of Enable Banking aggregation core!

This documentation focuses on the low-level interface of the core technology for aggregation of Open Banking APIs.

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 aggregation core 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 (i.e. banks and similar financial institutions), 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.

The aggregation core powers Enable Banking API and its on-premise version.

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

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

Reference

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

Enable Banking aggregation core consists of 4 interfaces:

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

The same calls and data structures are used for interacting with different ASPSPs. 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 aggregation core interfaces were originally based on STET PSD2 specification, but have been heavily modified and extended in order to support usage scenarious beyond the original specification.

License: LicenseRef-LICENSE

Meta API

getConnectors

Code samples

const enablebanking = require('enablebanking');

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

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

import enablebanking

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

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

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

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

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

Retrieval of the available connectors

Parameters

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

Returned value

Data type: HalConnectors

List of connectors

Auth API

getAuth

Code samples

const enablebanking = require('enablebanking');

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

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

import enablebanking

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

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

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

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

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

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

Request Authorization Data

Parameters

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

Detailed descriptions

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

Returned value

Data type: Auth

Authorization Data

Exceptions

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

makeToken

Code samples

const enablebanking = require('enablebanking');

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

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

import enablebanking

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

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

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

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

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

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

Request Access Token

Parameters

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

Detailed descriptions

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

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

Enumerated Values

grant_type

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

Returned value

Data type: Token

Authorisation token (Bearer)

Exceptions

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

getCurrentToken

Code samples

const enablebanking = require('enablebanking');

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

const token = await authApi.getCurrentToken();

import enablebanking

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

token = auth_api.get_current_token()

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

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

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

Token token = authApi.getCurrentToken();

Get current token data

Returned value

Data type: Token

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

parseRedirectUrl

Parsing of redirect url during authorization

Parameters

Name	Type	Required	Description
redirectUrl	string	true	Redirect url

Returned value

Data type: AuthRedirect

Structured data extracted from redirect URL

validateCredentials

Parsing of redirect url during authorization

Parameters

Name	Type	Required	Description
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

Returned value

Data type: AuthRedirect

Structured data extracted from redirect URL

setClientInfo

Set extra PSU headers

Parameters

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

Returned value

Data type: None

Client Info was successfully set.

AISP API

getAccounts

Code samples

const enablebanking = require('enablebanking');

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

const accounts = await aispApi.getAccounts();

import enablebanking

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

accounts = aisp_api.get_accounts()

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

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

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

HalAccounts accounts = aispApi.getAccounts();

Retrieval of the PSU accounts (AISP)

Returned value

Data type: HalAccounts

Returned value consists of the list of the accounts that have been made available to the AISP by the PSU.

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.
AccountNotAccessibleException	Raised when non accessible or inexsitent account transactions are requested.
InvalidResponseSignatureException	none

getAccountBalances

Code samples

const enablebanking = require('enablebanking');

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

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

import enablebanking

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

balances = aisp_api.get_account_balances('203059694928560295396833')

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

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

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

HalBalances balances = aispApi.getAccountBalances("203059694928560295396833")

Retrieval of an account balances report (AISP)

Parameters

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

Returned value

Data type: HalBalances

Returned value consists of the list of account balances.

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.
AccountNotAccessibleException	Raised when non accessible or inexsitent account transactions are requested.
InvalidResponseSignatureException	none

getAccount

Retrieval of an account details (AISP)

Parameters

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

Returned value

Data type: AccountResource

Returned value consists of the account details.

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.
AccountNotAccessibleException	Raised when non accessible or inexsitent account transactions are requested.
InvalidResponseSignatureException	none

getAccountTransactions

Code samples

const enablebanking = require('enablebanking');

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

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

import enablebanking

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

transactions = aisp_api.get_account_transactions('203059694928560295396833')

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

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

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

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

Retrieval of an account transaction set (AISP)

Parameters

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

Detailed descriptions

dateFrom: Inclusive minimal imputation date of the transactions.

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

dateTo: Exclusive maximal imputation date of the transactions.

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

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

Enumerated Values

transactionStatus

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

Returned value

Data type: HalTransactions

Complete transactions response

Exceptions

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

getTransactionDetails

Code samples

const enablebanking = require('enablebanking');

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

const transactions = await aispApi.getTransactionDetails('203059694928560295396833', '797272616');

import enablebanking

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

transactions = aisp_api.get_transaction_details('203059694928560295396833', '797272616')

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.getTransactionDetails("203059694928560295396833","797272616");

Retrieval of an account transaction details (AISP)

Parameters

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

Returned value

Data type: Transaction

Complete transactions details 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.
AccountNotAccessibleException	Raised when non accessible or inexsitent account transactions are requested.
InvalidResponseSignatureException	none

modifyConsents

Code samples

const enablebanking = require('enablebanking');

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

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

import enablebanking

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

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

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

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

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

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

Forwarding the PSU consent (AISP)

Parameters

Name	Type	Required	Description
state	string	false	Arbitrary String to be returned from to redirect URI
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.

deleteConsent

Deletes consent (AISP)

Returned value

Data type: None

Consent successfully revoked

getCurrentConsent

Code samples

const enablebanking = require('enablebanking');

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

const consent = await aispApi.getCurrentConsent();

import enablebanking

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

consent = aisp_api.get_current_consent()

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

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

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

Consent consent = aispApi.getCurrentConsent();

Returns current consent (AISP)

Returned value

Data type: Consent

Current consent used for accessing AIS APIs.

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)

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.

initiatePaymentRequestCancellation

Payment request cancellation (PISP)

Parameters

Name	Type	Required	Description
paymentRequestResourceId	string	true	Identification of the Payment Request Resource
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

Returned value

Data type: HalPaymentRequestCancellation

Cancellation successful

executePaymentRequestCancellation

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

Parameters

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

Detailed descriptions

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

Returned value

Data type: HalPaymentReuqestCancellationResult

retrieval of the Payment Cancellation enriched with the status report

Exceptions

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

validatePaymentRequest

Payment request initiation (PISP)

Parameters

Name	Type	Required	Description
paymentType	string	true	Payment type. Can be either SEPA, INST_SEPA, DOMESTIC or CROSSBORDER
skipDebtorAccountValidation	boolean	false	Flag whether to skip debtor account validation
paymentRequest	PaymentRequestResource	true	ISO20022 based payment Initiation Request

Returned value

Data type: None

Validation successful

getPaymentRequest

Retrieval of a payment request (PISP)

Parameters

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

Returned value

Data type: HalPaymentRequest

Retrieval of the previously posted Payment Request

Exceptions

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

getPaymentRequestTransaction

Retrieval of a payment request transaction (PISP)

Parameters

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

Returned value

Data type: HalPaymentRequestTransaction

Retrieval of the previously initiated transaction

makePaymentRequestConfirmation

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

Parameters

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

Detailed descriptions

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

Returned value

Data type: HalPaymentRequest

retrieval of the Payment Request enriched with the status report

Exceptions

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

CBPII API

makeFundsConfirmation

Payment coverage check request (CBPII)

Parameters

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

Returned value

Data type: HalPaymentCoverageReport

payment coverage request

Data types

Access

Requested access services.

Fields

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

AccountIdentification

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

Fields

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

AccountResource

PSU account that is made available to the TPP

Fields

Name	Type	Required	Description
resourceId	ResourceId	false	Identifier assigned by the ASPSP for further use of the created resource through API calls
accountServicer	FinancialInstitutionIdentification	false	ISO20022: Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.
accountId	AccountIdentification	false	Unique and unambiguous identification for the account between the account owner and the account servicer.
allAccountIds	[GenericIdentification]	false	All account identifiers provided by ASPSPs (including primary identifier available in the accountId field)
name	string	false	Account holder(s) name
details	string	false	Account description set by PSU or provided by ASPSP
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
postalAddress	PostalAddress	false	ISO20022 : Information that locates and identifies a specific address, as defined by postal services.

Enumerated Values

usage

Value	Description
PRIV	private personal account
ORGA	professional account

cashAccountType

Value	Description
CACC	Account used to post debits and credits when no specific account has been nominated
CASH	Account used for the payment of cash
CARD	Account used for card payments only
LOAN	Account used for loans
SVGS	Account used for savings
OTHR	Account not otherwise specified

AddressType

ISO20022: Identifies the nature of the postal address.

Base type

string

Enumerated Values

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

AmountType

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

API: only instructed amount can be used

Fields

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

Auth

Fields

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

AuthDataItem

structure used for returning auth parameters to be passed to user

Fields

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

Enumerated Values

type

Value	Description
otpIndex	—
message	—
APP	—
IMAGE_LINK	—
IMAGE_RENDER	—
IMAGE_B64	—

AuthInfo

Information about usage of getAuth method

Fields

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

AuthRedirect

structure used for returning parameters of redirect url

Fields

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

AuthUrlHint

Auxiliary data structure binding information about usage of an url returned from getAuth method

Fields

Name	Type	Required	Description
authType	AuthUrlType	false	Action which can be done with url returned from getAuth
refresh	boolean	true	Shows if the url needs to be refreshed
refreshFrequency	integer	false	Shows how often the url needs to be refreshed. Applicable only if refresh is true

AuthUrlType

Action which can be done with url returned from getAuth

Base type

string

Enumerated Values

Value	Description
REDIRECT	PSU needs to be redirected to the URL
IFRAME	the url needs to be displayed in an iframe
APP	the url needs to be opened in a mobile app
IMAGE_LINK	Link to an image which needs to be displayed
IMAGE_RENDER	Image data which needs to be displayed
IMAGE_B64	Image data in base64 format which needs to be displayed

AuthenticationApproach

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

Base type

string

Enumerated Values

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

BalanceResource

Structure of an account balance

Fields

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

BalanceStatus

Type of balance

Base type

string

Enumerated Values

Value	Description
CLAV	(ISO20022 Closing Available) Closing available balance
CLBD	(ISO20022 ClosingBooked) Accounting Balance
FWAV	(ISO20022 ForwardAvailable) Balance of money that is at the disposal of the account owner on the date specified
INFO	(ISO20022 Information) Balance for informational purposes
ITAV	(ISO20022 InterimAvailable) Available balance calculated in the course of the day
ITBD	(ISO20022 InterimBooked) Booked balance calculated in the course of the day
OPAV	(ISO20022 OpeningAvailable) Opening balance of amount of money that is at the disposal of the account owner on the date specified
OPBD	(ISO20022 OpeningBooked) Book balance of the account at the beginning of the account reporting period. It always equals the closing book balance from the previous report
PRCD	(ISO20022 PreviouslyClosedBooked) Balance of the account at the end of the previous reporting period
OTHR	Other Balance
VALU	Value-date balance
XPCD	(ISO20022 Expected) Instant Balance

BankTransactionCode

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

Fields

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

Beneficiary

Specification of a beneficiary

Fields

Name	Type	Required	Description
creditorAgent	FinancialInstitutionIdentification	false	ISO20022: Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.
creditor	PartyIdentification	false	API : Description of a Party which can be either a person or an organization.
creditorAccount	AccountIdentification	true	Unique and unambiguous identification for the account between the account owner and the account servicer.
creditorCurrency	string	false	Creditor account currency code

BookingInformation

indicator that the payment can be immediately booked or not

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

Base type

boolean

Brand

Information about ASPSP end-user recognizable brand

Fields

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

CategoryPurposeCode

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

Base type

string

Enumerated Values

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

ChargeBearerCode

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

Base type

string

Enumerated Values

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

ClearingSystemMemberIdentification

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

Fields

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

ClientInfo

Client Data.

Fields

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

Connector

Information about the connector used for interaction with ASPSPs

Fields

Name	Type	Required	Description
name	string	true	Name of the connector
environments	[string]	true	List of supported environments (sandbox/production)
countries	[string]	true	List of supported countries
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
maximumConsentValidity	integer	true	Maximum consent validity in seconds
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
betaAisp	boolean	true	Flag showing if the connector's AISP implementation is in beta
betaPisp	boolean	true	Flag showing if the connector's PISP implementation is in beta
psuIpAddressV6Supported	boolean	true	Flag showing if the connector supports IPv6 as PSU-IP-Address
deprecated	boolean	true	Flag showing if the connector is deprecated
transactionHistoryDays	integer	false	Number of days for which transaction history is available
pisAccountsAvailable	boolean	true	Flag showing if the connector supports fetching list of accounts with only PIS scope

ConnectorSettings

Base settings for all connectors

Fields

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

Consent

User consent

Fields

Name	Type	Required	Description
consentStatus	string	false	none
consentId	string	false	none
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]
_links	ConsentLinks	false	none

ContactDetails

Contact details of a person.

Fields

Name	Type	Required	Description
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

Name	Type	Required	Description
country	string	true	Country ISO 3166-1 alpha-2 code
method	string	false	Authentication method
hiddenMethod	boolean	true	Flag showing whether this authentication method is hidden from the list of authentication methods This method still can be chosen and expected to work
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

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

CountryModifyConsentsInfo

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

Fields

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

CountryPaymentTypes

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

Fields

Name	Type	Required	Description
country	string	true	Country ISO 3166-1 alpha-2 code
paymentTypes	[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

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

CreditTransferTransaction

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

Fields

Name	Type	Required	Description
paymentId	PaymentIdentification	false	ISO20022: Set of elements used to reference a payment instruction.
requestedExecutionDate	RequestedExecutionDate	false	ISO20022: Date at which the initiating party requests the clearing agent to process the payment. API: This date can be used in the following cases: - the single requested execution date for a payment having several instructions. In this case, this field must be set at the payment level. - the requested execution date for a given instruction within a payment. In this case, this field must be set at each instruction level. - The first date of execution for a standing order. When the payment cannot be processed at this date, the ASPSP is allowed to shift the applied execution date to the next possible execution date for non-standing orders. For standing orders, the [executionRule] parameter helps to compute the execution date to be applied.
referenceNumber	ReferenceNumber	false	ISO20022: This field specifies the reference assigned by the sender to unambiguously identify the message.
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.

CreditTransferTransactionDetails

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

Fields

Name	Type	Required	Description
paymentId	PaymentIdentification	false	ISO20022: Set of elements used to reference a payment instruction.
resourceId	PaymentTransactionResourceId	false	ISO20022 : Reference assigned by a sending party to unambiguously identify the transaction information block within the message.
transactionStatus	PaymentInformationStatusCode	false	ISO20022: Specifies the status of the payment information.
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.
referenceNumber	ReferenceNumber	false	ISO20022: This field specifies the reference assigned by the sender to unambiguously identify the message.
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	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
ultimateDebtor	PartyIdentification	false	API : Description of a Party which can be either a person or an organization.
beneficiary	Beneficiary	false	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

Value	Description
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
CNH	Chinese yuan
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)

EpirusBankConnectorSettings

Settings for initializing ApiClient for Epirus Bank API

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format
keyPath	string	true	Path to QWAC certificate private key in PEM format
signCertPath	string	true	Path to QSEAL certificate in PEM format

ExchangeRate

Provides details on the currency exchange rate and contract.

Fields

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

Enumerated Values

rateType

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

ExecutionRule

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

Base type

string

Enumerated Values

Value	Description
FWNG	following
PREC	preceding

FinancialInstitutionIdentification

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

Fields

Name	Type	Required	Description
bicFi	string	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

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

FundsAvailabilityInformation

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

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

Base type

boolean

GenericIdentification

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

Fields

Name	Type	Required	Description
identification	string	true	API Identifier
schemeName	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

Name	Type	Required	Description
connectedPsu	string	false	Last name and first name that has granted access to the AISP on the accounts data This information can be retrieved based on the PSU's authentication that occurred during the OAUTH2 access token initialisation.
accounts	[AccountResource]	true	List of PSU account that are made available to the TPP

HalBalances

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

Fields

Name	Type	Required	Description
balances	[BalanceResource]	true	List of account balances

HalBeneficiaries

HYPERMEDIA structure used for returning the list of the whitelisted beneficiaries

Fields

Name	Type	Required	Description
beneficiaries	[Beneficiary]	true	List of trusted beneficiaries

HalConnectors

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

Fields

Name	Type	Required	Description
connectors	[Connector]	true	List of connectors

HalPaymentCoverageReport

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

Fields

Name	Type	Required	Description
request	PaymentCoverageRequestResource	true	Payment coverage request structure. The request must rely either on a cash account or a payment card.
result	boolean	true	Result of the coverage check : true: the payment can be covered false: the payment cannot be covered

HalPaymentRequest

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

Fields

Name	Type	Required	Description
paymentRequestResourceId	ResourceId	false	Identifier assigned by the ASPSP for further use of the created resource through API calls
paymentRequest	PaymentRequestResourceDetails	false	ISO20022: The PaymentRequestResourceDetails message is sent by the Creditor sending party to the Debtor receiving party, directly or through agents. It is used by a Creditor to request movement of funds from the debtor account to a creditor. API: Information about the creditor (Id, account and agent) might be placed either at payment level or at instruction level. Thus multi-beneficiary payments can be handled. The requested execution date can be placed either at payment level when all instructions are requested to be executed at the same date or at instruction level. The latest case includes: - multiple instructions having different requested execution dates - standing orders settings
paymentInformationStatus	PaymentInformationStatusCode	false	Status of the payment request resource NULL value means that the status is not yet available from the bank
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.
authData	[AuthDataItem]	false	[structure used for returning auth parameters to be passed to user]

HalPaymentRequestCancellation

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

Fields

Name	Type	Required	Description
paymentRequestResourceId	ResourceId	false	Identifier assigned by the ASPSP for further use of the created resource through API calls
_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]

HalPaymentRequestCreation

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

Fields

Name	Type	Required	Description
paymentRequestResourceId	ResourceId	false	Identifier assigned by the ASPSP for further use of the created resource through API calls
_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]

HalPaymentRequestTransaction

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

Fields

Name	Type	Required	Description
paymentRequestResourceId	ResourceId	false	Identifier assigned by the ASPSP for further use of the created resource through API calls
paymentRequestTransaction	CreditTransferTransactionDetails	false	Payment instruction to transfer instructed amount of money to the specified beneficiary.

HalPaymentReuqestCancellationResult

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

Fields

Name	Type	Required	Description
paymentRequestResourceId	ResourceId	false	Identifier assigned by the ASPSP for further use of the created resource through API calls
paymentInformationStatus	PaymentInformationStatusCode	false	Status of the payment request resource NULL value means that the status is not yet available from the bank
_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.
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

Name	Type	Required	Description
transactions	[Transaction]	true	List of transactions
continuationKey	string	false	Value to be passed to getAccountTransactions to retrieve next page of transactions. Null if there are no more pages. Only valid in current session.

LocalInstrumentCode

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

Base type

string

Logo

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

Fields

Name	Type	Required	Description
url	string	true	Logo URL

ModifyConsentsInfo

Information about usage of modifyConsents method

Fields

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

PartyIdentification

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

Fields

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

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

PaymentIdentification

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

Fields

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

PaymentInformationId

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

Base type

string

PaymentInformationStatusCode

ISO20022: Specifies the status of the payment information.

Base type

string

Enumerated Values

Value	Description
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.
ACWP	AcceptedWithoutPosting. Payment instruction included in the credit transfer is accepted without being posted to the creditor's account.
PART	PartiallyAccepted. A number of transactions have been accepted, whereas another number of transactions have not yet achieved 'accepted' status.
RCVD	Received. Payment initiation has been received by the receiving agent.
PDNG	Pending. Payment request or individual transaction included in the Payment Request is pending. Further checks and status update will be performed.
RJCT	Rejected. Payment request has been rejected.
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

Name	Type	Required	Description
psuAuthenticationFactor	string	false	Authentication factor forwarded by the TPP to the ASPSP in order to fulfil the strong customer authentication process

PaymentRequestResource

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

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

Fields

Name	Type	Required	Description
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.

PaymentRequestResourceDetails

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

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

Fields

Name	Type	Required	Description
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	[CreditTransferTransactionDetails]	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.

PaymentTransactionResourceId

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

Base type

string

PaymentType

Payment type info

Base type

string

Enumerated Values

Value	Description
SEPA	SEPA credit transfers
INST_SEPA	Instant SEPA credit transfers
BULK_SEPA	SEPA bulk credit transfers
CROSSBORDER	Crossborder credit transfers
DOMESTIC	Domestic credit transfers
DOMESTIC_SE_GIRO	Swedish domestic Giro payments (BankGiro/PlusGiro)
INTERNAL	Transfer made within the same aspsp

PaymentTypeInfo

Information about available payment types

Fields

Name	Type	Required	Description
paymentType	PaymentType	true	Payment type info
maxTransactions	integer	false	Maximum number of transactions
currencies	[CurrencyCodeEnum]	false	List of supported currencies
debtorNameRequired	boolean	false	States if debtor name is required
debtorAccountRequired	boolean	false	States if debtor account is required during payment initiation request.
debtorAccountSchemas	[SchemeName]	false	List of supported debtor account schemas
debtorCountryRequired	boolean	false	States if debtor country is required
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
remittanceInformationLines	[RemittanceInformationLineInfo]	false	Properties of remittance information. Each item of the array correspond to the remittance information line with the same index. When provided, the number of lines in the remittance information should be the same as the length of this array.
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 is required
creditorAgentClearingSystemMemberIdRequired	boolean	false	States if creditor agent clearing system member ID is 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.
referenceNumberSupported	boolean	false	States if reference number can be provided for credit transfer transactions.
referenceNumberSchemas	[ReferenceNumberScheme]	false	List of reference number schemas supported by a payment method.
requestedExecutionDateSupported	boolean	false	States if requested execution date supported by a payment method.
requestedExecutionDateMaxPeriod	integer	false	Maximum requested execution date interval in the future.
remittanceReferenceSupported	boolean	false	States if both remittance information and reference number can be provided for credit transfer transactions.
finalSuccessfulStatuses	[PaymentInformationStatusCode]	false	List of final successful payment statuses

PaymentTypeInformation

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

Fields

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

PostalAddress

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

Fields

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

PriorityCode

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

Base type

string

Enumerated Values

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

PurposeCode

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

Base type

string

Enumerated Values

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

ReferenceNumber

ISO20022: This field specifies the reference assigned by the sender to unambiguously identify the message.

Base type

string

ReferenceNumberScheme

Name of the reference number scheme.

Base type

string

Enumerated Values

Value	Description
SEBG	Swedish Bankgiro OCR.
NORF	Norwegian KID (OCR).
FIRF	Finnish reference number.
INTL	International reference number (starting with RF).

RegulatoryAuthority

Entity requiring the regulatory reporting information.

Fields

Name	Type	Required	Description
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

Name	Type	Required	Description
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

Name	Type	Required	Description
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

Name	Type	Required	Description
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.

RemittanceInformationLineInfo

Information about expected properties of the remittance information line

Fields

Name	Type	Required	Description
minLength	integer	false	Minimum possible length of the remittance information line
maxLength	integer	false	Maximum possible length of the remittance information line
pattern	string	false	Perl compatible regular expression used for check of the remittance information line format

RequestedExecutionDate

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

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

Base type

string(date-time)

ResourceId

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

Base type

string

SchemeName

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

Base type

string

Enumerated Values

Value	Description
CHID	Clearing Identification Number
GS1G	GS1GLNIdentifier
DUNS	Data Universal Numbering System
BANK	BankPartyIdentification. Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client.
TXID	TaxIdentificationNumber
CUST	CorporateCustomerNumber
EMPL	EmployerIdentificationNumber
OTHC	OtherCorporate.
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 (masked or plain)
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.
MIBN	Masked IBAN
BGNR	Swedish BankGiro account number. Used in domestic swedish giro payments
PGNR	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

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

StatusReasonCode

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

Base type

string

Enumerated Values

Value	Description
AC01	Format of the account number specified is not correct
AC02	Debtor account number invalid or missing.
AC03	Wrong IBAN in SCT
AC04	Account number specified has been closed on the bank of account's books
AC06	Account specified is blocked, prohibiting posting of transactions against it.
AC07	Creditor account number closed.
AC13	Debtor account type is missing or invalid
AC14	An agent in the payment chain is invalid.
AC15	Account details have changed.
AC16	Account is in sequestration.
AC17	Account is in liquidation.
AG01	Transaction forbidden on this type of account (formerly NoAgreement)
AG02	Bank Operation code specified in the message is not valid for receiver
AG07	Debtor account cannot be debited for a generic reason.
AGNT	Agent in the payment workflow is incorrect.
AM01	Specified message amount is equal to zero
AM02	Specific transaction/message amount is greater than allowed maximum
AM03	Specified message amount is an non processable currency outside of existing agreement
AM04	Amount of funds available to cover specified message amount is insufficient.
AM05	Duplication
AM06	Specified transaction amount is less than agreed minimum.
AM07	Amount specified in message has been blocked by regulatory authorities.
AM09	Amount received is not the amount agreed or expected
AM10	Sum of instructed amounts does not equal the control sum.
ARDT	Already returned original SCT
BE01	Identification of end customer is not consistent with associated account number, organisation ID or private ID.
BE04	Specification of creditor's address, which is required for payment, is missing/not correct.
BE05	Party who initiated the message is not recognised by the end customer
BE06	End customer specified is not known at associated Sort/National Bank Code or does no longer exist in the books
BE07	Specification of debtor's address, which is required for payment, is missing/not correct.
BE08	Returned as a result of a bank error.
BE10	Debtor country code is missing or invalid.
BE11	Creditor country code is missing or invalid.
BE16	Debtor or Ultimate Debtor identification code missing or invalid.
BE17	Creditor or Ultimate Creditor identification code missing or invalid.
CN01	Authorisation is cancelled.
CNOR	Creditor bank is not registered under this BIC in the CSM
CNPC	Cash not picked up by Creditor or cash could not be delivered to Creditor
CURR	Currency of the payment is incorrect
CUST	Cancellation requested by the Debtor
DC04	Return of Covering Settlement due to the underlying Credit Transfer details not being received.
DNOR	Debtor bank is not registered under this BIC in the CSM
DS28	Return following technical problems resulting in erroneous transaction.
DT01	Invalid date (eg, wrong settlement date)
DT02	Cheque has been issued but not deposited and is considered expired.
DT04	Future date not supported.
DUPL	Payment is a duplicate of another payment.
ED01	Correspondent bank not possible.
ED03	Balance of payments complementary info is requested
ED05	Settlement of the transaction has failed.
EMVL	The card payment is fraudulent and was not processed with EMV technology for an EMV card.
ERIN	The Extended Remittance Information (ERI) option is not supported.
FF03	Payment Type Information is missing or invalid.
FF04	Service Level code is missing or invalid.
FF05	Local Instrument code is missing or invalid
FF06	Category Purpose code is missing or invalid.
FF07	Purpose is missing or invalid.
FOCR	Return following a cancellation request
FR01	Returned as a result of fraud.
FRTR	Final response/tracking is recalled as mandate is cancelled.
G004	Credit to the creditor's account is pending, status Originator is waiting for funds provided via a cover.
MD01	No Mandate
MD02	Mandate related information data required by the scheme is missing.
MD05	Creditor or creditor's agent should not have collected the direct debit.
MD06	Return of funds requested by end customer
MD07	End customer is deceased.
MS02	Reason has not been specified by end customer
MS03	Reason has not been specified by agent.
NARR	Reason is provided as narrative information in the additional reason information.
NOAS	No response from Beneficiary
NOCM	Customer account is not compliant with regulatory requirements.
NOOR	Original SCT never received
PINL	The card payment is fraudulent (lost and stolen fraud) and was processed as EMV transaction without PIN verification.
RC01	Bank Identifier code specified in the message has an incorrect format.
RC03	Debtor bank identifier is invalid or missing.
RC04	Creditor bank identifier is invalid or missing.
RC07	Incorrrect BIC of the beneficiary Bank in the SCTR
RC08	ClearingSystemMemberidentifier is invalid or missing.
RC11	Intermediary Agent is invalid or missing.
RF01	Transaction reference is not unique within the message.
RR01	Specification of the debtor's account or unique identification needed for reasons of regulatory requirements is insufficient or missing
RR02	Specification of the debtor's name and/or address needed for regulatory requirements is insufficient or missing.
RR03	Specification of the creditor's name and/or address needed for regulatory requirements is insufficient or missing.
RR04	Regulatory Reason
RR05	Regulatory or Central Bank Reporting information missing, incomplete or invalid.
RR06	Tax information missing, incomplete or invalid.
RR07	Remittance information structure does not comply with rules for payment type.
RR08	Remittance information truncated to comply with rules for payment type.
RR09	Structured creditor reference invalid or missing.
RR11	Invalid or missing identification of a bank proprietary service.
RR12	Invalid or missing identification required within a particular country or payment type.
RUTA	Return following investigation request and no remediation possible.
SL01	Due to specific service offered by the Debtor Agent
SL02	Due to specific service offered by the Creditor Agent
SL11	Whitelisting service offered by the Debtor Agent; Debtor has not included the Creditor on its 'Whitelist'.
SL12	Blacklisting service offered by the Debtor Agent; Debtor included the Creditor on his 'Blacklist'.
SL13	Due to Maximum allowed Direct Debit Transactions per period service offered by the Debtor Agent.
SL14	Due to Maximum allowed Direct Debit Transaction amount service offered by the Debtor Agent.
SP01	Payment is stopped by account holder.
SP02	Previously stopped by means of a stop payment advise.
SVNR	The card payment is returned since a cash amount rendered was not correct or goods or a service was not rendered to the customer.
TM01	Associated message was received after agreed processing cut-off time.
TRAC	Return following direct debit being removed from tracking process.
UPAY	Payment is not justified.

StatusReasonInformation

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

Fields

Name	Type	Required	Description
statusReasonCode	StatusReasonCode	true	ISO20022: Provides detailed information on the status reason. Can only be used in status equal to "RJCT".
description	string	true	none

Token

Fields

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

Transaction

structure of a transaction

Fields

Name	Type	Required	Description
resourceId	ResourceId	false	Identifier assigned by the ASPSP for further use of the created resource through API calls
entryReference	string	false	Unique transaction identifier provided by ASPSP. This identifier is both unique and immutable and can be used for matching transactions across multiple PSU authentication sessions. Usually the same identifier is available for transactions in ASPSP's online/mobile interface and is called archive ID or similarly.
transactionAmount	AmountType	true	ISO20022: structure aiming to carry either an instructed amount or equivalent amount. Both structures embed the amount and the currency to be used. API: only instructed amount can be used
creditor	PartyIdentification	false	API : Description of a Party which can be either a person or an organization.
creditorAccount	AccountIdentification	false	Unique and unambiguous identification for the account between the account owner and the account servicer.
creditorAgent	FinancialInstitutionIdentification	false	ISO20022: Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.
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.
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
exchangeRate	ExchangeRate	false	Provides details on the currency exchange rate and contract.
debtorAccountAdditionalIdentification	[GenericIdentification]	false	All other debtor account identifiers provided by ASPSPs
creditorAccountAdditionalIdentification	[GenericIdentification]	false	All other creditor account identifiers provided by ASPSPs
note	string	false	The internal note made by PSU

Enumerated Values

creditDebitIndicator

Value	Description
CRDT	Credit type transaction
DBIT	Debit type transaction

TransactionIndividualStatusCode

ISO20022: Specifies the status of the payment information group.

Base type

string

Enumerated Values

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

TransactionStatus

Type of Transaction

Base type

string

Enumerated Values

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

TransactionsInfo

Meta information about usage and limitations of getAccountTransactions method

Fields

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

UnstructuredRemittanceInformation

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

Fields

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

HAL

ConsentLinks

Fields

Name	Type	Required	Description
redirect	GenericLink	false	hypertext reference

GenericLink

hypertext reference

Fields

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

PaymentRequestLinks

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

Fields

Name	Type	Required	Description
consentApproval	GenericLink	false	URL to be used by the PISP in order to continue the ASPSP authentication and consent management process

PaymentRequestResourceCreationLinks

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

Fields

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

Exceptions

AccountNotAccessibleException

This exception is raised when PSU does not have access to the requested account or it doesn't exist.

Base type

DataRetrievalException

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

Name	Type	Required	Description
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

Name	Type	Required	Description
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

Name	Type	Required	Description
requestId	string	true	Request id

InvalidResponseSignatureException

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

Base type

ResponseValidationException

Fields

Name	Type	Required	Description
jws	string	true	JSON web signature

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

Fields

Name	Type	Required	Description
env	string	true	Environment
retry	string	true	Flag showing whether it is possible to retry the request
url	string	false	URL to retry
authData	[AuthDataItem]	false	[structure used for returning auth parameters to be passed to user]

ModelValidationException

Code samples

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

PispApi pispApi = new PispApi(apiClient);

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

This exception is raised when model validation failed.

Base type

ValidationException

Fields

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

NotImplementedException

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

Base type

CoreException

ParameterValidationException

Code samples

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

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

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

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

Base type

ValidationException

Fields

Name	Type	Required	Description
key	string	true	Reference to a parameter

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

RateLimitException

This exception is raised when maximum daily access exceeded.

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

Name	Type	Required	Description
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

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

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

Name	Type	Required	Description
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

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

AIBConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.AIBConnectorSettings;

ApiClient apiClient = new ApiClient(
  new AIBConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .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")
    .business(false)
    .sandbox(true);

import enablebanking

connector_settings = enablebanking.AIBConnectorSettings(
  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",
  business="false"
)
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",
  signKeyPath: "your-sign-key-path",
  signPubKeySerial: "your-sign-pub-key-serial",
  clientId: "your-client-id",
  clientSecret: "your-client-secret",
  business: "false",
}
const apiClient = new enablebanking.ApiClient('AIB', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for AIB

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signKeyPath	string	true	Path to QSEAL certificate 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.
business	boolean	true	Account type to access to. If true business, if false personal.

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

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

AXABanqueConnectorSettings

Settings for initializing ApiClient for AXA Banque (France).

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID.
clientSecret	string	true	API client secret (obtained at the 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 public certificate 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

AasenSparebankConnectorSettings

Code samples

package com.eb.sample;

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

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

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

Base type

ConnectorSettings

Fields

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

AbancaBusinessConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.AbancaBusinessConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.AbancaBusinessConnectorSettings(
  client_id="your-client-id",
  api_key="your-api-key",
  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"
)
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",
  apiKey: "your-api-key",
  certPath: "your-cert-path",
  keyPath: "your-key-path",
  signKeyPath: "your-sign-key-path",
  signPubKeySerial: "your-sign-pub-key-serial"
}
const apiClient = new enablebanking.ApiClient('AbancaBusiness', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for AbancaBusiness

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID.
apiKey	string	true	API client key.
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.

AbancaConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.AbancaConnectorSettings;

ApiClient apiClient = new ApiClient(
  new AbancaConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("your-client-id")
    .apiKey("your-apiKey")
    .certPath("your-cert-path")
    .keyPath("your-key-path")
    .signKeyPath("your-sign-key-path")
    .signPubKeySerial("qseal-cert-public-serial-here")
    .sandbox(true);

import enablebanking

connector_settings = enablebanking.AbancaConnectorSettings(
  client_id="your-client-id",
  apiKey="your-apiKey",
  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"
)
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",
  apiKey: "your-apiKey",
  certPath: "your-cert-path",
  keyPath: "your-key-path",
  signKeyPath: "your-sign-key-path",
  signPubKeySerial: "qseal-cert-public-serial-here"
}
const apiClient = new enablebanking.ApiClient('Abanca', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for Abanca

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID.
apiKey	string	true	none
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

AbancaPTConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.AbancaPTConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.AbancaPTConnectorSettings(
  client_id="your-client-id",
  apiKey="your-apiKey",
  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"
)
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",
  apiKey: "your-apiKey",
  certPath: "your-cert-path",
  keyPath: "your-key-path",
  signKeyPath: "your-sign-key-path",
  signPubKeySerial: "your-sign-pub-key-serial"
}
const apiClient = new enablebanking.ApiClient('AbancaPT', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for AbancaPT

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID.
apiKey	string	true	none
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.

ActivoBankConnectorSettings

Settings for initializing ApiClient for BANCO ACTIVOBANK, SA (Portugal)

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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
clientId	string	true	The client Id

ActivoBankESConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.ActivoBankESConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.ActivoBankESConnectorSettings(
  client_id="your-client-id",
  sign_key_path="your-sign-key-path",
  sign_cert_path="your-sign-cert-path",
  cert_path="your-cert-path",
  sign_pub_key_serial="your-sign-pub-key-serial",
  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",
  signKeyPath: "your-sign-key-path",
  signCertPath: "your-sign-cert-path",
  certPath: "your-cert-path",
  signPubKeySerial: "your-sign-pub-key-serial",
  keyPath: "your-key-path"
}
const apiClient = new enablebanking.ApiClient('ActivoBankES', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for ActivoBankES

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID.
signKeyPath	string	true	Path to QSEAL certificate 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	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.

AddikoBankHRConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.AddikoBankHRConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.AddikoBankHRConnectorSettings(
  client_id="your-client-id",
  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",
  certPath: "your-cert-path",
  keyPath: "your-key-path"
}
const apiClient = new enablebanking.ApiClient('AddikoBankHR', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for AddikoBankHR

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

AddikoConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.AddikoConnectorSettings;

ApiClient apiClient = new ApiClient(
  new AddikoConnectorSettings()
    .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.AddikoConnectorSettings(
  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('Addiko', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for Addiko

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

AionBank2ConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.AionBank2ConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.AionBank2ConnectorSettings(
  client_id="your-client-id",
  country="your-country",
  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",
  country: "your-country",
  certPath: "your-cert-path",
  keyPath: "your-key-path"
}
const apiClient = new enablebanking.ApiClient('AionBank2', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for AionBank2

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID.
country	string	true	Bank`s country, two-letter country code.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.

AktiaConnectorSettings

Settings for initializing ApiClient for Aktia (Finland).

Base type

ConnectorSettings

Fields

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

AktiaContingencyConnectorSettings

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

Base type

ConnectorSettings

Fields

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

AlandsbankenConnectorSettings

Code samples

package com.eb.sample;

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

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

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

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank country (only clients from the specified will be able to authenticate). Possilbe values: FI – Finland SE – Sweden
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

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

AlisaBankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.AlisaBankConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.AlisaBankConnectorSettings(
  client_id="your-client-id",
  client_secret="your-client-secret",
  cert_path="your-cert-path",
  key_path="your-key-path",
  sign_cert_path="your-sign-cert-path",
  sign_key_path="your-sign-key-path",
  sign_pub_key_serial="your-sign-pub-key-serial",
  sign_pub_key_serial="your-sign-pub-key-serial",
  api_key="your-api-key"
)
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",
  signCertPath: "your-sign-cert-path",
  signKeyPath: "your-sign-key-path",
  signPubKeySerial: "your-sign-pub-key-serial",
  signPubKeySerial: "your-sign-pub-key-serial",
  apiKey: "your-api-key"
}
const apiClient = new enablebanking.ApiClient('AlisaBank', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for AlisaBank

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.
signCertPath	string	true	Path to QSEAL public 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.
apiKey	string	true	API client key.

AllianzBankBGConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.AllianzBankBGConnectorSettings;

ApiClient apiClient = new ApiClient(
  new AllianzBankBGConnectorSettings()
    .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.AllianzBankBGConnectorSettings(
  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('AllianzBankBG', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for AllianzBankBG

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

AllianzBankFinancialAdvisorsConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.AllianzBankFinancialAdvisorsConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.AllianzBankFinancialAdvisorsConnectorSettings(
  cert_path="your-cert-path",
  key_path="your-key-path",
  client_id="your-client-id",
  client_secret="your-client-secret",
  business=False
)
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",
  business: false
}
const apiClient = new enablebanking.ApiClient('AllianzBankFinancialAdvisors', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for AllianzBankFinancialAdvisors

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
clientId	string	true	API client ID.
clientSecret	string	true	API client secret.
business	boolean	true	Account type to access to. If true business, if false personal.

AllianzBanqueConnectorSettings

Settings for initializing ApiClient for Allianz Banque (France).

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID.
clientSecret	string	true	API client secret (obtained at the 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 public certificate 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

AlphaBankCYConnectorSettings

Settings for initializing ApiClient for AlphaBankCY

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.
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.
ocpApimSubscriptionKey	string	true	none
pispOcpApimSubscriptionKey	string	true	API subscription key (obtained from Developer Portal)

AlphaBankGRConnectorSettings

Settings for initializing ApiClient for AlphaBankGR

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.
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.
ocpApimSubscriptionKey	string	true	API subscription key (obtained from Developer Portal)
pispOcpApimSubscriptionKey	string	true	API subscription key (obtained from Developer Portal)

AlphaBankROConnectorSettings

Settings for initializing ApiClient for AlphaBankRO

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.
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.
ocpApimSubscriptionKey	string	true	none
pispOcpApimSubscriptionKey	string	true	API subscription key (obtained from Developer Portal)

AmExNewConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.AmExNewConnectorSettings;

ApiClient apiClient = new ApiClient(
  new AmExNewConnectorSettings()
    .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.AmExNewConnectorSettings(
  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('AmExNew', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for AmExNew

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

AndbankConnectorSettings

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

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997
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)

AndbankLUConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained at the developer portal)
clientSecret	string	true	API client secret (obtained at the 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

AndelskassenFaelleskassenConnectorSettings

Base type

ConnectorSettings

Fields

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

ApoBankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.ApoBankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new ApoBankConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .country("your-country")
    .certPath("your-cert-path")
    .keyPath("your-key-path")
    .signCertPath("your-sign-cert-path")
    .signKeyPath("your-sign-key-path")
    .signPubKeySerial("your-sign-pub-key-serial")
    .sandbox(true);

import enablebanking

connector_settings = enablebanking.ApoBankConnectorSettings(
  country="your-country",
  cert_path="your-cert-path",
  key_path="your-key-path",
  sign_cert_path="your-sign-cert-path",
  sign_key_path="your-sign-key-path",
  sign_pub_key_serial="your-sign-pub-key-serial"
)
api_client = ApiClient(connector_settings)

const enablebanking = require('enablebanking');

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

Settings for initializing ApiClient for ApoBank

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank`s country, two-letter country code.
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 public 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.

ArbejdernesLandsbankConnectorSettings

Base type

ConnectorSettings

Fields

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

ArgentaConnectorSettings

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

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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

ArionBankiConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.ArionBankiConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.ArionBankiConnectorSettings(
  client_id="your-client-id",
  api_key="your-api-key",
  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",
  apiKey: "your-api-key",
  clientSecret: "your-client-secret",
  certPath: "your-cert-path",
  keyPath: "your-key-path"
}
const apiClient = new enablebanking.ApiClient('ArionBanki', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for Arion banki

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
language	string	false	Language of authentication user interface.
clientId	string	true	API client ID.
apiKey	string	true	API key (obtained from the API Portal)
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.

ArkeaBankingServicesConnectorSettings

Settings for initializing ApiClient for Arkea Banking Services (France).

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID.
clientSecret	string	true	API client secret (obtained at the 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 public certificate 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

ArkeaBanqueEntreprisesConnectorSettings

Settings for initializing ApiClient for Arkea Banque Entreprises (France).

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID.
clientSecret	string	true	API client secret (obtained at the 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 public certificate 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

ArkeaBanquePriveeConnectorSettings

Settings for initializing ApiClient for Arkea Banque Privee (France).

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID.
clientSecret	string	true	API client secret (obtained at the 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 public certificate 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

ArquiaConnectorSettings

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

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997
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

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

AtlanticoEuropaConnectorSettings

Settings for initializing ApiClient for BANCO ATLANTICO EUROPA, SA (Portugal)

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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
clientId	string	true	The client Id

AtruviaConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.AtruviaConnectorSettings;

ApiClient apiClient = new ApiClient(
  new AtruviaConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .certPath("your-cert-path")
    .keyPath("your-key-path")
    .signCertPath("your-sign-cert-path")
    .signKeyPath("your-sign-key-path")
    .signPubKeySerial("your-sign-pub-key-serial")
    .sandbox(true)
    .brand("Berliner Atruvia branches");

import enablebanking

connector_settings = enablebanking.AtruviaConnectorSettings(
  cert_path="your-cert-path",
  key_path="your-key-path",
  sign_cert_path="your-sign-cert-path",
  sign_key_path="your-sign-key-path",
  sign_pub_key_serial="your-sign-pub-key-serial",
  brand="Berliner Atruvia branches"
)
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",
  signCertPath: "your-sign-cert-path",
  signKeyPath: "your-sign-key-path",
  signPubKeySerial: "your-sign-pub-key-serial",
  brand: "Berliner Atruvia branches"
}
const apiClient = new enablebanking.ApiClient('Atruvia', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for Atruvia

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSEAL public 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.
brand	string	true	Name of Atruvia branches

AurlandSparebankConnectorSettings

Code samples

package com.eb.sample;

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

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

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

Base type

ConnectorSettings

Fields

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

BACDConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BACDConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BACDConnectorSettings()
    .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.BACDConnectorSettings(
  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('BACD', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BACD

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

BAWAGConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BAWAGConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.BAWAGConnectorSettings(
  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('BAWAG', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BAWAG

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.

BBRConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BBRConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BBRConnectorSettings()
    .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.BBRConnectorSettings(
  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('BBR', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BBR

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

BBVAConnectorSettings

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

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997
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)

BKSBankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BKSBankConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.BKSBankConnectorSettings(
  country="your-country",
  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",
  country: "your-country",
  certPath: "your-cert-path",
  keyPath: "your-key-path"
}
const apiClient = new enablebanking.ApiClient('BKSBank', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BKS Bank

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank`s country, two-letter country code.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.

BKSBankSIConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BKSBankSIConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BKSBankSIConnectorSettings()
    .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.BKSBankSIConnectorSettings(
  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('BKSBankSI', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BSK Bank

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

BKSHRConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BKSHRConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.BKSHRConnectorSettings(
  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('BKSHR', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BKSHR

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.

BNBankBusinessConnectorSettings

Settings for initializing ApiClient for BN Bank

Base type

ConnectorSettings

Fields

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

BNBankConnectorSettings

Settings for initializing ApiClient for BN Bank

Base type

ConnectorSettings

Fields

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

BNGConnectorSettings

Settings for initializing ApiClient for BNG Bank (Netherlands).

Base type

ConnectorSettings

Fields

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

BNLBusinessConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BNLBusinessConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BNLBusinessConnectorSettings()
    .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.BNLBusinessConnectorSettings(
  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('BNLBusiness', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BNLBusiness

Base type

ConnectorSettings

Fields

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

BNLConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BNLConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BNLConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .certPath("your-cert-path")
    .keyPath("your-key-path")
    .clientId("your-client-id")
    .clientSecret("your-client-secret")
    .brand("brands connected through BNL's end point")
    .sandbox(true);

import enablebanking

connector_settings = enablebanking.BNLConnectorSettings(
  cert_path="your-cert-path",
  key_path="your-key-path",
  client_id="your-client-id",
  client_secret="your-client-secret",
  brand="brands connected through BNL's end point"
)
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",
  brand: "brands connected through BNL's end point"
}
const apiClient = new enablebanking.ApiClient('BNL', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BNL

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
clientId	string	true	API client ID.
clientSecret	string	true	API client secret.
brand	string	true	Brands connected through BNL's end point

BNPParibasFRBusinessConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BNPParibasFRBusinessConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.BNPParibasFRBusinessConnectorSettings(
  client_id="your-client-id",
  client_secret="your-client-secret",
  cert_path="your-cert-path",
  key_path="your-key-path",
  sign_cert_path="your-sign-cert-path",
  sign_key_path="your-sign-key-path",
  sign_pub_key_serial="your-sign-pub-key-serial"
)
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",
  signCertPath: "your-sign-cert-path",
  signKeyPath: "your-sign-key-path",
  signPubKeySerial: "your-sign-pub-key-serial"
}
const apiClient = new enablebanking.ApiClient('BNPParibasFRBusiness', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BNPParibasFRBusiness

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.
signCertPath	string	true	Path to QSEAL public 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.

BNPParibasFRPersonalConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BNPParibasFRPersonalConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.BNPParibasFRPersonalConnectorSettings(
  client_id="your-client-id",
  client_secret="your-client-secret",
  cert_path="your-cert-path",
  key_path="your-key-path",
  sign_cert_path="your-sign-cert-path",
  sign_key_path="your-sign-key-path",
  sign_pub_key_serial="your-sign-pub-key-serial"
)
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",
  signCertPath: "your-sign-cert-path",
  signKeyPath: "your-sign-key-path",
  signPubKeySerial: "your-sign-pub-key-serial"
}
const apiClient = new enablebanking.ApiClient('BNPParibasFRPersonal', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BNPParibasFRPersonal

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.
signCertPath	string	true	Path to QSEAL public 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.

BNPParibasFortisBusinessConnectorSettings

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

Base type

ConnectorSettings

Fields

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

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

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

BOIConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BOIConnectorSettings;

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

Settings for initializing ApiClient for BOI

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.
business	boolean	true	Account type to access to. If true business, if false personal.

BPCEConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BPCEConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BPCEConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .certPath("your-cert-path")
    .keyPath("your-key-path")
    .signKeyPath("your-sign-key-path")
    .signPubKeySerial("your-sign-pub-key-serial")
    .clientId("your-client-id")
    .brand("bpce-brands")
    .sandbox(true);

import enablebanking

connector_settings = enablebanking.BPCEConnectorSettings(
  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",
  brand="bpce-brands"
)
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",
  signKeyPath: "your-sign-key-path",
  signPubKeySerial: "your-sign-pub-key-serial",
  clientId: "your-client-id",
  brand: "bpce-brands"
}
const apiClient = new enablebanking.ApiClient('BPCE', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BPCE Group

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signKeyPath	string	true	Path to QSEAL certificate private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath.
clientId	string	true	API client ID.
brand	string	true	BPCE brands.

BPEConnectorSettings

Settings for initializing ApiClient for BPE / Louvre Banque Privée (France).

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID.
clientSecret	string	true	API client secret (obtained at the 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 public certificate 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

BPERBancaBusinessConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BPERBancaBusinessConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.BPERBancaBusinessConnectorSettings(
  client_id="your-client-id",
  client_secret="your-client-secret",
  cert_path="your-cert-path",
  key_path="your-key-path",
  tpp_name="your-tpp-name",
  brand="your-brand"
)
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",
  tppName: "your-tpp-name",
  brand: "your-brand"
}
const apiClient = new enablebanking.ApiClient('BPERBancaBusiness', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BPERBancaBusiness

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
clientId	string	true	API client ID.
clientSecret	string	true	API client secret.
brand	string	true	Denotes the bank where the account is held.
tppName	string	true	The name of the original TPP that created the request.

BPERBancaConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BPERBancaConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BPERBancaConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .certPath("your-cert-path")
    .keyPath("your-key-path")
    .clientId("your-client-id")
    .clientSecret("your-client-secret")
    .brand("brands connected through BPER Banca's end point")
    .sandbox(true);

import enablebanking

connector_settings = enablebanking.BPERBancaConnectorSettings(
  cert_path="your-cert-path",
  key_path="your-key-path",
  client_id="your-client-id",
  client_secret="your-client-secret",
  brand="brands connected through BPER Banca's end point"
)
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",
  brand: "brands connected through BPER Banca's end point"
}
const apiClient = new enablebanking.ApiClient('BPERBanca', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BPERBanca

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
clientId	string	true	API client ID.
clientSecret	string	true	API client secret.
brand	string	true	Brands connected through BPER Banca's end point

BPIConnectorSettings

Settings for initializing ApiClient for BANCO BPI, SA (Portugal)

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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
clientId	string	true	The client Id

BRDBusinessConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BRDBusinessConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.BRDBusinessConnectorSettings(
  cert_path="your-cert-path",
  key_path="your-key-path",
  signCertPath="your-sign-cert-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",
  signCertPath: "your-sign-cert-path"
}
const apiClient = new enablebanking.ApiClient('BRDBusiness', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BRDBusiness

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signCertPath	string	true	Path to QSEAL public certificate in PEM format.

BRDConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BRDConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.BRDConnectorSettings(
  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('BRD', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BRD

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.

BTGPactualConnectorSettings

Settings for initializing ApiClient for BTG Pactual

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.

BTVConnectorSettings

Settings for initializing ApiClient for BTV

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
country	string	true	Bank`s country, two-letter country code.

BancaComercialaRomanaConnectorSettings

Settings for Erste&Steiermärkische Bank (Bank in Croatia Republic)

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank country.
clientId	string	true	API client ID.
clientSecret	string	true	API client secret.
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.

BancaCredifarmaConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BancaCredifarmaConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BancaCredifarmaConnectorSettings()
    .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.BancaCredifarmaConnectorSettings(
  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('BancaCredifarma', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BancaCredifarma

Base type

ConnectorSettings

Fields

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

BancaFideuramConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BancaFideuramConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BancaFideuramConnectorSettings()
    .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.BancaFideuramConnectorSettings(
  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('BancaFideuram', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BancaFideuram

Base type

ConnectorSettings

Fields

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

BancaMarchConnectorSettings

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

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997
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)

BancaMediolanumConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BancaMediolanumConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BancaMediolanumConnectorSettings()
    .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.BancaMediolanumConnectorSettings(
  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('BancaMediolanum', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for Banca Mediolanum

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

BancaPassadoreConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BancaPassadoreConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BancaPassadoreConnectorSettings()
    .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.BancaPassadoreConnectorSettings(
  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('BancaPassadore', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for CBIGlobe

Base type

ConnectorSettings

Fields

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

BancaPopolareDellAltoAdigeConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BancaPopolareDellAltoAdigeConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BancaPopolareDellAltoAdigeConnectorSettings()
    .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.BancaPopolareDellAltoAdigeConnectorSettings(
  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('BancaPopolareDellAltoAdige', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BancaPopolareDellAltoAdige

Base type

ConnectorSettings

Fields

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

BancaPopolareDiSondrioConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BancaPopolareDiSondrioConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BancaPopolareDiSondrioConnectorSettings()
    .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.BancaPopolareDiSondrioConnectorSettings(
  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('BancaPopolareDiSondrio', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BancaPopolareDiSondrio

Base type

ConnectorSettings

Fields

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

BancaTransilvaniaConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BancaTransilvaniaConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.BancaTransilvaniaConnectorSettings(
  client_id="your-client-id",
  client_secret="your-client-secret",
  cert_path="your-cert-path",
  key_path="your-key-path",
  sign_cert_path="your-sign-cert-path",
  sign_key_path="your-sign-key-path",
  sign_pub_key_serial="your-sign-pub-key-serial"
)
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",
  signCertPath: "your-sign-cert-path",
  signKeyPath: "your-sign-key-path",
  signPubKeySerial: "your-sign-pub-key-serial"
}
const apiClient = new enablebanking.ApiClient('BancaTransilvania', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BancaTransilvania

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.
signCertPath	string	true	Path to QSEAL public 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.

BancoBPMBusinessConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BancoBPMBusinessConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BancoBPMBusinessConnectorSettings()
    .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.BancoBPMBusinessConnectorSettings(
  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('BancoBPMBusiness', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BancoBPMBusiness

Base type

ConnectorSettings

Fields

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

BancoBPMConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BancoBPMConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BancoBPMConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .certPath("your-cert-path")
    .keyPath("your-key-path")
    .clientId("your-client-id")
    .clientSecret("your-client-secret")
    .brand("Brands connected through BPM's end point")
    .sandbox(true);

import enablebanking

connector_settings = enablebanking.BancoBPMConnectorSettings(
  cert_path="your-cert-path",
  key_path="your-key-path",
  client_id="your-client-id",
  client_secret="your-client-secret",
  brand="Brands connected through BPM's end point"
)
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",
  brand: "Brands connected through BPM's end point"
}
const apiClient = new enablebanking.ApiClient('BancoBPM', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BancoBPM

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
clientId	string	true	API client ID.
clientSecret	string	true	API client secret.
brand	string	true	Brands connected through BPM's end point.

BancoCetelemConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BancoCetelemConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.BancoCetelemConnectorSettings(
  client_id="your-client-id",
  sign_key_path="your-sign-key-path",
  sign_cert_path="your-sign-cert-path",
  cert_path="your-cert-path",
  sign_pub_key_serial="your-sign-pub-key-serial",
  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",
  signKeyPath: "your-sign-key-path",
  signCertPath: "your-sign-cert-path",
  certPath: "your-cert-path",
  signPubKeySerial: "your-sign-pub-key-serial",
  keyPath: "your-key-path"
}
const apiClient = new enablebanking.ApiClient('BancoCetelem', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BancoCetelem

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID.
signKeyPath	string	true	Path to QSEAL certificate 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	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.

BancoEuropeoDeFinanzasConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BancoEuropeoDeFinanzasConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.BancoEuropeoDeFinanzasConnectorSettings(
  client_id="your-client-id",
  sign_key_path="your-sign-key-path",
  sign_cert_path="your-sign-cert-path",
  cert_path="your-cert-path",
  sign_pub_key_serial="your-sign-pub-key-serial",
  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",
  signKeyPath: "your-sign-key-path",
  signCertPath: "your-sign-cert-path",
  certPath: "your-cert-path",
  signPubKeySerial: "your-sign-pub-key-serial",
  keyPath: "your-key-path"
}
const apiClient = new enablebanking.ApiClient('BancoEuropeoDeFinanzas', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BancoEuropeoDeFinanzas

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID.
signKeyPath	string	true	Path to QSEAL certificate 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	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.

BancoInversisConnectorSettings

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

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997
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)

BancoInvestimentoGlobalConnectorSettings

Settings for initializing ApiClient for BANCO DE INVESTIMENTO GLOBAL ESPANHA, SA (Portugal)

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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
clientId	string	true	The client Id

BancoMediolanumConnectorSettings

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

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997
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

Name	Type	Required	Description
clientId	string	true	Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997
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

Name	Type	Required	Description
clientId	string	true	Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997
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)

BancoSantanderCorporateConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BancoSantanderCorporateConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.BancoSantanderCorporateConnectorSettings(
  client_id="your-client-id",
  sign_key_path="your-sign-key-path",
  sign_cert_path="your-sign-cert-path",
  cert_path="your-cert-path",
  sign_pub_key_serial="your-sign-pub-key-serial",
  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",
  signKeyPath: "your-sign-key-path",
  signCertPath: "your-sign-cert-path",
  certPath: "your-cert-path",
  signPubKeySerial: "your-sign-pub-key-serial",
  keyPath: "your-key-path"
}
const apiClient = new enablebanking.ApiClient('BancoSantanderCorporate', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BancoSantanderCorporate

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID.
signKeyPath	string	true	Path to QSEAL certificate 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	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.

BankDeKremerConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BankDeKremerConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.BankDeKremerConnectorSettings(
  client_id="your-client-id",
  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",
  certPath: "your-cert-path",
  keyPath: "your-key-path"
}
const apiClient = new enablebanking.ApiClient('BankDeKremer', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BankDeKremer

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

BankNordikDenmarkConnectorSettings

Code samples

package com.eb.sample;

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

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

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

Base type

ConnectorSettings

Fields

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

BankNordikFaroeIslandsConnectorSettings

Code samples

package com.eb.sample;

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

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

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

Base type

ConnectorSettings

Fields

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

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

Name	Type	Required	Description
country	string	true	Bank country (only clients from the specified will be able to authenticate). Possilbe values: FI – Finland SE – Sweden 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.

BankOfValettaConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BankOfValettaConnectorSettings;

ApiClient apiClient = new ApiClient(
  new BankOfValettaConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .country("your-country")
    .signKeyPath("your-sign-key-path")
    .signCertPath("your-sign-cert-path")
    .signPubKeySerial("your-sign-pub-key-serial")
    .sandbox(true);

import enablebanking

connector_settings = enablebanking.BankOfValettaConnectorSettings(
  country="your-country",
  sign_key_path="your-sign-key-path",
  sign_cert_path="your-sign-cert-path",
  sign_pub_key_serial="your-sign-pub-key-serial"
)
api_client = ApiClient(connector_settings)

const enablebanking = require('enablebanking');

const CONNECTOR_SETTINGS = {
  sandbox: true,
  consentId: null,
  accessToken: null,
  redirectUri: "https://your-redirect-uri",
  country: "your-country",
  signKeyPath: "your-sign-key-path",
  signCertPath: "your-sign-cert-path",
  signPubKeySerial: "your-sign-pub-key-serial"
}
const apiClient = new enablebanking.ApiClient('BankOfValetta', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BankOfValetta

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank`s country, two-letter country code.
signKeyPath	string	true	Path to QSEAL certificate 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.

BankVanBredaConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BankVanBredaConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.BankVanBredaConnectorSettings(
  client_id="your-client-id",
  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",
  certPath: "your-cert-path",
  keyPath: "your-key-path"
}
const apiClient = new enablebanking.ApiClient('BankVanBreda', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for BankVanBreda

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

BankhausFaisstConnectorSettings

Settings for initializing ApiClient for BankhausFaisst (Germany).

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank country.
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 public certificate 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	false	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

BankhausLampeConnectorSettings

Settings for initializing ApiClient for BankhausLampe (Germany).

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank country.
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 public certificate 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	false	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

BankhausWerhahnConnectorSettings

Settings for initializing ApiClient for BankhausWerhahn (Germany).

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank country.
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 public certificate 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	false	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

BankinterConnectorSettings

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

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997
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)

BankinterLUConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained at the developer portal)
clientSecret	string	true	API client secret (obtained at the 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

BankinterSucursalConnectorSettings

Settings for initializing ApiClient for BANKINTER, SA - SUCURSAL EM PORTUGAL (Portugal)

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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
clientId	string	true	The client Id

BanqueCPHConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BanqueCPHConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.BanqueCPHConnectorSettings(
  client_id="your-client-id",
  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",
  certPath: "your-cert-path",
  keyPath: "your-key-path"
}
const apiClient = new enablebanking.ApiClient('BanqueCPH', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for Banque CPH

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

BanqueDeLuxembourgBEConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained at the developer portal)
clientSecret	string	true	API client secret (obtained at the 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

BanqueDeLuxembourgConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained at the developer portal)
clientSecret	string	true	API client secret (obtained at the 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

BanqueDePatrimoinesPrivesConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained at the developer portal)
clientSecret	string	true	API client secret (obtained at the 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

BanqueEuropeenneFRConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BanqueEuropeenneFRConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.BanqueEuropeenneFRConnectorSettings(
  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"
)
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",
  certPath: "your-cert-path",
  keyPath: "your-key-path",
  signKeyPath: "your-sign-key-path",
  signPubKeySerial: "your-sign-pub-key-serial"
}
const apiClient = new enablebanking.ApiClient('BanqueEuropeenneFR', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for Banque Européenne

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

BanqueTransatlantiqueBEConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained at the developer portal)
clientSecret	string	true	API client secret (obtained at the 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

BanqueTransatlantiqueConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BanqueTransatlantiqueConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.BanqueTransatlantiqueConnectorSettings(
  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"
)
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",
  certPath: "your-cert-path",
  keyPath: "your-key-path",
  signKeyPath: "your-sign-key-path",
  signPubKeySerial: "your-sign-pub-key-serial"
}
const apiClient = new enablebanking.ApiClient('BanqueTransatlantique', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for Banque Transatlantique

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

BanqueTransatlantiqueLUConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained at the developer portal)
clientSecret	string	true	API client secret (obtained at the 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

BasisbankConnectorSettings

Code samples

package com.eb.sample;

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

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

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

Base type

ConnectorSettings

Fields

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

BelfiusConnectorSettings

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

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID (obtained from Belfius Developer Portal).
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

BeobankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BeobankConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.BeobankConnectorSettings(
  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"
)
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",
  certPath: "your-cert-path",
  keyPath: "your-key-path",
  signKeyPath: "your-sign-key-path",
  signPubKeySerial: "your-sign-pub-key-serial"
}
const apiClient = new enablebanking.ApiClient('Beobank', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for Beobank

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

BerenbergConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BerenbergConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.BerenbergConnectorSettings(
  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('Berenberg', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for Berenberg

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.

BethmannBankConnectorSettings

Settings for initializing ApiClient for BethmannBank (Germany).

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank country.
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 public certificate 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	false	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

BetriFOConnectorSettings

Code samples

package com.eb.sample;

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

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

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

Base type

ConnectorSettings

Fields

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

BicPortuguesConnectorSettings

Settings for initializing ApiClient for BANCO BIC PORTUGUES, SA (Portugal)

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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
clientId	string	true	The client Id

BorbjergSparekasseConnectorSettings

Code samples

package com.eb.sample;

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

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

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

Base type

ConnectorSettings

Fields

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

BoursoramaConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BoursoramaConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.BoursoramaConnectorSettings(
  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"
)
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",
  certPath: "your-cert-path",
  keyPath: "your-key-path",
  signKeyPath: "your-sign-key-path",
  signPubKeySerial: "your-sign-pub-key-serial"
}
const apiClient = new enablebanking.ApiClient('Boursorama', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for Boursorama

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

BredBanquePopulaireConnectorSettings

Settings for initializing ApiClient for LCL

Base type

ConnectorSettings

Fields

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

BuddyBankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.BuddyBankConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.BuddyBankConnectorSettings(
  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('BuddyBank', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for Buddy Bank

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.

BundesbankConnectorSettings

Settings for initializing ApiClient for Deutsche Bundesbank (Germany).

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank country.
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 public certificate 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	false	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

BunqConnectorSettings

Code samples

package com.eb.sample;

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

ApiClient apiClient = new ApiClient(
  new BunqConnectorSettings()
    .clientId("put-your-client-id-here")
    .clientSecret("put-your-client-secret-here")
    .sandbox(true));

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

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Client ID
clientSecret	string	true	Client secret

C24ConnectorSettings

Settings for initializing ApiClient for C24

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.

CBNKConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.CBNKConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.CBNKConnectorSettings(
  client_id="your-client-id",
  sign_key_path="your-sign-key-path",
  sign_cert_path="your-sign-cert-path",
  sign_pub_key_serial="your-sign-pub-key-serial",
  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",
  signKeyPath: "your-sign-key-path",
  signCertPath: "your-sign-cert-path",
  signPubKeySerial: "your-sign-pub-key-serial",
  certPath: "your-cert-path",
  keyPath: "your-key-path"
}
const apiClient = new enablebanking.ApiClient('CBNK', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for CBNK

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID.
signKeyPath	string	true	Path to QSEAL certificate 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	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.

CCBConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.CCBConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.CCBConnectorSettings(
  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('CCB', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for CCB

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.

CECBankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.CECBankConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.CECBankConnectorSettings(
  client_id="your-client-id",
  client_secret="your-client-secret",
  cert_path="your-cert-path",
  key_path="your-key-path",
  sign_cert_path="your-sign-cert-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",
  signCertPath: "your-sign-cert-path"
}
const apiClient = new enablebanking.ApiClient('CECBank', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for CECBank

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.
signCertPath	string	true	Path to QSEAL public certificate in PEM format.

CIBBankBusinessConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.CIBBankBusinessConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.CIBBankBusinessConnectorSettings(
  client_id="your-client-id",
  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",
  certPath: "your-cert-path",
  keyPath: "your-key-path"
}
const apiClient = new enablebanking.ApiClient('CIBBankBusiness', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for CIB Bank Business

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

CIBBankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.CIBBankConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.CIBBankConnectorSettings(
  client_id="your-client-id",
  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",
  certPath: "your-cert-path",
  keyPath: "your-key-path"
}
const apiClient = new enablebanking.ApiClient('CIBBank', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for CIB Bank

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

CICBanquePriveeConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.CICBanquePriveeConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.CICBanquePriveeConnectorSettings(
  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"
)
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",
  certPath: "your-cert-path",
  keyPath: "your-key-path",
  signKeyPath: "your-sign-key-path",
  signPubKeySerial: "your-sign-pub-key-serial"
}
const apiClient = new enablebanking.ApiClient('CICBanquePrivee', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for CIC Banque Privée

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

CICConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.CICConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.CICConnectorSettings(
  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"
)
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",
  certPath: "your-cert-path",
  keyPath: "your-key-path",
  signKeyPath: "your-sign-key-path",
  signPubKeySerial: "your-sign-pub-key-serial"
}
const apiClient = new enablebanking.ApiClient('CIC', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for CIC

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

CSOBCZConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.CSOBCZConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.CSOBCZConnectorSettings(
  client_id="your-client-id",
  client_secret="your-client-secret",
  api_key="your-api-key",
  cert_path="your-cert-path",
  key_path="your-key-path",
  company_name="your-company-name"
)
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",
  apiKey: "your-api-key",
  certPath: "your-cert-path",
  keyPath: "your-key-path",
  companyName: "your-company-name"
}
const apiClient = new enablebanking.ApiClient('CSOBCZ', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for CSOBCZ

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	API client ID.
clientSecret	string	true	API client secret.
apiKey	string	true	API client key.
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
companyName	string	true	none

CSOBSKConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.CSOBSKConnectorSettings;

ApiClient apiClient = new ApiClient(
  new CSOBSKConnectorSettings()
    .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.CSOBSKConnectorSettings(
  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('CSOBSK', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for CSOBSK

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

CaisseDEpargneConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.CaisseDEpargneConnectorSettings;

ApiClient apiClient = new ApiClient(
  new CaisseDEpargneConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .certPath("your-cert-path")
    .keyPath("your-key-path")
    .signKeyPath("your-sign-key-path")
    .signPubKeySerial("your-sign-pub-key-serial")
    .clientId("your-client-id")
    .brand("your-brand")
    .business(false)
    .sandbox(true);

import enablebanking

connector_settings = enablebanking.CaisseDEpargneConnectorSettings(
  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",
  brand="your-brand",
  business=False
)
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",
  signKeyPath: "your-sign-key-path",
  signPubKeySerial: "your-sign-pub-key-serial",
  clientId: "your-client-id",
  brand: "your-brand",
  business: "false"
}
const apiClient = new enablebanking.ApiClient('CaisseDEpargne', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for CaisseDEpargne

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.
signKeyPath	string	true	Path to QSEAL certificate private key in PEM format.
signPubKeySerial	string	true	Public serial key of the QSeal certificate located in signKeyPath.
clientId	string	true	API client ID.
brand	string	true	Denotes the bank where the account is held.
business	boolean	true	Account type to access to. If true business, if false personal.

CaixaBankConnectorSettings

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

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997
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)

CaixaCentralCreditoAgricolaMutuoConnectorSettings

Settings for initializing ApiClient for CAIXA CENTRAL - CAIXA CENTRAL DE CREDITO AGRICOLA MUTUO, CRL (Portugal)

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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
clientId	string	true	The client Id

CaixaCreditoAgricolaMutuoBombarralConnectorSettings

Settings for initializing ApiClient for Caixa De Credito Agricola Mutuo De Bombarral Crl (Portugal)

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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
clientId	string	true	The client Id

CaixaCreditoAgricolaMutuoChamuscaConnectorSettings

Settings for initializing ApiClient for Caixa De Credito Agricola Mutuo Da Chamusca, C.r.l (Portugal)

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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
clientId	string	true	The client Id

CaixaCreditoAgricolaMutuoLeiriaConnectorSettings

Settings for initializing ApiClient for CAIXA DE CREDITO AGRICOLA MUTUO DE LEIRIA, CRL (Portugal)

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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
clientId	string	true	The client Id

CaixaCreditoAgricolaMutuoMafraConnectorSettings

Settings for initializing ApiClient for Caixa De Credito Agricola Mutuo De Mafra, C.R.L. (Portugal)

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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
clientId	string	true	The client Id

CaixaCreditoAgricolaMutuoTorresConnectorSettings

Settings for initializing ApiClient for Caixa De Credito Agricola Mutuo De Torres Vedras,c.r.l (Portugal)

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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
clientId	string	true	The client Id

CaixaEconomicaMisericordiaAngraHeroismoConnectorSettings

Settings for initializing ApiClient for CAIXA ECONOMICA DA MISERICORDIA DE ANGRA DO HEROISMO (Portugal)

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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
clientId	string	true	The client Id

CaixaEconomicaMontepioGeralConnectorSettings

Settings for initializing ApiClient for CAIXA ECONOMICA MONTEPIO GERAL (Portugal)

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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
clientId	string	true	The client Id

CaixaGeralDepositosConnectorSettings

Settings for initializing ApiClient for CAIXA GERAL DE DEPOSITOS, SA (Portugal)

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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
clientId	string	true	The client Id

CaixaGeralDepositosFranceConnectorSettings

Settings for initializing ApiClient for CAIXA GERAL DE DEPOSITOS FRANCE (Portugal)

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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
clientId	string	true	The client Id

CajaRuralConnectorSettings

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

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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
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

Name	Type	Required	Description
clientId	string	true	Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997
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

Name	Type	Required	Description
clientId	string	true	Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997
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)

CecabankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.CecabankConnectorSettings;

ApiClient apiClient = new ApiClient(
  new CecabankConnectorSettings()
    .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.CecabankConnectorSettings(
  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('Cecabank', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for Cecabank

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

CeskaSporitelnaConnectorSettings

Settings for Ceska Sporitelna (Bank in Czech Republic)

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank country.
clientId	string	true	API client ID.
clientSecret	string	true	API client secret.
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.

CheBancaCorporateConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.CheBancaCorporateConnectorSettings;

ApiClient apiClient = new ApiClient(
  new CheBancaCorporateConnectorSettings()
    .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.CheBancaCorporateConnectorSettings(
  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('CheBancaCorporate', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for CheBancaCorporate

Base type

ConnectorSettings

Fields

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

CitadeleConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	false	Bank`s country
language	string	false	Language of authentication user interface.
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

CitiHandlowyConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.CitiHandlowyConnectorSettings;

ApiClient apiClient = new ApiClient(
  new CitiHandlowyConnectorSettings()
    .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.CitiHandlowyConnectorSettings(
  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('CitiHandlowy', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for citiHandlowy

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

CofidisConnectorSettings

Settings for initializing ApiClient for COFIDIS (Portugal)

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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
clientId	string	true	The client Id

ColonyaConnectorSettings

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

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
clientId	string	true	Company id in the format PSD{country_code}-{NCA_code}-{PSP identifier} Eg. PSDFI-FINFSA-29884997
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)

ComdirectConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.ComdirectConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.ComdirectConnectorSettings(
  client_id="your-client-id",
  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",
  certPath: "your-cert-path",
  keyPath: "your-key-path"
}
const apiClient = new enablebanking.ApiClient('Comdirect', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for Comdirect

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

ComercialPortuguesConnectorSettings

Settings for initializing ApiClient for BANCO COMERCIAL PORTUGUES, SA (Portugal)

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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
clientId	string	true	The client Id

CommerzbankConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.CommerzbankConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.CommerzbankConnectorSettings(
  client_id="your-client-id",
  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",
  certPath: "your-cert-path",
  keyPath: "your-key-path"
}
const apiClient = new enablebanking.ApiClient('Commerzbank', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for Commerzbank

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

ConnectPayConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.ConnectPayConnectorSettings;

ApiClient apiClient = new ApiClient(
  new ConnectPayConnectorSettings()
    .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.ConnectPayConnectorSettings(
  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('ConnectPay', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for ConnectPay

Base type

ConnectorSettings

Fields

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

ConsorsBankConnectorSettings

Settings for initializing Consorsbank and BNP Paribas Wealth Management.

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
certPath	string	true	Path to QWAC certificate in PEM format.
keyPath	string	true	Path to QWAC certificate private key in PEM format.

ConsorsFinanzConnectorSettings

Settings for initializing ApiClient for Consors Finanz, BNP Paribas S.A. Niederlassung Deutschland (Germany).

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
country	string	true	Bank country.
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 public certificate 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	false	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

CoopBankDenmarkConnectorSettings

Code samples

package com.eb.sample;

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

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

Base type

ConnectorSettings

Fields

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

CoopPankConnectorSettings

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

CreatisConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.CreatisConnectorSettings;

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

import enablebanking

connector_settings = enablebanking.CreatisConnectorSettings(
  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"
)
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",
  certPath: "your-cert-path",
  keyPath: "your-key-path",
  signKeyPath: "your-sign-key-path",
  signPubKeySerial: "your-sign-pub-key-serial"
}
const apiClient = new enablebanking.ApiClient('Creatis', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for Creatis

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.

CreditAgricoleFRConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.CreditAgricoleFRConnectorSettings;

ApiClient apiClient = new ApiClient(
  new CreditAgricoleFRConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("your-client-id")
    .certPath("your-cert-path")
    .keyPath("your-key-path")
    .signCertPath("your-sign-cert-path")
    .signKeyPath("your-sign-key-path")
    .signPubKeySerial("your-sign-pub-key-serial")
    .brand("credit-agricole-branches")
    .sandbox(true);

import enablebanking

connector_settings = enablebanking.CreditAgricoleFRConnectorSettings(
  client_id="your-client-id",
  cert_path="your-cert-path",
  key_path="your-key-path",
  sign_cert_path="your-sign-cert-path",
  sign_key_path="your-sign-key-path",
  sign_pub_key_serial="your-sign-pub-key-serial",
  brand="credit-agricole-branches"
)
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",
  certPath: "your-cert-path",
  keyPath: "your-key-path",
  signCertPath: "your-sign-cert-path",
  signKeyPath: "your-sign-key-path",
  signPubKeySerial: "your-sign-pub-key-serial",
  brand: "credit-agricole-branches"
}
const apiClient = new enablebanking.ApiClient('CreditAgricoleFR', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for CreditAgricoleFR

Base type

ConnectorSettings

Fields

Name	Type	Required	Description
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.
signCertPath	string	true	Path to QSEAL public 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.
brand	string	true	One of available brands.
tppName	string	true	Name of the TPP using the connector.

CreditAgricoleITBusinessConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.CreditAgricoleITBusinessConnectorSettings;

ApiClient apiClient = new ApiClient(
  new CreditAgricoleITBusinessConnectorSettings()
    .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.CreditAgricoleITBusinessConnectorSettings(
  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('CreditAgricoleITBusiness', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for CreditAgricoleITBusiness

Base type

ConnectorSettings

Fields

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

CreditAgricoleITPersonalConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.CreditAgricoleITPersonalConnectorSettings;

ApiClient apiClient = new ApiClient(
  new CreditAgricoleITPersonalConnectorSettings()
    .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.CreditAgricoleITPersonalConnectorSettings(
  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('CreditAgricoleITPersonal', CONNECTOR_SETTINGS)

Settings for initializing ApiClient for CreditAgricoleITPersonal

Base type

ConnectorSettings

Fields

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

CreditAgricolePolandConnectorSettings

Code samples

package com.eb.sample;

import com.enablebanking.ApiClient;
import com.enablebanking.model.CreditAgricolePolandConnectorSettings;

ApiClient apiClient = new ApiClient(
  new CreditAgricolePolandConnectorSettings()
    .redirectUri("https://your-redirect-uri")
    .clientId("your-client-id")
    .signCertPath("your-sign-cert-path")
    .signKeyPath("your-sign-key-path")
    .signPubKeySerial("your-sign-pub-key-serial")
    .sandbox(true);

import enablebanking

connector_settings = enablebanking.CreditAgricolePolandConnectorSettings(
  client_id="your-client-id",
  sign_cert_path="your-sign-cert-path",
  sign_key_path="your-sign-key-path",
  sign_pub_key_serial="your-sign-pub-key-serial"
)
api_client = ApiClient(connector_settings)

const enabl