> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onstacks.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Build ramps into your own interface on the Onstacks intelligent routing engine.

The White-Label API is the path where you own the screens. Your backend holds a workspace API key, your front end owns the experience, and the Onstacks intelligent routing engine does the rest.

## Built on the intelligent routing engine

The power of Ramp is the routing engine behind it. You state an intent: the direction, the asset and amount, the market, and the rail. The engine finds every licensed provider that can settle that intent, quotes them all at once, ranks them by what the recipient receives after fees, executes with the one you confirm, and reconciles the result. You never integrate a provider, choose a network, or maintain a rate table.

* **One intent, many providers.** Every quote response is a ranked set of real options from different providers, not a single price.
* **Manual or automatic.** Show the options and let the user choose, or let the engine pick and create the payment in one call.
* **Coverage that grows on its own.** New providers and corridors appear in the routes endpoint the moment they are enabled, with no change to your integration.

See [How a payment settles](/ramps/how-it-works#how-a-payment-settles) for how selection works.

## Objects

| Object | What it is |
| - | - |
| Country | A market you can ramp into or out of, with the rails it supports. |
| Asset | A fiat currency or a stablecoin. Stablecoins list the networks they are available on. |
| Route | An enabled corridor: direction, rail, assets, countries, limits, provider. The source of truth for coverage. |
| Quote | A binding price from one provider for a corridor and amount, with fees and an expiry. One quote per eligible provider. |
| Payment | The order. Created by confirming a quote or directly. Carries direction, status, provider reference, and funding instructions. |
| Virtual account | A local bank account opened in a customer's name for pay-ins. |

## Lifecycle

```text theme={"system"}
routes  →  quote  →  confirm quote (or create payment)  →  pending  →  processing  →  succeeded | failed
```

Every endpoint takes `environment` and a workspace API key. Amounts are decimal strings in minor units for fiat and base units for stablecoins. Assets, networks, countries, and providers are referenced by code, never by internal ids.

<CardGroup cols={2}>
  <Card title="Quotes" icon="calculator" href="/ramps/api/quotes">
    Discover coverage, request quotes, confirm one.
  </Card>

  <Card title="Payments" icon="send" href="/ramps/api/offramp-intents">
    Create, read, and list payments; funding instructions.
  </Card>

  <Card title="Status tracking" icon="activity" href="/ramps/api/status-tracking">
    Poll or receive webhooks.
  </Card>

  <Card title="Onramp" icon="arrow-down-to-line" href="/ramps/api/onramp">
    Fiat in, stablecoins out, through the same calls.
  </Card>
</CardGroup>

The endpoint reference is under **API Reference → Ramp**.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.