DFS Fee Services API (latest)

Download OpenAPI specification:Download

Calculates fees/costs for orders in DFS (e.g. Portfolio operations like set up, rebalancing).

For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.

FeeManagement

Retrieve applicable fees for each portfolio change

Retrieves applicable fees for each portfolio change according to pricing

Authorizations:

Bearer

path Parameters

portfolioChangeTypeId

required

integer <int32>

Portfolio Change Type Id

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/fees/portfolio-change-types/{portfolioChangeTypeId}

https://example-host/v1.0/fees/portfolio-change-types/{portfolioChangeTypeId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
[
{"orderTypeId": 0,
"orderTypeName": "string",
"fees": 
[
{"feeTypeId": 0,
"feeTypeName": "string",
"categoryId": 0,
"categoryName": "string",
"parentCategoryId": 0,
"parentCategoryName": "string",
"priority": "string"
}
]
}
]
}

Update applicable fees for each portfolio change

Updates applicable fees for each portfolio change according to pricing

Authorizations:

Bearer

path Parameters

portfolioChangeTypeId

required

integer <int32>

Portfolio Change Type Id

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Request DTO

orderTypeId	integer <int32>
fees	Array of objects (FeeRequest) Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v1.0/fees/portfolio-change-types/{portfolioChangeTypeId}

