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
  • API Base path
  • Buy/Sell Quotes
  • 🧾 Request Parameters
  • 🧪 Example Request
  • ✅ Success Response (200 OK)
  • ❌ Error Response
  • ⚠️ Important Notes
  1. API Reference

REST API V1

API Base path

https://api.vortexfinance.co/

All request and response bodies should be in JSON

Buy/Sell Quotes

Endpoint

POST v1/quotes

This API allows partners to request quotes for Buy and Sell stablecoin transactions. The API returns a quote including the estimated output amount, fees, and an expiration time.

ℹ️ Authentication: Not required ⏱️ Rate Limit: None currently enforced 🧾 Content-Type: application/json 🏷️ API Version: v1


🧾 Request Parameters

Parameter
Type
Required
Description
Allowed Values

rampType

string

Yes

Direction of transaction

on, off

from

string

Yes

Source network/payment method

If rampType parameter is off: assethub, avalanche, arbitrum, bsc, base, ethereum, polygon

ELSE on: pix, sepa, cbu

to

string

Yes

Destination network/payment method

If rampType parameter is on: assethub, avalanche, arbitrum, bsc, base, ethereum, polygon ELSE off: pix, sepa, cbu

inputAmount

string

Yes

Amount to send (as string, e.g. "100.00")

Positive number string

inputCurrency

string

Yes

Currency code for input

eurc, ars, brl, usdc, usdt, usdce

outputCurrency

string

Yes

Desired currency for output

eurc, ars, brl, usdc, usdt, usdce


🧪 Example Request

{
  "rampType": "off",
  "from": "base",
  "to": "pix",
  "inputAmount": "200.00",
  "inputCurrency": "usdt",
  "outputCurrency": "brl"
}

✅ Success Response (200 OK)

{
  "id": "917a43e3-36c9-440c-a613-3757c0cc598f",
  "rampType": "off",
  "from": "base",
  "to": "pix",
  "inputAmount": "200.00",
  "inputCurrency": "usdt",
  "outputAmount": "1181.47",
  "outputCurrency": "brl",
  "fee": "0.75",
  "expiresAt": "2025-04-08T10:24:28.894Z"
}
Field
Type
Description

id

string

Unique identifier for the quote

rampType

string

Echoes request rampType

from

string

Echoes request source

to

string

Echoes request destination

inputAmount

string

Echoes input amount

inputCurrency

string

Echoes input currency

outputAmount

string

Estimated amount user will receive

outputCurrency

string

Echoes output currency

fee

string

Transaction fee in inputCurrency

expiresAt

string

ISO 8601 timestamp indicating quote expiry


❌ Error Response

{
  "code": 400,
  "message": "onramping from base to pix is not supported."
}
Field
Type
Description

code

integer

HTTP status code

message

string

Human-readable error message


⚠️ Important Notes

💡 Currency Rules

  • Sell: Most supported crypto to fiat payout combinations are allowed.

  • Buy: Currently supported only for brl via pix, delivering usdc, usdt, or usdce to supported networks. Support for eur and ars maybe added later.

💰 Fee Structure

  • USDC/T to BRL : Fixed fee

  • USDC/T to EUR : 0.25% of inputAmount

  • USDC/T to ARS: 2% of inputAmount

⏳ Quote Expiration

  • Quotes are time-sensitive.

  • expiresAt indicates the deadline to act on the quote.

PreviousAPI Reference

Last updated 1 month ago