Event Notification API v3.1.2

1. Navigate to the WSO2 Open Banking Developer portal at https://<WSO2_OB_APIM_HOST>:9443/devportal.

2. Select Applications in the menu. 
   
3. In the Sign-in form, click Create Account.
   
4. Provide a username and click Proceed Self Register.
   

5. Fill the Create New Account form to complete registration.

6. Read terms and conditions. Click the checkbox to agree to the terms and conditions.
   

7. Click Register.

1. Sign in to the Developer portal as the TPP at https://<WSO2_OB_APIM_HOST>:9443/devportal.

2. Enter the username and the password you entered when signing up as a TPP.  
   

3. Click Continue. 

The homepage of the Developer Portal is now displayed along with the published APIs.

1. Go to the Applications tab in the Developer Portal.  
   

2. Click ADD NEW APPLICATION.

   

3. Enter application details.

   WSO2 Open Banking currently authenticates the TPP applications using the Reference (Opaque) method.

   

4. Click SAVE. 

1. Go to the APIs tab in the Developer portal.
   

2. Select the Event Notification Subscription API.
   

3. Go to Subscriptions at the bottom of the API and select SUBSCRIBE.
   
4. Select the Application from the drop-down list, set the Throttling Policy and click SUBSCRIBE.
   

5. Once you subscribe, you can find the list of subscriptions in the bottom.
   

6. Follow step 2,3, 4 and 5 and subscribe to the Aggregated Event Polling API using your application.

Now that you have subscribed to the APIs, generate access tokens and invoke the API.

1. Sign in to WSO2 Open Banking Developer portal as a TPP user.

2. Go to the Applications tab and select the application you used to subscribe to the APIs.
   

3. Scroll down and select either of the following types of keys:

   1. Production Keys: Generates access tokens in the production environment.

   2. Sandbox Keys: Generates access tokens in the sandbox environment.

4. Click Manage at the bottom of the page.
   

5. Provide the requested information as defined below:  

   Field	Description
   Grant Types	These determine the credentials that are used to generate the access token. Code: This relates to the authorisation code grant type and is applicable when consuming the API as a user. Implicit: This is similar to the code grant type, but instead of generating code, this directly provides the access token. Refresh Token: This is to renew an expired access token. Client Credential: This relates to the client credentials grant type and is applicable when consuming the API as an application.
   Callback URL	This is the URL used by the TPP to receive the authorisation code sent from the Account Servicing Payment Service Provider (ASPSP), e.g: bank. The authorisation code can be used later to generate an OAuth2 access token.
   Application Certificate	This is the content between the BEGIN CERTIFICATE and END CERTIFICATE strings of the application certificate (.PEM).   If you have configured the OB certificates, for testing purposes, you can use the sample application certificate available here.

   

6. Click GENERATE KEYS to generate production or sandbox keys. It generates consumer key and consumer secret.

1. Once the client is successfully registered, sign in to WSO2 Open Banking Developer Portal and go to the Applications tab.

2. Select your client application from the Application List. 

3. You can view the keys you generated at the bottom of this page:
   

4. The Consumer Key shown above is the client ID of your application.

5. Now, generate the client assertion by signing the following JSON payload using the supported algorithms. 

   If you have configured the OB certificates, you may use the attached certificate and keys for signing and transports layer security testing purposes.

   The value of the aud claim should contain the same value as the Identity Provider Entity ID.

    Click here to view the Identity Provider Entity ID:

   1. Sign in to the Identity and Access Management console at  https://<WSO2_OB_IAM_HOST>t:9446/carbon . 
   2. In the Main menu, go to Home > Identity > Identity Providers > Resident.
   3. View the value in Resident Identity Provider > Inbound Authentication Configuration > OAuth2/OpenID Connect Configuration > Identity Provider Entity ID. By default this value is set to  https://<WSO2_OB_APIM>:8243/token .

6. Run the following cURL command in a command prompt to generate the access token. Update the placeholders with the relevant values. You need an 

   curl -X POST \
     https://<WSO2_OB_APIM_HOST>:8243/token \
     -H 'Cache-Control: no-cache' \
     -H 'Content-Type: application/x-www-form-urlencoded'   \
     --cert <PUBLIC_KEY_FILE_PATH> --key <PRIVATE_KEY_FILE_PATH> \
     -d 'client_id=<CLIENT_ID>&grant_type=client_credentials&scope=accounts%20payments%20fundsconfirmations&client_assertion=<CLIENT_ASSERTION_JWT>&client_assertion_type=urn%3Aietf%3Aparams%3Aoauth%3Aclient-assertion-type%3Ajwt-bearer&redirect_uri=<APPLICATION_CALLBACK_URL>'

   The access token is now generated.

   You can use the same cURL command to regenerate the access token.

GET /event-subscriptions

The TPP requests the ASPSP to retrieve its event-subscription resource.

PUT /event-subscriptions/{EventSubscriptionId}

The TPP to requests the ASPSP to update an event-subscription resource.

DELETE /event-subscriptions/{EventSubscriptionId}

The TPP requests the ASPSP to delete an event-subscription resource.

1. Once the client is successfully registered, sign in to WSO2 Open Banking Developer Portal and go to the Applications tab.

2. Select your client application from the Application List. 

3. You can view the keys you generated at the bottom of this page:
   

4. The Consumer Key shown above is the client ID of your application.

5. Now, generate the client assertion by signing the following JSON payload using the supported algorithms. 

   If you have configured the OB certificates, you may use the attached certificate and keys for signing and transports layer security testing purposes.

   The value of the aud claim should contain the same value as the Identity Provider Entity ID.

    Click here to view the Identity Provider Entity ID:

   1. Sign in to the Identity and Access Management console at  https://<WSO2_OB_IAM_HOST>t:9446/carbon . 
   2. In the Main menu, go to Home > Identity > Identity Providers > Resident.
   3. View the value in Resident Identity Provider > Inbound Authentication Configuration > OAuth2/OpenID Connect Configuration > Identity Provider Entity ID. By default this value is set to  https://<WSO2_OB_APIM>:8243/token .

6. Run the following cURL command in a command prompt to generate the access token. Update the placeholders with the relevant values. You need an 

   curl -X POST \
     https://<WSO2_OB_APIM_HOST>:8243/token \
     -H 'Cache-Control: no-cache' \
     -H 'Content-Type: application/x-www-form-urlencoded'   \
     --cert <PUBLIC_KEY_FILE_PATH> --key <PRIVATE_KEY_FILE_PATH> \
     -d 'client_id=<CLIENT_ID>&grant_type=client_credentials&scope=eventpolling&client_assertion=<CLIENT_ASSERTION_JWT>&client_assertion_type=urn%3Aietf%3Aparams%3Aoauth%3Aclient-assertion-type%3Ajwt-bearer&redirect_uri=<APPLICATION_CALLBACK_URL>'

   The access token is now generated.

   You can use the same cURL command to regenerate the access token.