OffRamp

Method Signature

offramp(token, amount, phoneNumber)

Parameters

Parameter
Description

token

The token you wish to withdraw. You can choose from the supported tokens. This parameter specifies the cryptocurrency or digital asset that the user wants to convert.

amount

The amount of funds to be withdrawn. This value indicates the quantity of the specified token that the user intends to convert to fiat currency.

phoneNumber

The recipient's phone number. This is where the converted funds will be sent for easy access by the user. Make sure to provide a valid and correctly formatted phone number.

By using the offramp method, you facilitate a streamlined process for your users to transform their chosen tokens into real-world currency, enhancing their overall user experience. Make sure to consult the supported tokens list to see the available options for the token parameter.

Return Value(s)

Returns a JSON object literal with the below info:

Return Value
Description

success

A boolean value indicating the success of the operation.

response

An object containing detailed information about the transaction & app.

Last updated