Orders API V2

POST

orders/public/set-email

Endpoint URL

https://quickex.io/api/v2/orders/public/set-email

Documentation

Nome	Obrigatório	Descrição
`X-Api-Public-Key`	sim	Sua chave pública da API para autenticação da requisição.
`X-Api-Timestamp`	sim	Timestamp no formato UNIX (ms). Usado para evitar ataques de repetição (replay attacks).
`X-Api-Signature`	sim	Assinatura HMAC de todo o corpo da requisição, gerada com sua chave secreta.

Campo	Tipo	Obrigatório	Descrição
`orderId`	number	sim	O identificador do pedido existente.
`userEmail`	string	sim	O endereço de e-mail para notificações.

Code Sample

Response Example

[
  {
    "orderId": 2096,
    "destinationAddress": "rMZiLhMHDKHSD9mMurzvixQGKFsDNLLP1",
    "createdAt": "2024-11-21T09:57:37.536Z",
    "updatedAt": "2024-11-21T09:57:37.536Z",
    "destinationAddressMemo": null,
    "refundAddress": null,
    "refundAddressMemo": null,
    "claimedDepositAmount": "11905.4",
    "claimedNetworkFee": "0.25",
    "amountToGet": "2000.535980286546",
    "amountToGetUSDT": "0",
    "amountToWithdrawFact": "0",
    "amountToWithdrawFactUSDT": "0",
    "instrumentFromCurrencyTitle": "TRX",
    "instrumentFromNetworkTitle": "TRX",
    "instrumentToCurrencyTitle": "XRP",
    "instrumentToNetworkTitle": "XRP",
    "ip": "165.22.73.162",
    "geoCode": "DE",
    "markup": "0",
    "userEmail": "qa@support.quickex.io",
    "completed": false,
    "state": "created"
  },
  {
    "orderId": 2097,
    "destinationAddress": "rMZiLhMHDKHSD9mMurzvixQGKFsDNLLP1",
    "createdAt": "2024-11-21T09:57:56.849Z",
    "updatedAt": "2024-11-21T09:57:56.849Z",
    "destinationAddressMemo": null,
    "refundAddress": null,
    "refundAddressMemo": null,
    "claimedDepositAmount": "500",
    "claimedNetworkFee": "0.25",
    "amountToGet": "88.201060256891",
    "amountToGetUSDT": "0",
    "amountToWithdrawFact": "0",
    "amountToWithdrawFactUSDT": "0",
    "instrumentFromCurrencyTitle": "TRX",
    "instrumentFromNetworkTitle": "TRX",
    "instrumentToCurrencyTitle": "XRP",
    "instrumentToNetworkTitle": "XRP",
    "ip": "165.22.73.162",
    "geoCode": "DE",
    "markup": "0",
    "userEmail": "qa@support.quickex.io",
    "completed": false,
    "state": "created"
  },
  {
    "orderId": 3038,
    "destinationAddress": "TFjfHBiDcL6B5S5W8g9b6gU2tbvnTR52ya",
    "createdAt": "2025-04-28T13:15:03.006Z",
    "updatedAt": "2025-07-22T10:36:58.557Z",
    "destinationAddressMemo": null,
    "refundAddress": null,
    "refundAddressMemo": null,
    "claimedDepositAmount": "0.034268",
    "claimedNetworkFee": "1.5",
    "amountToGet": "3263.05",
    "amountToGetUSDT": "3263.058154",
    "amountToWithdrawFact": "0",
    "amountToWithdrawFactUSDT": "0",
    "instrumentFromCurrencyTitle": "BTC",
    "instrumentFromNetworkTitle": "BTC",
    "instrumentToCurrencyTitle": "USDT",
    "instrumentToNetworkTitle": "TRC20",
    "ip": "45.76.90.73",
    "geoCode": "DE",
    "markup": "0",
    "userEmail": "qa@support.quickex.io",
    "completed": false,
    "state": "created"
  },
  {
    "orderId": 3172,
    "destinationAddress": "TPjT9p6UK5omA19h1QuYf4HbWvB9CukMzx",
    "createdAt": "2025-11-25T07:52:52.871Z",
    "updatedAt": "2025-11-27T11:34:19.690Z",
    "destinationAddressMemo": null,
    "refundAddress": null,
    "refundAddressMemo": null,
    "claimedDepositAmount": "52",
    "claimedNetworkFee": "2.054188275293",
    "amountToGet": "419.2",
    "amountToGetUSDT": "114.402051690569",
    "amountToWithdrawFact": "417.825363",
    "amountToWithdrawFactUSDT": "114.0245415627",
    "instrumentFromCurrencyTitle": "XRP",
    "instrumentFromNetworkTitle": "XRP",
    "instrumentToCurrencyTitle": "TRX",
    "instrumentToNetworkTitle": "TRX",
    "ip": "77.246.100.22",
    "geoCode": "NL",
    "markup": "0",
    "userEmail": "qa@support.quickex.io",
    "completed": true,
    "state": "withdraw"
  },
  {
    "orderId": 3192,
    "destinationAddress": "15vvDFQFksUS4r1cYxmjZuTVVUzWZSJauuUapg7Xjhgtkwqy",
    "createdAt": "2025-12-02T14:11:15.985Z",
    "updatedAt": "2025-12-02T14:11:16.107Z",
    "destinationAddressMemo": null,
    "refundAddress": "UQCGxjLy3msAFWG4r310Sk_rOz27QWRy252fdLMWJAMQJvSE",
    "refundAddressMemo": null,
    "claimedDepositAmount": "3300",
    "claimedNetworkFee": "0.14",
    "amountToGet": "2363.663",
    "amountToGetUSDT": "4999.384629917638",
    "amountToWithdrawFact": "0",
    "amountToWithdrawFactUSDT": "0",
    "instrumentFromCurrencyTitle": "TON",
    "instrumentFromNetworkTitle": "TON",
    "instrumentToCurrencyTitle": "DOT",
    "instrumentToNetworkTitle": "DOT",
    "ip": "77.246.100.22",
    "geoCode": "NL",
    "markup": "0",
    "userEmail": null,
    "completed": false,
    "state": "created"
  },
  {
    "orderId": 3193,
    "destinationAddress": "15vvDFQFksUS4r1cYxmjZuTVVUzWZSJauuUapg7Xjhgtkwqy",
    "createdAt": "2025-12-02T14:14:34.356Z",
    "updatedAt": "2025-12-02T14:14:34.557Z",
    "destinationAddressMemo": null,
    "refundAddress": "UQCGxjLy3msAFWG4r310Sk_rOz27QWRy252fdLMWJAMQJvSE",
    "refundAddressMemo": null,
    "claimedDepositAmount": "73",
    "claimedNetworkFee": "0.14",
    "amountToGet": "52.235",
    "amountToGetUSDT": "110.556162356583",
    "amountToWithdrawFact": "0",
    "amountToWithdrawFactUSDT": "0",
    "instrumentFromCurrencyTitle": "TON",
    "instrumentFromNetworkTitle": "TON",
    "instrumentToCurrencyTitle": "DOT",
    "instrumentToNetworkTitle": "DOT",
    "ip": "77.246.100.22",
    "geoCode": "NL",
    "markup": "0",
    "userEmail": null,
    "completed": false,
    "state": "created"
  }
]

