bLink API - account-information-service module (4.0.0.4-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)
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
| 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. (SCOPE: FI) |
| 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. (SCOPE: FI - optional) |
| 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
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 502
- 503
- 504
[- {
- "id": "abc123_abcxyz.123789.abcxyz.abcxyz_abcxyz_abcxyz_abcxyz_ccccc_123abc",
- "account": {
- "type": "IBAN",
- "identification": "CH9300762011623852957"
}, - "accountOwner": "Account Owner XYZ",
- "currency": "CHF",
- "allowedCurrencies": [
- "CHF"
], - "designation": "Firmenkonto",
- "accountTypeCode": "TRAN",
- "_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
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
| 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. (SCOPE: FI) |
| 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. (SCOPE: FI - optional) |
| 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
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 502
- 503
- 504
{- "id": "abc123_abcxyz.123789.abcxyz.abcxyz_abcxyz_abcxyz_abcxyz_ccccc_123abc",
- "account": {
- "type": "IBAN",
- "identification": "CH9300762011623852957"
}, - "accountOwner": "Account Owner XYZ",
- "currency": "CHF",
- "allowedCurrencies": [
- "CHF"
], - "designation": "Firmenkonto",
- "accountTypeCode": "TRAN",
- "_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
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
| 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. (SCOPE: FI) |
| 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. (SCOPE: FI - optional) |
| 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
- 200
- 202
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 502
- 503
- 504
{- "date": "2018-04-13",
- "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
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
| 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. (SCOPE: FI) |
| 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. (SCOPE: FI - optional) |
| 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
- 200
- 202
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 502
- 503
- 504
{- "iban": "CH5481230000001998736",
- "designation": "Checking Account",
- "entries": [
- {
- "entryId": "ENTRY123456789",
- "transactionType": "CRDT",
- "entryReference": "010001628",
- "entryReferenceInternalId": "010001628",
- "reversalIndicator": true,
- "bookingDate": "2018-04-13",
- "valueDate": "2018-04-13",
- "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"
}
}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
| 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. (SCOPE: FI) |
| 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. (SCOPE: FI - optional) |
| 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
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 502
- 503
- 504
[- {
- "name": "string",
- "description": "string",
- "type": "CAMT53",
- "schemaVersion": "camt.053.001.08",
- "id": "string",
- "account": {
- "type": "IBAN",
- "identification": "CH9300762011623852957"
}, - "dateFrom": "2018-04-13",
- "dateTo": "2018-04-13"
}
]Retrieves the designated ISO20022 XML CAMT document.
path Parameters
| reportId required | string <= 35 characters id of report |
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. (SCOPE: FI) |
| 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. (SCOPE: FI - optional) |
| 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
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 502
- 503
- 504
{- "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"
}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
| 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. (SCOPE: FI) |
| 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. (SCOPE: FI - optional) |
| 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
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 502
- 503
- 504
[- {
- "accountId": "13579",
- "iban": "CH9300762011623852957",
- "currency": "CHF",
- "accountOwner": "Account Owner XYZ",
- "designation": "Savings ABC",
- "allowedCurrencies": [
- "CHF"
]
}
]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 | string ID of the target, e.g., a financial institution. (SCOPE: FI - optional) |
| X-CorAPI-Client-ID required | string ID of the client forwarded to the provider. (SCOPE: FI) |
| 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
- 200
{- "requestDateTime": "2018-04-13T11:11:11Z",
- "receivedHeaders": [
- {
- "headerName": "X-Correlation-ID",
- "headerValue": "string"
}
], - "receivedPayload": "... as received ..."
}