Skip to content

Latest commit

 

History

History
 
 

tpp-as-aisp

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
v1.0.0
v1.0.0
 
 
README.md
README.md
 
 
deployment.jpg
deployment.jpg
 
 

README.md

WSO2 Financial Solutions Demonstration for TPPs

This docker setup demonstrates the capabilities that WSO2 Platform provides for TPPs in Open Banking.

Demo Flow

Setup Diagram

  1. User will log into TPP App (an AISP app) via OIDC with the Identity Server at TPP side
  2. TPP IS will use federation to authenticate the user via the Banks Identity Provider (in this demo will use an all in one APIM for this)
  3. TPP app will use the token received from OIDC, to invoke the API which is exposed via the APIM in TPP side (APIs secured via OAuth2)
  4. TPP APIM will call the API in EI which is exposed in a Standard format
  5. EI will perform the necessary mediations, and map the API request to the standard expected by the back end banks and vise versa

Versions

  • v1.0.0 - Setup using
    • MySQL v5.6
    • WSO2 API Manager 2.1.0
    • WSO2 Identity Server as Key Manager 5.3.0
    • WSO2 Enteprise Integrator 6.1.1
    • Apache Tomcat 8.5.27.0
    • Nginx 1.10.3 (Ubuntu)

How to run

  1. Add the following host entries in your local machine (i.e. Host Machine).
127.0.0.1       api.silverbank.com
127.0.0.1       api.goldbank.com
127.0.0.1       identity.tpp.com
127.0.0.1       integration.tpp.com
127.0.0.1       api.tpp.com
127.0.0.1       aisp.tpp.com

  1. Install docker into your setup environment.

  2. Clone this Git repository. If you need to download only this demo scenario follow this blog.

  3. Depending on the demo version you choose to run, download the desired wso2am-x.x.x.zip , wso2is-km-x.x.x.zip and wso2ei-x.x.x.zip WUM updated zip files.

  4. Copy the above zip file into presales-demos/finacial-solutions/tpp-demo/vX.X.X/packs/ location.

  5. Go to presales-demos/finacial-solutions/tpp-demo/vX.X.X/ location and run the following commands.

    ## Below command will build and run the full setup.
docker-compose build
docker-compose up

    Optional
    If you need to start the services as background processes execute the following command.

    docker-compose up -d

    If you need to build the images individually you can execute the commands in-order as following.

    docker-compose build demo-base
docker-compose build mysql-service
docker-compose build bank-apim-service
docker-compose build tpp-is-service
docker-compose build tpp-ei-service
docker-compose build tpp-apim-service
docker-compose build tpp-webapp
docker-compose build nginx

    To run the services individually you can execute the commands in-order as following.

    docker-compose up demo-base
docker-compose up mysql-service
docker-compose up tpp-is-service
docker-compose up bank-apim-service
docker-compose up tpp-ei-service
docker-compose up tpp-apim-service
docker-compose up tpp-webapp
docker-compose up nginx

  6. To stop the services execute the following command.

    docker-compose down

AISP Login demo

  1. To access the TPP AISP app, go to https://aisp.tpp.com/

  2. You will be redirected to TPP Identity server and there you have the option to use the federated login from Silver Bank Identity Provider (i.e api.silverbank.com). Credentials are;

    username : tomer
password : tomer

How to Invoke the APIs

There are two backend APIs as described in the above image. Silver Banks API is exposed via an APIM with OAuth2 and OpenBanking standard. Gold Banks API has their own standard with Username/Password security. More information on the payload transformations can be found in the appendix

Both these can be invoked from the TPP API Store which can be accessed by https://api.tpp.com/store (i.e AccountInformationAPI - 1.0.0).

Note: You can use the token generated in the login flow (displayed in User Info page) to invoke the APIs

Sample values to be used in API Calls

POST /account-requests

  • body
{
  "Data": {
    "Permissions": [
      "ReadAccountsBasic"
    ],
    "ExpirationDateTime": "2018-03-05T08:47:29.170Z",
    "TransactionFromDateTime": "2018-03-05T08:47:29.170Z",
    "TransactionToDateTime": "2018-03-05T08:47:29.170Z"
  },
  "Risk": {}
}

Common for POST /account-requests, GET /accounts, GET /accounts/{AccountID}

  • x-fapi-financial-id : 2134
  • x-fapi-interaction-id : 85bac548-d2de-4546-b106-880a5018460c
  • authorization: Bearer <GENERATED_TOKEN>
  • x-jws-signature : eyJhbGciOiJSUzI1NiJ9.ewogICJEYXRhIjogewogICAgIkluaXRpYXRpb24iOiB7CiAgICAgICJJbnN0cnV.SNwqXIAoR
  • x-bank-code : SILVER or GOLD

