Guia de Usabilidade

Este guia descreve o uso do TOOQ Backoffice com base no fluxo real do sistema e nas telas operacionais. Cada seção aborda um processo completo (da entrada até a confirmação/liquidação), com passos práticos e validações importantes.

Objetivo: padronizar o uso, reduzir retrabalho e garantir governança entre Front, Middle e Back Office.
Boletagem Alocação Pré‑Matching Liquidação Trademate Itaú FIX

Padrões de navegação

  • Filtro por data: praticamente todas as telas trabalham por data de operação ou liquidação.
  • Seleção em grid: selecione linhas para habilitar ações no menu de contexto.
  • Duplo clique: normalmente abre edição ou associações (ex.: pré‑boleta e instituição).
  • Real Time: algumas telas possuem toggle para atualizações em tempo real.

Fluxo macro (títulos públicos)

  1. Boletagem (pré‑boleta) →
  2. Criação de boleta →
  3. Alocação e quebra →
  4. Pré‑matching →
  5. Efetivação/Confirmação →
  6. Backoffice e e‑mail ao cliente.

Títulos Públicos · Boletagem

Tela: Boletador Títulos Públicos. O processo começa com a criação de pré‑boletas, que serão convertidas em boletas.

1. Criar pré‑boleta (manual)

  1. Selecione Instituição, Conta B3 e Título.
  2. Preencha lado (C/V), quantidade, taxa/PU e liquidação.
  3. Escolha tipo de corretagem (spread ou nota).
  4. Revise o cálculo automático de PU/financeiro.
  5. Clique em Adicionar para registrar a pré‑boleta.
O sistema calcula PU e financeiro via calculadora B3 quando há título e data de liquidação definidos.

2. Edição, duplicação e cancelamento

  • Duplo clique em uma pré‑boleta não boletada para editar.
  • Menu de contexto permite Duplicar, Cancelar ou Criar Facility.
  • O histórico de status está disponível por diálogo.

3. Upload de planilha

Use o botão de upload para importar boletas via planilha. O sistema valida e cria pré‑boletas em lote.

4. Gravar boletas

  1. Selecione pré‑boletas com status Pendente.
  2. Clique em Gravar para gerar boletas.
Validação: o sistema bloqueia gravação de itens já boletados.

Títulos Públicos · Trademate DC

Tela: Ordens Trademate DC. Captura automática de execuções via dropcopy, com associação de clientes e criação de boletas.

1. Carregar ordens

  1. Escolha a data.
  2. Use o campo de pesquisa para localizar por broker, título ou status.

2. Associar cliente

  • Se a instituição estiver como "NÃO ASSOCIADO", abra o diálogo e associe a mesa operacional.

3. Criar boletas

  1. Selecione as linhas válidas.
  2. Clique em Criar boletas.
Regra: não é possível criar boletas com instituições não associadas.

Títulos Públicos · Alocação

Tela: Alocação Títulos Públicos. Aqui ficam as boletas não casadas, prontas para quebra, casamento e envio ao pré‑matching.

1. Filtrar e selecionar

  1. Selecione a data.
  2. Use o filtro rápido para localizar boletas.
  3. Selecione uma ou mais linhas para habilitar ações.

2. Quebra e casamento

  • Quebrar boleta: divide a quantidade por conta/cliente.
  • Desfazer quebra: retorna para o estado original.
  • Casar boletas: exige lados C e V, mesma data de liquidação e mesmo ativo.

3. Envio e cancelamento

  • Enviar Virtual: integração com sistemas de estoque/posição.
  • Enviar para Pré‑Matching: gera envio ao ambiente de conciliação.
  • Cancelar envio Pré‑Matching: disponível para boletas sem comando.

4. Ajustes rápidos

  • Atualizar observação, comando, comando retorno SELIC e PU.
  • Atualizar instituição direto pela coluna de cliente/conta.
Integrações extras: criar Facility a partir de boleta e enviar confirmação Itaú FIX quando a origem for Itaú.

Títulos Públicos · Efetivação

Tela: Efetivação Títulos Públicos. Exibe boletas casadas e prontas para confirmação e liquidação.

1. Conferência e confirmação

  1. Revise status, casamento, quantidade e ativo.
  2. Use Confirmar boletas para marcar a liquidação.

2. Ações disponíveis

  • Descasar, quebrar, desfazer quebra.
  • Enviar Virtual e Pré‑Matching.
  • Atualizar PU, observação e comandos.
  • Retornar boleta para edição quando necessário.
Alerta: boletas inválidas (casamento com ativo diferente ou quantidades divergentes) são sinalizadas na tela.

Títulos Públicos · Backoffice

Tela: Backoffice Títulos Públicos. Finaliza o processo com envio de e‑mail, comandos e status de registro.

1. Filtrar por liquidação

  1. Selecione a data de liquidação.
  2. Use a busca para localizar operações.

2. Ações principais

  • Enviar para Virtual e Pré‑Matching.
  • Enviar e‑mail de confirmação ao cliente.
  • Adicionar observação em lote.
  • Casar boletas quando as quantidades compra/venda estiverem balanceadas.

