Vortex
  1. Vortex Widget
Vortex
  • General overview
  • Vortex Ramp Integration Guide
  • Vortex SDK
  • Sandbox Environment
  • Quotes
    • Get existing quote
      GET
    • Create a new quote
      POST
    • Create a quote for the best network
      POST
  • Vortex Widget
    • Widget parameters
    • Generate a widget URL (with quote refresh)
      POST
    • Generating widget URL (for existing quote)
      POST
  • Ramp
    • Get ramp status
      GET
    • Get ramp history for wallet address
      GET
    • Register new ramp process
      POST
    • Update ramp process
      POST
    • Start ramp process
      POST
  • Account Management
    • Brazil
      • Brazilian KYC Process Overview
      • Get user's remaining transaction limits
      • Get user information
      • Get status of the last ramp event for a user
      • Create user or retry KYC
      • Get user's KYC status
      • Start KYC level 2 process for a user
    • Europe
      • Coming soon...
  • Webhooks
    • Overview
    • Register Webhook
      POST
    • Delete Webhook
      DELETE
  • Public Key
    • Overview
    • Public Key
      GET
  • Supported Payment Methods
    GET
  • Supported Cryptocurrencies
    GET
  • Supported Countries
    GET
  • Supported Fiat Currencies
    GET
  • Schemas
    • Schemas
      • CleanupPhase
      • StartRampRequest
      • RampDirection
      • GetWidgetUrlLocked
      • CountryCode
      • PaymentMethod
      • SimpleStatus
      • FiatToken
      • OnChainToken
      • GetWidgetUrlRefresh
      • CreateBestQuoteRequest
      • GetRampHistoryTransaction
      • GetRampHistoryResponse
      • RegisterRampRequest
      • CreateQuoteRequest
      • UpdateRampRequest
      • BrlaErrorResponse
      • AccountMeta
      • QuoteResponse
      • PresignedTx
      • GetUserResponse
      • Networks
      • RampCurrency
      • PaymentData
      • GetKycStatusResponse
      • RampProcess
      • ValidatePixKeyResponse
      • RampPhase
      • GetUserRemainingLimitResponse
      • DestinationType
      • TriggerOfframpRequest
      • UnsignedTx
      • TriggerOfframpResponse
      • ErrorResponse
      • BrlaAddress
      • TaxIdType
      • CreateSubaccountRequest
      • CreateSubaccountResponse
      • KYCDocType
      • KYCDataUploadFileFiles
      • StartKYC2Request
      • StartKYC2Response
  1. Vortex Widget

Generate a widget URL (with quote refresh)

Production
https://api.vortexfinance.co
Production
https://api.vortexfinance.co
POST
/v1/session/create
You can call this endpoint to get a widget URL where the widget app will keep refreshing the quote with your specified direction, amount, and currencies.

Request

Body Params application/json

Examples

Responses

🟢201Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST 'https://api.vortexfinance.co/v1/session/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "callbackUrl": "https://www.example.org/",
    "countryCode": "BR",
    "cryptoLocked": "USDC",
    "externalSessionId": "my-session-id",
    "fiat": "BRL",
    "inputAmount": "300",
    "network": "base",
    "paymentMethod": "pix",
    "partnerId": "my-partner-id",
    "rampType": "BUY"
}'
Response Response Example
{
    "url": "string"
}
Modified at 2026-01-27 10:38:07
Previous
Widget parameters
Next
Generating widget URL (for existing quote)
Built with