Upvest Investment API.
API Reference/- Fee collection events
Get fee collections
Create a fee collection
Get a fee collection by ID
Fee collection events
Upvest Investment API (1.75.0)
Overview
Languages
Servers
Sandbox environment
https://sandbox.upvest.co/
Live environment
https://api.upvest.co/
Headers
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
Example: Bearer c2VjcmV0Cg==
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
- Sandbox environment
https://sandbox.upvest.co/fees/collections/{fee_collection_id}
- Live environment
https://api.upvest.co/fees/collections/{fee_collection_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://sandbox.upvest.co/fees/collections/{fee_collection_id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'authorization: Bearer c2VjcmV0Cg==' \
-H 'signature: string' \
-H 'signature-input: string' \
-H 'upvest-api-version: 1' \
-H 'upvest-client-id: ebabcf4d-61c3-4942-875c-e265a7c2d062'OK
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"
Status of the fee collection
- PROCESSING - Fee collection is in progress.
- FINALISED - Fees have been collected from the account and the funds has been transferred to the client.
- CANCELLED - Fee collection has been cancelled.
Enum"PROCESSING""FINALISED""CANCELLED"
Start date of the fee collection period in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339
End date of the fee collection period in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
Response
application/json
{ "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" }
Bodyapplication/json
Date and time when the event was created. RFC 3339-5, ISO8601 UTC
Event type
Enum"FEE_COLLECTION.CREATED""FEE_COLLECTION.FINALISED""FEE_COLLECTION.CANCELLED"
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"
Status of the fee collection
- PROCESSING - Fee collection is in progress.
- FINALISED - Fees have been collected from the account and the funds has been transferred to the client.
- CANCELLED - Fee collection has been cancelled.
Enum"PROCESSING""FINALISED""CANCELLED"
Start date of the fee collection period in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339
End date of the fee collection period in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
- Sandbox environment
https://sandbox.upvest.co/Fee collection events
- Live environment
https://api.upvest.co/Fee collection events
application/json
{ "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": { … }, "status": "PROCESSING", "type": "SERVICE_FEE", "updated_at": "2022-11-30T14:16:22Z" } }