Vortex
Brazil
Copy Page
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
Get user information
GET
Get status of the last ramp event for a user
GET
Create user or retry KYC
POST
Get user's KYC status
GET
Start KYC level 2 process for a user
POST
Europe
Coming soon...
Webhooks
Overview
Register Webhook
POST
Delete Webhook
DELETE
Public Key
Overview
Public Key
Supported Payment Methods
GET
Supported Cryptocurrencies
GET
Supported Countries
GET
Supported Fiat Currencies
GET
Brazil
Copy Page
Get status of the last ramp event for a user
Production
https://api.vortexfinance.co
Production
https://api.vortexfinance.co
GET
/v1/brla/getOfframpStatus
Try it
Run in Apidog
Run in Apidog
Request
Query Params
Generate Code
Responses
🟢
200
OK
application/json
Successfully retrieved offramp status.
Body
Generate Code
ðŸŸ
400
Bad Request
ðŸŸ
404
Record Not Found
🔴
500
Server Error
Request
Request Example
Shell
JavaScript
Java
Swift
cURL
cURL-Windows
Httpie
wget
PowerShell
curl
--location
--request
GET
'https://api.vortexfinance.co/v1/brla/getOfframpStatus?taxId'
Response
Response Example
200 -
Example 1
Modified atÂ
2025-06-06 09:44:32
Previous
Get user information
Next
Create user or retry KYC