Try it out

POST

orders/public/create

Endpoint URL

https://quickex.io/api/v2/orders/public/create

Documentation

Descrição geral
Este endpoint é utilizado para criar uma nova ordem de troca de criptomoedas. Ele retorna informações completas da ordem: endereços de depósito e saque, parâmetros de taxa, eventos e URLs para processamento adicional.

Parâmetros

Headers

Nome	Obrigatório	Descrição
`X-Api-Public-Key`	sim	Sua chave pública da API.
`X-Api-Timestamp`	sim	Timestamp no formato UNIX (ms).
`X-Api-Signature`	sim	Assinatura HMAC do corpo da requisição, gerada com sua chave secreta.

Corpo da requisição (JSON)

Campo	Tipo	Obrigatório	Descrição
`instrumentFrom`	object	sim	Moeda e rede de origem (`currencyTitle` / `networkTitle`).
`instrumentTo`	object	sim	Moeda e rede de destino.
`destinationAddress`	string	sim	Endereço para receber os fundos trocados.
`destinationAddressMemo`	string	não	Memo/tag opcional para o endereço de destino.
`refundAddress`	string	sim	Endereço para reembolso caso a troca falhe.
`refundAddressMemo`	string	não	Memo/tag para o endereço de reembolso.
`claimedDepositAmount`	string	sim	Valor que o usuário pretende depositar.
`claimedPublicRate`	object	não	Informações da taxa declarada: preço, hora da atualização e valor esperado a receber.
`claimedNetworkFee`	string	não	Taxa de rede declarada.
`userEmail`	string	não	E-mail para notificações.
`legacyOrderId`	string	não	ID externo do pedido da plataforma antiga.
`referrerId`	string	não	ID de referência para o programa de afiliados.
`markupAffiliateId`	string	não	ID do afiliado para distribuição de markup.
`rateMode`	string	não	Tipo de taxa: `FLOATING` ou `FIXED`.
`utmData`	object	não	Parâmetros UTM para análise.
`browserFingerprint`	string	não	Impressão digital do navegador para proteção antifraude.
`markup`	string	não	Percentual de markup.
`mercuryoBearerToken`	string	não	Token Mercuryo para integração opcional.
`locale`	string	não	Idioma da resposta (por exemplo, `en`, `ru`).

Exemplo de requisição

curl -X POST 'https://quickex.io/api/v2/orders/public/create' \ -H 'accept: application/json' \ -H 'X-Api-Public-Key: yourPublicKey' \ -H 'X-Api-Timestamp: 1691397873000' \ -H 'X-Api-Signature: yourHmacSignature' \ -H 'Content-Type: application/json' \ -d '{ "instrumentFrom": { "currencyTitle": "USDT", "networkTitle": "TRC20" }, "instrumentTo": { "currencyTitle": "LTC", "networkTitle": "LTC" }, "destinationAddress": "MWYK4uQXFvWc1Bj1CPACyX5HTQxUUpRZ2e", "refundAddress": "TFe5tdqSy8CMGMDVHPJHLTK8hrAL6ddUpD", "claimedDepositAmount": "3300", "claimedPublicRate": { "price": "0.014271620139287839394", "updatedAt": "2024-02-13T14:43:12.983Z", "claimedAmountToReceive": "47.09634645964987" }, "claimedNetworkFee": "0.001", "userEmail": "test@example.com", "referrerId": "aff_some-affiliate-id", "markupAffiliateId": "aff_some-affiliate-id", "rateMode": "FLOATING", "markup": "0.01", "mercuryoBearerToken": "string", "locale": "ru" }'

Possíveis respostas

200 OK — ordem criada com sucesso; objeto completo da ordem é retornado.
401 ERR_UNAUTHORIZED — tokens/chaves ausentes ou inválidos:

{ "status": "ERR_UNAUTHORIZED", "message": "Unauthorized" }

Caso de uso

Uma plataforma parceira deseja criar ordens automaticamente quando um usuário paga via Mercuryo.
Após a autenticação, o Mercuryo fornece um B2B-Bearer-Token, e então a plataforma monta os dados da troca e chama este endpoint para criar a ordem no Quickex.

Code Sample

Response Example

