Vortex
  1. Ramp
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. Ramp

Register new ramp process

Production
https://api.vortexfinance.co
Production
https://api.vortexfinance.co
POST
/v1/ramp/register
Initiates a new on-ramp or off-ramp process by providing quote details, signing accounts, and additional data.

Request

Body Params application/json

Examples

Responses

🟢201Created
application/json
Ramp process successfully registered.
Body

🟠400Bad Request
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.vortexfinance.co/v1/ramp/register' \
--header 'Content-Type: application/json' \
--data-raw '{
    "quoteId": "8e4bca04-aa22-4f86-9ce5-80aaef58ef83",
    "signingAccounts": [
        {
            "network": "moonbeam",
            "address": "0x7b79995e5f793a07bc00c21412e50ecae098e7f9"
        },
        {
            "network": "pendulum",
            "address": "6ftBYTotU4mmCuvUqJvk6qEP7uCzzz771pTMoxcbHFb9rcPv"
        }
    ],
    "additionalData": {
        "taxId": "711.711.011-11",
        "receiverTaxId": "0x7b79995e5f793a07bc00c21412e50ecae098e7f9",
        "pixDestination": "711.711.011-11"
    }
}'
Response Response Example
201 - Success
{
    "id": "proc_12345",
    "quoteId": "41a756dc-04e4-4e4b-b243-9c8f977c24d6",
    "type": "off",
    "currentPhase": "pending_signature",
    "from": "stellar",
    "to": "pix",
    "createdAt": "2024-05-16T10:00:00Z",
    "updatedAt": "2024-05-16T10:00:00Z",
    "unsignedTxs": [
        {
            "type": "stellar_payment",
            "data": "AAAA..."
        }
    ],
    "brCode": "00020126..."
}
Modified at 2025-10-16 17:25:49
Previous
Get ramp status
Next
Update ramp process
Built with