Ctrl+K

Internal order preview

get/api/stablecoin/v1/internal/order-preview

Estimates fees for a mint or burn order (service-to-service).

Query Parameters

orderTypestringRequired
Order type: either 'burn' or 'mint'.
Example: burn
Enum: burn mint
fromAssetIdstringRequired
Source asset identifier.
Example: 9025338d-ed25-4da0-aff3-ad970be213a9
toAssetIdstringRequired
Destination asset identifier.
Example: d634310c-3359-4fc3-b7d0-96e593f7660e
fromAmountstringRequired
Amount from the source asset, in its lowest denomination.
Example: 100000000
Pattern: ^[1-9][0-9]*$

toAmount string required

Amount the enterprise will receive after deducting any fee, in lowest denomination.

Example: 99750000

feeApplied boolean required

Whether the fee was applied.

Example: true

feeBps number required

Fee in basis points (0 when feeApplied is false).

Example: 25

fromAmount string required

Original order amount before fee deduction, in lowest denomination.

Example: 100000000

netPosition string required

Enterprise net position (mints minus burns) as a signed string in the stablecoin's lowest denomination.

Example: -5000000

Is this page helpful?