https://example-host/v1.0/fees/portfolio-change-types/{portfolioChangeTypeId}

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"orderTypeId": 0,
"fees": 
[
{"feeTypeId": 0,
"priority": "string"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

Get fee categories

Gets fee categories.

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/fees/categories

https://example-host/v1.0/fees/categories

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"feeCategories": 
[
{"id": 0,
"name": "string",
"parentId": 0
}
]
}

Calculate estimated trade(s) fees

Calculates estimated trade(s) fees. The fees will be presented at 3 different levels, grouped by instrument, accounts and consolidated in the aggregation currency provided.

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Simulate fees request

portfolioId	integer <int32> Nullable Id of portfolio
productId	integer <int32> Nullable Product used for standard pricing. Only provided when no Portfolio is provided
portfolioChangeTypeId	integer <int32> Portfolio change type used in the trades (e.g. Rebalancing, Initial Set-up, etc)
aggregationCurrencyId	integer <int32> Nullable Currency used as a presentation currency for the fees
orderBookEntries	Array of objects (OrderBookEntry) Nullable

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/order-book/fees/simulate

https://example-host/v1.0/order-book/fees/simulate

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"portfolioId": 0,
"productId": 0,
"portfolioChangeTypeId": 0,
"aggregationCurrencyId": 0,
"orderBookEntries": 
[
{"instrumentId": 0,
"accountId": 0,
"amountInstrumentCurrency": 0,
"orderTypeId": 0,
"quantity": 0,
"price": 0,
"stockExchangeOrderTypeId": 0
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"orderBookEntries": 
[
{"instrumentId": 0,
"instrumentCurrencyId": 0,
"instrumentCurrencyThreeLetterIsoCode": "string",
"accountId": 0,
"accountCurrencyId": 0,
"accountCurrencyThreeLetterIsoCode": "string",
"fxRateInstrumentAccount": 0,
"fxRateInstrumentSystem": 0,
"fxRateAggregationInstrument": 0,
"percentageAmount": 0,
"percentageAmountYearly": 0,
"percentageOneTimeAmount": 0,
"percentageInducementAmount": 0,
"percentageInducementAmountYearly": 0,
"accountCurrency": 
{"oneTimeAmount": 0,
"recurringAmountYearly": 0,
"oneTimeInducementAmount": 0,
"recurringInducementAmountYearly": 0
},
"instrumentCurrency": 
{"oneTimeAmount": 0,
"recurringAmountYearly": 0,
"oneTimeInducementAmount": 0,
"recurringInducementAmountYearly": 0
},
"aggregationCurrency": 
{"oneTimeAmount": 0,
"recurringAmountYearly": 0,
"oneTimeInducementAmount": 0,
"recurringInducementAmountYearly": 0
},
"feeCategories": 
[
{"id": 0,
"name": "string",
"accountCurrency": 
{"amount": 0,
"amountYearly": 0,
"oneTimeAmount": 0,
"inducementAmount": 0,
"inducementAmountYearly": 0
},
"instrumentCurrency": 
{"amount": 0,
"amountYearly": 0,
"oneTimeAmount": 0,
"inducementAmount": 0,
"inducementAmountYearly": 0
},
"aggregationCurrency": 
{"amount": 0,
"amountYearly": 0,
"oneTimeAmount": 0,
"inducementAmount": 0,
"inducementAmountYearly": 0
},
"percentageAmount": 0,
"percentageAmountYearly": 0,
"percentageOneTimeAmount": 0,
"percentageInducementAmount": 0,
"percentageInducementAmountYearly": 0,
"childCategories": 
[
{"id": 0,
"name": "string",
"accountCurrency": 
{"amount": 0,
"amountYearly": 0,
"oneTimeAmount": 0,
"inducementAmount": 0,
"inducementAmountYearly": 0
},
"instrumentCurrency": 
{"amount": 0,
"amountYearly": 0,
"oneTimeAmount": 0,
"inducementAmount": 0,
"inducementAmountYearly": 0
},
"aggregationCurrency": 
{"amount": 0,
"amountYearly": 0,
"oneTimeAmount": 0,
"inducementAmount": 0,
"inducementAmountYearly": 0
},
"percentageAmount": 0,
"percentageAmountYearly": 0,
"percentageOneTimeAmount": 0,
"percentageInducementAmount": 0,
"percentageInducementAmountYearly": 0
}
]
}
],
"fees": 
[
{"id": 0,
"feeType": 
{"id": 0,
"name": "string"
},
"recurrenceType": 
{"id": 0,
"name": "string"
},
"category": 
{"id": 0,
"name": "string",
"parentCategoryId": 0,
"parentCategory": "string"
},
"accountCurrency": 
{"amount": 0,
"amountYearly": 0,
"inducementAmount": 0,
"inducementAmountYearly": 0
},
"instrumentCurrency": 
{"amount": 0,
"amountYearly": 0,
"inducementAmount": 0,
"inducementAmountYearly": 0
},
"aggregationCurrency": 
{"amount": 0,
"amountYearly": 0,
"inducementAmount": 0,
"inducementAmountYearly": 0
},
"percentageAmount": 0,
"percentageAmountYearly": 0,
"percentageInducementAmount": 0,
"percentageInducementAmountYearly": 0
}
]
}
],
"aggregatedFees": 
{"systemCurrencyId": 0,
"systemCurrencyThreeLetterIsoCode": "string",
"totalTradeAmount": 0,
"aggregationCurrency": 
{"fxRateAggregationSystem": 0,
"oneTimeAmount": 0,
"recurringAmountYearly": 0,
"percentageOneTimeAmount": 0,
"percentageRecurringAmountYearly": 0,
"recurringInducementAmount": 0,
"oneTimeInducementAmount": 0,
"percentageOneTimeInducementAmount": 0,
"percentageRecurringInducementAmountYearly": 0,
"fees": 
[
{"feeType": 
{"id": 0,
"name": "string"
},
"category": 
{"id": 0,
"name": "string",
"parentCategoryId": 0,
"parentCategory": "string"
},
"amount": 0,
"amountYearly": 0,
"percentageAmount": 0,
"percentageAmountYearly": 0,
"inducementAmount": 0,
"inducementAmountYearly": 0,
"percentageInducementAmount": 0,
"percentageInducementAmountYearly": 0
}
]
}
},
"accounts": 
[
{"id": 0,
"currencyId": 0,
"currencyThreeLetterIsoCode": "string",
"totalTradeAmount": 0,
"fxRateAccountSystem": 0,
"oneTimeAmount": 0,
"recurringAmountYearly": 0,
"percentageOneTimeAmount": 0,
"percentageRecurringAmountYearly": 0,
"recurringInducementAmount": 0,
"oneTimeInducementAmount": 0,
"percentageOneTimeInducementAmount": 0,
"percentageRecurringInducementAmountYearly": 0,
"fees": 
[
{"feeType": 
{"id": 0,
"name": "string"
},
"category": 
{"id": 0,
"name": "string",
"parentCategoryId": 0,
"parentCategory": "string"
},
"amount": 0,
"amountYearly": 0,
"percentageAmount": 0,
"percentageAmountYearly": 0,
"inducementAmount": 0,
"inducementAmountYearly": 0,
"percentageInducementAmount": 0,
"percentageInducementAmountYearly": 0
}
]
}
]
}

DFS Fee Services API (latest)

FeeManagement

Retrieve applicable fees for each portfolio change

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Update applicable fees for each portfolio change

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get fee categories

Authorizations:

header Parameters

Responses

Response samples

Calculate estimated trade(s) fees

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Request Body schema:
application/json

Request Body schema:
application/json