This page describes the details of how to initiate payments on the behalf of a PSU, via Handelsbanken's PSD2 API.

An overview of the steps in these guidelines can be found here: Payment Initiation - Authorization 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 that provides support for different payment types and responses 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 PaymentInitiate End user (PSU) Payment process using the Payment API.
• 3. Authorization Code GrantEnd user authorization using available SCA Approach(es) received in the payment initiation response.
•    - SCA DecoupledSCA Decoupled Authorization flow using Decoupled Grant (Mobile BankID) API.
•    - SCA RedirectSCA Redirect Authorization flow using Authorization Code Grant API.
• 4. Request payment executionRequest the execution of a payment after PSU has signed.
• 5. Get Payment statusCheck the status of the payment.
• Sandbox test dataTest data documentation for Payments.

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

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=PIS&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)

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

The above response is an example.

With the CCG, the payment can be initiated. The returned payment-id should be used in the next step (Step 3), when the end user (PSU) signs the payment.

curl -X POST https://api.handelsbanken.com/openbanking/psd2/v1/payments/{paymentproduct} \
--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 'PSU-Accept-Language: <ISO 639-1:2002 language name>'\
-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 '{"debtorAccount": {"value": "987654321","accountType": "BBAN"},"instructedAmount": {"currency": "SEK","amount": 100.45},"creditorAccount":{"value": "1234-5678","accountType": "BG"},"creditor": {"name": "Abc 123 AB"},"remittanceInformation":{"text": "12345678901234556677890"}}'

Response

HTTP/1.1 201 Created
{
  "paymentId": "58cdfef9-7f6e-476e-a1af-c54c0a9a3135",
  "transactionStatus": "ACTC",
  "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 payment.

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 payment initiation (Step 2: Initiate payment 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 Payment API 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

After you have implemented the authorization process (in the previous step), the PUT (request payment execution) endpoint of the Payment API 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.

Request

curl -X PUT https://api.handelsbanken.com/openbanking/psd2/v1/payments/{paymentproduct}/58cdfef9-7f6e-476e-a1af-c54c0a9a3135 \
--key <Your private key file> \
--cert <Your public cert file> \
-H 'Authorization: Bearer QVQ6MGQ2YmYtMmZjOC00Yzg3LzYyOGU0NTg5YmM3' \
-H 'Accept: application/json'\
-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' \

Important: Please remove unused optional parameters in the request. Sending a parameter with an empty value can cause the validation to fail due to an invalid parameter.

Please ensure you check out the Country specific information (which contains important business rules per country) and the Implementation Guidelines here Country specific Payment rules

Response

HTTP/1.1 201 Created
{
  "transactionStatus": "ACCC"
}

The above response is an example.

The execution of a payment may not happen instantaneously, if for example, it's a weekend / bank holiday. To find out if a payment has been executed successfully, you can check its status.

Please note: The "Authorization" HTTP-header accepts either the CCG token from Step 1 or the ACG/DG token from Step 3.

curl -X GET https://api.handelsbanken.com/openbanking/psd2/v1/payments/{paymentproduct}/58cdfef9-7f6e-476e-a1af-c54c0a9a3135/status \
--key <Your private key file> \
--cert <Your public cert file> \
-H 'Authorization: Bearer QVQ6MGQ2YmYtMmZjOC00Yzg3LzYyOGU0NTg5YmM3' \
-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 201 Created
{
    "paymentId": "58cdfef9-7f6e-476e-a1af-c54c0a9a3135",
    "transactionStatus": "ACCC",
    "reasonCode": "<reason code if payment rejected>",
    "reason": "<reason description if payment rejected>"
}

The above response is an example.

The Sandbox test data is designed to provide app development support so we have made available a variety of fictitious PSUs and payment profiles to test.

The payment test data consists of different payment types and responses from the Payment endpoints.

Test Data documentation for PISP

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

Payment Initiation API documentation