Fee collection
Fee collections describe the processing of fee amounts calculated in advance. The fee amounts can originate from fee calculations via the Investment API or from fees calculated by the client.
Please note that you can only initiate a fee collection procedure for accounts that are not in PENDING_APPROVAL
or CLOSED
status. If the account is in one of these statuses, a Bad Request
response code will be returned. Otherwise, you will receive a fee collection object with the fee collection ID in the response.
Creating a fee collection
If you have pre-calculated the amount for a fee, you can create a fee collection as follows:
POST /fees/collections
{
"account_id": "689f7566-2ca3-4007-b99d-e501be8c7783",
"type": "SERVICE_FEE",
"collection_amount": "12.41",
"currency": "EUR",
"period_start": "2022-11-01",
"period_end": "2022-11-30"
}
Parameter | Description |
---|---|
account_id | Required: The ID of the account on which the fees shall be charged. |
type | Required: Specify the type SERVICE_FEE for normal cadence fee collections. |
collection_amount | Required: The pre-calculated amount of fees to be collected. |
currency | Required: Specify the currency. Currently, only EUR is supported. |
period_start | Required: Start date of the fees calculated. |
period_end | Required: End date of the fees calculated. |
Retrieving a list of fee collections
To retrieve all fee collections make the following request:
GET /fees/collections
.
Retrieving a fee collection by ID
You can retrieve a fee collection with its specific fee_collection_id
as follows:
GET /fees/collections/{fee_collection_id}
Fee collection status
The following statuses apply to a fee collection:
Status | Description |
---|---|
PROCESSING | The fee collection is in progress. |
FINALISED | The fee collection is finalised - fees have been collected from the account and the funds have been transferred to the client. |
CANCELLED | The fee collection is cancelled. |
Webhooks for potential sell-to-cover orders, cash balance updates and the financial transaction reporting of the type FEE_COLLECTION
are available. The transaction reporting webhook and object contains a reference to the fee collection object for additional details.