On-ramp Sdk

The On-Ramp Widget is a pre-built, embeddable user interface that allows your users to convert fiat currency into crypto assets directly within your application. Unlike the API-only integration, this fully hosted component manages the entire user journey—including amount input, real-time exchange rate display, payment method selection, and status updates. It abstracts the complexity of payment collection and blockchain settlement, delivering the equivalent USDC or USDT to the user’s wallet via a secure, low-code integration.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32
required

The amount of fiat currency to charge the customer.

string
required

The fiat currency to be charged. This must be a supported currency.

string
required

The cryptocurrency to be settled. Currently, only USDC and USDT are supported.

string
required

The blockchain network for the crypto settlement. This determines the network on which the crypto will be sent. Supported chains are ETH, ARB, BASE, MATIC, BSC, and OPTIMISM

string

The customer's email address. Optional, but highly recommended for sending transaction receipts.

string
required

The destination on-chain wallet address for the crypto settlement. This address must be valid on the specified chain.

string
required

A unique ID from your system to identify and reconcile this transaction. The API will reject requests with duplicate externalReference values to prevent double-spending.

string

Where to redirect the user on a successful deposit

string

Where to redirect the user after cancelling the transaction

string

Where to redirect the user on a failed deposit

string

Required when the chargeCurrency is XOF e.g BJ, SN etc

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json