Get on-ramp quote

Delegated Contract Mode will be deprecated soon; new partners should use Managed Custody Mode. On-ramp is not yet generally available; this endpoint is documented for preview only. Returns a real-time quote for fiat token to USDC (with optional swap or bridge) based on BufferPool and limit rules. If isSupport is false or needLivenessCheck is true, guide the user accordingly before submitting.

post

/v1/onramp/quote

Authorizations

X-Api-SignaturestringRequired

Partner Auth: EIP-191 signature by the partner's registered backend key, with X-Api-Deadline and optional X-Api-PublicKey headers. See the Signature and verify guide.

Header parameters

X-Api-SignaturestringRequired

Partner's EIP-191 signature (0x-prefixed hex).

X-Api-DeadlinestringRequired

Unix seconds when the request signature expires (within 5 minutes).

X-Api-PublicKeystringOptional

Partner's signer Ethereum address.

Body

urIdinteger · int64Required

UR user ID.

fromTokenstringRequired

Fiat token symbol from /v1/tokens.

toTokenstringRequired

Destination token symbol from /v1/tokens.

amountstringRequired

Input amount in smallest units. After conversion, must be at least 5 USDC.

slippageBpsintegerOptional

Slippage in basis points. Default 50.

chainIdstringOptional

Chain ID (CAIP-2); currently Mantle only.

Responses

200

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.

application/json

Standard response envelope for the partner API (openapi.ur.app).

codeinteger · int64Required

0 on success; non-zero indicates a business rejection.

messagestringRequired

Human-readable diagnostic; empty on success.

dataanyOptional

Business payload. Shape depends on the endpoint.

post/v1/onramp/quote

POST /v1/onramp/quote HTTP/1.1
Host: openapi.ur.app
X-Api-Signature: text
X-Api-Deadline: text
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "urId": 7639951412,
  "chainId": "eip155:5000",
  "fromToken": "USD",
  "toToken": "USDC",
  "amount": "10000",
  "slippageBps": 50
}

200

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.

{
  "code": 0,
  "message": "",
  "data": {
    "quoteId": "onramp_1700000000000000000",
    "chainId": "eip155:5000",
    "best": {
      "aggregator": "0xAggregatorAddress",
      "to": "0xAggregatorTarget",
      "swapCalldata": "0xabcdef...",
      "minUsdcAmount": "99500000",
      "expectedUsdcAmount": "99800000",
      "slippageBps": 50,
      "deadline": 1700000000
    },
    "isSupport": true,
    "needLivenessCheck": false,
    "outputAmount": "99800000",
    "exchangeRate": "0.9995",
    "maxAmounts": {
      "USD": "50000",
      "EUR": "46500"
    }
  }
}