latestOpenAPI 3.1.02026-08-108094177.6 KB

087dcf516ce2

External Wallet Access Mode

Initiate on-ramp with permit

On-ramp is not yet generally available; this endpoint is documented for preview only. Submits the on-ramp transaction with an EIP-2612 permit signature. Requires a valid cached quote (quoteId binding) and passed liveness when required; mismatched or expired quotes are rejected.

post/api/v1/onramp-with-permit

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

quoteIdstring required

quoteId from the on-ramp quote.

chainIdstring required

Source chain ID (CAIP-2).

tokenInstring required

Fiat token contract address.

amountInstring required

Input amount in smallest units; must match the cached quote.

dstChainIdstring

Destination chain ID (CAIP-2).

dstAggregatorstring

best.to from the quote.

dstTokenOutstring

Destination token address.

dstSwapCalldatastring

best.swapCalldata from the quote.

dstMinAmountOutstring

best.minAmountOut from the quote.

permitDeadlineinteger required

Unix seconds until which the permit is valid.

permitVinteger required

EIP-2612 signature component v.

permitRstring required

EIP-2612 signature component r.

permitSstring required

EIP-2612 signature component s.

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.