Getting Started
What is NowRamp and what does it do?
What is NowRamp and what does it do?
What's the difference between Partner, Project, and Customer?
What's the difference between Partner, Project, and Customer?
How do I get started with integration?
How do I get started with integration?
@nowramp/form) which provide a complete checkout form. Alternatively, use the JavaScript SDK (@nowramp/sdk) for programmatic control, or call the Onramp API directly. Follow our Quickstart guide to get running in minutes.What environments are available?
What environments are available?
api.sandbox.nowramp.com) for testing with mock data, and Production (api.nowramp.com) for live transactions. Always test thoroughly in sandbox before going live.Do I need to build my own UI?
Do I need to build my own UI?
@nowramp/form package provides a complete, customizable checkout form as a React component. For non-React apps, a standalone IIFE build is available. If you want full UI control, use the data hooks (useRampConfig, useQuotes, useCheckoutIntent, useTransaction) or the RampApi SDK client directly.Integration
Do I need an API key?
Do I need an API key?
projectId. Optionally include a public key (pk_) for higher rate limits (1000 vs 60 requests per minute). Secret keys (sk_) are only needed for partner dashboard operations.What are the three integration options?
What are the three integration options?
- React Components (
@nowramp/form) — drop-inRampFormcomponent with theming and hooks - JavaScript SDK (
@nowramp/sdk) —RampApiclient for programmatic access - Raw API — direct HTTP calls to the onramp endpoints
How long do transactions take?
How long do transactions take?
estimatedTime field in quotes gives per-gateway estimates. Blockchain confirmation times vary by network (Bitcoin takes longer than Polygon, for example).What transaction statuses should I track?
What transaction statuses should I track?
pending (awaiting payment), processing (payment received, transferring crypto), completed (crypto delivered), failed (something went wrong), and refunded (payment returned). See Core Concepts for the full status flow diagram.Multi-Provider Aggregation
What is multi-provider aggregation?
What is multi-provider aggregation?
Which payment gateways are supported?
Which payment gateways are supported?
getSupported() API method to get the current list of enabled gateways for your project. See the Onramp API reference.How are quotes ranked?
How are quotes ranked?
Can I restrict which gateways my users see?
Can I restrict which gateways my users see?
features field from the supported config.What happens if a gateway is unavailable?
What happens if a gateway is unavailable?
Fees & Pricing
How do fees work?
How do fees work?
bestQuote, cheapestFees, and fastestQuote convenience fields help users find the best option.Are the displayed amounts inclusive of all fees?
Are the displayed amounts inclusive of all fees?
cryptoAmount in each quote is the amount the user will actually receive after all fees. The fees object provides a transparent breakdown.Are there minimum or maximum transaction amounts?
Are there minimum or maximum transaction amounts?
minAmount and maxAmount fields in the supported config vary by currency and gateway. Typical minimums are around $20-50 USD equivalent. Use these to validate amounts before fetching quotes.Webhooks
Which webhook events should I listen for?
Which webhook events should I listen for?
transaction.completed (crypto delivered) and transaction.failed (something went wrong). See the Callback URLs guide for the complete event list and payload examples.What happens if my webhook endpoint is down?
What happens if my webhook endpoint is down?
How do I verify webhook signatures?
How do I verify webhook signatures?
X-Webhook-Signature header containing an HMAC-SHA256 signature. Compute the expected signature using your webhook secret and compare using a timing-safe comparison. See the Webhooks guide for code examples.Troubleshooting
Why am I getting rate limited?
Why am I getting rate limited?
pk_) in the X-API-Key header to increase the limit to 1000 requests per minute. See the Authentication guide.My webhook endpoint isn't receiving events. What should I check?
My webhook endpoint isn't receiving events. What should I check?
Who do I contact for support?
Who do I contact for support?