Update ramp process

Production

https://api.vortexfinance.co

POST

/v1/ramp/update

Submits presigned transactions and additional data to an existing ramp process before starting it.
This endpoint can be called many times, and data can be incrementally added to the ramp.

Note: For both pre-signed transactions and the generic additionalData object, existing properties will be overriden by new values.

Required data for ramps.

The signed counterpart of the initial unsignedTxs object must be provided for all ramps, as required by the object.
For offramps, the additionalData field must contain the confirmation hash corresponding to the inital transaction in which the user sends the funds.
If the originating chain is Assethub, then assetHubToPendulumHash must be provided.
If the originating chain is any EVM chain, then squidRouterApproveHash and squidRouterSwapHash must be provided.

For onramps, no additional data is required after registering the ramp.

Request

Body Params application/json

Examples

Responses

🟢200OK

application/json

Ramp process successfully started or updated.

Body

🟠400Bad Request

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.vortexfinance.co/v1/ramp/update' \
--header 'Content-Type: application/json' \
--data-raw '{
    "rampId": "proc_12345",
    "presignedTxs": [
        {
            "phase": "RampPhase",
            "nonce": 1,
            "signer": "GB2TP24WCY6BPGFX4SOGDHT7IGJRR7HCDQT2VL2MVCZJTJCGKMVGQGQB",
            "meta": {},
            "txData": "AAAAAKu..."
        }
    ],
    "additionalData": {
        "squidRouterApproveHash": "0x123...",
        "squidRouterSwapHash": "0x456..."
    }
}'

Response Example

200 - Success

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

Modified at 2025-10-16 17:50:04

Start ramp process

Update ramp process

Required data for ramps.#

Request

Responses

Required data for ramps.