Definições curtas dos termos usados ao longo da documentação. Os nomes de campos, enums e códigos permanecem em inglês — é como aparecem na API.

​
Termos da plataforma

​
objeto
Uma conexão entre um usuário e um Connector. É o ponto de entrada para todos os dados de produto e mantém o vínculo com os consentimentos. Identificado por um UUID. Sempre inclua o itemId ao reportar problemas — sem ele, o suporte não consegue investigar.
​
objeto
A integração com uma instituição financeira específica. Declara as credenciais que exige, os produtos que suporta e sua saúde. Identificado por um inteiro opaco obtido via GET /connectors; somente 0–99 é uma faixa reservada a mocks locais de sandbox.
​
objeto
O registro de Open Finance de quais produtos um Item pode acessar e por quanto tempo. Criado quando o Item se conecta pela primeira vez. Ciclo de vida em ortografia britânica AWAITING_AUTHORISATION/AUTHORISED/CONSUMED/REJECTED/REVOKED/EXPIRED.
​
string
Token de escopo restrito ao Connect Widget, com TTL de 30 minutos, obtido em POST /connect_token. Dirige o widget e lê apenas o próprio Item. Tentar ler dados de produto com ele retorna 403. A primeira mutação o consome e o vincula atomicamente a um único Item; retries retomam apenas esse mesmo Item e nunca criam outro. É o único token que pode chegar ao browser.
​
string
Chave server-side com TTL de 2 horas, obtida em POST /auth. Enviada no header X-API-KEY em todas as chamadas server-side. Nunca deve chegar ao browser.
​
string
As credenciais da Application, emitidas pelo Dashboard. Trocadas por uma apiKey em POST /auth. São server-side only — nunca embarcadas no cliente.
​
flag
Usa o mesmo host da API, mas uma Application com environment: SANDBOX e credenciais próprias. Inclui mocks locais e pode incluir ASPSPs de simulação internacionais. Items de sandbox inativos por mais de 30 dias são deletados.
​
conceito
Uma autorização de dados em produção. Mantenha o mesmo Item em reconsentimentos para preservar IDs e histórico. No Brasil, mantenha também um Item por (CPF/CNPJ + instituição) para não multiplicar cotas — veja Limites do Open Finance.

​
Termos do Open Finance

​
conceito
O sistema regulado de compartilhamento de dados financeiros do Brasil. O usuário autoriza no banco (via OAuth) e a leitura de dados passa a depender de um consentimento ativo.
​
conceito
Nesta documentação, é a conectividade de dados para Europa e Reino Unido. AIS (Account Information Service) cobre autorização, sessão, contas, saldos e transações; PIS (pagamentos) não é exposto pela Malvo.
​
conceito
A instituição que mantém a conta do usuário no ecossistema europeu/britânico. A lista efetiva varia por país, ambiente e configuração contratada.
​
conceito
Quando um consentimento expira ou é revogado, os endpoints de dados retornam vazio. A renovação é feita disparando uma atualização no mesmo Item (PATCH /items/{id} ou update mode), gerando um novo consentimento no Item existente — nunca um Item novo.
​
código
Identificador Padrão de Sistema de Pagamentos Brasileiro — o código que identifica a instituição participante na rede.
​
código
Merchant Category Code — o código que classifica o tipo de estabelecimento de uma transação.
​
código
Custo Efetivo Total — o custo total de uma operação de crédito, usado no contexto do produto LOANS.
​
código
Identificador padronizado de operação de crédito, usado para referenciar uma operação no contexto do produto LOANS.
​
conceito
Iniciação de Transação de Pagamento. Não é suportado pela Malvo — sem PIX/Boleto, sem Smart Transfers, sem PIX Automático. Campos como supportsPaymentInitiation permanecem nas respostas só por compatibilidade de wire, sempre false e inertes.

​
Campos de estado do Item

​
enum
O estado fino da última execução de um Item: transitivos (LOGIN_IN_PROGRESS, TRANSACTIONS_IN_PROGRESS, MERGING, …), o intermediário WAITING_USER_INPUT, e finais de sucesso (SUCCESS, PARTIAL_SUCCESS) ou de erro (INVALID_CREDENTIALS, SITE_NOT_AVAILABLE, …). Veja Códigos de erro.
​
objeto
Detalhamento por família de produto (accounts, creditCards, transactions, investments, identity, paymentData, loans, investmentsTransactions). Cada chave é null (não coletada) ou traz isUpdated, lastUpdatedAt e warnings[].
​
conceito
Após o sync inicial, cada execução busca desde lastUpdatedAt com sobreposição para capturar lançamentos tardios: aproximadamente três dias no Brasil e 90 dias no fluxo internacional. No AIS internacional, a Malvo também tenta uma reconciliação completa a cada 30 dias nos ASPSPs compatíveis com a janela máxima de histórico.

​
Termos de Webhook

​
conceito
Um endpoint HTTPS registrado pelo cliente que recebe notificações POST quando ocorrem eventos em recursos da Application (items, transações, conectores). Reduz polling, mas deve ser combinado com reconciliação periódica. No fluxo internacional, a Malvo consulta a infraestrutura upstream e emite seus próprios eventos. Apenas https:// é aceito; entrega bem-sucedida = qualquer 2XX em até 5 segundos.
​
string (UUID)
A chave de idempotência de cada entrega de webhook. O mesmo eventId é reusado em todas as reentregas de um evento e entre os endpoints inscritos nele. O receptor deve persistir e deduplicar.

​
Relacionado

  • Autenticação — cadeia clientId/clientSecret → apiKey → connect token.
  • Items — ciclo de vida, status, executionStatus e statusDetail.
  • Webhooks — eventos, eventId e regras de entrega.