v1

latestOpenAPI 3.0.02026-07-2656110201.6 KB

Deposits

Get Deposit Swap Quote

Returns a swap quote for converting a given input amount from fromCurrencyId into the deposit's settlement currency. The settlement currency is derived server-side from the deposit configuration (exactly one currency on the deposit). Use this to surface swap rates and expected receive amounts to merchants before a customer pays. Quotes expire 30 seconds after issue. Cross-chain swaps are not supported; fromCurrencyId and the deposit settlement currency must be on the same blockchain. No API key is required; this endpoint is rate-limited.

post/v1/deposits/{depositId}/swap-quote

Path parameters

depositIdstring required

The unique ID of the deposit.

Request body

fromCurrencyIdstring required

Currency ID the payer will send. Must differ from the deposit settlement currency. Retrieve available IDs via the Get Deposit Currencies endpoint.

amountInstring required

Input amount in fromCurrency base units as a positive int64 string, e.g. "1000000" = 1 USDC.

senderAddressstring required

Wallet address used as the swap sender for routing.

slippageBpsinteger

Slippage tolerance in basis points (1 bps = 0.01%). Forwarded to the routing provider.

Response

Swap quote retrieved successfully.

amountInstring required

Input amount in fromCurrency minimal units, echoed from the request.

amountOutGrossstring required

Quoted output in toCurrency minimal units before Helio platform and affiliate fees.

amountOutNetstring required

Net amount the merchant will receive after platform and affiliate fees (amountOutGross − platformFeeAmount − affiliateFeeAmount, floored at 0).

platformFeeBpsinteger required

Helio platform fee in basis points (1 bps = 0.01%).

platformFeeAmountstring required

Helio platform fee amount in toCurrency minimal units.

affiliateFeeBpsinteger required

Affiliate fee in basis points, if any (otherwise 0).

affiliateFeeAmountstring required

Affiliate fee amount in toCurrency minimal units.

slippageBpsinteger required

Slippage tolerance in basis points, echoed from the request (or the default of 100).

exchangeRatenumber

Reported exchange rate (amountOut / amountIn). Informational; not used in settlement.

estimatedPriceImpactnumber

Estimated price impact for the route (percentage). Informational.

expiresAtstring date-time required

ISO-8601 timestamp after which this quote should not be relied upon (30 seconds from issue time).