Onramp Widget
Overview
Onramp Widget is a hosted Calypso page that lets customers pay with fiat while the merchant receives cryptocurrency through the onramp flow.
Use the widget when you want to generate a payment session through API and then open a ready-to-use Calypso onramp page by redirecting the customer or embedding it into the merchant website.
How it works
| Step | Description |
|---|---|
| Generate widget key | Merchant creates a widget session with POST /api/v1/fiat/deposit/key/generate. |
| Open widget | Merchant builds the widget URL with account, widgetKey, and idempotencyKey. |
| Customer pays | Customer selects payment details and completes fiat payment in the widget. |
| Track status | Merchant receives ONRAMP webhooks and can verify order state through Fiat Deposit API. |
Test widget
You can try the test ONRAMP widget here: https://pay.calypso.money/onramp?color=256eff&logo=true&radius=6&test=true&theme=light.
Guides
| Guide | Description |
|---|---|
| How to integrate the ONRAMP widget | Generate widget key, build widget URL, open the widget, and track order status. |
| How to customize the ONRAMP widget | Configure widget color, logo visibility, corner radius, and theme. |
| How to embed the ONRAMP widget to your site | Embed the widget into the merchant website with iframe. |
Related API methods
| API | Link |
|---|---|
| Webhook API | Webhook API reference |