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`
`_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

The _tracking_session parameter can be used as follow:

https://b2b-widget-onramp.sandbox.ripio.com/index.html?_to=<token>&_tracking_session=random-tracking-id-onramp

Then, you will receive the tracking session in the webhooks as follows:

{
  "eventType": "ON-RAMP.DEPOSIT.RECEIVED",
  "transaction": {
    ...
    "metadata": {
      "session": "random-tracking-id-onramp"
    }
  }
}


### Post-Transaction Redirect Behavior
---
#### On Ramp

The On Ramp widget supports a **manual redirection flow** once the user completes a fiat-to-crypto purchase.

After the user confirms the operation and the On Ramp order is successfully created, the widget will display a **final screen with a "Back to Partner" button**. When the user clicks this button, they are redirected to a partner-configured URL with all relevant transaction information passed as query parameters.

To enable this functionality, the partner must **provide Ripio with a redirection URL** during onboarding. This URL must be publicly accessible and can follow any structure under the partner’s domain, for example:

```bash
https://partner-fintech.com/ramps/success

Upon redirection, the following parameters will be appended: Example final URL:

https://partner-fintech.com/ramps/success?external_ref=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...&action=onramp&crypto_amount=700.21146386&token=UXD&network=ETHEREUM_SEPOLIA&deposit_address=0x646eE511616A20a321A1cB72DADCB04C0485b97e&fiat_amount=100000&fiat_currency=ARS&fees=1000&session_id=1234&country_code=AR

Query Parameters:

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: The session_id parameter will only be included if the partner specified a _tracking_session when constructing the On Ramp widget URL.

Example image of the final On Ramp screen:

Final On Ramp screen with "Back to Partner" button

Off Ramp

The Off Ramp widget allows automatic redirection of the user upon completing a cryptocurrency sale transaction. To enable this, the partner must provide Ripio with a redirection URL, which will be configured in the partner’s account. This URL must be publicly accessible and can point to any valid route under the partner’s domain, for example:

https://partner-fintech.com/ramps/success

Once this URL is configured, the widget can redirect the user upon completing the Off Ramp flow. There are two ways this redirection may occur, depending on the partner’s integration setup:

1. Automatic Redirection (Partner-Assisted Flow)

If a redirection URL is configured, the widget will automatically redirect the user to that URL after the Off Ramp flow is confirmed. Additionally, relevant transaction details will be appended as query parameters.

https://partner-fintech.com/ramps/success?external_ref=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...&action=offramp&crypto_amount=20&token=UXD&network=ETHEREUM_SEPOLIA&deposit_address=0x76E0cCB0EBE289C6502F97EC8458cf2337a1d339&fiat_currency=ARS&session_id=tracking-id-example&country_code=AR

Query Parameters:

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: The session_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.

2. Manual Redirection (User-Initiated Flow)

If the partner does not manage the user’s crypto custody, the widget will display a final screen with the required information for the user to manually send the cryptocurrency from their preferred wallet. In this case:

The user will see the deposit address (deposit_address) and the network (network) details.
The user must send the specified amount manually from their wallet.
Once the funds are received, Ripio will process the transaction and deposit the corresponding fiat amount in the user’s bank account.

Additionally, this screen will display a “Back to Partner” button. If the user clicks this button, they will be redirected to the same redirection URL configured by the partner, with the full transaction details included in the query string—just as in the automatic redirection flow. This ensures that even in manual flows, the partner can receive the complete transaction context and allow users to return to their platform seamlessly. Example image of the final Off Ramp screen (manual flow):

Overview

Widget integration

API Integration

Parameters

Parameters

Tracking session parameter

Off Ramp

1. Automatic Redirection (Partner-Assisted Flow)

2. Manual Redirection (User-Initiated Flow)

​Parameters

​Tracking session parameter

​Off Ramp

1. Automatic Redirection (Partner-Assisted Flow)

2. Manual Redirection (User-Initiated Flow)

Parameters

Tracking session parameter

Off Ramp