On/Off Ramp
Documentation of Widget On Ramp and Off Ramp
Definition
On Ramp
Widget Onramp allows the user get cryptocurrencies from FIAT money.
User will need to have a crypto wallet to be able to fund and prove that he/she is an authenticated natural person through a KYC (Know Your Client) flow.
The payment methods integrated with the widget for Argentina are Mercado Pago and Bank Transfer.
The widget is developed to provide its functionalities in any browser.
Off Ramp
Widget Onramp allows the user get FIAT money from cryptocurrencies.
User will need to have a Bank account to be able to depositing and prove that he/she is an authenticated natural person through a KYC (Know Your Client) flow.
The deposit method integrated with the widget for Argentina is Bank Transfer.
The widget is developed to provide its functionalities in any browser,.
Requirements
-
Credentials: Credentials must be requested in order to generate an Authentication token needed to use Widget On Ramp. Contact Ripio support to request the partner’s registration and obtain
client_id
andclient_secret
, which univocally identify you as a Ripio customer. It is the partner’s responsibility to secure these credentials. -
Post-Confirmation Redirect URL: It is required to provide a URL which we will redirect the user once the operation is confirmed. This URL must be public in order to let user continue to the partner’s platform.
Integration
Generate authentication token
This service provides an access JWT token for the user to use the On Ramp Widget.
Endpoint: http://b2b-widget-onramp-api.ripio.com/api/v1/auth
Sandbox::
https://b2b-widget-onramp-api.sandbox.ripio.com/api/v1/auth
Method: POST
Parameters:
Parameter | Type | Description |
---|---|---|
username | string | The user is composed of a concatenation of client_id + “: ” + external_ref . |
password | string | La contraseña del usuario se debe enviar el client_secret |
Disclaimer:
external_ref
: UUID v4 that represents the user logged into your system. It must be a unique and unrepeatable identifier of a user of your system (Read more about UUID and try using generator). This value is then used in the request for approval of a purchase transaction or when reporting the result of a transaction. (see Webhooks). In the documentation we refer to this value as external_ref.
Request:
Example:
Response:
Widget Access
On Ramp
To access Widget On Ramp, you must direct the user from your platform to the Widget On Ramp along with the access token generated above.
The URL must be formed as follows:
Sandbox::
https://b2b-widget-onramp.sandbox.ripio.com
Example:
Off Ramp
To access Widget Off Ramp, you must direct the user from your platform to the Widget Off Ramp along with the access token generated above.
The URL must be formed as follows:
Sandbox::
https://b2b-widget-onramp.sandbox.ripio.com/offramp.html
Example:
When accessing the user will see the following welcome screen:
Parameters
Widget configuration parameters using query params.
Parameter | Type | Description |
---|---|---|
_addr | string (Optional) | Set address to prefill onramp wallet which it won’t be editable. Ex: 0x646eE511616A20a321A1cB72DADCB04C0485b97e |
_net | string | Set network to pre select chain. It must match the networks available to the partner. Ex: ETHEREUM |
_amount | string | Set amount to prefill amount of fiat to onramp. Ex: 1000 or 4321.35 |
_crypto | string (Optional) | Set crypto currency which it won’t be editable. It must match the cryptos available to the partner. Ex: USDT |
Settings
Customize your theme - UI
The Widget allows you to configure the theme of the user interface so that the styles are adjusted to the Partner’s brand style, and to the UX of its platform. The theme is set in the partner’s setting, and for this to be possible, the partner must send Ripio a CSS file with the variables corresponding to its brand style.
Below is a template with the default values of the theme, it is recommended to copy and modify the necessary values:
theme.css
Usage
The file with the theme can be assembled only with the values that need to be overwritten, the variables that are not overwritten will use the default value displayed in the template above.
Customize the typography
To use a font it is necessary to be able to import it from a static host and then modify the variable that owns font-family
.
Example:
- Font:
Monserrat
- Host:
https://fonts.googleapis.com/css2?family=Montserrat:ital,wght@0,100..900;1,100..900&display=swap
Default UI theme Customized UI theme
Customize Buttons
In case we want to modify the styles of the buttons, only variables starting with --ripio-btn
modify the buttons.
Example:
Primary Button
Default UI theme Customized UI theme
Secondary Button
Default UI theme Customized UI theme
Tertiary Button
Default UI theme Customized UI theme
Was this page helpful?