Skip to main content
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.
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 and Create order.
  • 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. If it has requirements, the user must complete them, as described in User capabilities.
  • 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.

Supported methods

The methods available to a user depend on your organization’s configuration and on the user, such as their country. Call List rails to find which ones you can offer for each ramp type.

Testing in sandbox

Use test card numbers 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 endpoint.

Start building

On-ramp

Pull deposit via API

Let users buy crypto with a card or an APM.

Push deposit via API Coming soon

Let users buy crypto with a bank transfer.

via Widget

Let the Payment Widget select the card or APM and the crypto address, and authorize the deposit.

Off-ramp

via API Coming soon

Let users sell crypto and cash out to a debit card.

via Widget Coming soon

Let the Payment Widget select the crypto to sell and the card to pay out to.