Widget Pop-up
Crypto on-ramp on your website
Last updated
Crypto on-ramp on your website
Last updated
The widget product allows you to on-ramp your users without them leaving your website/app by just initiating a pop-up.
Get your from your dashboard
Avoid exposing your secret key on the client side (or front end) of your application. Requests to LocalRamp's API should be initiated from your server.
reference
String
Required - Your unique transaction reference. Must be unique for every transaction. e.g "Abc123"
String
Optional e.g "customer@example.com"
sender_currency
String
Optionally Required - The currency your user would be paying in. It becomes required only if sender_amount
or receiver_amount
is provided. e.g "NGN"
country_code
String
Optionally Required - The country_code of the user paying in. It becomes required only if sender_currency
is provided. e.g "NG", "KE", "GH", "ZM"
receiver_currency
String
Optionally Required - The cryptocurrency that would be received. It becomes required only if sender_amount
, receiver_amount
or destination_address
is provided. e.g "USDT_BSC"
sender_amount
String
Optional - amount your user would be paying in sender_currency
unit. e.g "20000.00". If this is present, then receiver_amount
should be omitted
receiver_amount
String
Optional - crypto amount that should be received in receiver_currency
unit. e.g "0.78728772". If this is present, then sender_amount
should be omitted
destination_address
String
Optional - crypto address where payments will be sent to. e.g "0xC637255611b0A70259722c35D419077Da4cACcfF"
destination_tag
String
Optionally required - For coins that require a memo or tag. It is only required if address provided supports tags/memos e.g "3239783255"
payment_method
String
widget_color
String
Optional - Hex color code to customize widget e.g "#DA70D6"
onClose
[Function]
Optional - Gets called whenever the user closes the modal. This could be as a result of the transaction being completed or abandoned.
Once the modal is closed, the onClose function is called with the transaction reference
Optional - Specify a particular e.g instant_p2p
Before passing in either the sender_amount
or receiver_amount
, you'll need to know the maximum and minimum values allowed for each field. See .
To get the list of supported currencies and country codes for both sender_currency
and receiver_currency
see the
sender_amount
and receiver_amount
show payment intent and does not guarantee the exact value that would be received at the end of the transaction. To see the exact amounts received, .
This is the same reference used in initializing the widget which can now be used to verify the transaction. See
In some cases, the crypto might take a few minutes to arrive. If you do not want to keep querying the transaction status, you can always get informed when the transaction is complete through webhooks. See .