Start ramp process

POST

/v1/ramp/start

Starts a ramp process.

It is assumed all required information from the client has already been sent using the update endpoint. This endpoint is only used to tell the backend any external operation (like a bank transfer) has been completed, and the ramp can start.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.vortexfinance.co/v1/ramp/start' \
--header 'Content-Type: application/json' \
--data-raw '{
    "rampId": "proc_12345"
}'

Response Example

200 - Success

{
    "id": "proc_12345",
    "quoteId": "quote_7af7171e-aa42-49a2-80c2-9e18483bad38",
    "type": "sell",
    "currentPhase": "processing",
    "from": "stellar",
    "to": "pix",
    "createdAt": "2024-05-16T10:00:00Z",
    "updatedAt": "2024-05-16T12:30:00Z",
    "unsignedTxs": [],
    "depositQrCode": "00020126..."
}

Request

Body Params application/json

Examples

Responses

🟢200OK

application/json

Ramp process successfully started or updated.

Body

🟠400Bad Request

🔴500Server Error

Modified at 2025-07-11 20:46:01

Update ramp process

Brazilian KYC Process Overview