Flow description

Step 1: Authorize User's Accounts Consent

Authorizing access to client's personal banking data follows OAuth 2.0 Authorization Code Grant flow.

  1. Your application initiates the flow by directing user browser to the authorization endpoint. Initiation is carried out by making a GET.../auth/oauth/v2/authorize request (using /premium/sandbox or /premium/production as base URL).
  2. The bank authenticates user and establishes whether the user grants or denies your access request.
  3. Assuming user grants access, the bank server redirects the user browser to the result screen where the authorization code is displayed, or back to your application using the redirection URI provided during your application registration. In the latter case, the redirection URI includes an authorization code.
  4. Your application requests an access token from the bank server's token endpoint by including the authorization code received in the previous step. The authorization code exchange is carried out by making a POST.../auth/oauth/v2/token request.
  5. The bank server authenticates your application, validates the authorization code, and ensures that the redirection URI received matches the URI used to redirect your application in step 3. If valid, the bank server responds back with the access token and refresh token. Issued access token expires after 180 days, refresh token expires after 365 days.

Token validity

Issued token can be revoked by user or after time period e.g. 180 days. In this case the bank server responses with HTTP 401 Unauthorized to your API call.

Step 2: Get Consented Accounts List

  1. Your application can initiate GET /v1/accounts request with valid access token.
  2. The bank server validates access token and returns consented accounts list.
  3. Record the accountId parameter, since it is used as input for the other API methods.

Step 3: Get Account Information and Balances

  1. To provide user with detail information about account your application initiates GET.../v1/accounts/{account-id} request with valid access token.
  2. The bank server validates access token and returns account's detail and balances.

Step 4: Get Account Transactions History

  1. Your application requests account transaction history by GET.../v1/accounts/{account-id}/transactions with valid access token.
  2. The bank server validates access token and returns a page with account's transactions.

Pagination

Your application can provide a paginated response for transactions history that returns multiple transaction records. For a paginated responses, please ensure that the number of transaction records on a page (value of pageSize request parameter) are within reasonable limits.

Step 5: Refresh Expired Access Token

When the access token obtained through the authorization code grant expires, your application should attempt to get a new access and refresh token by calling POST.../auth/oauth/v2/token. For more information see Section 6 Refreshing an Access Token in of the OAuth 2.0 specification. If your application fails to get the access token by using a refresh token, your application would have to get your client to initiate a fresh authorization code grant using an existing consent