Vortex
    • Overview
    • Quick Start With The SDK
    • Authentication And Partner Keys
    • Ramp Lifecycle
    • Ephemeral Key Custody
    • Quotes And Pricing
    • Webhooks
    • Widget Integration
    • BRL / KYC notes
    • Sandbox
    • Production Checklist
    • AI Agent Integration
    • Quotes
      • Get existing quote
        GET
      • Create a new quote
        POST
      • Create a quote for the best network
        POST
    • Vortex Widget
      • Widget parameters
      • Generating widget URL (for existing quote)
        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
      • Get ramp error logs
        GET
    • Account Management
      • Brazil
        • Brazilian KYC Process Overview
        • Get status of the last ramp event for a user
        • Start KYC level 2 process for a user
      • Europe
        • Coming soon...
      • Get user's remaining transaction limits
        GET
      • Get KYC document upload URLs
        POST
      • Get user information
        GET
      • Create user or retry KYC
        POST
      • Submit KYC level 1 data
        POST
      • Get selfie liveness URL
        GET
      • Get user's KYC status
        GET
      • Validate Pix key
        GET
    • Webhooks
      • Register Webhook
      • Delete Webhook
    • Public Key
      • Overview
      • Public Key
    • Reference Data
      • Supported Payment Methods
      • Supported Cryptocurrencies
      • Supported Countries
      • Supported Fiat Currencies
    • Schemas
      • Schemas
      • StartKYC2Response
      • GetKycStatusResponse
      • ValidatePixKeyResponse
      • GetUserRemainingLimitResponse
      • TriggerOfframpRequest
      • TriggerOfframpResponse
      • BrlaAddress
      • TaxIdType
      • CreateSubaccountRequest
      • CreateSubaccountResponse
      • KYCDocType
      • KYCDataUploadFileFiles
      • StartKYC2Request
      • GetUserResponse
      • StartRampRequest
      • RampDirection
      • GetWidgetUrlLocked
      • CountryCode
      • PaymentMethod
      • SimpleStatus
      • FiatToken
      • OnChainToken
      • GetWidgetUrlRefresh
      • CreateBestQuoteRequest
      • GetRampHistoryTransaction
      • GetRampHistoryResponse
      • BrlaErrorResponse
      • RegisterRampRequest
      • AccountMeta
      • Networks
      • PaymentData
      • RampProcess
      • RampPhase
      • DestinationType
      • UnsignedTx
      • CleanupPhase
      • CreateQuoteRequest
      • QuoteResponse
      • RampCurrency
      • UpdateRampRequest
      • PresignedTx
      • ErrorResponse
      • RampErrorLog
      • GetRampErrorLogsResponse
      • BrlaValidatePixKeyResponse
      • BrlaGetSelfieLivenessUrlResponse
      • AveniaDocumentType
      • AveniaKYCDataUploadRequest
      • DocumentUploadEntry
      • AveniaKYCDataUploadResponse
      • KycLevel1Payload
      • KycLevel1Response

    Overview

    Vortex is a cross-border payments gateway that moves value between fiat currencies and crypto assets. It coordinates quoting, cross-chain swaps via XCM, anchor settlement, and payout across networks such as Base, Polygon, Ethereum, Arbitrum, BSC, Avalanche, Pendulum, Stellar, Moonbeam, AssetHub, and Hydration.
    These docs are written for partner developers integrating Vortex into a backend, wallet, checkout flow, or operations dashboard. The endpoint reference documents the raw API surface; the guide pages explain the recommended integration sequence and the responsibilities that sit on the API client side.

    Supported Corridors#

    The current SDK release is centered on BRL/PIX for both buy (onramp) and sell (offramp) flows. EUR onramp endpoints exist on the API surface but the SDK throws "Euro onramp handler not implemented yet"; SEPA buy flows are not production-ready today. Other fiat currencies are exposed through reference data endpoints and are added incrementally.
    For crypto, Vortex supports USDC and USDT across the listed EVM networks plus USDC on AssetHub. Stablecoin pegs and routes are subject to liquidity on the Nabla AMM and the wider Pendulum/Hydration corridor.

    How A Ramp Flows#

    Every Vortex ramp follows the same shape:
    1.
    Quote — your application requests pricing for a route.
    2.
    Register — your application creates per-chain ephemeral accounts and submits their public addresses with the quote ID. Vortex returns one or more unsigned transactions that move funds through the ramp.
    3.
    Sign and update — your application signs each unsigned transaction with the correct key (ephemeral key for SDK-controlled accounts, user wallet for the user's funds) and submits the signed payloads back to Vortex.
    4.
    Settle fiat — for BRL buys, the user pays a PIX QR; for BRL sells, Vortex pays out to the user's PIX key after settlement.
    5.
    Start — your application calls start once signatures and fiat payment are in place.
    6.
    Track — Vortex drives the on-chain phase machine. Your application listens via webhooks or polls the ramp status endpoint.
    The SDK wraps steps 2, 3, and parts of 5 for supported flows. Direct API integrations must implement them explicitly.

    Recommended Integration Paths#

    Stack / use caseRecommended path
    Trusted Node.js backend@vortexfi/sdk
    Python backendvortex-sdk-python (process-bridge wrapper around the Node SDK)
    Browser / mobile / hosted checkoutVortex Widget
    Any other language or runtimeDirect API integration following the SDK's behavior
    The SDK is intended for trusted server-side Node.js only. Browser support is not enabled. For browser-driven UX, embed the Widget instead of calling the API directly from the browser.

    Custody Model#

    Vortex does not custody user private keys. During a ramp, short-lived blockchain accounts called ephemeral accounts hold funds in transit. Vortex receives their public addresses; their secret keys never leave the SDK or your API client.
    This boundary is non-negotiable: if ephemeral secrets are lost while a ramp is in flight, recovery may be impossible for that ramp. See 5. Ephemeral Key Custody.

    Next Steps#

    New integrators: 2. Quick Start With The SDK.
    Building for a non-Node stack: 12. AI Agent Integration.
    Hosted checkout: 8. Widget Integration.

    Terms#

    By integrating with or using the Vortex API, SDK, or Widget, you agree to the Vortex Terms and Conditions and Privacy Policy.
    Modified at 2026-05-18 18:18:02
    Next
    Quick Start With The SDK
    Built with