Download OpenAPI specification:Download
Retrieve a specific account (active or inactive).
contactId required | integer <int32> The ID of the contact that is part of the Account's Contact Group |
accountId required | integer <int32> The ID of the account to be retrieved. |
language | string The language of the localized resources |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Id": 7,
- "UId": "00000000-0000-0000-0000-000000000000",
- "AccountNumber": "00250007871200007549",
- "Iban": "00250007871200007549",
- "InternalId": "871200007549",
- "Name": "00250007871200007549",
- "Balance": 1854.09,
- "BalanceLastUpdateDate": "2019-12-01T00:00:00",
- "BranchId": 4,
- "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Euro",
- "CurrencyCode": "EUR",
- "Symbol": "€",
- "RiskFreeRate": -0.005
}, - "ContactGroupId": 5,
- "Type": {
- "Id": 1,
- "Name": "Cash",
- "InternalId": "Cash"
}, - "IsActive": true,
- "OpeningDate": "2022-05-24T06:59:49.3984267+00:00",
- "ProductId": 3,
- "Status": {
- "Id": 1,
- "Name": "Active"
}, - "ClosingDate": "2023-11-24T06:59:49.3984319+00:00",
- "IntegrationStatus": {
- "Id": 1,
- "Name": "In Opening",
- "ExternalId": "In Opening"
}, - "Attributes": "{\"Description\": \"This the Account the Client always wanted to have!\"}",
- "SubAccounts": [ ],
- "AvailableBalance": 3000,
- "AvailableBalanceLastUpdateDate": "2022-08-18T00:00:00"
}
Modifies an existing account.
contactId required | integer <int32> The ID of the contact that belongs to the Account's contact group |
accountId required | integer <int32> The ID of the account to modify |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
AccountNumber | string Nullable The optional new account number of the account. |
Iban | string Nullable The optional new IBAN of the account. |
InternalId | string Nullable The optional new Internal Id of the account. |
Name | string Nullable The optional new name of the account. |
BranchId | integer <int32> Nullable The optional new branch id of the account. |
AccountType | integer <int32> Nullable The optional new account type id of the account. |
Balance | number <double> Nullable The optional new balance of the account. |
BalanceDate | string <date-time> Nullable The optional new date of the last balance update of the account. |
IsActive | boolean Nullable This determines whether the Account is active or not. |
ParentId | integer <int32> Nullable The optional new parent id of the account. |
Product | integer <int32> Nullable The optional new product id of the account. |
Status | integer <int32> Nullable The optional new status of the account. |
OpeningDate | string <date-time> Nullable The optional new date when the account was opened. |
ClosingDate | string <date-time> Nullable The optional new date when the account was closed. |
IntegrationStatus | integer <int32> Nullable The optional new integration status id of the account. |
CustomAttributes | string Nullable The optional new custom attributes of the account. |
ContactGroupId | integer <int32> The contact group associated with the Account |
AvailableBalance | number <double> Nullable The optional available balance of the Account |
AvailableBalanceLastUpdateDate | string <date-time> Nullable The optional last available balance update date of the Account |
UpdateProperties | Array of strings Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "AccountNumber": "string",
- "Iban": "string",
- "InternalId": "string",
- "Name": "string",
- "BranchId": 0,
- "AccountType": 0,
- "Balance": 0,
- "BalanceDate": "2023-05-24T07:09:17Z",
- "IsActive": true,
- "ParentId": 0,
- "Product": 0,
- "Status": 0,
- "OpeningDate": "2023-05-24T07:09:17Z",
- "ClosingDate": "2023-05-24T07:09:17Z",
- "IntegrationStatus": 0,
- "CustomAttributes": "string",
- "ContactGroupId": 0,
- "AvailableBalance": 0,
- "AvailableBalanceLastUpdateDate": "2023-05-24T07:09:17Z",
- "UpdateProperties": [
- "string"
]
}
{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Retrieve all accounts of a contact (active or inactive).
contactId required | integer <int32> The contactId of the contact |
language | string The language of the localized resources |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
[- {
- "Id": 0,
- "UId": "string",
- "AccountNumber": "string",
- "Iban": "string",
- "InternalId": "string",
- "Name": "string",
- "Balance": 0,
- "BalanceLastUpdateDate": "2023-05-24T07:09:17Z",
- "BranchId": 0,
- "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}, - "ContactGroupId": 0,
- "Type": {
- "Id": 0,
- "Name": "string",
- "InternalId": "string"
}, - "IsActive": true,
- "ParentId": 0,
- "OpeningDate": "2023-05-24T07:09:17Z",
- "ProductId": 0,
- "Status": {
- "Id": 0,
- "Name": "string"
}, - "ClosingDate": "2023-05-24T07:09:17Z",
- "IntegrationStatus": {
- "Id": 0,
- "Name": "string",
- "ExternalId": "string"
}, - "Attributes": "string",
- "SubAccounts": [
- 0
], - "AvailableBalance": 0,
- "AvailableBalanceLastUpdateDate": "2023-05-24T07:09:17Z"
}
]
Modifies an existing account.
This API is deprecated. Use PATCH /v1.1/contacts/{contactId}/accounts/{accountId} instead.
contactId required | integer <int32> The ID of the contact that belongs to the Account's contact group |
accountId required | integer <int32> The ID of the account to modify |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
AccountNumber | string Nullable The optional new account number of the account. |
Iban | object (UpdateProperty%3C%3E) |
InternalId | object (UpdateProperty%3C%3E) |
Name | object (UpdateProperty%3C%3E) |
BranchId | integer <int32> Nullable The optional new branch id of the account. |
AccountType | integer <int32> Nullable The optional new account type id of the account. |
Balance | object (Legacy.UpdateProperty%3CSystem.Nullable%3CDecimal%3E%3E) |
BalanceDate | object (Legacy.UpdateProperty%3CSystem.Nullable%3CDateTime%3E%3E) |
IsActive | boolean Nullable This determines whether the Account is active or not. |
ParentId | object (Legacy.UpdateProperty%3CSystem.Nullable%3CInt32%3E%3E) |
Product | object (Legacy.UpdateProperty%3CSystem.Nullable%3CInt32%3E%3E) |
Status | integer <int32> Nullable The optional new status of the account. |
OpeningDate | object (Legacy.UpdateProperty%3CSystem.Nullable%3CDateTime%3E%3E) |
ClosingDate | object (Legacy.UpdateProperty%3CSystem.Nullable%3CDateTime%3E%3E) |
IntegrationStatus | object (Legacy.UpdateProperty%3CSystem.Nullable%3CInt16%3E%3E) |
CustomAttributes | object (UpdateProperty%3C%3E) |
ContactGroupId | object (Legacy.UpdateProperty%3CInt32%3E) |
AvailableBalance | object (Legacy.UpdateProperty%3CSystem.Nullable%3CDecimal%3E%3E) |
AvailableBalanceLastUpdateDate | object (Legacy.UpdateProperty%3CSystem.Nullable%3CDateTime%3E%3E) |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "AccountNumber": "002500078712000099999",
- "Iban": {
- "DoUpdate": true,
- "Value": "002500078712000099999"
}, - "InternalId": {
- "DoUpdate": true,
- "Value": "712000099999"
}, - "Name": {
- "DoUpdate": true,
- "Value": "002500078712000099999"
}, - "BranchId": 4,
- "AccountType": 5,
- "Balance": {
- "DoUpdate": true,
- "Value": 3000
}, - "BalanceDate": {
- "DoUpdate": true,
- "Value": "2023-05-24T06:59:49.5172217+00:00"
}, - "IsActive": true,
- "ParentId": {
- "DoUpdate": false,
- "Value": 1
}, - "Product": {
- "DoUpdate": false,
- "Value": 3
}, - "Status": 1,
- "OpeningDate": {
- "DoUpdate": true,
- "Value": "2022-05-24T06:59:49.5172346+00:00"
}, - "ClosingDate": {
- "DoUpdate": true,
- "Value": "2023-11-24T06:59:49.5172405+00:00"
}, - "IntegrationStatus": {
- "DoUpdate": false,
- "Value": 1
}, - "CustomAttributes": {
- "DoUpdate": false,
- "Value": "{\"Description\": \"This the deposit Account the Client always wanted to have!\"}"
}, - "AvailableBalance": {
- "DoUpdate": false,
- "Value": 3000
}, - "AvailableBalanceLastUpdateDate": {
- "DoUpdate": false,
- "Value": "2023-05-24T06:59:49.5172423+00:00"
}
}
{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Creates a new account.
contactId required | integer <int32> The ID of the contact for the new account |
language | string The language of the localized resources |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
AccountNumber required | string non-empty The account number for the new account. |
Iban | string Nullable The IBAN for the new account. |
InternalId | string Nullable The Internal Id for the new account. |
Name | string Nullable The name of the new account. |
BranchId required | integer <int32> The id of the branch for the new account. |
CurrencyId required | integer <int32> The id of the currency for the new account. |
ContactGroupId | integer <int32> Nullable The id of the contact group for the new account. |
AccountType required | integer <int32> The id of the account type for the new account. |
Balance | number <double> Nullable The balance for the new account. |
BalanceDate | string <date-time> Nullable The date of the last update of the balance for the new account. |
IsActive | boolean This determines whether the Account is active or not. |
ParentId | integer <int32> Nullable The id of the parent for the new account. |
Product | integer <int32> Nullable The id of the product for the new account. |
Status required | integer <int32> The id of the status for the new account. |
OpeningDate | string <date-time> Nullable The date when the account was opened. |
ClosingDate | string <date-time> Nullable The date when the account was closed. |
IntegrationStatus | integer <int32> Nullable The id of the integration status for the new account. |
CustomAttributes | string Nullable The custom attributes for the new account. |
AvailableBalance | number <double> Nullable This is the available balance of the Account |
AvailableBalanceLastUpdateDate | string <date-time> Nullable This is the last available balance update date of the Account |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "AccountNumber": "002500078712000099999",
- "Iban": "002500078712000099999",
- "InternalId": "871200009999",
- "Name": "002500078712000099999",
- "BranchId": 4,
- "CurrencyId": 2,
- "ContactGroupId": 5,
- "AccountType": 1,
- "Balance": 1854.09,
- "BalanceDate": "2019-12-01T00:00:00",
- "IsActive": true,
- "Product": 3,
- "Status": 1,
- "OpeningDate": "2018-11-28T00:00:00",
- "ClosingDate": "2018-11-29T00:00:00",
- "CustomAttributes": "{\"Description\": \"Is this the Account the Client always wanted to have?\"}",
- "AvailableBalance": 3000,
- "AvailableBalanceLastUpdateDate": "2023-05-24T06:59:49.6130063+00:00"
}
{- "ContactId": 1,
- "Account": {
- "Id": 7,
- "UId": "00000000-0000-0000-0000-000000000000",
- "AccountNumber": "00250007871200007549",
- "Iban": "00250007871200007549",
- "InternalId": "871200007549",
- "Name": "00250007871200007549",
- "Balance": 1854.09,
- "BalanceLastUpdateDate": "2019-12-01T00:00:00",
- "BranchId": 4,
- "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Euro",
- "CurrencyCode": "EUR",
- "Symbol": "€",
- "RiskFreeRate": -0.005
}, - "ContactGroupId": 5,
- "Type": {
- "Id": 1,
- "Name": "Cash",
- "InternalId": "Cash"
}, - "IsActive": true,
- "OpeningDate": "2022-05-24T06:59:49.6133658+00:00",
- "Product": {
- "Fees": [ ],
- "Id": 3,
- "UId": "00000000-0000-0000-0000-000000000000",
- "ProductOfferId": 1,
- "Name": "<root><de>Discretionary</de><en>Discretionary</en><fr>Discretionary</fr><ja>Discretionary</ja><ru>Discretionary</ru></root>",
- "Description": "<root><de>Discretionary</de><en>Discretionary</en><fr /><ja /><ru /></root>",
- "Image": "",
- "Factsheet": "<root><en /></root>",
- "IsBlockOrderBookEnabled": true,
- "IsOrderBookEnabled": true
}, - "Status": {
- "Id": 1,
- "Name": "Active"
}, - "ClosingDate": "2023-11-24T06:59:49.613368+00:00",
- "IntegrationStatus": {
- "Id": 1,
- "Name": "In Opening",
- "ExternalId": "In Opening"
}, - "Attributes": "{\"Description\": \"This the Account the Client always wanted to have!\"}",
- "SubAccounts": [ ]
}
}
Allows the User to search for Accounts of an authenticated Contact for a given set of criteria
contactId required | integer <int32> The contactId of the contact |
language | string The language of the localized resources |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The search request parameters
BranchIds | Array of integers <int32> Nullable |
CurrencyIds | Array of integers <int32> Nullable Array with Currency Ids |
ContactGroupIds | Array of integers <int32> Nullable Array with Contact Group Ids |
AccountTypes | Array of strings (Domain.Abstractions.Enums.AccountType) Nullable Items Enum: "Cash" "Custody" "Savings" "Settlement" "Deposit" Array with Account Type Ids |
IsActive | boolean Nullable If null, active or inactive accounts are returned |
ProductIds | Array of integers <int32> Nullable Array with Product Ids |
AccountStatuses | Array of strings (AccountStatusId) Nullable Items Enum: "Active" "Blocked" "Inactive" "Closed" Array with Account Status Ids |
Page | integer <int32> |
PageSize | integer <int32> |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "BranchIds": [
- 1
], - "CurrencyIds": [
- 1
], - "ContactGroupIds": [
- 1
], - "AccountTypes": [
- "Cash"
], - "IsActive": true,
- "ProductIds": [
- 1
], - "AccountStatuses": [
- "Active"
], - "Page": 1,
- "PageSize": 10
}
{- "Results": [
- {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "AccountNumber": "12345800",
- "Iban": "CH9300762011623852957",
- "InternalId": "123456",
- "Name": "My New Account",
- "Balance": 1200,
- "BranchId": 12,
- "Currency": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Swiss Franc",
- "CurrencyCode": "CHF",
- "Symbol": "Fr",
- "RiskFreeRate": 0.0005
}, - "ContactGroupId": 6,
- "Type": {
- "Id": 1,
- "Name": "Cash",
- "InternalId": "Cash"
}, - "IsActive": true,
- "ParentId": 2,
- "OpeningDate": "2019-11-01T00:00:00",
- "ProductId": 1,
- "Status": {
- "Id": 1,
- "Name": "Active"
}, - "ClosingDate": "2020-01-01T00:00:00",
- "IntegrationStatus": {
- "Id": 1,
- "Name": "Integration Test",
- "ExternalId": "IntegrationTest"
}, - "Attributes": "{Test: 123}",
- "SubAccounts": [
- 1,
- 2,
- 3
], - "AvailableBalance": 3000,
- "AvailableBalanceLastUpdateDate": "2022-08-18T00:00:00"
}, - {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "AccountNumber": "5000000",
- "Iban": "CH9300000000000000000",
- "InternalId": "100000",
- "Name": "My Other Account",
- "Balance": 1200,
- "BranchId": 12,
- "Currency": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "EURO",
- "CurrencyCode": "EUR",
- "Symbol": "€",
- "RiskFreeRate": 0.0005
}, - "ContactGroupId": 6,
- "Type": {
- "Id": 1,
- "Name": "Cash",
- "InternalId": "Cash"
}, - "IsActive": true,
- "ParentId": 2,
- "OpeningDate": "2019-11-01T00:00:00",
- "ProductId": 1,
- "Status": {
- "Id": 1,
- "Name": "Active"
}, - "ClosingDate": "2020-01-01T00:00:00",
- "IntegrationStatus": {
- "Id": 1,
- "Name": "Integration Test",
- "ExternalId": "IntegrationTest"
}, - "Attributes": "{Test: 123}",
- "SubAccounts": [
- 1,
- 2,
- 3
], - "AvailableBalance": 3000,
- "AvailableBalanceLastUpdateDate": "2022-08-18T00:00:00"
}
], - "Page": 1,
- "PageSize": 10,
- "PageCount": 1,
- "TotalCount": 2
}
Searches for accounts and returns a list with accounts (and key attributes) matching the passed request parameters.
Sorting can be performed by specifying any property name or child property name using navigation (PortfolioChangeId, LimitPrice, ExternalId) in SortBy property in the request.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request DTO
AccountNumber | string Nullable |
Iban | string Nullable |
InternalId | string Nullable |
Name | string Nullable |
Ids | Array of integers <int32> Nullable |
BranchIds | Array of integers <int32> Nullable |
BankIds | Array of integers <int32> Nullable |
CurrencyIds | Array of integers <int32> Nullable |
ContactIds | Array of integers <int32> Nullable |
ContactGroupIds | Array of integers <int32> Nullable |
AccountTypeIds | Array of integers <int32> Nullable |
IsActive | boolean Nullable |
ParentIds | Array of integers <int32> Nullable |
ProductIds | Array of integers <int32> Nullable |
AccountStatusIds | Array of integers <int32> Nullable |
BalanceUpdateDateFrom | string <date-time> Nullable |
BalanceUpdateDateTo | string <date-time> Nullable |
OpeningDateFrom | string <date-time> Nullable |
OpeningDateTo | string <date-time> Nullable |
ClosingDateFrom | string <date-time> Nullable |
ClosingDateTo | string <date-time> Nullable |
SortBy | string Nullable |
SortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
Page | integer <int32> |
PageSize | integer <int32> |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "AccountNumber": "string",
- "Iban": "string",
- "InternalId": "string",
- "Name": "string",
- "Ids": [
- 0
], - "BranchIds": [
- 0
], - "BankIds": [
- 0
], - "CurrencyIds": [
- 0
], - "ContactIds": [
- 0
], - "ContactGroupIds": [
- 0
], - "AccountTypeIds": [
- 0
], - "IsActive": true,
- "ParentIds": [
- 0
], - "ProductIds": [
- 0
], - "AccountStatusIds": [
- 0
], - "BalanceUpdateDateFrom": "2023-05-24T07:09:17Z",
- "BalanceUpdateDateTo": "2023-05-24T07:09:17Z",
- "OpeningDateFrom": "2023-05-24T07:09:17Z",
- "OpeningDateTo": "2023-05-24T07:09:17Z",
- "ClosingDateFrom": "2023-05-24T07:09:17Z",
- "ClosingDateTo": "2023-05-24T07:09:17Z",
- "SortBy": "string",
- "SortOrder": "Ascending",
- "Page": 0,
- "PageSize": 0
}
{- "Results": [
- {
- "Id": 0,
- "AccountNumber": "string",
- "Iban": "string",
- "InternalId": "string",
- "Name": "string",
- "BranchId": 0,
- "CurrencyId": 0,
- "ContactGroupId": 0,
- "AccountTypeId": 0,
- "IsActive": true,
- "ParentId": 0,
- "ProductId": 0,
- "AccountStatusId": 0,
- "Balance": 0,
- "BalanceUpdateDate": "2023-05-24T07:09:17Z",
- "OpeningDate": "2023-05-24T07:09:17Z",
- "ClosingDate": "2023-05-24T07:09:17Z",
- "AvailableBalance": 0,
- "AvailableBalanceLastUpdateDate": "2023-05-24T07:09:17Z"
}
], - "Page": 0,
- "PageSize": 0,
- "PageCount": 0,
- "TotalCount": 0
}
Delete bank
id required | integer <int32> Id of the existing bank |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Return a bank by id
id required | integer <int32> Bank id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Id": 1,
- "Name": "Europe bank",
- "Bic": "BARCGB22XXX",
- "Code": "x9x9x9x"
}
Update existing bank
id required | integer <int32> Id of the existing bank |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the bank to update
Name | string Nullable |
Bic | string Nullable |
Code | string Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Name": "string",
- "Bic": "string",
- "Code": "string"
}
{- "Id": 1,
- "Name": "Europe bank",
- "Bic": "BARCGB22XXX",
- "Code": "x9x9x9x"
}
Deletes bank account type
id required | integer <int32> Id of the existing bank account type |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Returns a bank account type by id
id required | integer <int32> Bank account type id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Id": 1,
- "Name": "Cash",
- "InternalId": "Cash",
- "Description": "Cash account type"
}
Updates existing bank account type
id required | integer <int32> Id of the existing bank account type |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the bank account type to update
Name | string Nullable |
InternalId | string Nullable |
Description | string Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Name": "Cash",
- "InternalId": "Cash",
- "Description": "Cash account type"
}
{- "Id": 1,
- "Name": "Cash",
- "InternalId": "Cash",
- "Description": "Cash account type"
}
Delete bank branch from the system.
id required | integer <int32> Id of the existing bank branch |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Returns the list of all banks in the system.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Server Error
[- {
- "Id": 0,
- "Name": "string",
- "Bic": "string",
- "Code": "string"
}
]
Create a new bank
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the bank to create
Name | string Nullable |
Bic | string Nullable |
Code | string Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Name": "string",
- "Bic": "string",
- "Code": "string"
}
{- "Id": 1,
- "Name": "Europe bank",
- "Bic": "BARCGB22XXX",
- "Code": "x9x9x9x"
}
Returns the list of all bank account types in the system.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Server Error
[- {
- "Id": 0,
- "Name": "string",
- "InternalId": "string",
- "Description": "string"
}
]
Creates a new bank account type
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the bank account type to create
Name | string Nullable |
InternalId | string Nullable |
Description | string Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Name": "Cash",
- "InternalId": "Cash",
- "Description": "Cash account type"
}
{- "Id": 1,
- "Name": "Cash",
- "InternalId": "Cash",
- "Description": "Cash account type"
}
Returns bank branch by its id
id required | integer <int32> Id of the bank branch |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Id": 1,
- "Name": "0001 AD",
- "BankId": 1,
- "CountryId": 2,
- "Code": "227",
- "AddressLine1": "Rue des Avenges",
- "AddressLine2": "25",
- "AddressLine3": "6356",
- "AddressLine4": "Andorra",
- "Bic": "AD63746",
- "PhoneNumber": "+3233356989"
}
Update existing bank branch.
id required | integer <int32> Id of the existing bank branch |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the bank branch to update
Name | string Nullable |
BankId | integer <int32> |
CountryId | integer <int32> Nullable |
Code | string Nullable |
AddressLine1 | string Nullable |
AddressLine2 | string Nullable |
AddressLine3 | string Nullable |
AddressLine4 | string Nullable |
Bic | string Nullable |
PhoneNumber | string Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Name": "Branch 1",
- "BankId": 1,
- "CountryId": 2,
- "Code": "227",
- "AddressLine1": "Rue des Avenges",
- "AddressLine2": "25",
- "AddressLine3": "6356",
- "AddressLine4": "Andorra",
- "Bic": "AD63746",
- "PhoneNumber": "+32|33356989"
}
{- "Id": 1,
- "Name": "0001 AD",
- "BankId": 1,
- "CountryId": 2,
- "Code": "227",
- "AddressLine1": "Rue des Avenges",
- "AddressLine2": "25",
- "AddressLine3": "6356",
- "AddressLine4": "Andorra",
- "Bic": "AD63746",
- "PhoneNumber": "+3233356989"
}
Returns the list of all bank branches in the system.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Server Error
[- {
- "Id": 0,
- "Name": "string",
- "BankId": 0,
- "BankName": "string",
- "CountryId": 0,
- "CountryName": "string",
- "Code": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "AddressLine4": "string",
- "Bic": "string",
- "PhoneNumber": "string"
}
]
Create a new bank branch in the system.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the bank branch to create
Name | string Nullable |
BankId | integer <int32> |
CountryId | integer <int32> Nullable |
Code | string Nullable |
AddressLine1 | string Nullable |
AddressLine2 | string Nullable |
AddressLine3 | string Nullable |
AddressLine4 | string Nullable |
Bic | string Nullable |
PhoneNumber | string Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Name": "Branch 1",
- "BankId": 1,
- "CountryId": 2,
- "Code": "227",
- "AddressLine1": "Rue des Avenges",
- "AddressLine2": "25",
- "AddressLine3": "6356",
- "AddressLine4": "Andorra",
- "Bic": "AD63746",
- "PhoneNumber": "+32|33356989"
}
{- "Id": 1,
- "Name": "0001 AD",
- "BankId": 1,
- "CountryId": 2,
- "Code": "227",
- "AddressLine1": "Rue des Avenges",
- "AddressLine2": "25",
- "AddressLine3": "6356",
- "AddressLine4": "Andorra",
- "Bic": "AD63746",
- "PhoneNumber": "+3233356989"
}
Deletes a risk category.
id required | integer <int32> The Id of the risk category |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Delete economical zone
id required | integer <int32> Id of the existing economical zone |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Return a economical zone by id.
This API is deprecated. Use GET /v1.1/economicalzones/{id} instead
id required | integer <int32> Economical zone id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Id": 1,
- "Name": "<root><de>Europe zone</de><en>Europe zone</en><fr>Europe zone</fr><ja>Europe zone</ja><ru>Europe zone</ru></root>",
- "Color": "#56d96f"
}
Update existing economical zone.
This API is deprecated. Use PUT /v1.1/economicalzones/{id} instead
id required | integer <int32> Id of the existing economical zone |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the economical zone to update
Name required | Array of objects (LocalizedValue) |
Color | string Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Name": [
- {
- "LanguageCode": "string",
- "Value": "string"
}
], - "Color": "string"
}
{- "Id": 1,
- "Name": "<root><de>Europe zone</de><en>Europe zone</en><fr>Europe zone</fr><ja>Europe zone</ja><ru>Europe zone</ru></root>",
- "Color": "#56d96f"
}
Deletes a rating agency.
ratingAgencyId required | integer <int32> Rating agency Id to be deleted |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Returns a rating agency by its id.
ratingAgencyId required | integer <int32> Rating agency Id |
language | string Language to translate the resource. If null, returns xml for all languages |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Id": 0,
- "Name": "string",
- "Description": "string"
}
Updates an existing rating agency.
This API is deprecated. Use PATCH /v1.1/ratingagencies/{ratingAgencyId} instead
ratingAgencyId required | integer <int32> Rating agency Id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Request data
Name | object (UpdateProperty%3C%3E) |
Description | object (UpdateProperty%3C%3E) |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Name": {
- "DoUpdate": true,
- "Value": "string"
}, - "Description": {
- "DoUpdate": true,
- "Value": "string"
}
}
{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Deletes a rating.
ratingAgencyId required | integer <int32> Rating agency Id |
ratingId required | integer <int32> Rating Id to be deleted |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Returns a rating by its id.
ratingAgencyId required | integer <int32> Rating agency Id |
ratingId required | integer <int32> Rating Id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Rating": {
- "Id": 1,
- "Value": "Aaa",
- "Color": "J1827651"
}, - "RatingAgency": {
- "Id": 1,
- "Name": "Moody's"
}
}
Updates an existing rating.
This API is deprecated. Use PATCH /v1.1/ratingagencies/{ratingAgencyId}/ratings/{ratingId} instead.
ratingAgencyId required | integer <int32> Rating agency Id |
ratingId required | integer <int32> Rating Id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Request data
Value | object (UpdateProperty%3C%3E) |
Color | object (UpdateProperty%3C%3E) |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Value": {
- "DoUpdate": true,
- "Value": "string"
}, - "Color": {
- "DoUpdate": true,
- "Value": "string"
}
}
{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Performs a health check of the system. Will return "OK" as "text/plain" if everything is working properly.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Server Error
{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Returns system settings. If the optional group parameter is passed only settings for this group will be returned, otherwise all available settings.
group | string |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
[- {
- "Key": "string",
- "Value": "string",
- "Group": "string"
}
]
Returns a specific system setting. The name of the group and the name of the key need to be supplied.
group required | string |
key required | string |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Key": "string",
- "Value": "string",
- "Group": "string"
}
Returns campaign configuration data. Returns data about the active campaign of the tenant, including a list of product offers and their products, the list of supported languages and the default language. The language DTOs also contain specifications that can be used for number formatting (NumberDecimalSeparator and NumberGroupSeparator).
language required | string |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "ProductOffers": [
- {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "Picture": "string",
- "IsActive": true,
- "ExternalId": "string",
- "CreateDate": "2023-05-24T07:09:17Z",
- "ProductType": {
- "Id": 0,
- "Name": "string"
}, - "Products": [
- {
- "Id": 0,
- "UId": "string",
- "ProductOfferId": 0,
- "OfferName": "string",
- "Name": "string",
- "Description": "string",
- "Image": "string",
- "Factsheet": "string",
- "MinimumInvestmentValue": 0,
- "MaximumInvestmentValue": 0,
- "ExternalId": "string",
- "IsBlockOrderBookEnabled": true,
- "IsOrderBookEnabled": true,
- "Fees": [
- {
- "FeeId": 0,
- "FeeDefinitionId": 0,
- "ValidFrom": "2023-05-24T07:09:17Z",
- "ValidTo": "2023-05-24T07:09:17Z",
- "FeeType": {
- "Id": 0,
- "Name": "string"
}, - "FeeRecurrenceType": {
- "Id": 0,
- "Name": "string"
}, - "IsPercentage": true,
- "ValueFrom": 0,
- "ValueTo": 0,
- "FeeValue": 0
}
], - "DefaultOrderBookStatus": {
- "Key": "Reconciliation",
- "Id": 0,
- "Name": "string"
}, - "PortfolioRebalancingType": {
- "Key": "NoRebalancing",
- "Id": 0,
- "Name": "string"
}, - "OptimizationConstraintId": 0,
- "Settings": "string",
- "IsActive": true,
- "ContactType": {
- "Id": 0,
- "Name": "string"
}
}
], - "Currencies": [
- {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}
]
}
], - "Languages": [
- {
- "NumberDecimalSeparator": "string",
- "NumberGroupSeparator": "string",
- "Id": 0,
- "Name": "string",
- "ThreeLetterIsoCode": "string",
- "TwoLetterIsoCode": "string",
- "CultureCode": "string"
}
], - "DefaultLanguage": {
- "NumberDecimalSeparator": "string",
- "NumberGroupSeparator": "string",
- "Id": 0,
- "Name": "string",
- "ThreeLetterIsoCode": "string",
- "TwoLetterIsoCode": "string",
- "CultureCode": "string"
}, - "DefaultTimeZoneUtcOffsetMinutes": 0
}
Gets the details of a product.
productId required | integer <int32> The id of the product |
language required | string The language of the localized resources |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "Image": "string",
- "Factsheet": "string",
- "MinimumInvestmentValue": 0,
- "MaximumInvestmentValue": 0,
- "ExternalId": "string",
- "IsBlockOrderBookEnabled": true,
- "IsOrderBookEnabled": true,
- "Fees": [
- {
- "FeeId": 0,
- "FeeDefinitionId": 0,
- "ValidFrom": "2023-05-24T07:09:17Z",
- "ValidTo": "2023-05-24T07:09:17Z",
- "FeeType": {
- "Id": 0,
- "Name": "string"
}, - "FeeRecurrenceType": {
- "Id": 0,
- "Name": "string"
}, - "IsPercentage": true,
- "ValueFrom": 0,
- "ValueTo": 0,
- "FeeValue": 0
}
], - "DefaultOrderBookStatus": {
- "Key": "Reconciliation",
- "Id": 0,
- "Name": "string"
}, - "PortfolioRebalancingType": {
- "Key": "NoRebalancing",
- "Id": 0,
- "Name": "string"
}, - "OptimizationConstraintId": 0,
- "IsActive": true,
- "ProductOfferId": 0,
- "ProductOffer": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "Settings": "string"
}
Returns the list of all countries in the system.
language required | string The language of the localized resources |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
[- {
- "Id": 0,
- "UId": "string",
- "CountryCode": "string",
- "Name": "string",
- "ThreeLetterIsoCode": "string",
- "ThreeLetterExternalCode": "string",
- "PhoneCode": "string",
- "Continent": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}, - "EconomicalZone": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}
}
]
Returns the list of all languages in the system.
language required | string The language of the localized resources |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
[- {
- "Id": 0,
- "Name": "string",
- "ThreeLetterIsoCode": "string",
- "TwoLetterIsoCode": "string",
- "CultureCode": "string"
}
]
Returns a list of all available data sources.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Server Error
[- {
- "Name": "string",
- "CampaignId": 0,
- "OfferId": 0
}
]
Returns a list of stored procedures available for the provided data source and schema
dataSourceName required | string Name of the data source |
schema required | string Name of the specific DB schema |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
[- {
- "Name": "string"
}
]
Gets all risk categories for a specific product
productId required | integer <int32> |
language required | string |
active | boolean |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
[- {
- "Description": "string",
- "Return": 0,
- "ValidYears": 0,
- "RiskCategoryDefinitionId": 0,
- "RiskCategoryId": 0,
- "IsActive": true,
- "OptimizationConstraints": {
- "Id": 0,
- "AssetClassConstraints": [
- {
- "MinWeight": 0,
- "MaxWeight": 0,
- "AssetClass": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "Color": "string",
- "Parent": { },
- "ParentId": 0,
- "IsActive": true,
- "ExternalId": "string",
- "BenchmarkId": 0
}
}
], - "CurrencyConstraints": [
- {
- "MinWeight": 0,
- "MaxWeight": 0,
- "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}
}
], - "SecuritySectorConstraints": [
- {
- "MinWeight": 0,
- "MaxWeight": 0,
- "SecuritySector": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "Parent": { },
- "ParentId": 0,
- "Color": "string",
- "IsActive": true,
- "ExternalId": "string",
- "BenchmarkId": 0
}
}
], - "SecurityConstraints": [
- {
- "MinWeight": 0,
- "MaxWeight": 0,
- "Security": {
- "Id": 0,
- "Name": "string",
- "Isin": "string",
- "TradingPrice": 0,
- "FaceValue": 0,
- "ExternalId": "string",
- "AssetClass": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "Color": "string",
- "Parent": { },
- "ParentId": 0,
- "IsActive": true,
- "ExternalId": "string",
- "BenchmarkId": 0
}, - "Type": {
- "Id": 0,
- "Name": "string",
- "Description": "string",
- "Color": "string",
- "ExternalId": "string"
}, - "Sector": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "Parent": { },
- "ParentId": 0,
- "Color": "string",
- "IsActive": true,
- "ExternalId": "string",
- "BenchmarkId": 0
}, - "Country": {
- "Id": 0,
- "UId": "string",
- "CountryCode": "string",
- "Name": "string",
- "ThreeLetterIsoCode": "string",
- "ThreeLetterExternalCode": "string",
- "PhoneCode": "string",
- "Continent": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}, - "EconomicalZone": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}
}, - "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}, - "BondExtension": {
- "MaturityDate": "2023-05-24T07:09:17Z",
- "BondCouponFrequency": {
- "Key": "Quarterly",
- "Id": 0,
- "Name": "string"
}, - "CouponType": {
- "Key": "Fixed",
- "Id": 0,
- "Name": "string"
}, - "Coupon": 0,
- "IssuerType": {
- "Key": "Government",
- "Id": 0,
- "Name": "string"
}, - "IssueDate": "2023-05-24T07:09:17Z"
}, - "OptionExtension": {
- "Strike": 0,
- "IsPut": true,
- "MaturityDate": "2023-05-24T07:09:17Z",
- "OptionExerciseType": {
- "Key": "European",
- "Id": 0,
- "Name": "string"
}
}, - "FutureExtension": {
- "MaturityDate": "2023-05-24T07:09:17Z"
}, - "FundExtension": {
- "SecurityId": 0,
- "InceptionDate": "2023-05-24T07:09:17Z",
- "OfferingFromDate": "2023-05-24T07:09:17Z",
- "OfferingToDate": "2023-05-24T07:09:17Z",
- "Cap": 0,
- "CurrentFill": 0,
- "MinimumInvestmentAmount": 0,
- "MinimumIncrementAmount": 0,
- "FundTypeId": 0,
- "FundManagementTypeId": 0,
- "FundInvestmentTypeId": 0,
- "FundType": {
- "Key": "MutualFund",
- "Id": 0,
- "Name": "string"
}, - "FundManagementType": {
- "Key": "Passive",
- "Id": 0,
- "Name": "string"
}, - "FundInvestmentType": {
- "Key": "OpenEnd",
- "Id": 0,
- "Name": "string"
}
}, - "Ratings": [
- {
- "Id": 0,
- "Value": "string",
- "Color": "string",
- "Agency": {
- "Id": 0,
- "Name": "string",
- "Description": "string"
}
}
], - "Focus": {
- "Id": 0,
- "Name": "string",
- "Parent": { }
}, - "SecurityStockExchanges": [
- {
- "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}, - "Ticker": "string",
- "IsDefault": true,
- "SecurityStockExchangeId": "string",
- "PriceFeedIntegrationIdentifier": "string",
- "PriceFeedIntegrationIdentifierType": "string",
- "StockExchange": {
- "Id": 0,
- "MarketCode": "string",
- "Description": "string",
- "Country": {
- "Id": 0,
- "UId": "string",
- "CountryCode": "string",
- "Name": "string",
- "ThreeLetterIsoCode": "string",
- "ThreeLetterExternalCode": "string",
- "PhoneCode": "string",
- "Continent": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}, - "EconomicalZone": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}
}
}
}
], - "IsInvestable": true,
- "IsActive": true,
- "IsShariahCompliant": true,
- "CustomAttributes": "string",
- "TradingUnit": 0,
- "RoundingLot": 0,
- "BenchmarkId": 0,
- "Factor": 0,
- "IsPricePercentage": true,
- "LogoUrl": "string",
- "UId": "string"
}
}
], - "SecurityTypeConstraints": [
- {
- "MinWeight": 0,
- "MaxWeight": 0,
- "SecurityType": {
- "Id": 0,
- "Name": "string",
- "Description": "string",
- "Color": "string",
- "ExternalId": "string"
}
}
], - "ContinentConstraints": [
- {
- "MinWeight": 0,
- "MaxWeight": 0,
- "Continent": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}
}
], - "EconomicalZoneConstraints": [
- {
- "MinWeight": 0,
- "MaxWeight": 0,
- "EconomicalZone": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}
}
], - "CountryConstraints": [
- {
- "MinWeight": 0,
- "MaxWeight": 0,
- "Country": {
- "Id": 0,
- "UId": "string",
- "CountryCode": "string",
- "Name": "string",
- "ThreeLetterIsoCode": "string",
- "ThreeLetterExternalCode": "string",
- "PhoneCode": "string",
- "Continent": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}, - "EconomicalZone": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}
}
}
]
}, - "Id": 0,
- "Name": "string",
- "Min": 0,
- "Max": 0,
- "ExpectedReturn": 0,
- "Color": "string",
- "Attributes": "string"
}
]
Returns the list of all risk categories.
language required | string The language in which to return all properties |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
[- {
- "Id": 0,
- "Name": "string",
- "ExternalId": "string"
}
]
Creates a risk category.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO.
Name | Array of objects (LocalizedValue) Nullable The Name of the risk category |
ExternalId | string Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Name": [
- {
- "LanguageCode": "string",
- "Value": "string"
}
], - "ExternalId": "string"
}
{- "Id": 0
}
This API is deprecated. Use GET /v1.2/riskcategories/{id} instead
id required | integer <int32> The id of the risk category. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Id": 0,
- "Name": "string",
- "ExternalId": "string"
}
Updates a risk category.
id required | integer <int32> The id of the risk category. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO.
Name | Array of objects (LocalizedValue) Nullable The Name of the risk category |
ExternalId | string Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Name": [
- {
- "LanguageCode": "string",
- "Value": "string"
}
], - "ExternalId": "string"
}
{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Returns a risk cateogry by its id.
id required | integer <int32> The id of the risk category. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Id": 0,
- "Name": "string",
- "ExternalId": "string"
}
Gets the constraints of a product by ID
productId required | integer <int32> The ID of the product to retrieve optimization constraints for |
language required | string The language in which to return all properties |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Id": 0,
- "OptimizationConstraints": {
- "Id": 0,
- "AssetClassConstraints": [
- {
- "AssetClass": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "MinWeight": 0,
- "MaxWeight": 0
}
], - "CurrencyConstraints": [
- {
- "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string"
}, - "MinWeight": 0,
- "MaxWeight": 0
}
], - "SecuritySectorConstraints": [
- {
- "SecuritySector": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "MinWeight": 0,
- "MaxWeight": 0
}
], - "SecurityConstraints": [
- {
- "Security": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Isin": "string",
- "AssetClass": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "Type": {
- "Id": 0,
- "Name": "string"
}, - "Sector": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string"
}
}, - "MinWeight": 0,
- "MaxWeight": 0
}
], - "SecurityTypeConstraints": [
- {
- "SecurityType": {
- "Id": 0,
- "Name": "string"
}, - "MinWeight": 0,
- "MaxWeight": 0
}
], - "ContinentConstraints": [
- {
- "Continent": {
- "Id": 0,
- "Name": "string"
}, - "MinWeight": 0,
- "MaxWeight": 0
}
], - "EconomicalZoneConstraints": [
- {
- "EconomicalZone": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}, - "MinWeight": 0,
- "MaxWeight": 0
}
], - "CountryConstraints": [
- {
- "Country": {
- "Id": 0,
- "UId": "string",
- "CountryCode": "string",
- "Name": "string",
- "ThreeLetterIsoCode": "string"
}, - "MinWeight": 0,
- "MaxWeight": 0
}
]
}
}
Returns the tree of all assetclasses in the system.
language required | string The language of the localized resources |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
[- {
- "Data": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "Color": "string",
- "ParentId": 0,
- "IsActive": true,
- "ExternalId": "string",
- "BenchmarkId": 0
}, - "Children": [
- { }
]
}
]
Returns the list of all continents in the system.
language required | string The language of the localized resources |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
[- {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}
]
Returns the list of all securitytypes in the system.
language required | string The language of the localized resources |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
[- {
- "Id": 0,
- "Name": "string",
- "Description": "string",
- "Color": "string",
- "ExternalId": "string"
}
]
Returns the tree of all security sectors in the system.
language required | string The language of the localized resources |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
[- {
- "Data": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "Parent": { },
- "ParentId": 0,
- "Color": "string",
- "IsActive": true,
- "ExternalId": "string",
- "BenchmarkId": 0
}, - "Children": [
- { }
]
}
]
Returns the list of all economical zones in the system.
language required | string Language value for xml fields |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
[- {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}
]
Create a new economical zone.
This API is deprecated. Use POST /v1.1/economicalzones instead
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the economical zone to create
Name required | Array of objects (LocalizedValue) |
Color | string Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Name": [
- {
- "LanguageCode": "string",
- "Value": "string"
}
], - "Color": "string"
}
{- "Id": 1,
- "Name": "<root><de>Europe zone</de><en>Europe zone</en><fr>Europe zone</fr><ja>Europe zone</ja><ru>Europe zone</ru></root>",
- "Color": "#56d96f"
}
Return a economical zone by id
id required | integer <int32> Economical zone id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Id": 0,
- "Name": "string",
- "Color": "string"
}
Update existing economical zone
id required | integer <int32> Id of the existing economical zone |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the economical zone to update
Name required | string non-empty |
Color | string Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Name": "string",
- "Color": "string"
}