This page describes the details of how to get access to a PSU's account information, via Handelsbanken's PSD2 APIs.

An overview of the steps in these guidelines: Account and Card Information - Authorization flow chart

The guidelines on this page are only valid for the Live environment.

For Sandbox testing, please follow this guide (as there are differences): Sandbox testing guide for AISP

Live Data Gateway Host URL

When using our APIs in the Live environment, please ensure that the below base URL is used in the calls. 

• StepsDescription
• 1. Create CCG tokenClient Credentials Grant Access Token request using the Client Credentials Grant API.
• 2. Initiate Customer ConsentInitiate End user (PSU) consent process using the Consent API.
• 3. Consent Authorization GrantEnd user authorization using available SCA Approach(es) received in the consent response.
•    - SCA DecoupledSCA Decoupled Authorization flow using Decoupled Grant (Mobile BankID) API.
•    - SCA RedirectSCA Redirect Authorization flow using Authorization Code Grant API.
• 4. Get Account/Card InformationCall the functional PSD2 APIs - Account Information or Card-Account Information.
• Sandbox test dataTest data documentation for Accounts & Cards.

The authorization process starts with requiring a Client Credentials Grant (CCG).
This is an access token that is specific for the requesting client-id and scope, e.g. the registered application and scope AIS.

curl -X POST https://api.handelsbanken.com/bb/gls5/oauth2/token/1.0 \
--key <Your private key file> \
--cert <Your public cert file> \
-H 'Accept: application/json' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'grant_type=client_credentials&scope=AIS&client_id=f31b7318-8f21-4eaf-8817-6b5e4e02d6bc'

The above request is an example against the Live environment.

See below for the type of information that needs to be in your request. Please make sure you replace the example values with the correct ones in your request.

Please also refer to the API documentation for the full definitions, descriptions and codes Client Credentials Grant (OAuth 2.0)

Response

HTTP/1.1 200 OK
{
    "access_token": "QVQ6M2NkMjUzMzMtZDZkZS00OGU1LTk0MzMtMmVhOTY5ZDA5YmU4",
    "expires_in": 123456,
    "token_type": "Bearer"
}

The above response is an example.

curl -X POST https://api.handelsbanken.com/openbanking/psd2/v1/consents \
--key <Your private key file> \
--cert <Your public cert file> \
-H 'Authorization: Bearer QVQ6M2NkMjUzMzMtZDZkZS00OGU1LTk0MzMtMmVhOTY5ZDA5YmU4' \
-H 'Accept: application/json'\
-H 'Content-Type: application/json' \
-H 'Country: <ISO 3166-1 country code>' \
-H 'TPP-Request-ID: <Unique identifier for the request>' \
-H 'TPP-Transaction-ID: <Unique identifier for the transaction>' \
-H 'PSU-Corporate-ID: <Corporate Identification>' \
-H 'PSU-Corporate-ID-Type: <Corporate ID Type>' \
-H 'X-IBM-Client-Id: f31b7318-8f21-4eaf-8817-6b5e4e02d6bc' \
-d '{"access":"ALL_ACCOUNTS"}'

Response

HTTP/1.1 200 OK
{
  "consentId": "22aa3559-577d-441c-b9e6-664ac3311a3e",
  "consentStatus": "RECEIVED",
  "scaMethods": [{
      "_links": {
        "authorization": [{
            "href": "https://api.handelsbanken.com/bb/gls5/decoupled/mbid/initAuthorization/1.0",
            "name": "decpld_mbid_1.0",
            "type": "application/json"
          }
        ]
      },
      "scaMethodType": "DECOUPLED"
    },
    {
      "_links": {
        "authorization": [{
          "href": "https://secure.handelsbanken.com/bb/gls5/oauth2/authorize/1.0",
          "name": "authorize_1.0",
          "type": "application/x-www-form-urlencoded"
        }]
      },
      "scaMethodType": "REDIRECT"
    }
  ]
}

The above response is an example from the Live environment.

Decoupled:
https://api.handelsbanken.com/bb/gls5/decoupled/mbid/initAuthorization/1.0
Redirect:
https://secure.handelsbanken.com/bb/gls5/oauth2/authorize/1.0

This is the step where the end user (PSU) signs the consent.

For the authorization process, the end user (PSU) should be able to choose among the type of authorization flows that are applicable to the specific country and customer type (Individual or Corporate customer). The applicable types of authorization flows are returned, including the URL to initiate the process, in the response of the consent initiation (Step 2: Initiate consent using CCG token).

On the successful completion of these processes, you will receive an access token which will be an Authorization Code Grant (ACG) for the Redirect Authorization flow or Decoupled Grant (DG) for the Decoupled Authorization flow. With this access token, you will be able to call the endpoints of the Account and Card Account APIs in the next step.

In the below links you can find more detailed technical information and the next steps so you can implement the different authorization processes.

SCA Redirect

SCA Decoupled

Important: not all countries support both SCA methods. See here for which methods are applicable per country SCA Methods

After you have implemented the authorization process (in the previous step), the endpoints of the Account / Card Account Information APIs may now be called with either the ACG or the DG access token.

Please note: the access token from the previous step (Step 3) should be sent in the “Authorization” HTTP-header.

In the below links, you can find our API documentation (definitions, descriptions and codes):

Account Information API documentation

Card Account Information API documentation

and country specific information (which contains important business rules per country):

Country specific Account rules

Country specific Card Account rules

The Sandbox test data is designed to provide app development support, so we have made variety of fictitious PSUs and their accounts available to test.

The account profiles contain different response data with common account and transaction data. We have also included data that contains the maximum field lengths and number of transactions for each customer category (Individuals and Corporates) per country.

Sandbox testing guide for AISP