API status

Fee collection process and events

Regardless of who initiates the fee collection, the process of charging is the same and is accompanied by the same events.

To receive the fee collection events, you must subscribe to the webhook events of type FEE_COLLECTION, and of course all other events must also be subscribed to in order to receive them.

  1. Fee collection initiated

    Event:

    • FEE_COLLECTION_CREATED
      This event confirms the creation of a fee collection.

  2. Collection method: Sell-to-cover

    If your chosen collection method is Sell to cover, you will receive a series of events associated with an order and order fulfilments in the same way that events are sent out for regular orders.
    Events:

    • ORDER.NEW, ORDER.PROCESSING, ORDER.FILLED (in rare cases ORDER.CANCELLED)
    • EXECUTION.FILLED (in rare cases EXECUTION.CANCELLED)
    • CASH_BALANCE.UPDATED

    All orders relating to a fee collection have the initiation_flow:SELL_TO_COVER_FEES.


  3. Settlement and intake of fees

    After the execution of the sell-to-cover order, Upvest waits for the settlement of the order executions to actually collect the fee.
    Once the settlement has been made and the fee collected, you will receive the following events:
    Events:

    • EXECUTION.SETTLED
    • CASH_BALANCE.UPDATED ( several times, at least once for the settlement and once for the reduction of the cash balance)
    • CASH_TRANSACTION.EXECUTED of type FEE_COLLECTION
    • FEE_COLLECTION.FINALISED

Webhooks

Once a fee collection processes has been created, you will recieve fee collection events as webhooks. These events will notify you in changes in status of the fee collection entity. You'll recieve webhooks for each of the following statuses:

StatusDescription
FEE_COLLECTION.CREATEDThe fee collection is in progress.
FEE_COLLECTION.FINALISEDThe fee collection is finalised - fees have been collected from the account and the funds have been transferred to the client.
FEE_COLLECTION.CANCELLEDThe fee collection is cancelled.