Troubleshooting

  1. The setup use self signed certificates for all the host names. Hence there will be warnings in the browser when you access particular URLs. You can fix that by accepting the certificate to your browser.

Appendix

API Transformations for GOLD bank APIs

Conversion of the payload when invoking Gold Banks API for POST /account-requests

Request

From;

    {
       "Data":{
          "Permissions":[
             "ReadAccountsBasic"
          ],
          "ExpirationDateTime":"2018-03-05T08:47:29.170Z",
          "TransactionFromDateTime":"2018-03-05T08:47:29.170Z",
          "TransactionToDateTime":"2018-03-05T08:47:29.170Z"
       },
       "Risk":{
    
       }
    }

To;

    {
       "AccessInformation":{
          "RequestedPermissions":[
             "ReadAccountsBasic"
          ],
          "Expiration":"2018-03-05T08:47:29.170Z",
          "TransactionFrom":"2018-03-05T08:47:29.170Z",
          "TransactionTo":"2018-03-05T08:47:29.170Z"
       }
    }

Response

From;

    {
       "AccessInformation":{
          "AccessId":"3146",
          "Status":"Pending",
          "CreatedOn":"Mon Mar 05 09:15:51 UTC 2018",
          "AccessPermissions":[
             "ReadAccountsBasic",
             "ReadAccountsDetail",
             "ReadTransactionsDetail",
             "ReadTransactionsCredits",
             "ReadTransactionsDebits",
             "ReadStandingOrdersDetail",
             "ReadBeneficiariesDetail",
             "ReadDirectDebits",
             "ReadProducts",
             "ReadBalances"
          ]
       }
    }

To;

    {
       "Data":{
          "AccountRequestId":"3146",
          "Status":"Pending",
          "CreationDateTime":"Mon Mar 05 09:15:51 UTC 2018",
          "Permissions":[
             "ReadAccountsBasic",
             "ReadAccountsDetail",
             "ReadTransactionsDetail",
             "ReadTransactionsCredits",
             "ReadTransactionsDebits",
             "ReadStandingOrdersDetail",
             "ReadBeneficiariesDetail",
             "ReadDirectDebits",
             "ReadProducts",
             "ReadBalances"
          ],
          "self":"/account-requests/3146"
       },
       "Meta":{
          "copyright":"open-banking copyright",
          "totalPages":1
       }
    }

Conversion of the payload when invoking Gold Banks API for GET /accounts

Response

From;

    {
       "Accounts":[
          {
             "AccountId":"34568",
             "Currency":"GBP",
             "Nickname":"Bills",
             "Account":{
                "SchemeName":"BBAN",
                "Identification":"10203345",
                "Name":"Mr Tom",
                "SecondaryIdentification":"00021"
             }
          },
          {
             "AccountId":"41825",
             "Currency":"GBP",
             "Nickname":"Household",
             "Account":{
                "SchemeName":"BBAN",
                "Identification":"10203348",
                "Name":"Mr Tom"
             }
          }
       ]
    }

To;

    {
       "Data":{
          "Account":[
             {
                "Account":{
                   "SecondaryIdentification":"00021",
                   "SchemeName":"BBAN",
                   "Identification":"10203345",
                   "Name":"Mr Tom"
                },
                "AccountId":"34568",
                "Currency":"GBP",
                "Nickname":"Bills"
             },
             {
                "Account":{
                   "SchemeName":"BBAN",
                   "Identification":"10203348",
                   "Name":"Mr Tom"
                },
                "AccountId":"41825",
                "Currency":"GBP",
                "Nickname":"Household"
             }
          ]
       },
       "Links":{
          "self":"/accounts/"
       },
       "Meta":{
          "copyright":"open-banking copyright",
          "totalPages":1
       }
    }

Conversion of the payload when invoking Gold Banks API for GET /accounts/{AccountID}

Response

From;

    {
       "Account":{
          "AccountId":"34568",
          "Currency":"EURO",
          "Nickname":"Bills",
          "Account":{
             "SchemeName":"BBAN",
             "Identification":"10203345",
             "Name":"Mr Tom",
             "SecondaryIdentification":"00021"
          }
       }
    }

To;

    {
       "Data":{
          "Account":[
             {
                "Account":{
                   "SecondaryIdentification":"00021",
                   "SchemeName":"BBAN",
                   "Identification":"10203345",
                   "Name":"Mr Tom"
                },
                "AccountId":"34568",
                "Currency":"EURO",
                "Nickname":"Bills"
             }
          ]
       },
       "Links":{
          "self":"/accounts/34568"
       },
       "Meta":{
          "copyright":"open-banking copyright",
          "totalPages":1
       }
    }