Transaction Fees Models

Get transaction fee model

Changed on

Returns the transaction fee model with the given ID, including its currency, charge method, value type, and tier structure.

See the Transaction fees guide (TOL / BYOL) for fee model concepts.

get/transaction_fees/models/{transaction_fee_model_id}

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/transaction_fees/models/{transaction_fee_model_id}
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: transaction_fees:admin, transaction_fees:read)

Response

OK

idstring uuid required

Universally Unique Identifier (UUID) of the transaction fee model.

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

labelstring required

A human-readable label for the transaction fee model.

currency'EUR' | 'GBP' required

Alphabetic three-letter ISO 4217 currency code.

  • EUR — Euro.
  • GBP — Pound Sterling.
charge_method'CHARGED_BY_CLIENT' | 'COLLECTED_BY_UPVEST' | 'CHARGED_BY_CLIENT_NET' required

Indicates how the transaction fee is charged.

  • CHARGED_BY_CLIENT — The fee is charged by the client as part of post-trade settlement; the fee movement occurs outside Upvest cash balances.
  • COLLECTED_BY_UPVEST — The fee is charged by the client and collected by Upvest; the fee amount is debited from the user's Upvest cash balance.
  • CHARGED_BY_CLIENT_NET — The fee is charged and collected by the client; the fee amount is deducted from the transaction amount, so the user's Upvest cash balance changes by the net amount.
value_type'ABSOLUTE' | 'RELATIVE' required

The value type of the transaction fee model.

  • ABSOLUTE — Tier fees are fixed cash amounts.
  • RELATIVE — Tier fees are percentages of the order value, expressed in basis points.
application_type'VOLUME' required

The application type of the transaction fee model.

  • VOLUME — The full order value is assessed against the tier thresholds, and the matching tier's fee applies to the total order volume.
base_amount_scope'GROSS_AMOUNT' | 'ORDER' required

The scope of the base amount that fee tiers are evaluated against.

  • GROSS_AMOUNT — Tiers are evaluated against the gross cash amount of the transaction the fee model is applied to (e.g. the total cash value of an order, a contribution or a transfer).
  • ORDER — Tiers are evaluated against the total cash value of each order. DEPRECATED: Use GROSS_AMOUNT instead. Existing fee models using ORDER continue to work unchanged.

Changes

  • 052750ba3a1eRevision changes
    • warning

      added the new CHARGED_BY_CLIENT_NET enum value to the response property for the response status

  • 25a6cd1e39deRevision changes
    • warning

      added the new COLLECTED_BY_UPVEST enum value to the response property for the response status

    • warning

      added the new GROSS_AMOUNT enum value to the response property for the response status