Provide a valid phone number with the country code to complete the two-factor authentication (e.g., +44 xxxxxxxxxx for a UK phone number).
Click Register.
Validate your account details by accessing the one-time login URL that you received via email.
cURL: You need cURL on your machine so that you can make API calls using the command line.
A web browser: You need a web browser to work with the customer consent approval process.
Let's get started!
Auitabs
direction
horizontal
Auitabspage
title
AISP
AISP Flow
Imagine that you are an administrator at AccPro (the AISP) responsible for subscribing to ABC Bank's APIs that expose customers' account and transaction data. Let's take a look at the tasks you need to perform to consume these APIs.
Table of Content Zone
minLevel
3
location
top
Anchor
AISP-Sign-In
AISP-Sign-In
Step 1 - Sign in
Follow the steps below to sign in to the WSO2 Open Banking live demo:
Go to the Home page and click Try Developer Portal > App (Sandbox). Image Added The API Storewith the available APIs you can try appears.
Click Sign in in the upper right corner and sign in with your wso2.com account details. Image Added
Step 2 - Create an application
Follow the steps below to create an applicationwith which you can subscribe to APIs:
WSO2 Open Banking comes with a sample application named DefaultApplication, which has a service-level agreement (SLA) with unlimited access.
Click Add Application. Image Added
Enter a name for the application and click Add to create the application.
Tip
You can select an SLA via the Per Token Quota dropdown, e.g., 50PerMin. If you do not select an SLA, the default SLA, which is unlimited will be applied.
Image Added After the application is created, the application details page appears.
Image Added
Anchor
AISP-Step3
AISP-Step3
Step 3 - Subscribe to an API
Follow the steps below to subscribe to an API via an application:
Click APIs to view all the available WSO2 Open Banking APIs. Image Added
Click the AccountsInformationAPI API. Image Added
Select the application that you created from the Applications drop-down. If you did not create an application, select the DefaultApplication. Image Added
Click Subscribe. A message appears to confirm that you have successfully subscribed to the API. Click View Subscriptions. Image Added The Subscriptions tab of the Application Details page appears. Image Added
Anchor
AISP-Step4
AISP-Step4
Step 4 - Generate an application access token
Follow the steps below to generate the application access tokenand the security keys with which you can invoke an API:
Click Sandbox Keys tab on the Application Details page.
Enter the required information.
Field
Purpose
Grant Types
This determines the credentials used to generate the access token. There are two types of grant typesavailable in the WSO2 Open Banking live demo:
Client Credentials: This relates to the Client Credentials grant type and is applicable when consuming the API as an application.
Code: This relates to the Authorization Code grant type and is applicable when consuming the API as a user.
Callback URL
This is the URL used by AccPro to receive the authorization code sent from the ABC Bank.
Scopes
Scopes enable fine-grained access control to API resources based on user roles. Select the accounts : accounts scope.
Validity Period
This defines the access token's validity period after which it requires regeneration. You can keep the default value, which is 3600 seconds.
Tip
If you set the validity period to a minus value, e.g., -1, the token never expires.
Click Generate Keys. This generates an access token, consumer key, and consumer secret.
Image Added
Step 5 - Consume an API
Now that you have your access token, follow the steps below to invoke the AccountsInformationAPI and obtain the account information:
Enter the verification code that you received via SMS to the mobile number that you gave at the time of signing up to wso2.com. This serves as the second factor of SCA. Image Added After the authentication process is complete, you are directed to the customer consent approval process.
Click Approve to allow sharing of customer data.
Image Added
After the consent process is approved, the authorization code appears. Image Added
Copy the cURL command shown below and update the placeholders as follows:
<client-ID>:<client-secret>: Replace the <client-ID> and the <client-secret> with the consumer key and the consumer secret you generated in Step 4respectively. Make sure to keep the colon (:) separator between them.
<client-ID>: Again, replace the <client-ID> with the consumer key.
<authorization-code>: Replace this with the authorization code, e.g., 2b602c70-6a6e-3e96-9132-8570aaad4458.
<redirect-URL>: Replace this with the Callback URL that you used to generate the keys, e.g., https://openbanking.wso2.com/authenticationendpoint/authorize_callback.do.
Note
You can only use the authorization code once.
Localtabgroup
Localtab
active
true
id
format-access-token
Formatexample-access-tokenExample
Paste the updated cURL command in the command prompt to generate the user access token with the consented privileges.
Example:
Now, try out other API resources with the generated user access token.
trueac-info-apisAPIs used by usersWhen accessing the following API resources, use the user access token you generated.
GET /accounts/{AccountId}/beneficiaries
GET /accounts/{AccountId}/direct-debits
GET /accounts/{AccountId}/standing-orders
GET /accounts/{AccountId}/balances
GET /accounts/{AccountId}/product
GET /accounts/{AccountId}/transactions
GET /accounts
GET /accounts/{AccountId}
paymt-apisAPIs used by applicationsWhen accessing the following API resources, use the access token you generated using the Client Credentials grant type and accounts : accounts scope in .
POST /account-initiations
DELETE /account-initiations/{AccountRequestId}
GET /account-initiations/{AccountRequestId}
Auitabspage
title
PISP
PISP Flow
Imagine that you are an administrator at TransacPro (the PISP) responsible for subscribing to ABC Bank's APIs to initiate credit transfers on behalf of the ABC Bank's customers. Let's take a look at the tasks you need to perform to consume these APIs.
3top
PISP-Step1Step 1 - Sign in
Follow the steps below to sign in to the WSO2 Open Banking live demo:
Go to the Home page and click Try Developer Portal > App (Sandbox). The API Store with the available APIs you can try appears.Click Sign in in the upper right corner and sign in with your wso2.com account details.
Step 2 - Create an application
Follow the steps below to create an application with which you can subscribe to APIs:
Click Applications on the WSO2 Open Banking live demo to view all the . WSO2 Open Banking comes with a sample application named DefaultApplication, which has a with unlimited access, by default.Click Add Application.
Enter a name for the application and click Add to create an application.
If you like you can select an SLA via the Per Token Quota dropdown, e.g., 50PerMin. If you do not select an SLA, the default SLA, which is unlimited will be applied
After the application is created, the application details page appears.
PISP-Step3Step 3 - Subscribe to an API
Follow the steps below to subscribe to an API via an application:
Click APIs to view all available WSO2 Open Banking APIs. Click the PaymentsAPI v1.0.0 API. Select the application that you created from the Applications drop-down. If you did not create an application, select DefaultApplication. Click Subscribe. A message appears to confirm that you have successfully subscribed to the API. Click View Subscriptions. The Subscriptions tab of the Application Details page appears.
PISP-Step4Step 4 - Generate an application access token
Follow the steps below to generate the and the security keys with which you can create a user access token:Click Sandbox Keys tab on the Application Details page.
Enter the required information.
Field
Purpose
Grant Types
This determines the credentials used to generate the access token. There are two types of grant types available in the WSO2 Open Banking live demo:
Client Credentials: This relates to the Client Credentials grant type and is applicable when consuming the API as an application.
Code: This relates to the Authorization Code grant type and is applicable when consuming the API as a user.
Callback URL
This is the URL used by TransacPro to receive the authorization code sent from the ABC Bank.
Scopes
Scopes enable fine-grained access control to API resource based on user roles. Select payments : payments.
Validity Period
This defines the access token's validity period after which it requires regeneration. You can keep the default value, which is 3600 seconds.
If you set the validity period to a minus value, e.g., -1, the token never expires
Click Generate Keys.
This generates an access token, consumer key, and consumer secret, which you can use in token generation API calls.
Step 5 - Consume an API
Now that you have your access token, follow the steps below to invoke the PaymentsAPI API and post payments:
Select the application you used to subscribe to the PaymentsAPI API from the Try dropdown. The previously generated access token appears by default.
Click POST /payment-initiation to expand the POST /payment-initiation API resource.Enter the application access token you generated in to the Authorization : Bearer field.
Enter the sample values given in the UI to x-idempotency-key, x-jws-signature, x-fapi-interaction-id, x-fapi-financial-id, and body fields.
Click Try it out. A 201 response appears upon a successful API invocation.
Copy the PaymentID that is returned from the API call so that you can use it for other API invocations.
PISP-What'sNextWhat's Next?
Follow the steps below to generate a using the client key and the client secret: Copy the URL shown below and update the placeholders as follows: <client-ID>: Replace this with the consumer key that you generated in , e.g., fAIwK4n9QKKHIoGOv1DF6eUOkiMa.<riderect-URL>: Replace thiswith the Callback URL that you used when generating the kes in , e.g., https://openbanking.wso2.com/authenticationendpoint/authorize_callback.do.trueAISPURL FormatPISPURL Sample
Paste the updated URL on your browser to navigate to the ABC Bank's open banking system.
When prompted, sign in using your wso2.com credentials. This is the first factor of . Enter the verification code that you received via SMS to the mobile number that you gave at the time of signing up to wso2.com. This serves as the second factor of SCA. After the authentication process is complete, you are directed to the customer consent approval process.
Click Approve to perform the transaction.
After the consent process is approved, the authorization code appears.
Copy the cURL command shown below and update the placeholders as follows:
<client-ID>:<client-secret>: Replace the <client-ID> andthe <client-secrent> with the consumer key and the consumer secret you generated in respectively. Make sure to keep the colon (:) separator between them.
<client-ID>: Again, replace the <client-ID> withthe consumer key.
<authorization-code>: Replace this with the authorization code, e.g., 2b602c70-6a6e-3e96-9132-8570aaad4458.
<redirect-URL>: Replace this with the Callback URL that you used to , e.g., https://openbanking.wso2.com/authenticationendpoint/authorize_callback.do .
Now, try out other API resources with the generated user access token.
Localtabgroup
Localtab
active
true
id
ac-info-apis
title
APIs used by users
When accessing the following API resources, use the user access token you generated.
GET /accounts/{AccountId}/beneficiaries
GET /accounts/{AccountId}/direct-debits
GET /accounts/{AccountId}/standing-orders
GET /accounts/{AccountId}/balances
GET /accounts/{AccountId}/product
GET /accounts/{AccountId}/transactions
GET /accounts
GET /accounts/{AccountId}
Localtab
id
paymt-apis
title
APIs used by applications
When accessing the following API resources, use the access token you generated using the Client Credentials grant type and accounts : accounts scope in Step 4.
POST /account-initiations
DELETE /account-initiations/{AccountRequestId}
GET /account-initiations/{AccountRequestId}
PISP Flow
Imagine that you are an administrator at TransacPro (the PISP) responsible for subscribing to ABC Bank's APIs to initiate credit transfers on behalf of the ABC Bank's customers. Let's take a look at the tasks you need to perform to consume these APIs.
Table of Content Zone
minLevel
3
location
top
Anchor
PISP-Step1
PISP-Step1
Step 1 - Sign in
Follow the steps below to sign in to the WSO2 Open Banking live demo:
Go to the Home page and click Try Developer Portal > App (Sandbox). Image Added The API Store with the available APIs you can try appears.
Click Sign in in the upper right corner and sign in with your wso2.com account details. Image Added
Step 2 - Create an application
Follow the steps below to create an application with which you can subscribe to APIs:
WSO2 Open Banking comes with a sample application named DefaultApplication, which has a service-level agreement (SLA) with unlimited access, by default.
Click Add Application. Image Added
Enter a name for the application and click Add to create an application.
Tip
If you like you can select an SLA via the Per Token Quota dropdown, e.g., 50PerMin. If you do not select an SLA, the default SLA, which is unlimited will be applied
Image Added
After the application is created, the application details page appears. Image Added
Anchor
PISP-Step3
PISP-Step3
Step 3 - Subscribe to an API
Follow the steps below to subscribe to an API via an application:
Click APIs to view all available WSO2 Open Banking APIs. Image Added
Click the PaymentsAPI v1.0.0 API. Image Added
Select the application that you created from the Applications drop-down. If you did not create an application, select DefaultApplication. Image Added
Click Subscribe. A message appears to confirm that you have successfully subscribed to the API. Click View Subscriptions. Image Added The Subscriptions tab of the Application Details page appears. Image Added
Select the application you used to subscribe to the PaymentsAPI API from the Try dropdown. The previously generated access token appears by default.
Click POST /payment-initiation to expand the POST /payment-initiation API resource.
Enter the application access token you generated in Step 4 to the Authorization : Bearer field.
Enter the sample values given in the UI to x-idempotency-key, x-jws-signature, x-fapi-interaction-id, x-fapi-financial-id, and body fields.
Click Try it out. A 201 response appears upon a successful API invocation.
Tip
Copy the PaymentID that is returned from the API call so that you can use it for other API invocations.
Anchor
PISP-What'sNext
PISP-What'sNext
What's Next?
Follow the steps below to generate a user access token using the client key and the client secret:
Copy the URL shown below and update the placeholders as follows:
<client-ID>: Replace this with the consumer key that you generated in Step 4, e.g., fAIwK4n9QKKHIoGOv1DF6eUOkiMa.
<riderect-URL>: Replace thiswith the Callback URL that you used when generating the kes in Step 4, e.g., https://openbanking.wso2.com/authenticationendpoint/authorize_callback.do.
Enter the verification code that you received via SMS to the mobile number that you gave at the time of signing up to wso2.com. This serves as the second factor of SCA. Image Added After the authentication process is complete, you are directed to the customer consent approval process.
Click Approve to perform the transaction.
Image Added
After the consent process is approved, the authorization code appears.
Image Added
Copy the cURL command shown below and update the placeholders as follows:
<client-ID>:<client-secret>: Replace the <client-ID> andthe <client-secrent> with the consumer key and the consumer secret you generated in Step 4 respectively. Make sure to keep the colon (:) separator between them.
<client-ID>: Again, replace the <client-ID> withthe consumer key.
<authorization-code>: Replace this with the authorization code, e.g., 2b602c70-6a6e-3e96-9132-8570aaad4458.
<redirect-URL>: Replace this with the Callback URL that you used to generate the keys, e.g., https://openbanking.wso2.com/authenticationendpoint/authorize_callback.do.
Now, try out other API resources of the PaymentsAPI API.
Localtabgroup
Localtab
id
paymt-apis
title
APIs used by users
When accessing the following API resources, use the user access token you generated.
POST /payment-submissions
GET /payment-submissions/{PaymentSubmissionId}
Localtab
id
payment-apis
title
APIs used by applications
When accessing the following API resources, use the access token you generated using the Client Credentials grant type and the payments : payments scope in Step 4.