Skip to main content

bLink API - account-information-service module (5.1.0.0-fi)

Download OpenAPI specification:Download

This is the specification of the bLink 'account-information-service' module API. (as implemented by providers (e.g. financial institutions) and used by SIX)

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.

query Parameters
cursor
string
Example: cursor=cursorIDxyz

Optional parameter for pagination. Use the ID of the last item from the previous response to retrieve the next set of results.

limit
integer <int32> >= 1
Default: 25
Example: limit=25

Optional parameter for pagination, specifying the number of items to return. The actual maximum limit can be defined by the provider.

header Parameters
Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider.

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
string

ID of the target, e.g., a financial institution.

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)

Responses

Response samples

Content type
application/json
{
  • "accounts": [
    ]
}

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...
Example: accountId

ID of the account.

header Parameters
Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider.

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
string

ID of the target, e.g., a financial institution.

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)

Responses

Response samples

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

Retrieve account balance information

Returns account balance information of the specified account.

  • Returns the interim booked balance (ISO20022 Balance Type ITBD) for the current day, if called without a date. The balance is calculated in the course of the service provider's business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.
  • Returns the closing booked balance (ISO20022 Balance Type CLBD) for a specific day, if called for a past date. It is the sum of the opening booked balance at the beginning of that day and all entries booked to the account during 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...
Example: accountId

ID of the account.

query Parameters
date
string <date> (Shared date)
Example: date=2018-04-13

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

header Parameters
Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider.

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
string

ID of the target, e.g., a financial institution.

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)

Responses

Response samples

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

Retrieve transactions of a specific account

Returns the transaction list of the specified account.

  • When called without a date, it returns all transactions since the last completed booking day. Both "pending" and "booked" entries may be included based on the entryStatus parameter.
  • When called with a date range, only "booked" transactions from completed booking days are returned. For days not yet finalized, a 202 response code is returned.

Results are sorted by bookingDate in descending order. Additional sorting logic is provider-specific but all providers must ensure stable and consistent pagination behavior. If pagination is required, the server includes an opaque cursor in the X-Next-Cursor header. This cursor identifies a specific position in the sorted result set and is internally derived from the sorting criteria. Clients must pass this value unchanged in the cursor parameter of the next request to retrieve subsequent pages.

Transaction details are optional in the schema, but all available information must be included if present for a given transaction.

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

ID of the account.

query Parameters
date_from
string <date> (Shared date)
Example: date_from=2018-04-13

The start date for the query. Must be earlier than or equal to the dateTo parameter.

date_to
string <date> (Shared date)
Example: date_to=2018-04-13

The end date for the query. Must be later than or equal to the dateFrom parameter.

entry_status
string
Default: "booked"
Enum: "booked" "pending" "both"

Specifies the status of the entries to be queried. Intraday movements can have a status of either "pending" or "booked." For completed booking days, only entries with a "booked" status will be returned.

cursor
string
Example: cursor=cursorIDxyz

Optional parameter for pagination. Use the ID of the last item from the previous response to retrieve the next set of results.

limit
integer <int32> >= 1
Default: 25
Example: limit=25

Optional parameter for pagination, specifying the number of items to return. The actual maximum limit can be defined by the provider.

header Parameters
Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider.

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
string

ID of the target, e.g., a financial institution.

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)

Responses

Response samples

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

iso20022

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

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

Get a list of resource links to available account statements (camt.053) for all accounts covered by the eBanking contract delivered. The returned account statements must be conform to the XML schema and implementation guidelines defined by Swiss Payment Standards. If the call covers a period of several days, then an account statement is returned for each day and account, if available.

query Parameters
date_from
string <date> (Shared date)
Example: date_from=2018-04-13

The start date for the query. Must be earlier than or equal to the dateTo parameter.

date_to
string <date> (Shared date)
Example: date_to=2018-04-13

The end date for the query. Must be later than or equal to the dateFrom parameter.

cursor
string
Example: cursor=cursorIDxyz

Optional parameter for pagination. Use the ID of the last item from the previous response to retrieve the next set of results.

limit
integer <int32> >= 1
Default: 25
Example: limit=25

Optional parameter for pagination, specifying the number of items to return. The actual maximum limit can be defined by the provider.

header Parameters
Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider.

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
string

ID of the target, e.g., a financial institution.

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)

Responses

Response samples

Content type
application/json
{
  • "statements": [
    ]
}

Retrieve the designated ISO20022 XML camt.053 document

Retrieve the designated ISO20022 XML camt.053 document.

path Parameters
reportId
required
string <= 35 characters

Unique ID of the requested ISO20022 XML camt.053 document.

header Parameters
Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider.

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
string

ID of the target, e.g., a financial institution.

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)

Responses

Response samples

Content type
application/problem+json
{
  • "detail": "Detailed problem description with respect to the current request",
  • "title": "This is the general problem description",
  • "type": "/problems/TECHNICAL_ERROR",
  • "instance": "path/to/corresponding/resource",
  • "status": 404
}

Retrieve a list of resource links to account reports (camt.052)

Get a list of resource links to available account reports (camt.052) generated since the last End-of-Day (EOD) processing. Only intraday reports created after the most recent EOD cycle are included. The returned account reports must conform to the XML schema and implementation guidelines defined by Swiss Payment Standards.

query Parameters
cursor
string
Example: cursor=cursorIDxyz

Optional parameter for pagination. Use the ID of the last item from the previous response to retrieve the next set of results.

limit
integer <int32> >= 1
Default: 25
Example: limit=25

Optional parameter for pagination, specifying the number of items to return. The actual maximum limit can be defined by the provider.

header Parameters
Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider.

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
string

ID of the target, e.g., a financial institution.

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)

Responses

Response samples

Content type
application/json
{
  • "reports": [
    ]
}

Retrieve the designated ISO20022 XML camt.052 document

Retrieve the designated ISO20022 XML camt.052 document.

path Parameters
reportId
required
string <= 35 characters

Unique ID of the requested ISO20022 XML camt.053 document.

header Parameters
Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider.

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
string

ID of the target, e.g., a financial institution.

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)

Responses

Response samples

Content type
application/problem+json
{
  • "detail": "Detailed problem description with respect to the current request",
  • "title": "This is the general problem description",
  • "type": "/problems/TECHNICAL_ERROR",
  • "instance": "path/to/corresponding/resource",
  • "status": 404
}

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.

User-Agent
string

Name and version of the of the client software

X-CorAPI-Target-ID
string

ID of the target, e.g., a financial institution.

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider.

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)

Responses

Response samples

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