All fees related paths.

Get fee collections

get /fees/collections

Returns a list of fee collections.

account_id

string

uuid

Filters the list to show only fees associated with a specific account ID.

Example
"413715f2-5401-4b97-8055-034a6b879f8c"

account_group_id

string

uuid

Filters the list to show only fees associated with a specific account group ID.

Example
"72da9e41-9926-419f-976e-4c8069a04249"

sort

string

Field of resource to sort by.

Default
"created_at"
Enum
  • created_at
  • updated_at
Example
"created_at"

order

string

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default
"ASC"
Enum
  • ASC
  • DESC

offset

int

i32

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Min
0

limit

int

i32

Use the limit argument to specify the maximum number of items returned.

Default
100
Min
0
Max
1000

Response

ExamplesSchema

OK

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 3,
    "total_count": 3,
    "sort": "id",
    "order": "ASC"
  },
  "data": [
    {
      "id": "d77e6924-9bb7-4db0-addc-404442258f4b",
      "created_at": "2022-11-30T14:16:22Z",
      "updated_at": "2022-11-30T14:16:22Z",
      "account_id": "689f7566-2ca3-4007-b99d-e501be8c7783",
      "account_group_id": "999f7566-2ca3-4007-b99d-e501be8c7222",
      "type": "SERVICE_FEE",
      "collection_amount": "12.41",
      "processed_amount": {
        "cash_balance": "6.50",
        "sell_to_cover": "0"
      },
      "currency": "EUR",
      "status": "PROCESSING",
      "period_start": "2022-11-01",
      "period_end": "2022-11-30"
    },
    {
      "id": "7c5f2b11-7078-4bb9-8ed8-9dcf5eb7597f",
      "created_at": "2022-11-30T14:16:22Z",
      "updated_at": "2022-11-30T14:16:22Z",
      "account_id": "5b8b1e66-cf3c-40f3-94d3-c94f2ac7abb7",
      "account_group_id": "87805651-ad25-4a85-8c04-88a666164ad4",
      "type": "SERVICE_FEE",
      "collection_amount": "82.12",
      "processed_amount": {
        "cash_balance": "40.00",
        "sell_to_cover": "42.12"
      },
      "currency": "EUR",
      "status": "FINALISED",
      "period_start": "2022-09-01",
      "period_end": "2022-12-31"
    },
    {
      "id": "85fba2a0-da2f-46ac-a2a8-b4e7c66cb375",
      "created_at": "2022-11-30T14:16:22Z",
      "updated_at": "2022-11-30T14:16:22Z",
      "account_id": "c28b6611-7ac1-405a-8eb7-ab3b35caccc2",
      "account_group_id": "f930f9d4-3e21-4ad5-a266-730821d9a9fc",
      "type": "SERVICE_FEE_LIQUIDATION",
      "collection_amount": "65.30",
      "processed_amount": {
        "cash_balance": "0.00",
        "sell_to_cover": "0.00"
      },
      "currency": "EUR",
      "status": "CANCELLED",
      "period_start": "2022-03-01",
      "period_end": "2022-07-30"
    }
  ]
}

Create a fee collection

post /fees/collections

Creates a fee collection for pre-calculated fee amounts.

account_id

string

uuid

required

Account unique identifier.

type

string

required

Type of the fee collection

  • SERVICE_FEE - Service fee intake in a pre-defined cadence (e.g. monthly)
  • SERVICE_FEE_LIQUIDATION - Service fee intake as a result of a Portfolio liquidation
Enum
  • SERVICE_FEE
  • SERVICE_FEE_LIQUIDATION

collection_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

required

currency

string

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

period_start

string

date

required

Start date of the fee collection period in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339

period_end

string

date

required

End date of the fee collection period in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339

Request

{
  "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"
}

Response

ExamplesSchema

Fee collection created.

{
  "id": "d77e6924-9bb7-4db0-addc-404442258f4b",
  "created_at": "2022-11-30T14:16:22Z",
  "updated_at": "2022-11-30T14:16:22Z",
  "account_id": "689f7566-2ca3-4007-b99d-e501be8c7783",
  "account_group_id": "999f7566-2ca3-4007-b99d-e501be8c7222",
  "type": "SERVICE_FEE",
  "collection_amount": "12.41",
  "processed_amount": {
    "cash_balance": "6.50",
    "sell_to_cover": "0"
  },
  "currency": "EUR",
  "status": "PROCESSING",
  "period_start": "2022-11-01",
  "period_end": "2022-11-30"
}

Get a fee collection by ID

get /fees/collections/{fee_collection_id}

Returns the fee collection specified by its ID.

fee_collection_id

string

uuid

required

Fee collection unique identifier.

Response

ExamplesSchema

OK

{
  "id": "d77e6924-9bb7-4db0-addc-404442258f4b",
  "created_at": "2022-11-30T14:16:22Z",
  "updated_at": "2022-11-30T14:16:22Z",
  "account_id": "689f7566-2ca3-4007-b99d-e501be8c7783",
  "account_group_id": "999f7566-2ca3-4007-b99d-e501be8c7222",
  "type": "SERVICE_FEE",
  "collection_amount": "12.41",
  "processed_amount": {
    "cash_balance": "6.50",
    "sell_to_cover": "0"
  },
  "currency": "EUR",
  "status": "PROCESSING",
  "period_start": "2022-11-01",
  "period_end": "2022-11-30"
}

Fee collection events

webhook

Fee collection events

id

string

uuid

required

Event unique identifier

created_at

string

date-time

required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

type

string

required

Event type

Enum
  • FEE_COLLECTION.CREATED
  • FEE_COLLECTION.FINALISED
  • FEE_COLLECTION.CANCELLED

object

object (object)

required

webhook_id

string

uuid

required

Webhook unique identifier.

Request

{
  "id": "38fc59d0-fc42-46ef-9512-824773219b2e",
  "created_at": "2023-08-19T13:06:57.820371265Z",
  "type": "FEE_COLLECTION.CREATED",
  "webhook_id": "1b097e06-8a14-4181-b72a-de0972a3c57b",
  "object": {
    "account_group_id": "999f7566-2ca3-4007-b99d-e501be8c7222",
    "account_id": "689f7566-2ca3-4007-b99d-e501be8c7783",
    "collection_amount": "12.41",
    "created_at": "2022-11-30T14:16:22Z",
    "currency": "EUR",
    "id": "d77e6924-9bb7-4db0-addc-404442258f4b",
    "period_start": "2022-11-01",
    "period_end": "2022-11-30",
    "processed_amount": {
      "cash_balance": "0",
      "sell_to_cover": "0"
    },
    "status": "PROCESSING",
    "type": "SERVICE_FEE",
    "updated_at": "2022-11-30T14:16:22Z"
  }
}

Response

ExamplesSchema

Request has been processed successfully.

Empty response