Hosted Mode

The hosted mode is the quickest method to add offramp support to your app.

Offramp integration

simple integration(offramp)

Integrating in hosted mode is pretty straight forward, the only thing you would need to do is redirect your user to offramp (link below), this would work for both on desktop and mobile, just add a link to your app.

https://onramp.money/main/sell/?appId=1

Note:

• Supported Currencies: To view the list of all the fiat currencies supported by Onramp, click here.

• Supported Payment Methods: To view the list of all the supported payment methods for various currencies supported by Onramp, click here.

Customisation(offramp)

If you want to set some custom options for your integration, just add them as query parameters to the URL.

For example, we can pre-fill the network, coinAmount etc so the user flow can be enhanced and seamless overall, for detailed customisation refer to the block below.

customisation options via query params

GET https://onramp.money/main/sell/?appId=1

User is redirected to the offramp page, with configs set in query params.

Path Parameters

Name	Type	Description
appId*	1	App Id of the merchant/Partner
coinAmount	10	amount denoted in the native coin/token. either coinAmount or fiatAmount, can be passed. When passed both coinAmount takes precedence
network	bep20	supported networks by onramp for onchain transactions current supported networks: usdt - bep20 | matic20 | erc20 | trc20 usdc - bep20 | matic20 busd - bep20 matic - matic20 bnb - bep20 eth - erc20 | matic20
coinCode	usdt	Name of the coin (also denoted as key in data.allCoinConfig in the response returned in the allConfig endpoint) current supported coins: usdt| usdc | busd | eth | bnb | matic | sol
fiatAmount	1000	amount denoted in fiat amount. (only ₹ INR is currently supported)
merchantRecognitionId	13422	Specific string that can be passed by the merchant/Partner at the time of making the request, this would reflect via update from webhook.
authToken	"eyJhbG.."	The generated token for the transaction
redirectUrl*	onramp-example.com	URL* to which the user would be redirected to after the user confirms the order details. *Applicable only in hosted mode
phoneNumber	%2B90-9993749865	The user's phone number should be URL-encoded, with the country code and phone number separated by a hyphen. e.g. the number [phone] would be encoded as %2B90-9993749865.
fiatType	1	1 -> India (Default) INR 2 -> Turkey (TRY) 6 -> Nigerian Naira (NGN) etc Note: For a complete list of supported fiat currencies, please visit the "Fiat Currencies" page under "Supported Assets & Fiat"

200: OK

{
    // Response
}

Note: After generating the token and initiating the order, Onramp.money will send a request to initiate the on-chain withdrawal to the destination address on behalf of the user.

Redirect Response

The Onramp widget URL allows the inclusion of a redirectUrl parameter. Upon completion of a purchase, Onramp will redirect the user to the specified URL using this parameter. This feature can be utilised by your application to detect the completion of a transaction and execute subsequent actions, such as providing the user with purchase status notifications.

if your app name is onramp-example, and the parameter is set to redirectUrl = http://onramp-example.com

the redirect would be as the following

//after successful transaction
http://onramp-example.com?orderId=123&status=success

//incase transaction is pending
http://onramp-example.com?orderId=123&status=pending