Integration Type

The Vortex Widget supports multiple integration modes

TL;DR

Recommended Integration	Suitable for	Setup Time	UX Control	Maintenance
Link Integration	All dAPPs	Very Low	Low	Minimal
Parameter Integration	Ramp aggregators, wallets	Moderate	Medium	Low
UI (iFrame) Integration	dAPPs who want full control of UX	Higher	High	Low

Below are the three main integration types currently supported:

Link Integration

This is the simplest and fastest way to integrate. You can link directly to the Vortex Widget from your app or website using a standard URL with predefined query parameters like the partner ID

How it works?

1. The user clicks a “Buy” or “Sell” button in your app.

2. Your app redirects them to the hosted Vortex widget (e.g., https://app.vortexfinance.co/buy?...).

3. The user completes the flow entirely on Vortex’s interface.

Idealy for?

1. Fast go-live with minimal development.

2. Use cases where the user experience can shift briefly to an external hosted page.

Advantages

1. Easiest to set up (no backend changes needed).

2. Automatically updated as new features roll out.

3. Secure and fully handled by Vortex (KYC, payments, callbacks, etc.).

How to integrate?

1. Add the following link to your BUY button https://www.vortexfinance.co/en/widget?rampType=BUY

2. Add the following linke to your SELL button https://www.vortexfinance.co/en/widget?rampType=SELL

Parameter Integration

In this mode, your app captures or preconfigures specific parameters on your UI and passes them to the Vortex widget link. This allows you to skip certain user input steps — for example, automatically setting the quote, fiat amount, or wallet address.

How it works?

1. The partner app collects details such as amount, asset, or network.

2. These parameters are appended to the widget URL.

3. The widget launches directly at the Verification, quote confirmation or payment step, skipping redundant screens.

Idealy for?

1. Partners who want tighter UX control while still using the hosted widget.

2. Scenarios where quotes or trade parameters are generated on your side.

Advantages

1. Smoother user flow (fewer steps).

2. Easy to embed dynamic user inputs.

3. Still minimal maintenance — Vortex handles backend logic and compliance.

How to Integrate?

To integrate the Vortex Finance widget, append your desired configuration as query parameters to the Base URL.

Base URL:

https://www.vortexfinance.co/en/widget

Contructing the URL

1. Start with the Base URL.

2. Add a question mark (?) to begin the query string.

3. Define your parameters using key=value pairs.

4. Separate multiple parameters using an ampersand (&).

Parameters

Parameter	Description	Example Values
rampType	The direction of the transaction	BUY, SELL
cryptoLocked	The specific cryptocurrency	USDT, ETH, BTC
fiat	The currency used for payment	EUR, USD, GBP
inputAmount	The numerical amount to trade	50, 100
network	The blockchain network	polygon, ethereum, bsc
paymentMethod	Supported payment methods	CBU, SEPA, PIX

Example URL

1. If you want to set up a widget for a user to sell 50 USDT on the Polygon network for EUR, your URL would look like this:

https://www.vortexfinance.co/en/widget?rampType=SELL&cryptoLocked=USDT&fiat=EUR&inputAmount=50&network=polygon

UI Integration (iFrame / Embedded Widget) - Coming soon

This is the deepest integration option. The full widget interface is embedded directly inside your app or web page using an iFrame, allowing the user to complete buy and sell transactions without leaving your platform.

How it works?

1. You embed the widget URL inside an iFrame container on your front end.

2. The user interacts with the widget UI as if it’s part of your app.

3. All backend actions (KYC, quote, settlement, etc.) remain fully handled by Vortex.

Idealy for?

1. Apps wanting a native in-app experience with complete UX continuity.

2. Partners with active user sessions or account systems that prefer not to redirect externally.

Advantages

1. Fully contained UX (no context switch).

2. Secure and compliant — Vortex handles all flows.