This documentation is for WSO2 Open Banking version 1.5.0. View documentation for the latest release.
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 35 Next »

Configure open-banking.xml files in both WSO2 Open Banking Key Manager(WSO2 OB KM) and WSO2 Open Banking API Manager(WSO2 OB APIM) components based on the configurations listed below.

The open-banking.xml files are in below locations:

  • <WSO2_OB_KM_HOME>/repository/conf/finance/open-banking.xml
  • <WSO2_OB_APIM_HOME>/repository/conf/finance/open-banking.xml

Do the following configurations in both the Key Manager and API Manager components and restart the servers.


Define the specification that you plan to deploy.

Possible values: UK, BERLIN, AU, STET


If you want to enable the event notification feature, set the <isEnabled> to true, and define the following configurations:

  • <TokenIssuer>: The URL from where the token is issued.
  • <NotificationExpiryTime>: The expiry time of the notification, in seconds.
  • <NotificationAPIUrl>: The URL of the event-notification endpoint which is exposed from API Manager.
  • <NumberOfSetsToReturn>: The maxEvents parameter in the polling request informs the ASPSP how many notifications the TPP wants to retrieve at a moment. When the maxEvents parameter is absent in the polling request,  NumberOfSetsToReturn defines this value.
  •  <SigningAlias>: The alias of the certificate that signs the notifications sent from ASPSP to TPP.  

To log the Consent Management API calls in JSON format:

  1. Set the LogConsentInformation configuration to true in <WSO2_OB_KM_HOME>/repository/conf/finance/open-banking.xml.



<DaysToExpireRequest>: In Multiple Authorisation, this parameter defines the number of days after which the system considers the consent as expired if the required authorisation is not given.

  • Shareable accounts - accounts that are accessible online.

<SharableAccountsRetrieveEndpoint>: Configures the endpoint to retrieve sharable accounts that required to list on the consent page.

  • Payable accounts - accounts from which a PSU can make a payment.

<PayableAccountsRetrieveEndpoint>: Configures the endpoint to retrieve payable accounts that required to list on the consent page.


In some banks, some PSUs may have a certain number of accounts, but not all accounts have the ability to be shared externally or to make a payment online. In a bank, the shareable account list and the payable account list can either be the same or different.