3. Atualizações em lote

  • Registrar (sim/não).
  • Comando (sequencial quando informado número inicial).
  • Tipo de conta (própria/broker).

Títulos Privados · Boletagem

Tela: Boletador Títulos Privados. Processa balcão e Trademate, com criação de pré‑boletas e casamento quando necessário.

1. Escolher o tipo de negociação

  • Balcão: criação manual e upload de planilha.
  • Trademate: acompanha pré‑boletas recebidas pelo fluxo de voices.

2. Criar pré‑boleta

  1. Use o formulário manual ou Upload de boletas.
  2. Informe cliente, ativo, lado (C/V), PU, taxa, quantidade e liquidação.
  3. Salve para gerar a pré‑boleta.

3. Casar e descasar

  • Casar boletas: exige lados diferentes e quantidades iguais para o mesmo ativo.
  • Descasar: disponível apenas para boletas com código de casamento.

4. Gravar boletas

  1. Selecione pré‑boletas Pendentes.
  2. Clique em Gravar para gerar boletas efetivas.

Títulos Privados · Backoffice

Tela: Backoffice Títulos Privados. Acompanha boletas e integrações de estoque.

1. Acompanhar e filtrar

  1. Selecione a data.
  2. Use o filtro rápido para localizar operações.

2. Ações principais

  • Enviar Virtual para integração de estoque.
  • Retornar boleta para edição quando permitido.
  • Código Controle NoME: edição direta no grid para integrar com sistemas externos.
Regra: boletas com código NoME não podem ser retornadas para edição.

Itaú FIX

Tela: Itaú FIX. Lista pré‑boletas recebidas por FIX para criação de boletas internas.

1. Selecionar pré‑boletas

  • Selecione apenas itens com status Pendente.
  • As boletas selecionadas devem ter mesmo título, mesmo tipo de preço, mesma liquidação e mesmo preço.
  • Cliente precisa estar definido.

2. Criar boleta

  1. Clique em Criar boleta.
  2. O sistema valida as regras e gera a boleta interna.

3. Confirmar Itaú

Na etapa de alocação/efetivação, use a ação Enviar confirmação Itaú FIX para boletas de origem Itaú.

Cadastros e Posição

Estas telas garantem que o fluxo operacional tenha dados consistentes e atualizados.

Cadastros principais

  • Títulos Públicos e Títulos Privados: inclusão e manutenção do cadastro de ativos.
  • Instituições (públicos e privados): gestão de contas, matrícula, SELIC/CETIP.
  • Entidades: vínculo com mesas e instituições.
  • Mesas & Brokers: manutenção de mesas operacionais e brokers.
  • Contas & Acessos: gestão de usuários e permissões.

Posição e monitoramento

  • Posição Títulos Públicos e Posição Títulos Privados: acompanhamento intraday por papel e cliente.
  • Compliances: visão de conformidade operacional.
  • UP2Data: integração e atualização de dados externos.
Boa prática: mantenha cadastros atualizados antes de iniciar a boletagem para evitar bloqueios ou retornos em etapas finais.
API de Market Data Renda Fixa

Visão Geral do Produto

A API de Market Data para Renda Fixa fornece acesso a um catálogo de instrumentos de renda fixa e a atualizações em tempo real dos melhores preços de compra e venda.

1. Visão Geral

A API de Market Data para Renda Fixa fornece acesso a um catálogo de instrumentos de renda fixa e a atualizações em tempo real dos melhores preços de compra e venda.

A API permite que os clientes:

  • consultem os ativos disponíveis
  • filtrem os ativos por segmento (públicos ou privados)
  • assinem um conjunto de ativos
  • recebam atualizações em tempo real via webhook quando o melhor preço de compra ou venda mudar

Este produto simplifica o acesso aos dados de mercado por meio de uma API REST e eventos enviados via webhook.

2. Principais Funcionalidades

A API expõe duas capacidades principais:

  1. Acesso ao catálogo de ativos
  2. Assinatura de market data com entrega via webhook

3. Catálogo de Ativos

Os clientes podem consultar a lista de ativos de renda fixa disponíveis.

Filtros suportados:

  • Ativos públicos
  • Ativos privados

As informações retornadas normalmente incluem:

  • Identificador do ativo
  • Símbolo
  • Descrição
  • Segmento
  • Data de vencimento
  • Moeda
  • Tipo de preço
  • Status de negociação

Este catálogo permite que os clientes descubram quais ativos podem ser monitorados por meio de assinaturas de market data.

4. Assinatura de Market Data

Os clientes podem assinar um ou mais ativos para receber atualizações do livro de ofertas nível 1.

O Nível 1 representa:

  • Melhor preço de compra e sua quantidade
  • Melhor preço de venda e sua quantidade

Após a assinatura, o cliente recebe eventos via webhook sempre que esses valores forem alterados.

5. Entrega via Webhook

As atualizações de mercado são entregues para um endpoint de webhook definido pelo cliente.

Cada evento contém os dados atualizados de Nível 1 de um ativo.

