Documentation of Widget On Ramp and Off Ramp
client_id
and client_secret
, which univocally identify you as a Ripio customer. It is the partner’s responsibility to secure these credentials.
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 username is composed of a concatenation of client_id + “: ” + external_ref . |
password | string | The password is the client_secret |
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.
Sandbox:: https://b2b-widget-onramp.sandbox.ripio.com
Example:
Sandbox:: https://b2b-widget-onramp.sandbox.ripio.com/offramp.html
Example:
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 |
_tracking_session | string (Optional) | Custom identifier to track the user session on your end. It will be returned in the webhooks under metadata.session . Ex: random-tracking-id-onramp |
_tracking_session
parameter can be used as follow:
Parameter | Description |
---|---|
external_ref | Session token generated by the partner. |
action | Operation type, always onramp in this case. |
crypto_amount | Amount of cryptocurrency the user received. |
token | Cryptocurrency selected by the user (e.g., UXD ). |
network | Blockchain network used for the crypto transfer. |
deposit_address | User’s wallet address where crypto was sent. |
fiat_amount | Amount of fiat used in the transaction. |
fiat_currency | Fiat currency used by the user (e.g., ARS ). |
fees | Total fees applied to the transaction (e.g., platform, network, etc.). |
session_id | Optional session identifier if sent using _tracking_session . |
country_code | Country code based on the user’s location (e.g., AR ). |
Note: TheExample image of the final On Ramp screen:session_id
parameter will only be included if the partner specified a_tracking_session
when constructing the On Ramp widget URL.
Parameter | Description |
---|---|
external_ref | Session token generated by the partner. |
action | Operation type, always offramp in this case. |
crypto_amount | Amount of cryptocurrency being sold. |
token | Selected cryptocurrency (e.g., UXD ). |
network | Selected blockchain network (e.g., ETHEREUM , ETHEREUM_SEPOLIA ). |
deposit_address | Deposit address where the crypto must be sent. |
fiat_currency | Fiat currency the user will receive (e.g., ARS ). |
session_id | Optional session identifier if provided using _tracking_session . |
country_code | Country code based on the user’s location (e.g., AR ). |
Note: Thesession_id
parameter will only be present if the partner includes a_tracking_session
value when generating the Off Ramp widget URL. This allows the partner to maintain traceability between their internal user session and the transaction on Ripio’s side.
deposit_address
) and the network (network
) details.font-family
.
Example:
Monserrat
https://fonts.googleapis.com/css2?family=Montserrat:ital,wght@0,100..900;1,100..900&display=swap
--ripio-btn
modify the buttons.
Example:
Primary Button