Skip to main content
The meCash Ramp API lets you move value across crypto and fiat rails programmatically. All flows follow a two-step pattern:
  1. Create a Quote — lock in rates, fees, and corridor limits.
  2. Execute a Payout — consume the quote to deliver funds.

Transaction categories


API lifecycle

Step 1 — Create Quote

All three flows use a single unified endpoint:
The request body shape changes based on the direction of the trade. See the dedicated pages: The response always includes:
  • A quoteId (data.id) — required for the next step.
  • rate, fee, and summary.total — so your UI can display a breakdown.
  • rules — corridor-level transaction limits to validate before payout.
  • settlement — estimated delivery time.

Step 2 — Execute Payout

Once you have a quoteId, execute the transfer:
The recipient object changes based on whether the target is a blockchain wallet or a bank account. See the full guide:

Sequence diagrams

Crypto-to-Crypto

Offramp (Crypto → Fiat)

Onramp (Fiat → Crypto)


Authentication

All Ramp API requests require the x-api-key header: See Authentication for details on obtaining and rotating keys.

Transaction states

Subscribe to ramp webhooks to receive reliable transaction outcome notifications. The /v2/ramp/payout response is an acknowledgement only — treat webhooks as the source of truth.

Environments

Use the sandbox environment for all testing. Production keys will process real transactions.

Operational considerations

  • Quotes expire — always create a new quote if the previous one has timed out.
  • Check rules before executing — the rules array in every quote response contains per-corridor min/max limits. Validate in your UI before proceeding.
  • Webhooks are the source of truth — the payout response gives an initial PENDING state. Final status arrives asynchronously via webhook.
  • Gas fees — for crypto-to-crypto transfers, gas is included in the fee object. For offramp, gas is bundled into the quote.

Create Quote (Crypto)

Generate a quote for crypto-to-crypto transfers with rate and fee breakdown.

Create Quote (Offramp)

Generate a quote to convert crypto to fiat currency.

Create Quote (Onramp)

Generate a quote to convert fiat to cryptocurrency.

Create Ramp Payout

Execute a ramp transaction using a valid quoteId.

Next steps