{
  "deposits": [
    {
      "createdAt": "2025-12-02T08:52:08.178Z",
      "instrument": {
        "currencyTitle": "USDT",
        "networkTitle": "TRC20"
      },
      "amount": "1000.1",
      "confirmations": 0,
      "txId": "0xdeadc0dedeadbeef",
      "depositAddress": "0xdeadc0de",
      "isPending": true,
      "id": 0,
      "counterPartyAddress": "0xdeadc0dedeadbeef"
    }
  ],
  "withdrawals": [
    {
      "createdAt": "2025-12-02T08:52:08.178Z",
      "instrument": {
        "currencyTitle": "USDT",
        "networkTitle": "TRC20"
      },
      "amount": "1000.1",
      "networkFee": "1.1",
      "txId": "0xdeadc0dedeadbeef"
    }
  ],
  "depositAddress": {
    "orderId": 0,
    "liquidityProviderTitle": "QUICKEX_BUSINESS_ACCOUNT",
    "instrument": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20"
    },
    "depositAddress": "0xdeadc0de",
    "depositAddressMemo": "string",
    "redirectUrl": "string"
  },
  "orderId": 0,
  "userId": 0,
  "legacyOrderId": "string",
  "pair": {
    "instrumentFrom": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20"
    },
    "instrumentTo": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20"
    }
  },
  "createdAt": "2025-12-02T08:52:08.179Z",
  "claimedDepositAmount": "10.01",
  "amountToGet": "10.01",
  "claimedPublicRate": {
    "price": "1000.1",
    "quotes": {
      "sellQuote": {
        "baseValue": "1000.1",
        "quoteValue": "1000.1"
      },
      "buyQuote": {
        "baseValue": "1000.1",
        "quoteValue": "1000.1"
      }
    },
    "updatedAt": "2025-12-02T08:52:08.179Z",
    "liquidityProviderPublicCode": "formulae",
    "claimedAmountToReceive": "0.01",
    "finalNetworkFeeAmount": "0.01",
    "platformFee_Absolute": "0.01",
    "fixedRate_maxAmount": "1000.000",
    "fixedRate_maxTimeMinutes": 1,
    "fixedRate_maxRateVolatilityPercent": "1000.000"
  },
  "claimedNetworkFee": "10.01",
  "KYCFormLink": "string",
  "orderEvents": [
    {
      "kind": "TRACKING_STARTED",
      "createdAt": "2025-12-02T08:52:08.179Z"
    }
  ],
  "userEmail": "test@example.com",
  "rateMode": "FLOATING",
  "destinationAddress": "0xdeadbeef",
  "destinationAddressMemo": "0xdeadbeef",
  "completed": false,
  "possibleCashbackAmountUSDT": "500.00",
  "redirectUrl": "https://payments.mercuryo.io/",
  "minConfirmationsToTrade": 3,
  "minConfirmationsToWithdraw": 3
}

Try it out

POST

orders/public/set-email

Endpoint URL

https://quickex.io/api/v2/orders/public/set-email

Documentation

Visão geral

Este método permite definir um e-mail para um pedido público já criado.

Ele é usado quando o pedido foi criado sem o campo userEmail na requisição /api/v2/orders/public/create, mas posteriormente é necessário anexar um e-mail (por exemplo, para que o usuário possa receber notificações sobre o status do pedido).

> Importante: o e-mail pode ser definido apenas uma vez. Se o pedido já tiver um userEmail, ele não poderá ser alterado por este método.

HTTP Request

Método: POST
URL: https://quickex.io/api/v2/orders/public/set-email

Exemplo de requisição

curl -X 'POST' \ 'https://quickex.io/api/v2/orders/public/set-email' \ -H 'accept: application/json' \ -H 'X-Api-Public-Key: {YOUR_PUBLIC_KEY}' \ -H 'X-Api-Timestamp: {UNIX_MS_TIMESTAMP}' \ -H 'X-Api-Signature: {SIGNATURE}' \ -H 'Content-Type: application/json' \ -d '{ "orderId": 3038, "userEmail": "QA@quickex.com" }'

Headers

Header	Required	Description
`Accept`	sim	Valor recomendado: `application/json`.
`Content-Type`	sim	`application/json`.
`X-Api-Public-Key`	sim	Sua chave pública da API.
`X-Api-Timestamp`	sim	Timestamp (normalmente UNIX em ms), incluído na assinatura.
`X-Api-Signature`	sim	Assinatura da requisição (HMAC SHA256 de acordo com o esquema da API v2).

Parâmetros da requisição

Parâmetros do corpo (Body)

{ "orderId": 3038, "userEmail": "QA@quickex.com" }

Field	Type	Required	Description
`orderId`	number	sim	ID do pedido para o qual você deseja definir o e-mail.
`userEmail`	string	sim	E-mail do usuário que será vinculado ao pedido e usado para notificações.

Restrições: se userEmail já estiver definido para este pedido, o método retornará o erro 403 ERR_FORBIDDEN.

Formato da resposta

Se a requisição for bem-sucedida, o método retorna um objeto JSON do pedido, semelhante à resposta de POST /api/v2/orders/public/create / GET /api/v2/orders/info, mas com o campo userEmail preenchido.

Exemplo de resposta

{ "deposits": [ { "createdAt": "2025-12-02T09:31:46.246Z", "instrument": { "currencyTitle": "USDT", "networkTitle": "TRC20" }, "amount": "1000.1", "confirmations": 0, "txId": "0xdeadc0dedeadbeef", "depositAddress": "0xdeadc0de", "isPending": true, "id": 0, "counterPartyAddress": "0xdeadc0dedeadbeef" } ], "withdrawals": [ { "createdAt": "2025-12-02T09:31:46.246Z", "instrument": { "currencyTitle": "USDT", "networkTitle": "TRC20" }, "amount": "1000.1", "networkFee": "1.1", "txId": "0xdeadc0dedeadbeef" } ], "depositAddress": { "orderId": 0, "liquidityProviderTitle": "QUICKEX_BUSINESS_ACCOUNT", "instrument": { "currencyTitle": "USDT", "networkTitle": "TRC20" }, "depositAddress": "0xdeadc0de", "depositAddressMemo": "string", "redirectUrl": "string" }, "orderId": 0, "userId": 0, "legacyOrderId": "string", "pair": { "instrumentFrom": { "currencyTitle": "USDT", "networkTitle": "TRC20" }, "instrumentTo": { "currencyTitle": "USDT", "networkTitle": "TRC20" } }, "createdAt": "2025-12-02T09:31:46.246Z", "claimedDepositAmount": "10.01", "amountToGet": "10.01", "claimedPublicRate": { "price": "1000.1", "quotes": { "sellQuote": { "baseValue": "1000.1", "quoteValue": "1000.1" }, "buyQuote": { "baseValue": "1000.1", "quoteValue": "1000.1" } }, "updatedAt": "2025-12-02T09:31:46.246Z", "liquidityProviderPublicCode": "formulae", "claimedAmountToReceive": "0.01", "finalNetworkFeeAmount": "0.01", "platformFee_Absolute": "0.01", "fixedRate_maxAmount": "1000.000", "fixedRate_maxTimeMinutes": 1, "fixedRate_maxRateVolatilityPercent": "1000.000" }, "claimedNetworkFee": "10.01", "KYCFormLink": "string", "orderEvents": [ { "kind": "TRACKING_STARTED", "createdAt": "2025-12-02T09:31:46.246Z" } ], "userEmail": "QA@example.com", "rateMode": "FLOATING", "destinationAddress": "0xdeadbeef", "destinationAddressMemo": "0xdeadbeef", "completed": false, "possibleCashbackAmountUSDT": "500.00", "redirectUrl": "https://payments.mercuryo.io/", "minConfirmationsToTrade": 3, "minConfirmationsToWithdraw": 3 }

