Start ramp process

Production

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

Body Params application/json

Examples

Responses

🟢200

application/json

Ramp process successfully started or updated.

Bodyapplication/json

🟠400

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/ramp/start' \
--header 'Content-Type: application/json' \
--data '{
    "rampId": "proc_12345"
}'

Response Example

200 - Success

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

Modified at 2026-05-19 08:43:06

Update ramp process