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
    • 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
  1. Vortex Widget

Generating widget URL (for existing quote)

Production
https://api.vortexfinance.co
Production
https://api.vortexfinance.co
POST
/v1/session/create
You can call this endpoint to get a widget URL ready with a quote you provide. You need to pass the quoteId parameter to the body, and optionally supply the callbackUrl, walletAddressLocked and externalSessionId. The quote will not automatically refresh and if it expires, the user needs to close the window and start over.

Request

Body Params application/json

Examples

Responses

🟢201Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.vortexfinance.co/v1/session/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "quoteId": "my-quote-id",
    "externalSessionId": "my-session-id",
    "callbackUrl": "https://www.example.com/",
    "walletAddressLocked": "0x00000000000000000000000000000000"
}'
Response Response Example
{
    "url": "string"
}
Modified at 2025-10-17 15:25:37
Previous
Generate a widget URL (with quote refresh)
Next
Get ramp status
Built with