Ponto principal: o campo userEmail associado ao pedido estará preenchido na resposta.

Erros

403 ERR_FORBIDDEN — E-mail já definido

{ "status": "ERR_FORBIDDEN", "message": "Order.userEmail already set and can not be modified" }

Este erro é retornado se você tentar alterar o e-mail de um pedido em que o campo userEmail já foi definido (seja durante a criação do pedido ou em uma chamada anterior de set-email).

O que fazer:

O e-mail não pode ser alterado para pedidos que já possuem um e-mail definido.

Possíveis casos de uso

Adicionar um e-mail a pedidos criados de forma anônima (por exemplo, através de um widget em que o campo de e-mail não é obrigatório).

Code Sample

Response Example

{
  "deposits": [
    {
      "createdAt": "2025-12-02T09:31:46.246Z",
      "instrument": {
        "currencyTitle": "USDT",
        "networkTitle": "TRC20"
      },
      "amount": "1000.1",
      "confirmations": 0,
      "txId": "0xdeadc0dedeadbeef",
      "depositAddress": "0xdeadc0de",
      "isPending": true,
      "id": 0,
      "counterPartyAddress": "0xdeadc0dedeadbeef"
    }
  ],
  "withdrawals": [
    {
      "createdAt": "2025-12-02T09:31:46.246Z",
      "instrument": {
        "currencyTitle": "USDT",
        "networkTitle": "TRC20"
      },
      "amount": "1000.1",
      "networkFee": "1.1",
      "txId": "0xdeadc0dedeadbeef"
    }
  ],
  "depositAddress": {
    "orderId": 0,
    "liquidityProviderTitle": "QUICKEX_BUSINESS_ACCOUNT",
    "instrument": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20"
    },
    "depositAddress": "0xdeadc0de",
    "depositAddressMemo": "string",
    "redirectUrl": "string"
  },
  "orderId": 0,
  "userId": 0,
  "legacyOrderId": "string",
  "pair": {
    "instrumentFrom": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20"
    },
    "instrumentTo": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20"
    }
  },
  "createdAt": "2025-12-02T09:31:46.246Z",
  "claimedDepositAmount": "10.01",
  "amountToGet": "10.01",
  "claimedPublicRate": {
    "price": "1000.1",
    "quotes": {
      "sellQuote": {
        "baseValue": "1000.1",
        "quoteValue": "1000.1"
      },
      "buyQuote": {
        "baseValue": "1000.1",
        "quoteValue": "1000.1"
      }
    },
    "updatedAt": "2025-12-02T09:31:46.246Z",
    "liquidityProviderPublicCode": "formulae",
    "claimedAmountToReceive": "0.01",
    "finalNetworkFeeAmount": "0.01",
    "platformFee_Absolute": "0.01",
    "fixedRate_maxAmount": "1000.000",
    "fixedRate_maxTimeMinutes": 1,
    "fixedRate_maxRateVolatilityPercent": "1000.000"
  },
  "claimedNetworkFee": "10.01",
  "KYCFormLink": "string",
  "orderEvents": [
    {
      "kind": "TRACKING_STARTED",
      "createdAt": "2025-12-02T09:31:46.246Z"
    }
  ],
  "userEmail": "QA@example.com",
  "rateMode": "FLOATING",
  "destinationAddress": "0xdeadbeef",
  "destinationAddressMemo": "0xdeadbeef",
  "completed": false,
  "possibleCashbackAmountUSDT": "500.00",
  "redirectUrl": "https://payments.mercuryo.io/",
  "minConfirmationsToTrade": 3,
  "minConfirmationsToWithdraw": 3
}

Try it out

GET

orders/public-info

Endpoint URL

https://quickex.io/api/v2/orders/public-info

Documentation

Descrição geral

Este método retorna informações detalhadas sobre um pedido específico pelo seu orderId.
Ao contrário da lista de pedidos (GET /api/v2/orders), ele fornece todos os dados relacionados ao pedido selecionado:
o par completo de instrumentos com parâmetros, a taxa fixa (claimedPublicRate),
limites de confirmação, o histórico de eventos (orderEvents), o endereço de depósito,
bem como informações sobre possível cashback ou créditos de referência e o status de conclusão.
O acesso aos pedidos é restrito pela chave de API atual — você só pode visualizar pedidos que foram criados
usando sua X-Api-Public-Key.

Requisição HTTP

Método: GET
URL: https://quickex.io/api/v2/orders/public-info

Exemplo de requisição

curl -X 'GET' \
  'https://quickex.io/api/v2/orders/public-info?orderId=3038' \
  -H 'accept: application/json' \
  -H 'X-Api-Public-Key: {YOUR_PUBLIC_KEY}' \
  -H 'X-Api-Timestamp: {UNIX_MS_TIMESTAMP}' \
  -H 'X-Api-Signature: {SIGNATURE}'

Cabeçalhos

Cabeçalho	Obrigatório	Descrição
Accept	sim	Valor recomendado: `application/json`.
X-Api-Public-Key	sim	Sua chave pública de API.
X-Api-Timestamp	sim	Timestamp (geralmente UNIX em ms), incluído na assinatura.
X-Api-Signature	sim	Assinatura da requisição (HMAC SHA256 conforme o esquema da API v2).

Parâmetros da requisição

