Vortex Docs
  • Introduction
  • Sell USDT/C
    • Personal
    • Business
  • Buy USDT/C
    • Personal
    • Business
  • Hosted Mode
  • Fund Flow
  • Fund Security & Resilience
  • Provide DEX liquidity
  • Technical Architecture
  • Support and Contact
  • API Reference
    • REST API V1
Powered by GitBook
On this page
  • Basic integration​
  • Base URL
  • Supported URL Parameters
  • Example Integration
  • Notes
  • Support

Hosted Mode

The hosted mode is the quickest method to add the Vortex ramp to your app.

Basic integration​

Integrating Vortex in hosted mode is pretty straightforward - the only thing you need to do is to redirect your user to https://app.vortexfinance.co/ with mandatory URL params. Note that this approach will work for both desktop and mobile integrations - no extra work needed! Just add a link to your app.

Base URL

https://app.vortexfinance.co/

Supported URL Parameters

Parameter

Type

Description

fromAmount

Number

The amount the user wants to off-ramp. Example: 20

from

String

The token being off-ramped. Values: usdc, usdt, usdc.e

to

String

The fiat currency the user wants to receive. Values: eur, ars, brl

network

String

The blockchain network. Values: base, polygon, assethub, ethereum, arbitrum, avalanche, bsc

partnerId

String

Your unique partner identifier (required for tracking and attribution)

mode

String

Values: widget

ramp

String

Values: buy, sell

Example Integration

If a user wants to Sell 50 USDC on the base network to receive EUR:

https://app.vortexfinance.co/?fromAmount=20&to=eur&from=usdc&network=base&partnerId=partnerID&mode=widget&ramp=sell

To open this dynamically in a new tab:

const params = new URLSearchParams({
  fromAmount: '20',
  to: 'eur',
  from: 'usdc',
  network: 'base',
  partnerId: 'partnerID',
  mode: 'widget',
  ramp: 'sell'
});

window.open(`https://app.vortexfinance.co/?${params.toString()}`, '_blank');

If a user wants to Buy 50 USDC on the Base network to with BRL:

https://app.vortexfinance.co/?fromAmount=20&to=usdc&from=brl&network=base&partnerId=partnerID&mode=widget&ramp=buy

Notes

  • All parameters are case-sensitive.

  • partnerId is required for attribution and analytics.

  • mode=widget ensures a lightweight embedded experience. If omitted, the full app is loaded.

  • ramp=buy or ramp=sell pre-selects the respective tab in the widget/app.

  • Make sure to validate user inputs to avoid malformed URLs.

Support

Need help with your integration? Reach out to your partnership manager or email us at support@vortexfinance.co

PreviousBusinessNextFund Flow

Last updated 1 month ago