This page describes the details of how you can check whether funds are available on an end user's (PSU's) account, via Handelsbanken's PSD2 API.

An overview of the steps in these guidelines can be found here: Confirmation of Funds - flow chart

These guidelines are valid for the Live environment and Sandbox environment, however, please note that in the Live environment, the endpoints are requested with a TPP certificate (issued by a QTSP).

At the bottom of this page you’ll find Sandbox test data which has a variety of fictitious PSUs and their accounts so you can test our API before going Live.

Sandbox Gateway Host URL

When testing our API in our Sandbox environment, please ensure that the below base URL is used in the calls.

Live Data Gateway Host URL

When using our API 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 Confirmation of Funds 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. Validate Customer ConsentValidate End user (PSU) consent process using the Confirmation of Funds API.
• 5. Check availability of fundsCheck whether there are available funds or not, by using the Confirmation of Funds API.
• Sandbox test dataTest data documentation for Funds Confirmations.

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 CBPII.

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=CBPII&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/funds-confirmations/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 '{"account" : {"iban" : "SE5460000000000403333911"} }'

Response

HTTP/1.1 200 OK
{
  "consentId": "69b50cd4-33d9-47b6-bfe7-98aea7bda22d",
  "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 validate the PSU consent 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 Decoupled

SCA Redirect

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

curl -X PUT https://api.handelsbanken.com/openbanking/psd2/v1/funds-confirmations/consents/69b50cd4-33d9-47b6-bfe7-98aea7bda22d \
--key <Your private key file> \
--cert <Your public cert file> \
-H 'Authorization: Bearer QVQ6YTM2ZmYyMmIyYjFkMS00M2VlLTk5MWMt' \
-H 'Accept: 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 'X-IBM-Client-Id: f31b7318-8f21-4eaf-8817-6b5e4e02d6bc' 

Response

HTTP/1.1 200 OK
{
    "consentStatus": "VALID"
}

At this point, the PSU will have signed the consent and you will have validated it. By using a CCG token, the POST /funds-confirmations endpoint may now be called so you can retrieve confirmation on whether there are available funds in the customer's account. If you want to remove the PSU's consent, you do this via the endpoint DELETE /funds-confirmations/consents/{consentId}.

Please note: the CCG token from Step 1 should be sent in the “Authorization” HTTP-header, or you may need to request a new CCG token if the old one has expired.

curl -X POST https://api.handelsbanken.com/openbanking/psd2/v1/funds-confirmations \
--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 'X-IBM-Client-Id: f31b7318-8f21-4eaf-8817-6b5e4e02d6bc' \
-d '{
        "account" : {
            "iban" : "SE5460000000000403333911"
        },
        "consentId" : "69b50cd4-33d9-47b6-bfe7-98aea7bda22d",
        "instructedAmount" : {
                                "currency" : "SEK",
                                "amount" : 4321.50
                            },
        "payee" : "Betalningsmottagare AB"
    }'

Response

HTTP/1.1 200 OK
{
    "fundsAvailable": true
}

The Sandbox test data is designed to provide app development support.

Test Data documentation for CBPII

For guidance on how to make API requests, please follow the API documentation:

Confirmation of Funds API documentation