Parâmetros de query

Parâmetro	Tipo	Obrigatório	Descrição
orderId	int	sim	Identificador do pedido para o qual a informação é solicitada.

Formato da resposta

O método retorna um objeto JSON com informações completas sobre o pedido.

Exemplo de resposta

{
  "orderId": 174059,
  "legacyOrderId": "602184da-5881-408e-bffa-3562702d7d3e",
  "pair": {
    "instrumentFrom": {
      "currencyTitle": "XRP",
      "networkTitle": "XRP",
      "precisionDecimals": 2,
      "slug": "xrp",
      "liquidityProviderCurrencies": [
        {
          "minConfirmationsToTrade": 12,
          "minConfirmationsToWithdraw": 12
        }
      ]
    },
    "instrumentTo": {
      "currencyTitle": "TRX",
      "networkTitle": "TRX",
      "precisionDecimals": 2,
      "slug": "trx",
      "liquidityProviderCurrencies": [
        {
          "minConfirmationsToTrade": 3,
          "minConfirmationsToWithdraw": 3
        }
      ]
    }
  },
  "createdAt": "2025-12-15T14:38:40.523Z",
  "instrumentFromCurrencyTitle": "XRP",
  "instrumentFromNetworkTitle": "XRP",
  "instrumentToCurrencyTitle": "TRX",
  "instrumentToNetworkTitle": "TRX",
  "feeMode": "FIXED",
  "userId": 2382,
  "userEmail": "sam.white@support.example.io",
  "isPlatformEmail": false,
  "refundAddress": "rNFSruW9B1NwVoGgUMmfwXbruWMp8Mgv3K",
  "refundAddressMemo": null,
  "destinationAddress": "TWRW8YiZtjW7JkYxxzuPrN9fQzoDK5FHgm",
  "destinationAddressMemo": null,
  "claimedNetworkFee": "1.987665024814",
  "rateMode": "FIXED",
  "claimedDepositAmount": "57",
  "amountToGet": "393.07",
  "platformFee": "3.86",
  "redirectUrl": null,
  "orderEvents": [
    {
      "createdAt": "2025-12-15T14:42:43.317Z",
      "kind": "WITHDRAWAL_COMPLETED"
    },
    {
      "createdAt": "2025-12-15T14:41:54.109Z",
      "kind": "FUNDS_WITHDRAWAL_START"
    },
    {
      "createdAt": "2025-12-15T14:41:00.379Z",
      "kind": "DEPOSIT_REGISTERED"
    },
    {
      "createdAt": "2025-12-15T14:39:58.760Z",
      "kind": "INCOMING_FUNDS_DETECTED"
    },
    {
      "createdAt": "2025-12-15T14:38:41.642Z",
      "kind": "CREATION_END"
    }
  ],
  "depositAddress": {
    "instrument": {
      "currencyTitle": "XRP",
      "networkTitle": "XRP"
    },
    "depositAddress": "rwXnv8BfEHi7WmkLXZ6ChcWX9hMnSsTMNK",
    "depositAddressMemo": "2097040307"
  },
  "deposits": [
    {
      "id": 50958,
      "counterPartyAddress": null,
      "createdAt": "2025-12-15T14:39:45.000Z",
      "instrument": {
        "currencyTitle": "XRP",
        "networkTitle": "XRP"
      },
      "amount": "57",
      "amountUSDT": "112.40742",
      "txId": "DEA15CCF7AF04799A090298CB06D78DD177B3B518BED9C9DE8A0A5B717CCDBE7",
      "confirmations": 12,
      "depositAddress": {
        "instrument": {
          "currencyTitle": "XRP",
          "networkTitle": "XRP"
        },
        "depositAddress": "rwXnv8BfEHi7WmkLXZ6ChcWX9hMnSsTMNK",
        "depositAddressMemo": "2097040307"
      },
      "isPending": false
    }
  ],
  "withdrawals": [
    {
      "instrument": {
        "currencyTitle": "TRX",
        "networkTitle": "TRC20"
      },
      "amount": "393.07",
      "txId": "39dc5802a931da0613f687087397e812dd6c0aa0b9041124d76e864e37bd1e09",
      "createdAt": "2025-12-15T14:41:58.926Z",
      "networkFee": "1.98"
    }
  ],
  "KYCFormLink": null,
  "liquidityProviderPublicCode": "hat",
  "possibleRefferalAccrualAmount": "0.78",
  "possibleCashbackAmountUSDT": "0.22",
  "actualCashbackAmountUSDT": "0.22",
  "claimedPublicRate": {
    "claimedAmountToReceive": "393.07",
    "finalNetworkFeeAmount": "1.9876650248138958",
    "platformFee_Absolute": null,
    "price": "7.000992555831266",
    "quotes": {
      "sellQuote": {
        "baseValue": "0.2821",
        "quoteValue": "1.9453930016929823"
      },
      "buyQuote": {
        "baseValue": "1.97499",
        "quoteValue": "0.2777753832835882"
      }
    },
    "updatedAt": "2025-12-15T14:38:36.201Z",
    "instrumentFrom": {
      "currencyTitle": "XRP",
      "networkTitle": "XRP",
      "precisionDecimals": 2,
      "slug": "xrp",
      "liquidityProviderCurrencies": [
        {
          "minConfirmationsToTrade": 12,
          "minConfirmationsToWithdraw": 12
        }
      ]
    },
    "instrumentTo": {
      "currencyTitle": "TRX",
      "networkTitle": "TRX",
      "precisionDecimals": 2,
      "slug": "trx",
      "liquidityProviderCurrencies": [
        {
          "minConfirmationsToTrade": 3,
          "minConfirmationsToWithdraw": 3
        }
      ]
    }
  },
  "completed": true,
  "minConfirmationsToTrade": 12,
  "minConfirmationsToWithdraw": 12
}

Detalhamento dos campos da resposta

Abaixo estão os principais campos da resposta. Algumas estruturas aninhadas (por exemplo, instrumentFrom / instrumentTo) têm uma estrutura semelhante aos objetos dos métodos /instruments e /rates.

Informações gerais do pedido

