SettleMint
API integrationToken features

conversion

API reference for configuring the conversion token feature during token creation and operating the conversion-window mechanics for convertible instruments.

The conversion token feature handles instruments that exchange holdings into a target token at a configured rate. It always pairs with conversion-minter on the target asset.

For the operator how-to, see Conversion how-to. For the architecture model, see Conversion architecture.

Configuration during token creation

{
  "conversion": {
    "targetToken": "0x...",
    "conversionMinter": "0x...",
    "denominationAsset": "0x...",
    "discountBps": 2000,
    "capPricePerShareWad": "...",
    "conversionWindowStart": "2026-06-01",
    "conversionWindowEnd": "2027-12-31",
    "minConversionAmount": "1.00",
    "partialAllowed": true,
    "includeInterestInConversion": true,
    "closeInterestOnConversion": true
  }
}
ParameterTypeRequiredDescription
targetTokenEthereum addressYesToken the holder converts into. Must be equity-class or retirement.
conversionMinterEthereum addressYesAddress of the conversion-minter on the target token.
denominationAssetEthereum addressYesERC-20 for any cash-leg payments.
discountBpsIntegerYesConversion discount in basis points.
capPricePerShareWadDecimal string (WAD)OptionalOptional cap on conversion price.
conversionWindowStartISO 8601 dateYesWhen conversion becomes available.
conversionWindowEndISO 8601 dateYesWhen conversion closes.
minConversionAmountDecimal stringYesMinimum per-request conversion amount.
partialAllowedBooleanYesWhether partial conversions are allowed.
includeInterestInConversionBooleanYesWhether accrued interest converts.
closeInterestOnConversionBooleanYesWhether interest accrual stops after conversion.

Holder conversion request

POST /api/v2/token/{address}/features/conversion/convert
{
  "amount": "100.00"
}

The platform burns the source position and the paired conversion-minter mints the matching target amount. Conversion is window-bound and validates against minConversionAmount and partialAllowed.

Mandatory conversion at window end

POST /api/v2/token/{address}/features/conversion/force-convert

Available to authorised operators after conversionWindowEnd when the operating model includes mandatory conversion.

On this page