Skip to main content
API docs by Redocly

bLink API - account-information-service module (4.0.0.4-six_caas)

Download OpenAPI specification:Download

URL: https://www.six-group.com/en/products-services/banking-services/blink.html

This is the specification of the bLink 'account-information-service' module API.

accounts

Third party access to bank account service considering account information and transaction data operations (JSON).

Retrieve list of authorized accounts

Return the list of all accounts accessible for the logged in user.

header Parameters
Permission-ID
required
string <uuid,>

This contains the permission Id returned by the post permission, which was performed prior to any request.

X-Correlation-ID
required
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

X-PSU-IP-Address
required
string

IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

X-PSU-User-Agent
required
string

User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

Authorization
string

Bearer followed by a base64 encoded OAuth access token

X-Instance-ID
string <= 64 characters

(Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve information about a single specific account

Returns the accounts details of the specified account.

path Parameters
accountId
required
string <= 256 characters [A-Za-z0-9](([A-Za-z0-9._]|-){0,254}[A-Za-z0-...

id of account

header Parameters
Permission-ID
required
string <uuid,>

This contains the permission Id returned by the post permission, which was performed prior to any request.

X-Correlation-ID
required
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

X-PSU-IP-Address
required
string

IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

X-PSU-User-Agent
required
string

User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

Authorization
string

Bearer followed by a base64 encoded OAuth access token

X-Instance-ID
string <= 64 characters

(Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Responses

Response samples

Content type
application/json
{
  • "id": "abc123_abcxyz.123789.abcxyz.abcxyz_abcxyz_abcxyz_abcxyz_ccccc_123abc",
  • "account": {
    },
  • "accountOwner": "Account Owner XYZ",
  • "currency": "CHF",
  • "allowedCurrencies": [
    ],
  • "designation": "Firmenkonto",
  • "accountTypeCode": "TRAN",
  • "_links": {
    }
}

Retrieve account balance information

Returns account balance information of the specified account.

  • Returns the intraday booked balance (ITBD) for the current day, if called without a date.
  • Returns the closing booked balance (CLBD) for a specific day, if called for a past date (i.e. the closing booked balance (CLBD) of that day). In case the specified day has not yet been finalized, the response code will be 202.
path Parameters
accountId
required
string <= 256 characters [A-Za-z0-9](([A-Za-z0-9._]|-){0,254}[A-Za-z0-...

id of account

query Parameters
date
string <date>

The date to query, formatted as yyyy-mm-dd. Default value: current date

header Parameters
Permission-ID
required
string <uuid,>

This contains the permission Id returned by the post permission, which was performed prior to any request.

X-Correlation-ID
required
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

X-PSU-IP-Address
required
string

IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

X-PSU-User-Agent
required
string

User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

Authorization
string

Bearer followed by a base64 encoded OAuth access token

X-Instance-ID
string <= 64 characters

(Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Responses

Response samples

Content type
application/json
{
  • "date": "2018-04-13",
  • "balanceType": "CLBD",
  • "balance": {
    },
  • "_links": {
    }
}

Retrieve transactions of a specific account

Returns the transaction list of the specified account. Only postings with status booked will be returned.

  • Returns the transaction list of the current day, if called without a date.
  • Returns the transaction list for a specific day, if called for a past date (i.e. all transactions from that day). In case the specified day is not yet finalized, the response code will be 202.
path Parameters
accountId
required
string <= 256 characters [A-Za-z0-9](([A-Za-z0-9._]|-){0,254}[A-Za-z0-...

id of account

query Parameters
date
string <date>

The date to query, formatted as yyyy-mm-dd. Default value: current date

header Parameters
Permission-ID
required
string <uuid,>

This contains the permission Id returned by the post permission, which was performed prior to any request.

X-Correlation-ID
required
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

X-PSU-IP-Address
required
string

IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

X-PSU-User-Agent
required
string

User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

Authorization
string

Bearer followed by a base64 encoded OAuth access token

X-Instance-ID
string <= 64 characters

(Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Responses

Response samples

Content type
application/json
{
  • "iban": "CH5481230000001998736",
  • "designation": "Checking Account",
  • "entries": [
    ],
  • "_links": {
    }
}

iso20022

Third party access to bank account service considering camt.053 operations (XML).

Retrieve a list of resource links to account statements (CAMT.053)

Get the resources links to available account statements (camt.053). The returned account statements must be conform to the XML schema and implementation guidelines defined by Swiss Payment Standards.

  • bLink supports account statements only in XML-Schema «camt.053.001.08»
header Parameters
Permission-ID
required
string <uuid,>

This contains the permission Id returned by the post permission, which was performed prior to any request.

X-Correlation-ID
required
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

X-PSU-IP-Address
required
string

IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

X-PSU-User-Agent
required
string

User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

Authorization
string

Bearer followed by a base64 encoded OAuth access token

X-Instance-ID
string <= 64 characters

(Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieves the designated ISO20022 XML CAMT document.

path Parameters
reportId
required
string <= 35 characters

id of report

header Parameters
Permission-ID
required
string <uuid,>

This contains the permission Id returned by the post permission, which was performed prior to any request.

X-Correlation-ID
required
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

X-PSU-IP-Address
required
string

IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

X-PSU-User-Agent
required
string

User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

Authorization
string

Bearer followed by a base64 encoded OAuth access token

X-Instance-ID
string <= 64 characters

(Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Responses

Response samples

Content type
application/problem+json
{
  • "type": "/problems/TECHNICAL_ERROR",
  • "title": "This is the general problem description",
  • "detail": "Detailed problem description with respect to the current request, e.g., invalid account number format",
  • "instance": "path/to/corresponding/resource"
}

consents

Retrieve a list of consents

The consents endpoint allows the client (e.g., a third party provider) to query the consents for a given corporate user. The provider (e.g., a financial institution) must return the consents linked with the access token supplied with the request.

header Parameters
Permission-ID
required
string <uuid,>

This contains the permission Id returned by the post permission, which was performed prior to any request.

X-Correlation-ID
required
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

X-PSU-IP-Address
required
string

IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

X-PSU-User-Agent
required
string

User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

Authorization
string

Bearer followed by a base64 encoded OAuth access token

X-Instance-ID
string <= 64 characters

(Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

diagnostics

Returns all specified request headers and additional diagnostic information

header Parameters
X-Correlation-ID
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

Authorization
string

Bearer followed by a base64 encoded OAuth access token

User-Agent
string

Name and version of the of the client software

X-CorAPI-Target-ID
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

X-PSU-IP-Address
string

IP address of the user initiating the operation (SCOPE: FI - optional)

X-PSU-User-Agent
string

User of the client software (SCOPE: FI - optional)

X-Instance-ID
string <= 64 characters

(Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Responses

Response samples

Content type
application/json
{
  • "requestDateTime": "2018-04-13T11:11:11Z",
  • "receivedHeaders": [
    ],
  • "receivedPayload": "... as received ..."
}