Campo	Tipo	Descrição
orderId	number	Identificador único do pedido no sistema Quickex.
legacyOrderId	string	Identificador do pedido no sistema legado (se usado para migração/compatibilidade).
createdAt	string	Hora de criação do pedido (ISO8601).
instrumentFromCurrencyTitle	string	Código da moeda de origem (por exemplo, `BTC`).
instrumentFromNetworkTitle	string	Rede de origem (por exemplo, `BTC`).
instrumentToCurrencyTitle	string	Código da moeda de destino (por exemplo, `USDT`).
instrumentToNetworkTitle	string	Rede de destino (por exemplo, `TRC20`).
feeMode	string	Modo de taxa do pedido: • `FLOATING` – a taxa pode variar dependendo das condições da rede ou da taxa de mercado. • `FIXED` – a taxa é fixada no momento em que o pedido é criado.
rateMode	string	Modo da taxa de câmbio: • `FIXED` – a taxa é fixada ao criar o pedido; o valor a receber não muda. • `FLOATING` – a taxa pode oscilar até a conclusão; o valor a receber é atualizado conforme as condições atuais do mercado.
claimedDepositAmount	string	Valor do depósito usado ao criar o pedido.
amountToGet	string	Valor que o usuário deve receber neste pedido.
claimedNetworkFee	string	Taxa de rede considerada no cálculo do pedido.
platformFee	string	Taxa da plataforma.
redirectUrl	string	URL para redirecionamento para um serviço externo.
completed	boolean	Indicador de conclusão do pedido: `true` — troca concluída, `false` — em andamento.
minConfirmationsToTrade	number	Confirmações mínimas para que o depósito seja considerado disponível para a troca.
minConfirmationsToWithdraw	number	Confirmações mínimas necessárias para o saque.

Par de instrumentos (pair)

  "pair": {
    "instrumentFrom": {
      "currencyTitle": "XRP",
      "networkTitle": "XRP",
      "precisionDecimals": 2,
      "slug": "xrp",
      "liquidityProviderCurrencies": [
        {
          "minConfirmationsToTrade": 12,
          "minConfirmationsToWithdraw": 12
        }
      ]
    },
    "instrumentTo": {
      "currencyTitle": "TRX",
      "networkTitle": "TRX",
      "precisionDecimals": 2,
      "slug": "trx",
      "liquidityProviderCurrencies": [
        {
          "minConfirmationsToTrade": 3,
          "minConfirmationsToWithdraw": 3
        }
      ]
    }
  },

Campo	Tipo	Descrição
instrumentFrom	object	Instrumento de origem: a moeda que o usuário envia.
instrumentFrom.currencyTitle	string	Código da moeda do instrumento de origem (por exemplo, XRP).
instrumentFrom.networkTitle	string	Rede blockchain do instrumento de origem.
instrumentFrom.precisionDecimals	number	Quantidade de casas decimais suportadas para valores.
instrumentFrom.slug	string	Identificador interno da moeda.
instrumentFrom.liquidityProviderCurrencies	array	Configurações do provedor de liquidez para esta moeda e rede.
instrumentFrom.liquidityProviderCurrencies.minConfirmationsToTrade	number	Confirmações mínimas para usar o depósito na troca.
instrumentFrom.liquidityProviderCurrencies.minConfirmationsToWithdraw	number	Confirmações mínimas antes de permitir o saque.
instrumentTo	object	Instrumento de destino: a moeda que o usuário recebe.
instrumentTo.currencyTitle	string	Código da moeda do instrumento de destino (por exemplo, TRX).
instrumentTo.networkTitle	string	Rede blockchain do instrumento de destino.
instrumentTo.precisionDecimals	number	Quantidade de casas decimais suportadas para valores.
instrumentTo.slug	string	Identificador interno da moeda.
instrumentTo.liquidityProviderCurrencies	array	Configurações do provedor de liquidez para esta moeda e rede.
instrumentTo.liquidityProviderCurrencies.minConfirmationsToTrade	number	Confirmações mínimas antes que os fundos possam ser trocados.
instrumentTo.liquidityProviderCurrencies.minConfirmationsToWithdraw	number	Confirmações mínimas antes que os fundos possam ser retirados.

orderEvents

  "orderEvents": [
    {
      "createdAt": "2025-12-15T14:42:43.317Z",
      "kind": "WITHDRAWAL_COMPLETED"
    },
    {
      "createdAt": "2025-12-15T14:41:54.109Z",
      "kind": "FUNDS_WITHDRAWAL_START"
    },
    {
      "createdAt": "2025-12-15T14:41:00.379Z",
      "kind": "DEPOSIT_REGISTERED"
    },
    {
      "createdAt": "2025-12-15T14:39:58.760Z",
      "kind": "INCOMING_FUNDS_DETECTED"
    },
    {
      "createdAt": "2025-12-15T14:38:41.642Z",
      "kind": "CREATION_END"
    }
  ],

Campo	Tipo	Descrição
orderEvents	array	Lista de eventos que descreve o ciclo de vida do pedido (em ordem cronológica).
orderEvents[].createdAt	string (ISO 8601)	Timestamp de quando o evento ocorreu.
orderEvents[].kind	string	Tipo do evento do pedido.

Valores possíveis de orderEvents[].kind

Valor	Descrição
CREATION_END	Pedido criado com sucesso.
INCOMING_FUNDS_DETECTED	Transação de depósito de entrada detectada na blockchain.
DEPOSIT_REGISTERED	O depósito recebeu as confirmações necessárias e foi creditado.
FUNDS_WITHDRAWAL_START	Transação de retirada iniciada.
WITHDRAWAL_COMPLETED	Fundos enviados com sucesso para o endereço de destino.

Objeto depositAddress

  "depositAddress": {
    "instrument": {
      "currencyTitle": "XRP",
      "networkTitle": "XRP"
    },
    "depositAddress": "rwXnv8BfEHi7WmkLXZ6ChcWX9hMnSsTMNK",
    "depositAddressMemo": "2097040307"
  },

