latestOpenAPI 3.1.02026-08-108094177.6 KB

087dcf516ce2

External Wallet Access Mode

Get on-ramp quote

On-ramp is not yet generally available; this endpoint is documented for preview only. Returns a quote for scene onramp (fiat token to destination token) or scene swap_retry (retry a failed destination swap). When needLiveness is true, the user must pass liveness before submitting.

post/api/v1/quote/onramp

Headers

tokenIdstring required

The user's URID (NFT token id).

networkstring required

Network identifier: 5000 for mainnet, 5003 for testnet.

signstring required

Signature generated by the user's wallet key (EIP-191).

hashstring required

SHA3/Keccak256 hash of the original request payload.

deadlinestring required

Signature expiry: server timestamp plus a validity window (max 20 minutes).

Request body

scene'onramp' | 'swap_retry' required

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

srcChainIdstring required

Source chain ID (CAIP-2).

dstChainIdstring required

Destination chain ID (CAIP-2).

fromTokenstring required

Fiat token contract address.

toTokenstring required

Destination token address.

amountstring required

Input amount in smallest units (e.g. "10000" is 100 USD).

slippageBpsinteger

Slippage tolerance in basis points.

Response

Response envelope. For the user API, retCode 0 means success; for the partner API, code 0 means success. Business rejections return HTTP 200 with a non-zero code.

retCodeinteger required

0 on success; non-zero indicates failure.

retMsgstring required

Human-readable message; error details when retCode is non-zero.

{"stackTrail":"components:schemas:EwaEnvelope:properties:result","oasType":"schema","type":"unknown","description":"Business payload. Shape depends on the endpoint; some endpoints return it as a JSON-encoded string."}

timeNowinteger

Server timestamp in milliseconds.