bLink API - custody services module (1.0.10.5-six_caas)
Download OpenAPI specification:Download
This is the specification of the bLink 'custody-services' module API. It is part of the OpenWealth APIs for the connectivity between custody banks and WealthTechs (e.g. Portfolio Management Systems). This API allows the user to receive data from custody banks regarding accounts and positions. The API is designed to be used for either update end of day data batches or single near-realtime account/position information. Furthermore, this API allows the user to receive data from custody banks regarding transactions. In this version only transactions which include effective cash or securities movements are in scope and corporate actions are delivered only on a informative basis.
Returns all customers and respective accounts accessible for the logged in user.
This endpoint returns a highlevel list of customers and the respective accounts accessible for the logged in user. Paging is done based on the customerOverview object, i.e. if limit is set to 1, then 1 customerOverview will be returned per page.
query Parameters
cursor | string An opaque string value used for pagination |
limit | integer <int32> >= 1 Maximum number of items to return. |
header Parameters
X-Correlation-ID required | string <= 64 characters Unique ID (defined by the caller) which will be reflected back in the response. |
Permission-ID required | string <uuid,> This contains the permission Id returned by the post permission, which was performed prior to any request. |
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
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 503
[- {
- "customerIdentification": 123123456,
- "customerReferenceCurrency": "CHF",
- "accountOverview": [
- {
- "accountIdentification": 876543219,
- "accountIdentificationType": "other",
- "accountType": "cashAccount",
- "accountReferenceCurrency": "CHF",
- "accountName": "Household account",
- "accountDesignation": "Current Account CHF",
- "portfolioInformation": {
- "portfolioIdentification": 876543219,
- "portfolioReferenceCurrency": "CHF"
}
}
]
}
]
Returns a specific customers and respective accounts accessible for the logged in user.
This endpoint returns a highlevel list of a customer and the respective accounts accessible for the logged in user.
path Parameters
customerId required | string The customer's id |
query Parameters
cursor | string An opaque string value used for pagination |
limit | integer <int32> >= 1 Maximum number of items to return. |
header Parameters
X-Correlation-ID required | string <= 64 characters Unique ID (defined by the caller) which will be reflected back in the response. |
Permission-ID required | string <uuid,> This contains the permission Id returned by the post permission, which was performed prior to any request. |
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
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 503
[- {
- "customerIdentification": 123123456,
- "customerReferenceCurrency": "CHF",
- "accountOverview": [
- {
- "accountIdentification": 876543219,
- "accountIdentificationType": "other",
- "accountType": "cashAccount",
- "accountReferenceCurrency": "CHF",
- "accountName": "Household account",
- "accountDesignation": "Current Account CHF",
- "portfolioInformation": {
- "portfolioIdentification": 876543219,
- "portfolioReferenceCurrency": "CHF"
}
}
]
}
]
Returns all positions for a specific customer.
Returns all positions (incl. investment cash accounts) for a specific customer. Paging is done based on the account object, i.e. if limit is set to 1, then 1 account will be returned per page.
path Parameters
customerId required | string The customer's id |
query Parameters
date required | string <date> Example: date=2019-12-31 Full-date according to ISO 8601 i.e. YYYY-MM-DD format. |
eodIndicator required | boolean Default: true Example: eodIndicator=true Indicates whether the position data is end-of-day (eod) data for the positions. If the parameter is set to false, the most recent data is shown, incl intraday changes on the position if the date is set to today. |
dateType required | string Enum: "transactionDate" "bookingDate" "valueDate" Indicates which type of date is decisive for the data shown. |
cursor | string An opaque string value used for pagination |
limit | integer <int32> >= 1 Maximum number of items to return. |
header Parameters
X-Correlation-ID required | string <= 64 characters Unique ID (defined by the caller) which will be reflected back in the response. |
Permission-ID required | string <uuid,> This contains the permission Id returned by the post permission, which was performed prior to any request. |
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
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 503
{- "statement": {
- "statementDateTime": "2018-04-13T11:11:11Z",
- "date": {
- "date": "2018-04-13",
- "dateType": "transactionDate"
}, - "endOfDayIndicator": true
}, - "customer": {
- "customerIdentification": 123123456,
- "customerReferenceCurrency": "CHF",
- "accountList": [
- {
- "accountInformation": {
- "accountIdentification": 876543219,
- "accountIdentificationType": "other",
- "accountType": "cashAccount",
- "accountReferenceCurrency": "CHF",
- "accountName": "Household account",
- "accountDesignation": "Current Account CHF",
- "portfolioInformation": {
- "portfolioIdentification": 876543219,
- "portfolioReferenceCurrency": "CHF"
}
}, - "externalReference": "987-654-321",
- "positionList": [
- {
- "identification": 876543219,
- "externalReference": "987-654-321",
- "currency": "CHF",
- "amountOrUnits": {
- "amount": "12000",
- "type": "nominal",
- "creditDebitIndicator": "debit"
}, - "positionName": "Stark Industries Inc.",
- "prices": [
- {
- "amount": "100.36",
- "amountType": "percentage",
- "creditDebitIndicator": "debit",
- "priceType": "costPrice",
- "currency": "CHF",
- "date": "2019-08-24",
- "sourceOfPrice": "SIX Swiss Exchange",
- "foreignExchangeRates": [
- {
- "sourceCurrency": null,
- "rate": null,
- "targetCurrency": null,
- "fxType": null
}
], - "valuation": {
- "amount": "13104.5",
- "currency": "CHF",
- "creditDebitIndicator": "credit"
}
}
], - "safekeepingPlace": "INSECHZZXXX",
- "additionalCustodianInformation": "INSECHZZXXX",
- "accruedInterest": {
- "amount": "10.25",
- "currency": "CHF",
- "creditDebitIndicator": "debit",
- "numberOfDaysAccrued": 34
}, - "positionAdditionalDetails": "Belongs to contract 129959959",
- "financialInstrument": {
- "financialInstrumentIdentification": {
- "identification": "CH0012005267",
- "type": "isin"
}, - "financialInstrumentName": "Novartis AG",
- "interests": {
- "rate": "0.00125",
- "currency": "CHF",
- "dayCountBasis": "u30_360",
- "paymentDate": "2020-04-19",
- "paymentFrequency": "quarterly"
}, - "dates": [
- {
- "type": "issueDate",
- "date": "2019-12-31"
}
], - "optionDetails": {
- "optionType": "call",
- "optionStyle": "amer"
}, - "contractSize": "100",
- "minimumDenomination": "100000",
- "minimumIncrement": "10000",
- "financialInstrumentPrices": [
- {
- "amount": "100.9",
- "creditDebitIndicator": "debit",
- "currency": "CHF",
- "type": "strikePrice"
}
], - "inactiveIndicator": false,
- "underlyingList": [
- {
- "underlyingFinancialInstrument": {
- "identification": null,
- "type": null
}
}
], - "financialInstrumentAttributeAdditionalDetails": "Group contract number 129959961"
}
}
]
}
]
}
}
Returns the positions for a customer's specific account.
Returns all positions for a specific account. Paging is done based on the position object, i.e. if limit is set to 1, then 1 position will be returned per page.
path Parameters
accountId required | string The customer's account identification |
query Parameters
date required | string <date> Example: date=2019-12-31 Full-date according to ISO 8601 i.e. YYYY-MM-DD format. |
eodIndicator required | boolean Default: true Example: eodIndicator=true Indicates whether the position data is end-of-day (eod) data for the positions. If the parameter is set to false, the most recent data is shown, incl intraday changes on the position if the date is set to today. |
dateType required | string Enum: "transactionDate" "bookingDate" "valueDate" Indicates which type of date is decisive for the data shown. |
cursor | string An opaque string value used for pagination |
limit | integer <int32> >= 1 Maximum number of items to return. |
header Parameters
X-Correlation-ID required | string <= 64 characters Unique ID (defined by the caller) which will be reflected back in the response. |
Permission-ID required | string <uuid,> This contains the permission Id returned by the post permission, which was performed prior to any request. |
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
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 503
{- "statement": {
- "statementDateTime": "2018-04-13T11:11:11Z",
- "date": {
- "date": "2018-04-13",
- "dateType": "transactionDate"
}, - "endOfDayIndicator": true
}, - "customer": {
- "customerIdentification": 123123456,
- "customerReferenceCurrency": "CHF",
- "accountList": [
- {
- "accountInformation": {
- "accountIdentification": 876543219,
- "accountIdentificationType": "other",
- "accountType": "cashAccount",
- "accountReferenceCurrency": "CHF",
- "accountName": "Household account",
- "accountDesignation": "Current Account CHF",
- "portfolioInformation": {
- "portfolioIdentification": 876543219,
- "portfolioReferenceCurrency": "CHF"
}
}, - "externalReference": "987-654-321",
- "positionList": [
- {
- "identification": 876543219,
- "externalReference": "987-654-321",
- "currency": "CHF",
- "amountOrUnits": {
- "amount": "12000",
- "type": "nominal",
- "creditDebitIndicator": "debit"
}, - "positionName": "Stark Industries Inc.",
- "prices": [
- {
- "amount": "100.36",
- "amountType": "percentage",
- "creditDebitIndicator": "debit",
- "priceType": "costPrice",
- "currency": "CHF",
- "date": "2019-08-24",
- "sourceOfPrice": "SIX Swiss Exchange",
- "foreignExchangeRates": [
- {
- "sourceCurrency": null,
- "rate": null,
- "targetCurrency": null,
- "fxType": null
}
], - "valuation": {
- "amount": "13104.5",
- "currency": "CHF",
- "creditDebitIndicator": "credit"
}
}
], - "safekeepingPlace": "INSECHZZXXX",
- "additionalCustodianInformation": "INSECHZZXXX",
- "accruedInterest": {
- "amount": "10.25",
- "currency": "CHF",
- "creditDebitIndicator": "debit",
- "numberOfDaysAccrued": 34
}, - "positionAdditionalDetails": "Belongs to contract 129959959",
- "financialInstrument": {
- "financialInstrumentIdentification": {
- "identification": "CH0012005267",
- "type": "isin"
}, - "financialInstrumentName": "Novartis AG",
- "interests": {
- "rate": "0.00125",
- "currency": "CHF",
- "dayCountBasis": "u30_360",
- "paymentDate": "2020-04-19",
- "paymentFrequency": "quarterly"
}, - "dates": [
- {
- "type": "issueDate",
- "date": "2019-12-31"
}
], - "optionDetails": {
- "optionType": "call",
- "optionStyle": "amer"
}, - "contractSize": "100",
- "minimumDenomination": "100000",
- "minimumIncrement": "10000",
- "financialInstrumentPrices": [
- {
- "amount": "100.9",
- "creditDebitIndicator": "debit",
- "currency": "CHF",
- "type": "strikePrice"
}
], - "inactiveIndicator": false,
- "underlyingList": [
- {
- "underlyingFinancialInstrument": {
- "identification": null,
- "type": null
}
}
], - "financialInstrumentAttributeAdditionalDetails": "Group contract number 129959961"
}
}
]
}
]
}
}
Returns transactions for a specific customer.
Returns all transactions for the a specific customer. Paging is done based on the transaction object, i.e. if limit is set to 1, then 1 transaction will be returned per page.
path Parameters
customerId required | string The customer's id |
query Parameters
date required | string <date> Example: date=2019-12-31 Full-date according to ISO 8601 i.e. YYYY-MM-DD format. |
dateType required | string Enum: "transactionDate" "bookingDate" "valueDate" Indicates which type of date is decisive for the data shown. |
eodIndicator required | boolean Default: true Example: eodIndicator=true Indicates whether the position data is end-of-day (eod) data for the positions. If the parameter is set to false, the most recent data is shown, incl intraday changes on the position if the date is set to today. |
cursor | string An opaque string value used for pagination |
limit | integer <int32> >= 1 Maximum number of items to return. |
header Parameters
X-Correlation-ID required | string <= 64 characters Unique ID (defined by the caller) which will be reflected back in the response. |
Permission-ID required | string <uuid,> This contains the permission Id returned by the post permission, which was performed prior to any request. |
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
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 503
{- "statement": {
- "statementDateTime": "2018-04-13T11:11:11Z",
- "date": {
- "date": "2018-04-13",
- "dateType": "transactionDate"
}, - "endOfDayIndicator": true
}, - "transactions": [
- {
- "customerIdentification": 987654321,
- "transactionIdentification": 987654321,
- "placeOfTrade": {
- "marketIdentificationCode": "XSWX",
- "marketDescription": "OTC"
}, - "reversalIndicator": false,
- "reversedTransactionIdentification": 2134123415,
- "dateList": [
- {
- "date": "2018-04-13",
- "dateType": "settlementDate"
}
], - "transactionType": "securitiesExchange",
- "transactionSubtype": "Buy",
- "underlyingFinancialInstrument": {
- "identification": "US8851601018",
- "type": "isin",
- "name": "N-Akt Thor Industries Inc USD 0.1 nom (977822)"
}, - "movementList": [
- {
- "amount": "100000",
- "amountType": "nominal",
- "creditDebitIndicator": "debit",
- "currency": "CHF",
- "movementType": "security",
- "financialInstrument": {
- "identification": "US8851601018",
- "type": "isin",
- "name": "N-Akt Thor Industries Inc USD 0.1 nom (977822)"
}, - "positionIdentification": "1234566-12-1",
- "accountDetails": {
- "accountIdentification": 876543219,
- "accountIdentificationType": "other"
}
}
], - "postingAmounts": [
- {
- "amount": "13023",
- "currency": "CHF",
- "creditDebitIndicator": "debit",
- "accountInformation": {
- "accountIdentification": 876543219,
- "accountIdentificationType": "other",
- "accountType": "cashAccount",
- "accountReferenceCurrency": "CHF",
- "accountName": "Household account",
- "accountDesignation": "Current Account CHF",
- "portfolioInformation": {
- "portfolioIdentification": 876543219,
- "portfolioReferenceCurrency": "CHF"
}
}
}
], - "foreignExchangeRates": [
- {
- "sourceCurrency": "CHF",
- "rate": "1.0963",
- "targetCurrency": "CHF",
- "fxType": "calculatory"
}
], - "settlementCurrency": "CHF",
- "prices": [
- {
- "amount": "100.36",
- "amountType": "percentage",
- "priceType": "dealPrice",
- "currency": "CHF"
}
], - "transactionAdditionalDetails": "Replaces transaction nr. 12234567489"
}
]
}
Returns the transactions a specific account.
Returns the transactions for all positions in a specific account. Paging is done based on the transaction object, i.e. if limit is set to 1, then 1 transaction will be returned per page.
path Parameters
accountId required | string The customer's account identification |
query Parameters
date required | string <date> Example: date=2019-12-31 Full-date according to ISO 8601 i.e. YYYY-MM-DD format. |
dateType required | string Enum: "transactionDate" "bookingDate" "valueDate" Indicates which type of date is decisive for the data shown. |
eodIndicator required | boolean Default: true Example: eodIndicator=true Indicates whether the position data is end-of-day (eod) data for the positions. If the parameter is set to false, the most recent data is shown, incl intraday changes on the position if the date is set to today. |
cursor | string An opaque string value used for pagination |
limit | integer <int32> >= 1 Maximum number of items to return. |
header Parameters
X-Correlation-ID required | string <= 64 characters Unique ID (defined by the caller) which will be reflected back in the response. |
Permission-ID required | string <uuid,> This contains the permission Id returned by the post permission, which was performed prior to any request. |
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
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 503
{- "statement": {
- "statementDateTime": "2018-04-13T11:11:11Z",
- "date": {
- "date": "2018-04-13",
- "dateType": "transactionDate"
}, - "endOfDayIndicator": true
}, - "transactions": [
- {
- "customerIdentification": 987654321,
- "transactionIdentification": 987654321,
- "placeOfTrade": {
- "marketIdentificationCode": "XSWX",
- "marketDescription": "OTC"
}, - "reversalIndicator": false,
- "reversedTransactionIdentification": 2134123415,
- "dateList": [
- {
- "date": "2018-04-13",
- "dateType": "settlementDate"
}
], - "transactionType": "securitiesExchange",
- "transactionSubtype": "Buy",
- "underlyingFinancialInstrument": {
- "identification": "US8851601018",
- "type": "isin",
- "name": "N-Akt Thor Industries Inc USD 0.1 nom (977822)"
}, - "movementList": [
- {
- "amount": "100000",
- "amountType": "nominal",
- "creditDebitIndicator": "debit",
- "currency": "CHF",
- "movementType": "security",
- "financialInstrument": {
- "identification": "US8851601018",
- "type": "isin",
- "name": "N-Akt Thor Industries Inc USD 0.1 nom (977822)"
}, - "positionIdentification": "1234566-12-1",
- "accountDetails": {
- "accountIdentification": 876543219,
- "accountIdentificationType": "other"
}
}
], - "postingAmounts": [
- {
- "amount": "13023",
- "currency": "CHF",
- "creditDebitIndicator": "debit",
- "accountInformation": {
- "accountIdentification": 876543219,
- "accountIdentificationType": "other",
- "accountType": "cashAccount",
- "accountReferenceCurrency": "CHF",
- "accountName": "Household account",
- "accountDesignation": "Current Account CHF",
- "portfolioInformation": {
- "portfolioIdentification": 876543219,
- "portfolioReferenceCurrency": "CHF"
}
}
}
], - "foreignExchangeRates": [
- {
- "sourceCurrency": "CHF",
- "rate": "1.0963",
- "targetCurrency": "CHF",
- "fxType": "calculatory"
}
], - "settlementCurrency": "CHF",
- "prices": [
- {
- "amount": "100.36",
- "amountType": "percentage",
- "priceType": "dealPrice",
- "currency": "CHF"
}
], - "transactionAdditionalDetails": "Replaces transaction nr. 12234567489"
}
]
}
Returns the transactions for a specific position.
Returns transactions for a specific position. Paging is done based on the transaction object, i.e. if limit is set to 1, then 1 transaction will be returned per page.
path Parameters
positionId required | string The position's id |
query Parameters
date required | string <date> Example: date=2019-12-31 Full-date according to ISO 8601 i.e. YYYY-MM-DD format. |
dateType required | string Enum: "transactionDate" "bookingDate" "valueDate" Indicates which type of date is decisive for the data shown. |
eodIndicator required | boolean Default: true Example: eodIndicator=true Indicates whether the position data is end-of-day (eod) data for the positions. If the parameter is set to false, the most recent data is shown, incl intraday changes on the position if the date is set to today. |
cursor | string An opaque string value used for pagination |
limit | integer <int32> >= 1 Maximum number of items to return. |
header Parameters
X-Correlation-ID required | string <= 64 characters Unique ID (defined by the caller) which will be reflected back in the response. |
Permission-ID required | string <uuid,> This contains the permission Id returned by the post permission, which was performed prior to any request. |
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
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 503
{- "statement": {
- "statementDateTime": "2018-04-13T11:11:11Z",
- "date": {
- "date": "2018-04-13",
- "dateType": "transactionDate"
}, - "endOfDayIndicator": true
}, - "transactions": [
- {
- "customerIdentification": 987654321,
- "transactionIdentification": 987654321,
- "placeOfTrade": {
- "marketIdentificationCode": "XSWX",
- "marketDescription": "OTC"
}, - "reversalIndicator": false,
- "reversedTransactionIdentification": 2134123415,
- "dateList": [
- {
- "date": "2018-04-13",
- "dateType": "settlementDate"
}
], - "transactionType": "securitiesExchange",
- "transactionSubtype": "Buy",
- "underlyingFinancialInstrument": {
- "identification": "US8851601018",
- "type": "isin",
- "name": "N-Akt Thor Industries Inc USD 0.1 nom (977822)"
}, - "movementList": [
- {
- "amount": "100000",
- "amountType": "nominal",
- "creditDebitIndicator": "debit",
- "currency": "CHF",
- "movementType": "security",
- "financialInstrument": {
- "identification": "US8851601018",
- "type": "isin",
- "name": "N-Akt Thor Industries Inc USD 0.1 nom (977822)"
}, - "positionIdentification": "1234566-12-1",
- "accountDetails": {
- "accountIdentification": 876543219,
- "accountIdentificationType": "other"
}
}
], - "postingAmounts": [
- {
- "amount": "13023",
- "currency": "CHF",
- "creditDebitIndicator": "debit",
- "accountInformation": {
- "accountIdentification": 876543219,
- "accountIdentificationType": "other",
- "accountType": "cashAccount",
- "accountReferenceCurrency": "CHF",
- "accountName": "Household account",
- "accountDesignation": "Current Account CHF",
- "portfolioInformation": {
- "portfolioIdentification": 876543219,
- "portfolioReferenceCurrency": "CHF"
}
}
}
], - "foreignExchangeRates": [
- {
- "sourceCurrency": "CHF",
- "rate": "1.0963",
- "targetCurrency": "CHF",
- "fxType": "calculatory"
}
], - "settlementCurrency": "CHF",
- "prices": [
- {
- "amount": "100.36",
- "amountType": "percentage",
- "priceType": "dealPrice",
- "currency": "CHF"
}
], - "transactionAdditionalDetails": "Replaces transaction nr. 12234567489"
}
]
}
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
{- "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/jsonrequired
Responses
Request samples
- Payload
"string"
Response samples
- 200
{- "requestDateTime": "2018-04-13T11:11:11Z",
- "receivedHeaders": [
- {
- "headerName": "X-Correlation-ID",
- "headerValue": "string"
}
], - "receivedPayload": "... as received ..."
}