Documentation Index
Fetch the complete documentation index at: https://yieldxyz.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Overview
Real-world asset (RWA) yields give wallets exposure to off-chain, regulated assets — U.S. Treasury bills, money-market funds, private credit pools, and structured carry strategies — through tokenized vaults that settle on-chain. Yield.xyz exposes every RWA yield through the same lifecycle as any other yield on the platform (enter → accrue → exit). The only thing that varies is whether the underlying issuer requires KYC. That single distinction drives everything else: discovery, error handling, redemption mechanics, and the user-facing onboarding path.
Permissioned (KYC Required)
Issuer enforces an on-chain allowlist. Users complete KYC at the issuer’s portal before deposits or redemptions can settle. Examples: Superstate USTB / USCC, BlackRock BUIDL, Ondo OUSG.
Permissionless (No KYC)
Open ERC-4626-style vaults or issuance contracts. Any address can deposit. Examples: Maple Syrup USDC / USDT, Midas mTBILL, Frax sfrxUSD, Ondo USDY (secondary market).
All RWA yields share
type: "real-world-asset" and the same enter / exit action contract. The permissioned vs permissionless split is surfaced through the requirements block on the yield metadata — covered in Identifying RWA Yields.Why RWA Yields
RWA yields complement on-chain native yield in three ways that matter for institutional and treasury workflows:Regulated backing
Returns sourced from U.S. Treasuries, money-market funds, and private credit — not protocol incentives or reflexive on-chain demand.
Stable yield profile
Lower volatility relative to crypto-native strategies. Yield tracks short-duration rates rather than DeFi cycles.
Composable on-chain
Tokenized vault shares plug into the same wallet, custody, and accounting infrastructure as any ERC-20 — no off-chain settlement on the integrator side.
The Integration Model
Every RWA yield — KYC-gated or not — follows the same three-phase lifecycle exposed by the Yield.xyz API.Discover
Call
GET /v1/yields to enumerate enabled yields for your project. Filter on type === "real-world-asset" to isolate the RWA set.Enter
Call
POST /v1/actions/enter with a yield ID, user address, and amount. Yield.xyz returns one or more fully constructed unsigned transactions (typically APPROVAL then DEPOSIT). Sign and submit in order.Identifying RWA Yields
Every RWA yield is returned byGET /v1/yields (and the per-yield endpoints) with the canonical shape:
Filter strategies
Permissioned RWA Yields
Permissioned yields are restricted by the issuer to verified investors — typically U.S. Qualified Purchasers, accredited investors, or KYC’d entities under the issuer’s compliance program. Yield.xyz handles the on-chain allowlist check; the off-chain KYC happens on the issuer’s portal.Issuer coverage
| Issuer | Assets | Status |
|---|---|---|
| Superstate | USTB (T-Bills), USCC (crypto carry) | Live |
| Securitize / BlackRock | BUIDL (BlackRock USD Institutional Digital Liquidity Fund) | Upcoming |
| Ondo Finance | USDY, rUSDY, OUSG | Upcoming |
| Hashnote | USYC | Upcoming |
| Backed Finance | bIB01, bC3M | Upcoming |
| Franklin Templeton | BENJI | Upcoming |
| Mountain Protocol | USDM, wUSDM | Upcoming |
| Midas | mUSDC, mTBILL, mBASIS | Upcoming |
| Figure Markets | PRIME, CASH | Upcoming |
Superstate (USTB, USCC) — Live
Superstate (USTB, USCC) — Live
Superstate issues two tokenized funds, both restricted to U.S. Qualified Purchasers.
Onboarding. Before any
Pending redemptions surface as
| Yield ID | Underlying strategy | Reward token |
|---|---|---|
ethereum-usdc-superstate-ustb-vault | Short-duration U.S. Treasuries | USTB |
ethereum-usdc-superstate-uscc-vault | Crypto carry strategy | USCC |
enter / exit transaction is built, the API calls isAllowed(address) on the on-chain Superstate allowlist. If the address is not allowlisted, the API responds with HTTP 412 Precondition Failed and the issuer’s KYC URL. Treat this as a recoverable state — redirect the user, complete KYC, and retry.Lifecycle.| Phase | Mechanism | Notes |
|---|---|---|
| Enter | subscribe(amountUSDC, USDC) on the Superstate token contract | Requires prior approve on USDC. Minimum 100,000 USDC. |
| Accrual | NAV/share updates daily via Chainlink oracle | getBalances returns USDC-equivalent value, not raw shares |
| Exit | offchainRedeem(shares) | Submits a redemption request. Settled T+1 via Superstate’s off-chain process. |
BalanceTypes.Unstaking entries with an expectedSettlementAt date.Pause behavior. Both funds expose paused(). When paused, getStatus returns { enter: false, exit: false } and the yield is hidden from discovery.Securitize / BlackRock BUIDL — Upcoming
Securitize / BlackRock BUIDL — Upcoming
BlackRock USD Institutional Digital Liquidity Fund, distributed via Securitize. Backed by short-duration U.S. Treasuries, repos, and cash. Restricted to qualified institutional investors per Securitize’s onboarding requirements.Integration target: same
enter / exit contract; KYC handled via Securitize’s investor portal.Ondo Finance (OUSG, rUSDY) — Upcoming
Ondo Finance (OUSG, rUSDY) — Upcoming
Tokenized exposure to short-term Treasuries via Ondo’s institutional product line.
OUSG and rUSDY are KYC-gated for primary mint/redeem. Note: USDY is also covered but accessed via secondary market and is treated as permissionless from an integration standpoint — see Permissionless RWA Yields.Other upcoming issuers
Other upcoming issuers
Hashnote (
USYC), Backed Finance (bIB01, bC3M), Franklin Templeton (BENJI), Mountain Protocol (USDM, wUSDM), Midas (mUSDC, mTBILL, mBASIS), and Figure Markets (PRIME, CASH) are on the roadmap. Each will follow the same enter / exit lifecycle with issuer-specific KYC handoff.KYC Precondition Errors
When a user attempts to interact with a permissioned yield from a non-allowlisted address, the API returns HTTP 412 Precondition Failed:This is intentionally HTTP 412, not 403 — the request is well-formed, but a precondition (allowlist membership) is unmet. Recommended UX:
- Catch the 412 response.
- Redirect the user to
details.kycUrl. - After the issuer confirms allowlist inclusion (typically minutes to hours), retry the original request.
Permissionless RWA Yields
Permissionless RWA yields require no KYC and no allowlist — any address can deposit through the standardenter / exit flow. They expose users to the same off-chain assets (Treasuries, private credit, structured strategies) but route access through open vault contracts or DEX secondary markets.
requirements is not set on permissionless RWA yields. There are no preconditions beyond holding the input token.At a glance
| Asset | Protocol | TVL | Indicative APY | Backing | Redemption |
|---|---|---|---|---|---|
| Syrup USDC / USDT | Maple | — | Variable | Private-credit pools | Per pool terms |
| mTBILL | Midas | ~$36.8M | ~3.3% | U.S. Treasuries (BUIDL-linked) | Instant or T+1–3 |
| sfrxUSD | Frax | ~$25M | ~5.2% | Mixed: stablecoins, RWA, AMOs | Instant |
| USDY | Ondo | ~$680M | ~3.6% | Short-dated U.S. Treasuries + cash | DEX secondary |
| sUSDe | Ethena | ~$3.46B | ~4.2% | Delta-hedged crypto + stables | 7-day cooldown |
| stUSDT | JustLend / Tron | ~$63M | ~3.8% | T-bills + cash equivalents | Up to ~3 days |
| Nest Credit (vaults) | Nest | ~$37M | ~6.1%–14.0% | Vault-specific RWA mix | 1–10 days |
Protocol details
- Maple (Syrup)
- Midas (mTBILL)
- Frax (sfrxUSD)
- Ondo (USDY)
- Ethena (sUSDe)
- stUSDT
- Nest Credit
Open ERC-4626-style vaults backed by Maple’s private-credit pools. No KYC, no allowlist, no minimum.
Lifecycle. Standard ERC-4626
| Yield ID | Input | Vault token |
|---|---|---|
ethereum-usdc-syrupusdc-…-4626-vault | USDC | syrupUSDC |
ethereum-usdt-syrupusdt-…-4626-vault | USDT | syrupUSDT |
deposit / redeem. requirements is not set.Indirect RWA Exposure
Several non-RWA integrations let users gain RWA exposure without KYC by lending against an RWA token as collateral. These appear under their host protocol’s type (lending / vault) — never as real-world-asset — and do not set kycRequired.
| Yield ID | Wraps | Surface type |
|---|---|---|
solana-kamino-maple-syrupusdc-…-lending | Maple syrupUSDC market on Kamino | lending |
solana-kamino-maple-pyusd-…-lending | Maple PYUSD market on Kamino | lending |
solana-kamino-superstate-opening-bell-usdc-…-lending | Superstate Opening Bell market on Kamino | lending |
ethereum-syrupusdc-esyrupusdc-…-4626-vault | Euler Yield over syrupUSDC | vault |
plasma-syrupusdt-aave-v3-lending | Aave v3 lending of syrupUSDT on Plasma | lending |
Integration Walkthrough — Syrup USDC
The Yield.xyz API contract is identical for every RWA yield. We use Maple’ssyrupUSDC below as the concrete example as it represents the most common permissionless RWA pattern: a standard ERC-4626 vault with asynchronous withdrawals (similar to EIP-7540). Most permissionless RWA integrations on the platform follow this same shape.
Dashboard setup & API key
- Log in to
dashboard.yield.xyz. - Navigate to Projects → Create Project.
- Inside the project: API Keys → Create API Key.
Reference: Creating an API Key
Enable RWA yields
By default, no yields are enabled in a new project. You must explicitly enable each one.
- In your project, scroll to the Yields section.
- Open the RWA category.
- Search for and select the yields you want enabled (e.g.
syrupUSDCon Ethereum). - Click Save.
GET /v1/yields for this project’s API key.Discover yields and fetch metadata
Current annualized yield, sourced from the underlying Maple private credit pool.
Total value locked in the yield.
{ enter: boolean, exit: boolean } — current action availability.Required fields per action. The
amount field is denominated in USDC (the input asset), not in syrupUSDC shares.Network identifier. Ethereum mainnet is the primary deployment. Cross-chain mint/redeem on Base and Arbitrum via CCIP is on the roadmap.
Deposit (Enter)
Deposit USDC and receive The response contains one or more fully constructed unsigned transactions, in order:
Deposit behavior. Single atomic flow — shares mint in the same transaction as the deposit.
syrupUSDC — an ERC-4626 vault share token. No KYC, no allowlist, no minimum.| Step | Transaction | What happens |
|---|---|---|
| 0 | APPROVAL | Approve the Maple vault to spend USDC |
| 1 | DEPOSIT | Deposit USDC into the ERC-4626 vault; syrupUSDC shares are minted to the user wallet |
No client-side calldata construction is required. Sign and submit each transaction in order via your custody infrastructure.
Redeem (Exit)
Maple’s withdrawal flow is asynchronous — modeled on ERC-4626 with async withdrawal handling (similar to EIP-7540). The same
/exit endpoint covers two paths:Standard async withdrawal
- Flow: submit redemption request → pool processes → USDC returned to user
- Settlement: typically near-instant when pool liquidity is available
- Worst case: up to 30 days, depending on underlying pool liquidity
- Fee: none beyond standard pool economics
Secondary market swap
- Flow: swap
syrupUSDC→ USDC on a DEX - Settlement: atomic
- Tradeoff: subject to price impact and slippage vs vault NAV
- When to use: users needing immediate exit when the async queue is congested
Syrup has a single withdrawal flow (async by default), with the DEX swap as an independent alternative — there is no instant/standard mode toggle on the redemption itself. Surface both options in client UI when settlement timing matters to the user.
Track balances and lifecycle
syrupUSDC shares held and earning yield. Includes both share-denominated and USD-equivalent values.Shares submitted for async redemption, awaiting pool processing. Includes an
expectedSettlementAt estimate.POST /v1/yields/balances.Reference: Balances
Position Lifecycle & Balance States
The Yield.xyz balance model normalizes every RWA position into one of four states, regardless of issuer:| State | Meaning | When it surfaces |
|---|---|---|
Active | Tokens held, accruing yield | After successful enter |
Unstaking / Pending | Redemption submitted, awaiting settlement | T+1 (Superstate), 1–3 days (Midas standard), 1–10 days (Nest), 7 days (Ethena) |
Claimable | Settled, awaiting user claim | After cooldown elapses for protocols requiring a separate claim transaction (e.g. Ethena unstake) |
Pause / Hidden | Issuer-paused or temporarily unavailable | Surfaced via getStatus returning { enter: false, exit: false } |
Error Handling Reference
412 Precondition Failed — KYC required
412 Precondition Failed — KYC required
Returned for permissioned yields when the user address is not on the issuer’s allowlist. Recoverable.Action: redirect to
details.kycUrl, retry after allowlist confirmation.409 Conflict — issuer paused
409 Conflict — issuer paused
Returned when an
enter or exit is attempted on a yield whose underlying contract has been paused by the issuer (e.g. Superstate paused() returns true).Action: poll GET /v1/yields/{id} until status.enter or status.exit returns to true. There is no manual override.422 Unprocessable Entity — minimum not met
422 Unprocessable Entity — minimum not met
Returned when the requested
amount is below the issuer’s minimum (e.g. Superstate’s 100,000 USDC floor).Action: surface the minimum to the user from the yield metadata arguments.amount.min field before request submission.503 Service Unavailable — instant liquidity exhausted
503 Service Unavailable — instant liquidity exhausted
Comparison Reference
For product reviewers comparing options across the integrated set:| Asset | Backing | KYC | Redemption window | DEX exit available |
|---|---|---|---|---|
| USTB / USCC (Superstate) | T-Bills / crypto carry | Required | T+1 | No |
| mTBILL (Midas) | T-Bills (BUIDL-linked) | None | Instant or T+1–3 | Limited |
| Syrup USDC / USDT (Maple) | Private credit | None | Per pool terms | Yes |
| sfrxUSD (Frax) | Mixed yield strategy | None | Instant | Yes |
| USDY (Ondo) | T-Bills + cash | None (secondary) | Instant via DEX | Yes |
| sUSDe (Ethena) | Delta-hedged synthetic | None | 7-day cooldown | Yes |
| stUSDT | T-Bills + cash (limited disclosure) | None | Up to ~3 days | Yes (Tron) |
| Nest vaults | Vault-specific RWA mix | Predicate AML check | 1–10 days | No |
Resources
API Reference
Full Yield.xyz API specification — endpoints, schemas, response shapes.
Yield Metadata
Detailed reference for the
/yields discovery endpoint and metadata fields.Balances
Balance lifecycle states and the per-yield / batch balance endpoints.
Creating an API Key
Project setup and API key creation in the Yield.xyz dashboard.

