For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get off-ramp quote

Delegated Contract Mode will be deprecated soon; new partners should use Managed Custody Mode. Returns fees, exchange rate, and estimated receipt amount for a crypto-to-fiat deposit. Minimum 5 USDC. Pass the returned quoteId to /v1/deposit to lock in the quoted fees.

post
/v1/deposit/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

Input token symbol (currently USDC only).

toTokenstringRequired

Target fiat token symbol (USD, EUR, etc.).

amountstringRequired

Input amount in smallest units (5 USDC is "5000000"). Minimum 5 USDC.

chainIdstringOptional

Source chain ID (CAIP-2). Defaults to Mantle when omitted.

userAddressstringOptional

User's UR account address; required for deposits from non-Mantle chains.

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/deposit/quote
POST /v1/deposit/quote HTTP/1.1
Host: openapi.ur.app
X-Api-Signature: text
X-Api-Deadline: text
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "urId": 12345,
  "fromToken": "USDC",
  "toToken": "USD",
  "amount": "5000000",
  "chainId": "eip155:97",
  "userAddress": "0x1234567890abcdef..."
}
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": "deposit_1700000000000_12345",
    "feeAmountViaUsdc": "0.50",
    "outputAmount": "999.50",
    "outputAmountBeforeFee": "1000.00",
    "exchangeRate": "1.0",
    "processingFee": "0.50",
    "networkFee": "0",
    "totalFee": "0.50",
    "chainId": "eip155:5000"
  }
}

Last updated