Sign in
latestOpenAPI 3.1.02026-08-108094177.6 KB

087dcf516ce2

Managed Custody Mode

Get on-ramp quote

Quote an On-ramp (scene onramp) or a retry swap (scene swap_retry). When the response has needLiveness true, complete the liveness check before submitting; after liveness passes, request a new quote and submit with the new quoteId. On-ramp is not yet available for integration; this reference is a preview.

post/api/fma/v1/quote/onramp

Headers

X-Api-Signaturestring required

0x-prefixed 65-byte hex EIP-191 signature over the Partner Auth message. See the Signature and verify guide.

X-Api-Deadlinestring required

Unix seconds. UR rejects the request when the current time is past the deadline. Keep the validity window at or under 5 minutes.

X-Api-PublicKeystring required

0x-prefixed partner signer address registered with UR.

X-Ur-Idstring

Send at least one of X-Ur-Id or X-External-User-Id. When both are present, UR resolves the user by X-Ur-Id first.

X-External-User-Idstring

Send at least one of X-Ur-Id or X-External-User-Id. When both are present, UR resolves the user by X-Ur-Id first.

Request body

scene'onramp' | 'swap_retry' required

onramp for the main flow; swap_retry for retrying a failed swap leg.

srcChainIdstring

Source chain ID in CAIP-2 format; the chain where the user's tokenized fiat is held. For swap_retry, use the pending retry's chainId.

dstChainIdstring required

Destination chain ID in CAIP-2 format. Must match a token with aggregator support in the chain config.

fromCurrencystring

Source fiat currency symbol. Required when scene is onramp.

fromTokenstring

USDC token address. Required when scene is swap_retry.

toTokenstring required

Destination token address.

amountstring required

Input amount as a human-readable decimal string; UR converts it to smallest units by the input currency decimals.

slippageBpsinteger

Slippage tolerance in basis points. Defaults to 50.

Response

Standard envelope. Business errors return HTTP 200 with a non-zero code.

codeinteger required

0 on success; non-zero business error code.

messagestring required

Human-readable explanation. May be empty on success.