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

# Introduction to On & Off Ramp

> Let users buy crypto with fiat and sell crypto for fiat as a single order, with both ends of the transfer outside Uphold.

The On & Off Ramp API moves value between fiat and crypto in a single **order**, where both ends of the transfer are external to Uphold.

* **On-ramp** moves fiat into crypto: the user pays from a card or an alternative payment method (APM), and the crypto is sent to a crypto address or a crypto external account.
* **Off-ramp** moves crypto into fiat: the user sends crypto to an address, and the fiat is paid out to a payment method of the user, such as a debit card.

Behind each order, Uphold takes the deposit, converts it and sends the withdrawal, and usually refunds the deposit if the order cannot be completed. You follow a single order instead of coordinating a deposit, a trade and a withdrawal yourself, as you would with [Buy and Sell](https://developer.uphold.com/developer-guides/buy-and-sell/introduction.md).

> [!NOTE]
>
> The On & Off Ramp API is a **preview**. It is available in **Sandbox** only, and it can change before release.

## Key concepts

* **Quote and order** — every order is created from a quote that previews the amounts, rates and fees. See [Create quote](https://developer.uphold.com/rest-apis/on-off-ramp-api/orders/create-quote.md) and [Create order](https://developer.uphold.com/rest-apis/on-off-ramp-api/orders/create-order.md).
* **`on-ramp` and `off-ramp` capabilities** — the user needs the capability of the order type enabled. Its requirements depend on the user's [verification tier](https://developer.uphold.com/rest-apis/on-off-ramp-api/introduction.md#capabilities-and-verification-tiers). If it has requirements, the user must complete them, as described in [User capabilities](https://developer.uphold.com/rest-apis/core-api/capabilities/overview.md).
* **Requirements** — a quote may list `requirements` that must be addressed before or when creating the order: `travel-rule` must be resolved before creating it, `authorize:3ds` is provided when creating it, and the APM `authorize:*` requirements, such as `authorize:apple-pay`, are handled by the Payment Widget, which also creates the order.
* **Pricing** — quotes with a pull deposit, such as a card payment, are `locked`, and quotes with a push deposit, such as crypto the user sends, are `estimated`, so their final amounts may differ from the quote.
* **Order lifecycle** — an order moves through the `pending`, `processing`, `on-hold`, `completed`, `failed` and `expired` statuses, and its `timeline` records what happened on each leg. See the [Orders overview](https://developer.uphold.com/rest-apis/on-off-ramp-api/orders/overview.md#order-lifecycle).

## Supported methods

| Direction | Origin | Destination | Notes |
| - | - | - | - |
| On-ramp | Card | Crypto address or crypto external account | May require 3DS authorization |
| On-ramp | APM | Crypto address or crypto external account | Such as Apple Pay, Google Pay and PayPal |
| Off-ramp | Crypto address | Debit card | The user sends the deposit to an address provided by Uphold |

The methods available to a user depend on your organization's configuration and on the user, such as their country. Call [List rails](https://developer.uphold.com/rest-apis/on-off-ramp-api/assets/list-rails.md) to find which ones you can offer for each ramp type.

## Testing in sandbox

Use [test card numbers](https://developer.uphold.com/rest-apis/test-helpers.md) to simulate the card payment of an on-ramp origin and the card payout of an off-ramp destination. The crypto deposit of an off-ramp origin can be triggered via the [simulate crypto deposit](https://developer.uphold.com/rest-apis/core-api/accounts/test-helpers/simulate-crypto-deposit.md) endpoint.

## Start building

### On-ramp

> [card] [Pull deposit via API](https://developer.uphold.com/developer-guides/on-off-ramp/on-ramp/via-rest-api/pull-deposit.md)
>
> Let users buy crypto with a card or an APM.

> [card] [Push deposit via API Coming soon](https://developer.uphold.com/developer-guides/on-off-ramp/on-ramp/via-rest-api/push-deposit.md)
>
> Let users buy crypto with a bank transfer.

> [card] [via Widget](https://developer.uphold.com/developer-guides/on-off-ramp/on-ramp/via-payment-widget.md)
>
> Let the Payment Widget select the card or APM and the crypto address, and authorize the deposit.

### Off-ramp

> [card] [via API Coming soon](https://developer.uphold.com/developer-guides/on-off-ramp/off-ramp/via-rest-api.md)
>
> Let users sell crypto and cash out to a debit card.

> [card] [via Widget Coming soon](https://developer.uphold.com/developer-guides/on-off-ramp/off-ramp/via-payment-widget.md)
>
> Let the Payment Widget select the crypto to sell and the card to pay out to.
