onramp-docs-cli
Version:
CLI tool to set up Onramp documentation and integration in your project
67 lines (43 loc) • 4.97 kB
Markdown
# Coinbase Onramp Overview
<Warning>
**Effective 7/31/2025, all Coinbase Onramp & Offramp URLs must be securely initialized using the `sessionToken` parameter.**
This migration is mandatory for continued access to Coinbase Onramp and Offramp APIs. [Learn more about the migration](/onramp-&-offramp/mandatory-migration/secure-init-migration) or [contact us](https://discord.com/invite/cdp) for help.
</Warning>
## Bring money onchain using the Onramp API
### From a Coinbase account
If a user is connected to a Coinbase account, they can pay using fiat or crypto balances in their account.
Coinbase users can also directly transfer money from their linked [payment methods](/onramp-&-offramp/developer-guidance/payment-methods) (eg. bank accounts and debit cards).
### From a debit card (Guest checkout)
Any US resident with a debit card can onramp up to \$500/week. Minimum transaction amount is \$5.
Now with [Apple Pay](https://www.coinbase.com/blog/Fiat-to-crypto-in-seconds-with-Apple-Pay), US users can bring funds onchain in seconds, not minutes.
If a user is not connected to a Coinbase account, they will automatically be directed to this flow.
Drop us a message in the **#onramp** channel of the [CDP Discord](https://discord.com/invite/cdp) if you need help with Guest checkout.
Try out this flow in the [sandbox](/onramp-&-offramp/integration/sandbox-testing)!
<Tip>
Buying USDC with Coinbase Onramp is now free!
That's right, **0% fees** to go from fiat to USDC. [Learn more](https://www.coinbase.com/developer-platform/discover/launches/zero-fee-usdc)
</Tip>
## Countries & local payment methods
Get the latest list of [countries and payment methods](/onramp-&-offramp/onramp-apis/countries-&-currencies) where Coinbase Onramp is supported. As Coinbase grows, access payment rails in new countries.
If you'd like to recommend new countries, drop us a message in the **#onramp** channel of the [CDP Discord](https://discord.com/invite/cdp).
## Onramp API Endpoints
Coinbase Onramp is accessed by directing users to a URL which can be generated by your app's frontend or backend.
For the smoothest user experience, we recommend generating a [one-click-buy URL](/onramp-&-offramp/onramp-apis/one-click-buy-url).
The Onramp API has the following endpoints:
| Method | Description |
| :------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Session Token](/onramp-&-offramp/onramp-apis/generating-onramp-url#getting-a-session-token) | **Required starting 7/31/2025**: Provides a secure way for the client to initialize the Onramp and Offramp widget. |
| [Onramp Config](/onramp-&-offramp/onramp-apis/countries-&-currencies) | Returns list of countries supported by Coinbase Onramp, and the payment methods available in each country. |
| [Onramp Options](/onramp-&-offramp/onramp-apis/countries-&-currencies) | Returns supported fiat currencies and available crypto assets that can be passed into the Buy Quote API. |
| [Onramp Quote](/onramp-&-offramp/onramp-apis/generating-quotes) | Provides a quote based on the asset the user would like to purchase, plus the network, the fiat payment, the payment currency, payment method, and country. |
| [Transaction Status](/onramp-&-offramp/onramp-apis/transaction-status) | Real time transaction status updates. |
| [Transactions](/onramp-&-offramp/onramp-apis/transaction-status) | Historical transaction status. |
<Tip>
Full API endpoint list
For a complete list of all API endpoints supported by Onramp/Offramp, visit our [API Reference section](/api-reference/rest-api/onramp-offramp/create-buy-quote).
</Tip>
## Rate Limiting
The **Buy Quote API and Sell Quote API** are rate limited to prevent abuse that would degrade our ability to maintain consistent API performance for all users.
Throttling is enforced per endpoint by app ID at **10 requests per second**.
If your requests are being rate limited, HTTP response code 429 is returned with a `rate_limit_exceeded` error.
Rate limiting is implemented using a sliding window algorithm.