Campo	Tipo	Descrição
depositAddress	object	Detalhes do depósito para o instrumento de origem.
depositAddress.instrument	object	Instrumento e rede usados para o depósito.
depositAddress.instrument.currencyTitle	string	Código da moeda do instrumento de depósito (por exemplo, XRP).
depositAddress.instrument.networkTitle	string	Rede blockchain usada para o depósito.
depositAddress.depositAddress	string	Endereço blockchain para o qual o usuário deve enviar os fundos.
depositAddress.depositAddressMemo	string \| null	Memo / tag necessário para o depósito (por exemplo, XRP Destination Tag). Deve ser informado se estiver presente.

Array deposits

"deposits": [
  {
    "id": 50958,
    "counterPartyAddress": null,
    "createdAt": "2025-12-15T14:39:45.000Z",
    "instrument": {
      "currencyTitle": "XRP",
      "networkTitle": "XRP"
    },
    "amount": "57",
    "amountUSDT": "112.40742",
    "txId": "DEA15CCF7AF04799A090298CB06D78DD177B3B518BED9C9DE8A0A5B717CCDBE7",
    "confirmations": 12,
    "depositAddress": {
      "instrument": {
        "currencyTitle": "XRP",
        "networkTitle": "XRP"
      },
      "depositAddress": "rwXnv8BfEHi7WmkLXZ6ChcWX9hMnSsTMNK",
      "depositAddressMemo": "2097040307"
    },
    "isPending": false
  }
]

Campo	Tipo	Descrição
deposits[]	array	Lista de transações de depósito associadas ao pedido.
deposits[].id	number	Identificador interno da transação de depósito.
deposits[].counterPartyAddress	string \| null	Endereço da contraparte que enviou o depósito, se conhecido.
deposits[].createdAt	string (ISO 8601)	Hora em que a transação de depósito foi registrada no sistema.
deposits[].instrument	object	Instrumento e rede da moeda depositada.
deposits[].instrument.currencyTitle	string	Código da moeda do depósito (por exemplo, XRP).
deposits[].instrument.networkTitle	string	Rede blockchain do depósito (por exemplo, XRP).
deposits[].amount	string	Valor do depósito no token original.
deposits[].amountUSDT	string	Equivalente do depósito em USDT no momento do depósito.
deposits[].txId	string	ID da transação de depósito na blockchain.
deposits[].confirmations	number	Número de confirmações na blockchain para este depósito.
deposits[].depositAddress	object	Objeto do endereço de depósito para o qual os fundos foram enviados (veja o bloco `depositAddress`).
deposits[].isPending	boolean	Indica se o depósito ainda está pendente (true) ou confirmado/creditado (false).

Array withdrawals

"withdrawals": [
  {
    "instrument": {
      "currencyTitle": "TRX",
      "networkTitle": "TRC20"
    },
    "amount": "393.07",
    "txId": "39dc5802a931da0613f687087397e812dd6c0aa0b9041124d76e864e37bd1e09",
    "createdAt": "2025-12-15T14:41:58.926Z",
    "networkFee": "1.98"
  }
]

Campo	Tipo	Descrição
withdrawals[]	array	Lista de transações de retirada do pedido.
withdrawals[].instrument	object	Instrumento e rede da moeda retirada.
withdrawals[].instrument.currencyTitle	string	Código da moeda retirada (por exemplo, TRX).
withdrawals[].instrument.networkTitle	string	Rede blockchain usada para a retirada (por exemplo, TRC20).
withdrawals[].amount	string	Valor retirado no token original.
withdrawals[].txId	string	ID da transação de retirada na blockchain.
withdrawals[].createdAt	string (ISO 8601)	Hora de criação da retirada.
withdrawals[].networkFee	string	Taxa de rede cobrada pela transação de retirada.

Possíveis casos de uso

Buscar os detalhes completos de um pedido específico para exibir o histórico completo de transações, o status e os dados financeiros relacionados na conta do usuário/painel do parceiro, ou para fins de conciliação e auditoria.

Code Sample

Response Example

{
  "orderId": 3038,
  "legacyOrderId": "4602ddf9-e516-4c3a-9146-7bc748edd89b",
  "pair": {
    "instrumentFrom": {
      "currencyTitle": "BTC",
      "networkTitle": "BTC",
      "precisionDecimals": 7,
      "slug": "btc",
      "liquidityProviderCurrencies": [
        {
          "minConfirmationsToTrade": 3,
          "minConfirmationsToWithdraw": 3
        }
      ]
    },
    "instrumentTo": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20",
      "precisionDecimals": 5,
      "slug": "usdttrc20",
      "liquidityProviderCurrencies": [
        {
          "minConfirmationsToTrade": 3,
          "minConfirmationsToWithdraw": 3
        }
      ]
    }
  },
  "createdAt": "2025-04-28T13:15:03.006Z",
  "instrumentFromCurrencyTitle": "BTC",
  "instrumentFromNetworkTitle": "BTC",
  "instrumentToCurrencyTitle": "USDT",
  "instrumentToNetworkTitle": "TRC20",
  "feeMode": "FLOATING",
  "userId": 229,
  "userEmail": "qa@support.quickex.io",
  "isPlatformEmail": false,
  "refundAddress": null,
  "refundAddressMemo": null,
  "destinationAddress": "TFjfHBiDcL6B5S5W8g9b6gU2tbvnTR52ya",
  "destinationAddressMemo": null,
  "claimedNetworkFee": "1.5",
  "rateMode": "FLOATING",
  "claimedDepositAmount": "0.034268",
  "amountToGet": "3263.05",
  "platformFee": null,
  "redirectUrl": null,
  "orderEvents": [
    {
      "createdAt": "2025-04-28T13:15:03.021Z",
      "kind": "CREATION_END"
    }
  ],
  "depositAddress": {
    "instrument": {
      "currencyTitle": "BTC",
      "networkTitle": "BTC"
    },
    "depositAddress": "3LpR1ZKEVysoi6sxFqoGtB49638RsxzKSh",
    "depositAddressMemo": null
  },
  "deposits": [],
  "withdrawals": [],
  "KYCFormLink": null,
  "liquidityProviderPublicCode": "hat",
  "possibleRefferalAccrualAmount": "3.01",
  "possibleCashbackAmountUSDT": "0",
  "actualCashbackAmountUSDT": null,
  "claimedPublicRate": {
    "claimedAmountToReceive": "3259.38",
    "finalNetworkFeeAmount": "1.5",
    "price": "95158.1",
    "quotes": {
      "sellQuote": {
        "baseValue": "1",
        "quoteValue": "95114.32743505127"
      },
      "buyQuote": {
        "baseValue": "95158",
        "quoteValue": "0.9995400016924599"
      }
    },
    "updatedAt": "2025-04-28T13:11:30.251Z",
    "instrumentFrom": {
      "currencyTitle": "BTC",
      "networkTitle": "BTC",
      "precisionDecimals": 7,
      "slug": "btc",
      "liquidityProviderCurrencies": [
        {
          "minConfirmationsToTrade": 3,
          "minConfirmationsToWithdraw": 3
        }
      ]
    },
    "instrumentTo": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20",
      "precisionDecimals": 5,
      "slug": "usdttrc20",
      "liquidityProviderCurrencies": [
        {
          "minConfirmationsToTrade": 3,
          "minConfirmationsToWithdraw": 3
        }
      ]
    }
  },
  "completed": false,
  "minConfirmationsToTrade": 3,
  "minConfirmationsToWithdraw": 3
}

