Register new ramp process

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 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 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

Get ramp status

Update ramp process