Create Offramp URLs for your Users

We offer three integrations, Transak, Moonpay, and Ramp Network, that you can use to generate offramp URLs for your users by defining parameters like the fiat currency, fiat amount, destination wallet address, and the crypto currency.

Transak Offramp

Request Endpoint: reference

POST /fiat-ramp/transak/off

Request Body:

{
    "fiatCurrency": "USD",
    "cryptoAmount": "0.15",
    "cryptoCurrency": {
        "network": "mainnet",
        "symbol": "BTC"
    },
    "redirectUrl": "https://www.venly.io/",
    "email": "[email protected]"
}

Parameter	Type	Description	Required
`fiatCurrency`	String	The code of the fiat currency you want the user to be paid in.	❌
`cryptoAmount`	Number	The amount in crypto currency showing how much crypto your user wants to sell. If this is passed, the user can't change the crypto amount.	❌
`cryptoCurrency.network`	String	The crypto network such as `bitcoin` or `ethereum` that you would allow your customers to buy/sell. Can be obtained from the response of the Get supported fiat and crypto currencies endpoint .	❌
`cryptoCurrency.symbol`	String	The code/symbol of the cryptocurrency you want the user to buy/sell. Can be obtained from the response of the Get supported fiat and crypto currencies endpoint .	❌
`redirectUrl`	String	Once the customer has completed the purchase/sell process, Transak will redirect back to this URL with additional order info appended to it as parameters.	❌
`email`	String	The email that will be used to identify your user and their order.	❌
`isFeeCalculationHidden`	Boolean	If this is set to `true`, your user won't see a detailed breakdown of fees—they'll only see the total fee	❌
`hideMenu`	Boolean	When `true`, then the user will not see the menu options. This will hide the menu completely	❌

Response Body:

Generated URL Preview

Moonpay Offramp

Request Endpoint: reference

POST /fiat-ramp/moonpay/off

Request Body:

{
    "fiatCurrency": "EUR",
    "cryptoAmount": "3000",
    "cryptoCurrency": {
        "symbol": "usdc"
    },
    "redirectUrl": "https://www.venly.io/",
    "email": "[email protected]",
    "refundWalletAddress": "0x3FE9a7D68C6a4a2d6575A6C803E4CDF9340E370E"
}

Parameter	Type	Description	Required
`fiatCurrency`	String	The code of the fiat currency (e.g. USD, AUD, GBP) you want the user to be paid in.	❌
`cryptoAmount`	Number	A positive number representing how much crypto the user wants to sell. This parameter will be skipped if `cryptoCurrency.symbol` is not passed.	❌
`cryptoCurrency.symbol`	String	The code/symbol of the cryptocurrency you want the user to buy/sell. Can be obtained from the response of the Get supported fiat and crypto currencies endpoint .	❌
`redirectUrl`	String	A URL you'd like to redirect the user to after they complete the sell flow.	❌
`email`	String	The user's email address.	❌
`refundWalletAddress`	String	The cryptocurrency wallet address where the funds will be sent to in case of a refund. This parameter will be skipped if `cryptoCurrency.symbol` is not passed.	❌

Response Body:

{
    "success": true,
    "result": {
        "url": "https://sell-sandbox.moonpay.com?apiKey=pk_test_uHJf0DO1w0yfpJxhh7xkLaejUmjeY0&quoteCurrencyCode=EUR&baseCurrencyAmount=3000&refundWalletAddress=0x3FE9a7D68C6a4a2d6575A6C803E4CDF9340E370E&redirectURL=https%3A%2F%2Fwww.venly.io%2F&email=abdullah.baig%40venly.io&baseCurrencyCode=usdc&signature=E6rrGWrGpf%2FTNyZRenULguG6lF4NacD%2F0PiaQk4WhzY%3D"
    }
}

Generated URL Preview

Ramp Network Offramp

Request Endpoint: reference

POST /fiat-ramp/ramp-network/off

Request Body:

{
    "fiatCurrency": "USD",
    "fiatAmount": "1000",
    "cryptoCurrency": {
        "network": "MATIC",
        "symbol": "MATIC"
    },
    "redirectUrl": "https://www.venly.io/",
    "email": "[email protected]",
    "userAddress": "0x3FE9a7D68C6a4a2d6575A6C803E4CDF9340E370E",
    "selectedCountryCode": "US"
}

Parameter	Type	Description	Required
`fiatCurrency`	String	The code of the fiat currency (e.g. USD, AUD, GBP) you want the user to purchase with. Mandatory if `fiatAmount` is passed.	❌
`fiatAmount`	Number	A positive integer representing how much fiat the user wants to spend	❌
`cryptoCurrency.network`	String	The crypto network such as `bitcoin` or `ethereum` that you would allow your customers to buy/sell. Can be obtained from the response of the Get supported fiat and crypto currencies endpoint .	❌
`cryptoCurrency.symbol`	String	The code/symbol of the cryptocurrency you want the user to buy/sell. Can be obtained from the response of the Get supported fiat and crypto currencies endpoint .	❌
`redirectUrl`	String	The URL the user will be redirected to after completing the flow.	❌
`email`	String	The email address for your user to make their onramping experience even quicker.	❌
`userAddress`	String	The wallet address of your user where crypto will be sent to.	❌
`selectedCountryCode`	String	This param pre-selects the user's country. The value should be a two-letter country code (ISO 3166-1 alpha-2).	❌

Response Body:

{
    "success": true,
    "result": {
        "url": "https://app.demo.ramp.network?hostApiKey=unkvxgqfdpbpzet33gqnpnf2at7p7rytq458avkc&enabledFlows=OFFRAMP&fiatValue=1000&fiatCurrency=USD&finalUrl=https%3A%2F%2Fwww.venly.io%2F&userEmailAddress=abdullah.baig%40venly.io&selectedCountryCode=US&swapAsset=MATIC_MATIC"
    }
}