Os eventos são disparados quando qualquer um dos seguintes itens mudar:

  • melhor preço de compra
  • quantidade da melhor compra
  • melhor preço de venda
  • quantidade da melhor venda

Cada evento de webhook contém o estado completo do Nível 1 para o ativo.

6. Fluxo Típico de Integração

  1. O cliente consulta o catálogo de ativos para descobrir os ativos disponíveis.
  2. O cliente cria uma assinatura para os ativos selecionados.
  3. O cliente informa um endpoint de webhook.
  4. O sistema envia eventos de market data sempre que os preços de Nível 1 forem alterados.

7. Segurança

A API suporta:

  • requisições autenticadas
  • eventos de webhook assinados

As assinaturas dos webhooks permitem que os clientes verifiquem a autenticidade dos eventos recebidos.

8. Confiabilidade

A plataforma fornece mecanismos para garantir a entrega confiável dos eventos.

Se a entrega do webhook falhar, o sistema poderá reenviar o evento de acordo com suas políticas internas de retry. Os clientes devem retornar uma resposta HTTP 2xx para confirmar o recebimento com sucesso.

9. Limitações

A versão atual do produto oferece:

  • apenas market data nível 1
  • assinatura por ativo
  • entrega baseada em webhook

Versões futuras poderão suportar níveis mais profundos do livro e filtros adicionais.

10. Autenticação da API

Todas as requisições da API devem incluir: 

Authorization: Bearer <token>

11. Catálogo de Ativos

Retorna a lista de ativos disponíveis.

Endpoint

GET /v1/securities

Parâmetros de Query

Parâmetro Tipo Obrigatório Descrição
segment string não Filtra por segmento: public ou private
symbol string não Filtra por símbolo
page integer não Número da página (padrão: 1)
pageSize integer não Quantidade de itens por página (padrão: 100)

Exemplo de Requisição

GET /v1/securities?segment=public&page=1&pageSize=50

Exemplo de Resposta

{
  "page": 1,
  "pageSize": 50,
  "total": 2,
  "items": [
    {
      "securityId": "21010020290101",
      "symbol": "NTNB29",
      "segment": "public",
      "description": "Tesouro IPCA+ 2029",
      "maturityDate": "2029-05-15",
      "currency": "BRL",
      "priceType": "Yield",
      "tradingStatus": "READY_TO_TRADE"
    },
    {
      "securityId": "21010020350101",
      "symbol": "LTN35",
      "segment": "public",
      "description": "Tesouro Prefixado 2035",
      "maturityDate": "2035-01-01",
      "currency": "BRL",
      "priceType": "Yield",
      "tradingStatus": "READY_TO_TRADE"
    }
  ]
}

12. Assinatura de Market Data

Cria uma assinatura para um ou mais ativos e define o endpoint de webhook que receberá as atualizações de market data Nível 1.

Endpoint

POST /v1/subscriptions

Corpo da Requisição

Campo Tipo Obrigatório Descrição
name string sim Nome da assinatura definido pelo cliente
securities array[string] sim Lista de identificadores de ativos a serem monitorados
webhookUrl string sim URL de destino para entrega do webhook
secret string não Segredo opcional usado para assinar os eventos do webhook

Exemplo de Requisição

POST /v1/subscriptions
Authorization: Bearer <token>
Content-Type: application/json

{
  "name": "titulos-publicos-level1",
  "securities": [
    "21010020290101",
    "21010020350101"
  ],
  "webhookUrl": "https://cliente.exemplo.com/webhooks/marketdata",
  "secret": "seu-segredo-de-assinatura"
}

Exemplo de Resposta

{
  "subscriptionId": "sub_01JMDATA8XQ9P4J6A7B2C3D4E",
  "name": "titulos-publicos-level1",
  "status": "active",
  "securities": [
    "21010020290101",
    "21010020350101"
  ],
  "webhookUrl": "https://cliente.exemplo.com/webhooks/marketdata",
  "createdAt": "2026-03-16T18:00:00Z"
}

13. Evento de Webhook

Quando um ativo assinado tiver alteração no melhor preço de compra ou no melhor preço de venda, a plataforma enviará um evento via webhook contendo o estado completo do Nível 1 para aquele ativo.

Exemplo de Headers

POST /client/webhook-endpoint
Content-Type: application/json
X-Webhook-Event: marketdata.level1.updated
X-Webhook-Signature: sha256=4f7c2f1f0b3d0c9a8c7d6e5f4a3b2c1d9e8f7a6b5c4d3e2f1a0b9c8d7e6f5a4

Exemplo de Payload

{
  "event": "marketdata.level1.updated",
  "subscriptionId": "sub_01JMDATA8XQ9P4J6A7B2C3D4E",
  "timestamp": "2026-03-16T18:00:05Z",
  "data": {
    "securityId": "21010020290101",
    "symbol": "NTNB29",
    "segment": "public",
    "bid": {
      "price": 6.125,
      "quantity": 250000
    },
    "ask": {
      "price": 6.118,
      "quantity": 300000
    }
  }
}

Resposta Esperada do Cliente

HTTP/1.1 200 OK