In the default WSO2 Open Banking solution, at least two APIs are expected to return shareable and payable accounts when passing the user_id, and the given JSON response must be returned. Then it automatically loads the accounts list in the consent page.

 "data": [
   "account_id": "1234-2345-3456-4567",
   "display_name": "1234-2345-3456-4567"
   "account_id": "9999-4345-8456-4567",
   "display_name": "9999-4345-8456-4567"

By default, mock backend deployed in WSO2_OB_APIM is configured. Required parameters can be passed as query parameters to those endpoints. An example of configuring the endpoint to retrieve payable accounts:


If you plan to implement the multi-authorization feature for the PISP flow, the payable account retrieval endpoint should return the following JSON response.

 "data": [{
   "account_id": "30080098971337",
   "display_name": "30080098971337",
   "authorizationMethod": "multiple",
   "authorizationUsers": [{
     "customer_id": "123",
     "user_id": "[email protected]@carbon.super"
     "customer_id": "456",
     "user_id": "[email protected]@carbon.super"

An example of configuring the endpoint to retrieve sharable accounts:


Enable Request-URI validation:

During account retrieval to validate AccountID against the AccountID in consent, add the following configurations under the <UK> element:

<!-- Validate AccountID with consented accountID in account retrieval -->

Configure the role to identify the customer care officers, who are able to access the customer care portal, and revoke the consents on behalf of customers.


The unique ID of the ASPSP to which the request is issued. The unique ID is issued by OBIE and corresponds to the Organization ID of the ASPSP in the Open Banking Directory. If the value does not match the expected value (based on the Client ID or network certificate of the caller), the ASPSP must reject the request with a 403 (Forbidden) status code.


According to the specification, the links to access the created resource must be returned, as follows.

"Links": {
   "Self": ""

In order to generate the self URL shown in the above JSON, configure the URLs of the exposed APIs, as shown in the below configuration.

   <!--configure the url to get details about the error-->

In order to improve the performance of the API Gateway, the consent validation responses for account information retrieval calls are cached.

  • <EnableConsentValidationCache>: Determines whether or not the consent validation cache is enabled at the API Gateway.
  • <ConsentValidationCacheExpiry>: The expiry time for the consent validation info cache, in seconds.
  • <DefaultCacheTimeout>: The time in which the cache times out, in seconds.

In the AISP flow, when the TPP invokes the account retrieval APIs, they can either use the /accounts/{consentId} or /accounts/{accountId}.

If they want to use consentId, the UseConsentIdInPath must be changed to true. By default, it works with the accountId.


The following configuration is used to handle release management of the deployed API specifications.

If the resource is created using the API specification version v2.0, that resource can only be accessed using API specifications v2.0 and above. 


Account permissions not supported by the ASPSP can be restricted for the TPP by specifying one or more permissions separated by a pipe (|). By default, no permissions are restricted.

E.g. ReadOffers|ReadPAN|ReadParty|ReadPartyPSU


WSO2 Open Banking supports Dynamic Client Registration (DCR) v1.0.0 and v3.2. According to the DCR version you run, configure the following under the <Server> element:



 Click here to see the parameter descriptions for the above-mentioned parameters...
  • <TokenAuthentication>: The supported authentication methods for the token endpoint. Possible values are private_key_jwt and tls_client_auth.
  • <ConnectionTimeout> and <ReadTimeout>: The time out values when connecting to the JWKS endpoint of the Open Banking directory to retrieve the JSON web keys related to the TPP.
  • <EndPointURL>: The endpoint URLs to access the REST APIs of the API Manager in order to create the application and service provider, and generate keys for the application.
  • <EnableURIValidation>: If true, validate the policy, client, terms of service, and logo URIs.
  • <EnableHostNameValidation>: True or false can be set as values to check the hostname of policy, client, terms of service, and logo URIs against the hostname of redirect URI.
  • <APISubscriptions>: Specify the context of the APIs that need to subscribe when the TPP registers through DCR. 
  • <UseSoftwareIdAsApplicationName>: Set the <UseSoftwareIdAsApplicationName> to true to use SoftwareID in SSA as the name of the application.

  • <MaximumInstructedAmount>: The maximum instructed amount allowed.
  • <PermittedFrequencyPattern>: Frequency patterns that are supported by the ASPSP can be configured as a regex pattern separated by a pipe (|). By default, the ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ regex is supported. If you want to change the default pattern, configure the regex pattern.
  • <AllowedAmountPattern>: The allowed pattern for payment amount in domestic stading orders. Default pattern is ^\d{1,13}\.\d{1,5}$
  • <AllowedCurrencyPattern>: The allowed currency pattern for domestic standing orders. Default pattern is ^[A-Z]{3,3}$
  • <MaximumFuturePaymentDays>: The maximum future date of a scheduled-payment.


    <!--Frequency patterns that are supported by the ASPSP can be configured as a regex pattern separated by
    a pipe (|). By default, ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$
    regex is supported. If you want to change the default pattern uncomment the following configuration
    and configure the regex pattern
    before v1.3.0, there was a configuration to configure restricted frequency pattern.
    But it is now deprecated <RestrictedFrequencyPattern></RestrictedFrequencyPattern> -->

    <!--The allowed pattern for configuring the amount for domestic standing orders-->
   <!-- <AllowedAmountPattern></AllowedAmountPattern>-->

    <!--The allowed pattern for configuring the currency for domestic scheduled payments-->


<CutOffDateTime>.<Enabled>: Set to true if the bank wants to enforce the CutOffDateTime behaviour for the payments.

<CutOffDateTime>.<CutOffDateTimePolicy>: Specify the preferred approach to handle the CutOffDateTime behaviour

<CutOffDateTime>.<DailyCutOffTime>: The daily request cut off time.

<CutOffDateTime>.<ExpectedExecutionTime>: If the SelectedPolicy is set to ACCEPT, the expected execution time for the next day.

<CutOffDateTime>.<ExpectedSettlementTime>: If the SelectedPolicy is set to ACCEPT, the expected settlement time for the next day.

    Configurations regarding the handling of Payment requests after a cut off DateTime
        <!--IsEnabled denotes whether a CutOffDateTime is to be enforced by the ASPSP -->
        <!--SelectedPolicy denotes the preferred Approach to handling requests past the CutOffDateTime.
         Allowed values are:
         1. REJECT - Reject all requests arriving past the DateTime value
         2. ACCEPT - Accept all requests arriving past the DateTime value and return ExpectedExecutionDateTime
         and ExpectedSettlementDateTime.
        <!--Expected format for all dates - hh:mm:ss.ffffff+|-hh:mm -->
        <!--The Daily time requests are to be cut off at -->
        <!--Need to be set if the SelectedPolicy is set to ACCEPT.
            The ExpectedExecutionTime and the ExpectedSettlementTime for the next day -->

The expiry time for the issuer certificate and the subjectDN of the sent transport certificate stored in cache.


In consent re-authentication of the accounts flow, during authorisation, the PSU is allowed to change the selected account. If the <EnableAccountUpdateByPSU> property is set to true, the account bound to the consent is updated during re-authentication. If set to false, the account is not updated.


If Mutual Transport Layer Security (MTLS) is terminated before the request reaches the Gateway, retrieve the TPP's certificate from the MTLS session and include as a transport certificate header. By default, the gateway expects ssl.client.auth.cert.X509 as the transport header. Include the value for the transport certificate header in TransportCertificateHeader under CertificateManagement element. See the sample configuration below.

        <!-- In order to enable the client certificate validation feature (Certificate Expiry, Signature and
        Revocation validation during MTLS), the following module needs to be engaged under the "Global Engaged
        Modules" section in the axis2.xml file.

        <module ref="mtlscertvalidator"/>

        <!--Set the value of the transport certificate header sent in the request if MTLS is terminated before the
        gateway default value is ssl.client.auth.cert.X509-->

The load balancer should not allow the TPP to send its certificate as a transport certificate header that is configured in the open-banking.xml under <TransportCertificateHeader> element. 

If such header was found in the TPP’s request, it is mandatory to remove that header from the TPP’s request. This is applicable even when the MTLS session is not terminated at the load balancer.


In order to enable certificate revocation validation for API security, make sure that the following configurations are added under the server root element.

	<!-- Expiry time for the cache (in seconds) for storing the validation result of the certificates-->
	<!-- Enable/Disable certificate OCSP and CRL validation. Default value has been set to true -->

  • <SigningConfiguration>: This configuration applies to request signing for x-jws-signature.
  • <Enable>: Determines whether or not to enable signing.
  • <TrustedAnchors>: The trusted anchor configuration. OBIE-specific trust anchor definitions.
  • <TrustedAnchors>.<Signing>: The trust anchor used in signing JOSE.
  • <TrustedAnchors>.<Validation>: Multiple values supported with the | delimiter. For example,|
  • <OrganizationId>: The OBIE organization ID.
  • <Algorithm>: The default signing algorithm is RS256. To support other algorithms, uncomment this property and specify the value.
  • <MandatedAPIs> : Define the API contexts that require x-jws-signature verification
    <!-- Enable Signing -->
            Trusted Anchor Configuration
   specific Trust Anchor definitions
            <!-- Trust Anchor used in signing JOSE -->
                Multiple values supported with `|` delimiter
                IE -|
        <!-- OBIE Organization Id -->
    <!-- Default Singing Algorithm is PS256, to support others uncomment line below -->

    <!-- The following specified APIs will be mandated for message signing. -->


Add the following configurations that specify the allowed signature algorithms in TPP requests. With this configuration, WSO2 Open Banking rejects the JWTs signed in algorithms that are not in the following list. If the configuration is not added, no validation occurs and any algorithm is passed through. Allowed values are;

  • PS256
To use a custom value for the LocalInstrument attribute in Payment API:
  • By default, the following configurations are disabled. To enable, uncomment the following and add relevant custom values. These custom values represent a local instrument or a local clearing option.
  • The <CustomValue> tag supports default local instrument values as well as defined custom values. 


By default, two factors (basic, and smsotp) are configured to engage when a TPP creates an application and generates keys. If you want to configure a different authentication factor as the second authentication factor, configure that authenticator as a federated authentication in WSO2_OB_KM and configure the name here.


Determines whether or not ACR is enabled.

  • <Server>: The server key configuration used for message signing purposes.
  • <Server>.<SigningCertificateAlias>: The certificate is under this alias.

  • <Server>.<SigningCertificateKid>: The KID value for signing the certificate.

  • <JWKS-Retriever>.<SizeLimit>: Maximum size limit for remote JWKSet retrieval.

  • <JWKS-Retriever>.<ConnectionTimeout>: Connection timeout for remote JWKSet retrieval.

  • <JWKS-Retriever>.<ReadTimeout>: Content read timeout for remote JWKSet retrieval.

  • <Cache>.<ModifiedExpiryMinutes>: JWKSet/Certificate cache after modification expiry time, in minutes.

  • <Cache>.<AccessedExpiryMinutes>: JWKSet/Certificate cache after accessed expiry time, in minutes.

        Server Key configuration
        used for singing purposes IE - message signing
        <!-- alias the certificate is under -->
        <!-- KID value for signing certificate -->
    <!-- Cache Configuration for Identity Retriever Cache -->

Debitor account validation checks the debitor account for the PSU in the initiation request.

trueDisables the debtor account validation to check if the debtor account for the PSU that is sent in the initiation request is valid.
falseThe bank back end checks if a valid account is sent as the debtor account when initiating the consent. Returns only valid account when calling payable accounts endpoint during authentication to retrieve the endpoints.
<!-- Configuration to disable debtor account validation in payments -->

ASPSP supports payment data permissions that give access to the TPP by specifying one or more permissions to access payment information, separated by a pipe(l).

By default, create permission is granted.


This is for the Data Reporting feature, to enable data publishing set the <Enabled> property value to true. So, the WSO2 Open Banking Business Intelligence can capture and summarize data. Replace the <WSO2_OB_BI_HOSTNAME> placeholder with the hostname of Open Banking Business Intelligence server.

	<!-- Include all configurations related to Data publishing -->
	<!-- Enable data publishing in WSO2 Open Banking-->
	<!-- Server URL of the remote BI server used to collect statistics. Must
            be specified in protocol://hostname:port/ format. -->
	<!-- Administrator username to login to the BI server for data publishing. -->
	<Username>[email protected]@carbon.super</Username>
	<!-- Administrator password to login to the BI server for data publishing. -->

To enable Transaction Risk Analysis, set the <IsEnabled> property under <TRA> to true. Replace the <WSO2_OB_BI_HOST> place holder with the hostname of Open Banking Business Intelligence server. Use the <AccountValidationEnabled> and <PaymentValidationEnabled> properties to enable TRA for Accounts and Payments respectively.

	<!-- Include all configurations related to Transaction Risk Analysis -->
	<!-- Enable TRA in WSO2 Open Banking-->
	<!-- following configurations are used to enable TRA for specific flows only-->
	<!-- Enable TRA for Payments-->
	<!-- Enable TRA for Accounts-->
	<!-- Configurations related to TRA Receivers-->
		<!-- Administrator username to login to the remote BI server. -->
		<Username>[email protected]@carbon.super</Username>
		<!-- Administrator password to login to the remote BI server. -->
		<!-- Receiver URLs of the Siddhi Apps used to validate for TRA.-->
    <!-- Number of maximum days of transaction history that can be accessed with the first-time consent use for Berlin.-->

You can enable the Fraud Detection feature by setting the <IsEnabled> value to true. Replace the <WSO2_OB_BI_HOST> placeholder with the hostname of WSO2 Open Banking Business Intelligence server.

	<!-- Include all configurations related to Fraud Detection -->
	<!-- Enable FD in WSO2 Open Banking-->
	<!-- Configurations related to FD Receivers-->
		<!-- Administrator username to login to the remote BI server. -->
		<Username>[email protected]@carbon.super</Username>
		<!-- Administrator password to login to the remote BI server. -->
		<!-- Receiver URLs of the Siddhi Apps used to validate for FD.-->

By default, the Consent Management APIs are secured with basic authentication. To access the Consent Management APIs, use the default user or create a new user using the Key Manager Management Console.

  1. Open the <WSO2_OB_APIM_HOME>/repository/conf/finance/open-banking.xml file.
  2. Update the credentials under <APISecurity><Global> with the created user details.

    By default, this is set to the username and password of the super admin.

    		<Username>[email protected]</Username>

For more information, see configuring basic authentication for Consent Management APIs.


By default, MTLS token binding is disabled in WSO2 Open Banking. To enable, locate <WSO2_OB_KM_HOME>/repository/conf/finance/open-banking.xml and change the <EnableMTLSTokenBinding> parameter value to true as follows:


Upon enabling the feature, you need to configure the client certificate header name in the <ClientAuthenticationHeader> parameter under <CertificateManagement>:

         <!--Mutual TLS Authenticator Certificate header-->
In addition to the above steps, follow the instructions described under MTLS bound access token.
  • No labels