Try it out

POST

accept-rate-mode-change

Endpoint URL

https://quickex.io/api/v2/orders/public/accept-rate-mode-change

Documentation

Campo	Tipo	Obrigatório	Descrição
`orderId`	number	sim	O identificador do pedido para o qual a mudança do modo de taxa precisa ser confirmada.
`destinationAddress`	string	sim	O endereço de destino associado ao pedido (usado como verificação adicional).

Código	Descrição
`201 Created`	A mudança do modo de taxa foi confirmada, e o pedido continua sendo processado.
`404 Not Found`	Pedido não encontrado (`{"status":"ERR_NOT_FOUND","message":"Order not found"}`).
`400 Bad Request`	Erro de validação (por exemplo, dados de entrada inválidos).
`5xx`	Erro interno do servidor.

Code Sample

Try it out

POST

request-refund

Endpoint URL

https://quickex.io/api/v2/orders/public/request-refund

Documentation

Solicita um reembolso para um pedido. Usado em situações em que a troca não foi concluída ou os fundos precisam ser devolvidos ao usuário.
Para ter sucesso, o valor do reembolso e o endereço de reembolso devem ser especificados.

URL

https://quickex.io/api/v2/orders/public/request-refund

Headers

Accept: application/json
Content-Type: application/json

Request Body (JSON)

Campo	Tipo	Obrigatório	Descrição
`orderId`	number	sim	O identificador do pedido para o qual o reembolso é solicitado.
`destinationAddress`	string	sim	O endereço de destino especificado no pedido original (usado como verificação adicional).
`refundAmount`	string	sim	O valor a ser reembolsado ao usuário.
`refundAddress`	string	sim	O endereço da carteira do usuário para onde os fundos serão reembolsados.
`claimedNetworkFee`	string	não	O valor da taxa de rede que o usuário concorda em pagar pelo reembolso.

{
  "orderId": 123456,
  "destinationAddress": "0xdeadbeef",
  "refundAmount": "10.00",
  "refundAddress": "0xuserrefundwallet",
  "claimedNetworkFee": "0.50"
}

Request Example (cURL)

curl -X POST \
  'https://quickex.io/api/v1/orders/public/request-refund' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "orderId": 123456,
    "destinationAddress": "0xdeadbeef",
    "refundAmount": "10.00",
    "refundAddress": "0xuserrefundwallet",
    "claimedNetworkFee": "0.50"
  }'

Responses

Código	Descrição
`201 Created`	A solicitação de reembolso foi aceita e será processada.
`404 Not Found`	Pedido não encontrado (`{"status":"ERR_NOT_FOUND","message":"Order not found"}`).
`400 Bad Request`	Erro de validação (por exemplo, valor de reembolso abaixo do mínimo permitido ou `refundAddress` inválido).
`5xx`	Erro interno do servidor.

Notes

Este método é usado apenas para pedidos que não podem ser concluídos.

O reembolso é feito para o endereço especificado em refundAddress, menos quaisquer taxas de rede aplicáveis.

Após o envio, o reembolso pode exigir verificação manual pela equipe de suporte.

Code Sample

Try it out

GET

order-refund-info

Código	Descrição
`200 OK`	Retorna JSON com informações de reembolso (valor, endereço, status, taxas).
`400 Bad Request`	Erro de validação ou dados de pedido inválidos (`{"status":"ERR_BAD_REQUEST","message":"Unknown liquidity provider title: ..."}`).
`404 Not Found`	Pedido não encontrado.
`5xx`	Erro interno do servidor.

Orders API V2

Documentation

Parâmetros

Exemplo de requisição

Possíveis respostas

Caso de uso

Code Sample

Response Example

Try it out

Query Parameters

Request Body

Headers

Documentation

Parâmetros

Exemplo de requisição

Possíveis respostas

Caso de uso

Code Sample

Response Example

Try it out

Request Body

Headers

Documentation

Visão geral

HTTP Request

Exemplo de requisição

Headers

Parâmetros da requisição

Parâmetros do corpo (Body)

Formato da resposta

Exemplo de resposta

Erros

403 ERR_FORBIDDEN — E-mail já definido

Possíveis casos de uso

Code Sample

Response Example

Try it out

Request Body

Headers

Documentation

Descrição geral

Requisição HTTP

Exemplo de requisição

Cabeçalhos

Parâmetros da requisição

Parâmetros de query

Formato da resposta

Exemplo de resposta

Detalhamento dos campos da resposta

Informações gerais do pedido

Par de instrumentos (pair)

orderEvents

Valores possíveis de orderEvents[].kind

Objeto depositAddress

Array deposits

Array withdrawals

Possíveis casos de uso

Code Sample

Response Example

Try it out

Query Parameters

Headers

Documentation

URL

Headers

Request Body (JSON)

Request Example (cURL)

Responses

Notes

Code Sample

Try it out

Request Body

Headers

Documentation

URL

Headers

Request Body (JSON)

Request Example (cURL)

Responses

Notes