How to use the ASPSP API

Copy page

This API is used to retrieve information about supported Account Servicing Payment Service Providers (ASPSP) that Open Payments Platform currently support. You will also get information about the specific ASPSP that will be used to call the other APIs.

Hosts

Available AUTH_HOST values

Environment	URL
Sandbox	https://auth.sandbox.openbankingplatform.com
Production	https://auth.openbankingplatform.com

Available API_HOST values

Environment	URL
Sandbox	https://api.sandbox.openbankingplatform.com
Production	https://api.openbankingplatform.com

Account Servicing Payment Service Provider (ASPSP) Flow

Acquire an access token for ASPSP Information

Code
 
curl -X POST
    [AUTH_HOST]/connect/token
    -H 'Content-Type: application/x-www-form-urlencoded'
    -d 'client_id=[CLIENT_ID]&client_secret=[CLIENT_SECRET]&scope=aspspinformation private&grant_type=client_credentials'

This post will return a JSON object that looks like this:

Code
 
{
    "access_token": "[ACCESS_TOKEN]",
    "expires_in": 3600,
    "token_type": "Bearer",
    "scope": "aspspinformation private"
}

Bring the ACCESS_TOKEN forward to subsequent calls.

Get Country List

Code
 
curl -X GET
    [API_HOST]/psd2/aspspinformation/v1/countries
    -H 'Authorization: Bearer [ACCESS_TOKEN]'
    -H 'X-Request-ID: [GUID]'

Query parameters

• isoCountryCodes a comma separated list of countries to retrieve. Optional.

Response

Code
 
{
    "countries": [
        {
            "isoCountryCode": "SE",
            "name": "Sweden"
        },
        {
            "isoCountryCode": "FI",
            "name": "Finland"
        }
    ]
}

Where the country code and name will be according to the ISO 3166-1 alpha-2 standard.

Get Country Details

Code
 
curl -X GET \
    [API_HOST]/psd2/aspspinformation/v1/countries/[COUNTRY_CODE]
    -H 'Authorization: Bearer [ACCESS_TOKEN]'
    -H 'X-Request-ID: 6ff9e7ee-2ac2-42d3-a188-c7314d434b9c'

Path parameter

The COUNTRY_CODE parameter should be one of the codes in the ISO 3166-1 alpha-2 standard.

Response

Code
 
{
    "isoCountryCode": "SE",
    "name": "Sweden"
}

This is exactly the same as in the country list.

Get City List

Code
 
curl -X GET
    [API_HOST]/psd2/aspspinformation/v1/cities
    -H 'Authorization: Bearer [ACCESS_TOKEN]'
    -H 'X-Request-ID: [GUID]'

Query parameters

• isoCountryCodes a comma separated list of countries to retrieve cities for. Optional.

The service will return all matches for the queries. So querying for SE and ba9dd929-1408-33a6-3ce2-bc45fcfaaa5c will result in both Stockholm and Helsinki being returned.

Response

Code
 
{
    "cities": [
        {
            "cityId": "37efa883-c8ad-4ff7-927b-b11b02beb923",
            "name": "Stockholm",
            "isoCountryCode": "SE"
        },
        {
            "cityId": "ba9dd929-1408-33a6-3ce2-bc45fcfaaa5c",
            "name": "Helsinki",
            "isoCountryCode": "FI"
        }
    ]
}

Get City Details

Code
 
curl -X GET
    [API_HOST]/psd2/aspspinformation/v1/cities/[CITY_ID]
    -H 'Authorization: Bearer [ACCESS_TOKEN]'
    -H 'X-Request-ID: [GUID]'

Path parameter

CITY_ID should be one of the ids returned from the "get cities" endpoint.

Response

Code
 
{
    "cityId": "37efa883-c8ad-4ff7-927b-b11b02beb923",
    "name": "Stockholm",
    "isoCountryCode": "SE"
}

This is exactly as one item in the list returned from the "get cities" endpoint.

Get ASPSP List

Code
 
curl -X GET
    [API_HOST]/psd2/aspspinformation/v1/aspsps
    -H 'Authorization: Bearer [ACCESS_TOKEN]'
    -H 'X-Request-ID: [GUID]'

Query parameters

• isoCountryCodes a comma separated list of countries to retrieve ASPSPs for. Optional.

The service will return all matches for the query.

Response

Code
 
{
    "aspsps": [
        {
            "bicFi": "ESSESESS",
            "name": "Skandinaviska Enskilda Banken AB",
            "logoUrl": "https://openbankingplatform.blob.core.windows.net/image/ESSESESS.png"
        },
        {
            "bicFi": "NDEASESS",
            "name": "Nordea Bank AB",
            "logoUrl": "https://openbankingplatform.blob.core.windows.net/image/NDEASESS.png"
        },
        {
            "bicFi": "HANDSESS",
            "name": "Handelsbanken",
            "logoUrl": "https://openbankingplatform.blob.core.windows.net/image/HANDSESS.png"
        }
    ]
}

Get ASPSP Details

Code
 
curl -X GET
    [API_HOST]/psd2/aspspinformation/v1/aspsps/[BICFI]
    -H 'Authorization: Bearer [ACCESS_TOKEN]'
    -H 'X-Request-ID: [GUID]'

Path parameter

• BICFI ASPSP identifier. It can be known upfront or it can be picked from the previous response.

Response

Code
 
{
  "city": "Stockholm",
  "country": "Sweden",
  "postalCode": "105 34",
  "streetAddress": "Landsvägen 40",
  "companyNumber": "502017-7753",
  "phone": "+46-8-585 900 00",
  "websiteUrl": "https://www.swedbank.se",
  "globalPaymentProducts": [
    "domestic",
    "international",
    "swedish-giro"
  ],
  "supportedAuthorizationMethods": [
    {
      "name": "OAuth2",
      "uri": "https://auth.openbankingplatform.com/.well-known/openid-configuration"
    },
    {
      "name": "Decoupled",
      "uri": ""
    }
  ],
  "bicFi": "SWEDSESS",
  "name": "Swedbank",
  "logoUrl": "https://opeopenbanking.blob.core.windows.net/images/SWEDSESS.png",
  "affiliatedAspsps": [
    {
      "id": "08999",
      "name": "Swedbank"
    },
    {
      "id": "08114",
      "name": "Södra Dalarnas Sparbank AB"
    }
  ]
}

This result contains contact details for the bank and information about how to access its services through Open Payments API.

The list of global payment products defines a subset of payment products supported for a specific bank. The models for each product is unified across all banks that support it.

The list of affiliatedAspsps includes any affiliated ASPSPs to the main entry that can be accessed when using the BICFI. Please see ASPSP specific documentation here for usage.

Read more about the payment initiation API.

Flows of usage

The APIs in this product does not interface directly with the banks but provide information to be able to access banks dynamically. We will add banks continuously and if you get the list of banks from this API you will get access to these new banks automatically without the need to do any coding.

A typical flow in the system may be like this:

1. the user is presented a list of supported countries
2. the user selects a country
3. the system retrieves a list of banks for that country
4. the user selects their bank
5. the system moves on to one of the other APIs to get account information or to initiate a payment