Fees

Create a fee collection

Creates a fee collection for a fee amount you have already calculated.

The account must not be in PENDING_APPROVAL or CLOSED status; a request against an account in either status is rejected with a 400 response. Set type to SERVICE_FEE for collections that follow your normal fee cadence.

See the Fee collection guide (TOL / BYOL) for the collection lifecycle and webhook events.

post/fees/collections

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/fees/collections
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: fees:admin)

Headers

idempotency-keystring uuid required
Example:ccb07f42-4104-44ad-8e1f-c660bb7b269c

A UUID to be used as an idempotency key. This prevents a duplicate request from being replayed. https://docs.upvest.co/documentation/concepts/api_concepts/idempotency

Request body

account_idstring uuid required

Universally Unique Identifier (UUID) of the account.

type'SERVICE_FEE' | 'SERVICE_FEE_LIQUIDATION' required

Type of the fee collection.

  • SERVICE_FEE — Service fee intake in a pre-defined cadence, for example monthly.
  • SERVICE_FEE_LIQUIDATION — Service fee intake resulting from a portfolio liquidation.
collection_amountstring required

A positive cash amount, as a decimal string with up to two decimal places.

currency'EUR' | 'GBP' required

Alphabetic three-letter ISO 4217 currency code.

  • EUR — Euro.
  • GBP — Pound Sterling.
period_startstring date required

The start date of the fee collection period, as a RFC 3339, section 5.6 full date in YYYY-MM-DD format.

period_endstring date required

The end date of the fee collection period, as a RFC 3339, section 5.6 full date in YYYY-MM-DD format.

Response

Fee collection created.

idstring uuid required

The unique identifier of the fee collection, as a UUID.

created_atstring date-time required

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

updated_atstring date-time required

Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC

account_idstring uuid required

Universally Unique Identifier (UUID) of the account.

account_group_idstring uuid required

Universally Unique Identifier (UUID) of the account group.

type'SERVICE_FEE' | 'SERVICE_FEE_LIQUIDATION' required

Type of the fee collection.

  • SERVICE_FEE — Service fee intake in a pre-defined cadence, for example monthly.
  • SERVICE_FEE_LIQUIDATION — Service fee intake resulting from a portfolio liquidation.
collection_amountstring required

A positive cash amount, as a decimal string with up to two decimal places.

currency'EUR' | 'GBP' required

Alphabetic three-letter ISO 4217 currency code.

  • EUR — Euro.
  • GBP — Pound Sterling.
status'PROCESSING' | 'FINALISED' | 'CANCELLED' required

Status of the fee collection.

  • PROCESSING — The fee collection is in progress.
  • FINALISED — The fees have been collected from the account and the funds transferred to the client.
  • CANCELLED — The fee collection was cancelled.
period_startstring date required

The start date of the fee collection period, as a RFC 3339, section 5.6 full date in YYYY-MM-DD format.

period_endstring date required

The end date of the fee collection period, as a RFC 3339, section 5.6 full date in YYYY-MM-DD format.

replaced_collection_idstring uuid

The unique identifier of the fee collection, as a UUID.

Changes

No recorded changes to this operation across all 25 revisions of this API.