bLink API - account-information-service module (3.1.0.7-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

account information Account Information Service - third party access to bank account data

Retrieve list of authorized accounts

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": {"type": "IBAN",
"identification": "CH9300762011623852957"
},
"currency": "CHF",
"designation": "Firmenkonto",
"_links": {"self": "/accounts/550e8400-e29b-11d4-a716-446655440000",
"balance": "/accounts/550e8400-e29b-11d4-a716-446655440000/balance",
"transactions": "/accounts/550e8400-e29b-11d4-a716-446655440000/transactions"
}
}
]

Retrieve information about a single specific 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": {"type": "IBAN",
"identification": "CH9300762011623852957"
},
"currency": "CHF",
"designation": "Firmenkonto",
"_links": {"self": "/accounts/550e8400-e29b-11d4-a716-446655440000",
"balance": "/accounts/550e8400-e29b-11d4-a716-446655440000/balance",
"transactions": "/accounts/550e8400-e29b-11d4-a716-446655440000/transactions"
}
}

Retrieve account balance information

Account data of the specified account.

Returns the intraday booked balance (ITBD), if called without a date.
Returns the closing booked balance (CLBD), if called for a past date. In case the specified day has not yet been finalized, the response will be a 404 error.

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": "2010-02-15",
"balanceType": "CLBD",
"balance": {"currency": "CHF",
"amount": "10.25"
},
"_links": {"self": "/accounts/550e8400-e29b-11d4-a716-446655440000/balance",
"account": "/accounts/550e8400-e29b-11d4-a716-446655440000",
"transactions": "/accounts/550e8400-e29b-11d4-a716-446655440000/transactions"
}
}

Retrieve transactions of a specific account

Transactions to and from the specified account.

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. In case the specified day has not yet been finalized, the response will be a 404 error.

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": [{"entryId": "ENTRY123456789",
"transactionType": "CRDT",
"entryReference": 10001628,
"entryReferenceInternalId": "010001628",
"reversalIndicator": true,
"bookingDate": "2018-10-29",
"valueDate": "2018-10-29",
"amount": {"currency": "CHF",
"amount": "10.25"
},
"instructedAmount": {"amount": "10.25",
"sourceCurrency": "CHF",
"targetCurrency": "USD",
"exchangeRate": "0.957",
"exchangeIndicator": "MULT"
},
"totalChargesAmount": {"amount": "10.25",
"currency": "CHF",
"chargeRecords": [{"amount": "10.25",
"currency": "CHF",
"type": "Some type of charge",
"chargesIncludedIndicator": true
}
]
},
"bankTransactionCode": {"domainCode": "PMNT",
"familyCode": "RCDT",
"subFamilyCode": "DMCT"
},
"additionalEntryInformation": "string",
"transactions": [{"transactionId": "TX12345A987",
"transactionType": "CRDT",
"endToEndId": "ENDTOENDID-01",
"bankTransactionCode": {"domainCode": "PMNT",
"familyCode": "RCDT",
"subFamilyCode": "DMCT"
},
"amount": {"currency": "CHF",
"amount": "10.25"
},
"instructedAmount": {"amount": "10.25",
"sourceCurrency": "CHF",
"targetCurrency": "USD",
"exchangeRate": "0.957",
"exchangeIndicator": "MULT"
},
"totalChargesAmount": {"amount": "10.25",
"currency": "CHF",
"chargeRecords": [{"amount": "10.25",
"currency": "CHF",
"type": "Some type of charge",
"chargesIncludedIndicator": true
}
]
},
"counterparty": {"name": "Hans Muster",
"postalAddress": {"structured": {"streetName": "Rue de la gare",
"buildingNumber": "24",
"postCode": "2501",
"townName": "Biel",
"country": "CH"
},
"unstructured": {"addressLines": ["Robert Schneider SA",
"Rue de la gare 24"
],
"country": "CH"
}
},
"account": {"type": "IBAN",
"identification": "CH9300762011623852957"
},
"agent": {"bic": "string",
"clearingSystemMemberIdentification": {"code": "CHBCC",
"memberId": "00230"
}
}
},
"remittanceInformation": "Rechnung Nr. 408",
"remittanceReference": {"type": "SCOR",
"reference": "210000000003139471430009017"
},
"additionalTransactionInformation": "string"
}
]
}
],
"_links": {"self": "/accounts/550e8400e29b11d4a716446655440000/statements",
"account": "/accounts/550e8400e29b11d4a716446655440000",
"balance": "/accounts/550e8400e29b11d4a716446655440000/balance"
}
}

iso20022

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

Retrieve resources links to available account statements. The returned account statements must conform to the XML Schema and Implementation Guidelines defined by Swiss Payment Standards; see: https://www.six-interbank-clearing.com/en/home/standardization/iso-payments/customer-bank/implementation-guidelines.html

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

[{"name": "string",
"description": "string",
"type": "CAMT53",
"id": "string"
}
]

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

[{"accountId": 13579,
"iban": "CH9300762011623852957",
"currency": "CHF",
"accountOwner": "Account Owner XYZ",
"designation": "Savings ABC",
"allowedCurrencies": ["CHF"
]
}
]

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

200

Content type

application/json

{"requestDateTime": "2018-04-13T11:11:11Z",
"receivedHeaders": [{"headerName": "X-Correlation-ID",
"headerValue": "string"
}
],
"receivedPayload": "... as received ..."
}

Returns all specified request headers, the request body 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).

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

200

Content type

application/json

{"requestDateTime": "2018-04-13T11:11:11Z",
"receivedHeaders": [{"headerName": "X-Correlation-ID",
"headerValue": "string"
}
],
"receivedPayload": "... as received ..."
}

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

accounts

Retrieve list of authorized accounts

header Parameters

Responses

Response samples

Retrieve information about a single specific account

path Parameters

header Parameters

Responses

Response samples

Retrieve account balance information

path Parameters

query Parameters

header Parameters

Responses

Response samples

Retrieve transactions of a specific account

path Parameters

query Parameters

header Parameters

Responses

Response samples

iso20022

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

header Parameters

Responses

Response samples

Retrieves the designated ISO20022 XML CAMT document.

path Parameters

header Parameters

Responses

Response samples

consents

Retrieve a list of consents

header Parameters

Responses

Response samples

diagnostics

Returns all specified request headers and additional diagnostic information

header Parameters

Responses

Response samples

Returns all specified request headers, the request body and additional diagnostic information

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: application/json
required