# ONZ Developers > Documentação das APIs ONZ Finance: Pix, contas, Banking API e SPB. > ## Agent Instructions > Responda em português brasileiro, a menos que o usuário peça outro idioma. > Host de produção da API de Contas: https://secureapi.onz.finance/api/v2. Nunca use api.example.com. > Host de produção da API de QRCodes (Pix recebedor): https://pix.onz.finance. Token em POST /oauth/token. > Todas as APIs exigem mTLS + OAuth 2.0 client_credentials e allowlist de IP. O playground interativo no browser não funciona por causa do mTLS. > O header x-account-id só se aplica a contas BaaS (Banking API / credenciais filhas). Não enviar em Pix/QRCodes de parceiro tradicional. > Não invente endpoints. Use apenas paths documentados no OpenAPI correspondente (specs/*.yaml|json). > Cobranças Pix no padrão Bacen (cob/cobv/rec) são a API de QRCodes. Cobranças Pix/boleto/híbrido pela API de Contas estão em /invoices. > Onboarding BaaS (PF/PJ + imagens) está na API de Contas: POST /onboarding e POST /onboarding/{id}/images. Não há spec pública de cash-operations. > Páginas de documentação respondem em Markdown de duas formas: Accept: text/markdown na URL canônica, ou o mesmo conteúdo-fonte em /{path}.md. > Servidor MCP HTTP em https://developers.onz.software/mcp (JSON-RPC). Ferramentas: list_docs, get_doc, search_docs. Prefira o MCP para buscar guias; o contrato da API está no OpenAPI em /specs. ## MCP - [ONZ Developers MCP](https://developers.onz.software/mcp): servidor MCP HTTP. GET descreve as ferramentas; POST é JSON-RPC (`initialize`, `tools/list`, `tools/call`). Use `list_docs`, `get_doc` e `search_docs` para ler os guias. ## OpenAPI Specs - [accounts](https://developers.onz.software/specs/accounts.yaml) - [qrcodes](https://developers.onz.software/specs/qrcodes.yaml) - [banking-api](https://developers.onz.software/specs/banking-api.json) - [cloudpix](https://developers.onz.software/specs/cloudpix.yaml) - [spb](https://developers.onz.software/specs/spb-api.yaml) ## Table of Contents - [Ambiente Sandbox](https://developers.onz.software/docs/ambiente-sandbox): O ambiente sandbox é uma versão simulada do ambiente de produção onde o cliente irá operar. Neste ambiente, o parceiro pode testar suas integrações... - [Assuntos relacionados ao Pix](https://developers.onz.software/docs/assuntos-relacionados-pix): CPF (Cadastro de Pessoas Físicas) é um número de identificação fiscal usado no Brasil para pessoas físicas. É como se fosse um número de identidade... - [Autenticação](https://developers.onz.software/docs/autenticacao): A implementação de cache para tokens JWT pode ser uma estratégia valiosa para melhorar o desempenho e reduzir o tráfego de rede em sistemas que dep... - [Account Management](https://developers.onz.software/docs/banking-api/account-management): displayed_sidebar: bankingApiSidebar - [Authentication & mTLS](https://developers.onz.software/docs/banking-api/auth-and-mtls): Este guia descreve o contrato atual de autenticação da Banking API para integrações server-to-server. - [BaaS Management](https://developers.onz.software/docs/banking-api/baas-management): Este guia apresenta como listar os parceiros **BaaS** (Banking as a Service) configurados para a instituição e como usar o `baasId` para segmentar ... - [BaaS Users](https://developers.onz.software/docs/banking-api/baas-users): Gerencie os usuários do portal do parceiro BaaS (mesmo fluxo do portal em `/management/users/list`). - [Balance Flow](https://developers.onz.software/docs/banking-api/balance-flow): Este guia apresenta o fluxo completo de consulta de saldo na Banking API, desde a autenticação até a recepção da resposta. - [Changelog](https://developers.onz.software/docs/banking-api/changelog): displayed_sidebar: bankingApiSidebar - [Credit Bankarization](https://developers.onz.software/docs/banking-api/credit-bankarization): A Banking API expõe a jornada de bancarização do crédito. O intake segue o `credential_type` do token: - [Errors & Retries](https://developers.onz.software/docs/banking-api/errors-and-retries): displayed_sidebar: bankingApiSidebar - [Fee Rules (Automatic Debits)](https://developers.onz.software/docs/banking-api/fee-rules): Gerencie as regras usadas para gerar débitos automáticos (tarifas) do parceiro **BaaS**. - [Getting Started](https://developers.onz.software/docs/banking-api/getting-started): Este é o caminho mais rápido para começar a consumir a Banking API. - [Invoices](https://developers.onz.software/docs/banking-api/invoices): A Banking API expõe a emissão e a gestão de faturas (Pix, boleto registrado ou híbrido) da conta. O contrato é o de **invoice** — um título da cont... - [Onboarding Journey](https://developers.onz.software/docs/banking-api/onboarding-journey): Este guia apresenta o fluxo completo para realizar o onboarding (cadastro) de novos clientes através da API, desde a criação até a aprovação e aber... - [Onboarding do Parceiro](https://developers.onz.software/docs/banking-api/partner-onboarding): Bem-vindo ao guia de onboarding da Banking API. - [People Management](https://developers.onz.software/docs/banking-api/people-management): displayed_sidebar: bankingApiSidebar - [QRCodes Credentials Journey](https://developers.onz.software/docs/banking-api/pix-manager-credentials-journey): Este guia apresenta o fluxo completo para gerenciar credenciais da API de QRCodes, permitindo que contas realizem operações PIX através de QR Codes... - [Requisitos de Segurança](https://developers.onz.software/docs/banking-api/security-requirements): Este documento descreve as ferramentas e componentes mínimos que sua instituição parceira precisa ter implementados para se conectar de forma segur... - [Configurando o certificado mTLS](https://developers.onz.software/docs/certificado-mtls): Passo a passo para conectar na API: gerar a credencial no portal, preparar o certificado e configurá-lo no **Postman**, no **Insomnia** e no **Brun... - [CloudPix OpenAPI — mapa de respostas](https://developers.onz.software/docs/cloudpix-response-map): Fonte das formas JSON: `ONZ-Software/cloudpix-turbo` branch `next`, e `ONZ-Software/cloudpix-lp` para `GET /v3/lp/{pullNext}`. Spec publicada: `sta... - [Autenticação](https://developers.onz.software/docs/cobrancas/autenticacao-api-pix): > **Lembrando** que antes é necessário [configurar o certificado MTLS](../certificado-mtls.md). - [Cobrança com data de vencimento](https://developers.onz.software/docs/cobrancas/cobranca-com-vencimento): Uma solicitação de pagamento Pix para cobrança com vencimento normalmente funciona: - [Cobrança de pagamento imediato](https://developers.onz.software/docs/cobrancas/cobranca-imediata): Uma solicitação de pagamento Pix para pagamento imediato normalmente funciona: - [Jornada da cobrança](https://developers.onz.software/docs/cobrancas/jornada-cobranca): Esta seção documenta a **API de QR Codes** (cobranças Pix imediatas e com vencimento no padrão Bacen). Para emitir Pix, boleto ou híbrido pela **AP... - [Jornadas de Autorização do Pix Automático](https://developers.onz.software/docs/cobrancas/pix-automatico-jornadas): O Pix Automático é o débito automático no Pix. Primeiro o cliente **autoriza** a recorrência. Depois você **cobra cada parcela**. - [Configurando Webhook](https://developers.onz.software/docs/cobrancas/webhook-api-qrcodes): Cada chave Pix receptora pode ter um webhook associado. - [Automação Sisbajud](https://developers.onz.software/docs/guias/banco-central/automacao-sisbajud): O **SISBAJUD** (Sistema de Busca de Ativos do Poder Judiciário) é o canal de comunicação eletrônica entre o Poder Judiciário e as instituições auto... - [Guia do BC Protege+](https://developers.onz.software/docs/guias/banco-central/bc-protege): A funcionalidade está disponível nos registros de onboardings e no momento de aprovação destes, exibindo se existe uma consulta vinculada ao docume... - [Guia de transmissão do certificado EV de QRCodes - CERTQRC](https://developers.onz.software/docs/guias/banco-central/certificado-ev-qrcodes): Guia para transmissão do certificado EV de QRCodes (CERTQRC) através do portal do STA do Banco Central. - [Guia de Gerência de Autorizações - Autran](https://developers.onz.software/docs/guias/banco-central/gerencia-autorizacoes-autran): O Autran é o sistema de segurança do Sisbacen pelo qual é realizado o gerenciamento do acesso e identidade, garantindo que apenas contas autenticad... - [Política de controle de consultas ao DICT — passo a passo](https://developers.onz.software/docs/guias/banco-central/politica-consultas-dict): Como funciona a política institucional de prevenção a ataques de leitura ao DICT, organizada conforme o item 13 do Manual Operacional do DICT (v8.2... - [Guia de transmissão do APIX001](https://developers.onz.software/docs/guias/banco-central/transmissao-apix001): Guia para transmissão do arquivo APIX001 através do portal do STA do Banco Central. - [Regras de Acesso do usuário: bancodigital_bi](https://developers.onz.software/docs/guias/bi/acesso-bancodigital-bi): **Objetivo:** - [Conectando ao BD](https://developers.onz.software/docs/guias/bi/conectando-ao-bd): Vamos realizar a configuração de uma interface ao Banco de Dados para obter as *views*, que são representações virtuais de dados extraídos de uma o... - [Documentação de Visões para BI - Banco Digital](https://developers.onz.software/docs/guias/bi/visoes-banco-digital): Documentação das views do schema bancodigital_bi para consumo analítico (contas, movimentos, planos, MEDs, infrações e limites por conta). - [Assinaturas Eletrônicas](https://developers.onz.software/docs/guias/core/assinaturas-eletronicas): O menu **Assinaturas Eletrônicas** reúne o cadastro de documentos para assinatura eletrônica e a gestão das assinaturas em andamento. - [Cadastros](https://developers.onz.software/docs/guias/core/cadastros): O menu **Cadastros**, cuida da abertura de conta do cliente do começo ao fim: o cliente acessa o aplicativo, seja por iniciativa própria ou através... - [Compliance](https://developers.onz.software/docs/guias/core/compliance): O menu **Compliance**, disponível em **SEGURANÇA OPERACIONAL → Compliance**, concentra os recursos de prevenção a fraudes, monitoramento cadastral ... - [Contas a pagar](https://developers.onz.software/docs/guias/core/contas-a-pagar): O menu **Contas a pagar**, em **INSTITUCIONAL → Contas a pagar**, é onde a instituição registra, paga e - [Contas](https://developers.onz.software/docs/guias/core/contas): O menu **Contas** reúne o que a instituição precisa para manter as contas sob sua gestão: abrir uma conta, localizar e filtrar as contas existentes... - [Financeiro](https://developers.onz.software/docs/guias/core/financeiro): O menu **Financeiro** reúne a visão consolidada das movimentações da instituição e o gerenciamento das conciliações do ambiente. É por ele que a in... - [Mesa de Câmbio](https://developers.onz.software/docs/guias/core/mesa-de-cambio): O menu **Mesa de Câmbio** reúne as funcionalidades utilizadas para operar e acompanhar o ciclo de câmbio da instituição, desde a criação e aprovaçã... - [Pessoas](https://developers.onz.software/docs/guias/core/pessoas): O menu **Pessoas** é o cadastro de pessoas do CORE — pessoas físicas e jurídicas — e reúne o que a instituição precisa para manter esse cadastro em... - [Rel. Financeiros](https://developers.onz.software/docs/guias/core/rel-financeiros): O menu **Rel. Financeiros** reúne os relatórios financeiros do Core. Hoje ele tem uma tela: - [Segurança](https://developers.onz.software/docs/guias/core/seguranca): O menu **Segurança** reúne o controle dos dispositivos móveis que acessam as contas pelo aplicativo. Um dispositivo passa a constar no ambiente qua... - [SPB](https://developers.onz.software/docs/guias/core/spb): O menu **SPB** acompanha a troca de mensagens com o Banco Central pelo Sistema de Pagamentos Brasileiro: as mensagens do **STR** (Sistema de Transf... - [Taxas](https://developers.onz.software/docs/guias/core/taxas): O menu **Taxas** concentra a cobrança de tarifas da plataforma em um só lugar. Por ele a instituição acompanha o que foi cobrado, resolve as pendên... - [Transações](https://developers.onz.software/docs/guias/core/transacoes): O menu **Transações** concentra o acompanhamento e o tratamento das operações do ambiente. Por ele a instituição localiza e classifica as transaçõe... - [Workflow](https://developers.onz.software/docs/guias/core/workflow): O menu **Workflow** concentra as tarefas operacionais do ambiente. Cada demanda — uma análise, uma conferência, uma tratativa — vira uma tarefa com... - [Acompanhar](https://developers.onz.software/docs/guias/finance/acompanhar): O menu **Acompanhar**, disponível em **ACOMPANHAR → Acompanhar**, permite acompanhar operações que dependem de aprovação ou processamento, consulta... - [Busca de Transações](https://developers.onz.software/docs/guias/finance/busca-de-transacoes): O menu **Busca de Transações** permite consultar vários identificadores em uma única busca, sem a necessidade de percorrer todo o extrato. Nesta te... - [Chaves Pix](https://developers.onz.software/docs/guias/finance/chaves-pix): Neste menu são exibidas as chaves Pix registradas para a conta e são disponibilizadas as operações de - [Cobranças](https://developers.onz.software/docs/guias/finance/cobrancas): O menu **Cobranças**, disponível em **RECEBER → Cobranças**, concentra os recursos de criação, envio e acompanhamento das cobranças pagas pelos cli... - [Configurações](https://developers.onz.software/docs/guias/finance/configuracoes): O menu **Configurações**, disponível em **CADASTROS E CONTA**, concentra as opções de administração da - [Dados da Conta](https://developers.onz.software/docs/guias/finance/dados-da-conta): O menu **Dados da Conta** reúne as estatísticas e as informações cadastrais da conta: o que passou por ela, o saldo fechado dia a dia, as cobranças... - [Extrato](https://developers.onz.software/docs/guias/finance/extrato): O **Extrato** permite consultar as movimentações de entrada e saída da conta, acompanhar o saldo após cada lançamento e gerar arquivos para consult... - [Favorecidos](https://developers.onz.software/docs/guias/finance/favorecidos): Neste menu são exibidos os favorecidos cadastrados para a conta e são disponibilizadas as operações de consulta, cadastro, alteração do apelido e r... - [Lotes](https://developers.onz.software/docs/guias/finance/lotes): O menu **Lotes**, disponível em **Gestão → Lotes**, permite criar pagamentos em lote, acompanhar os lotes criados e trabalhar com arquivos de remes... - [Pix](https://developers.onz.software/docs/guias/finance/pix): O menu **Pix** reúne as opções disponíveis para envio de Pix pelo Finance. - [QR Codes](https://developers.onz.software/docs/guias/finance/qr-codes): Os **QR Codes Pix dinâmicos** da conta são criados **fora do FINANCE** — pela integração da conta ou - [Transferir](https://developers.onz.software/docs/guias/finance/transferir): O **Transferir** é o ponto de partida para realizar transações no Finance. Em uma única tela, você informa - [Frente de Caixa - Guia](https://developers.onz.software/docs/guias/frente-de-caixa/): Este manual apresenta, em linguagem institucional, o funcionamento da ferramenta Frente de Caixa no Core, contemplando requisitos de acesso, abertu... - [ONZ Print Server](https://developers.onz.software/docs/guias/frente-de-caixa/onz-print-server): Este manual explica como instalar, configurar e validar o ONZ Print Server em uma máquina Windows para uso com impressora térmica USB. O serviço pe... - [Guias](https://developers.onz.software/docs/guias): Guias de uso do Finance, do Core Banking e de procedimentos operacionais. - [Auto-Submit Apple](https://developers.onz.software/docs/guias/lojas-e-app/auto-submit-apple): Guia para realizar o Auto-Submit no site da Apple, criando usuário e chave de equipe para submissão automática de apps. - [Guia do Dispositivo Único](https://developers.onz.software/docs/guias/lojas-e-app/dispositivo-unico): O dispositivo único é uma ferramenta de segurança para o aplicativo que consiste em cada usuário ter acesso apenas em um único dispositivo móvel. - [Guia liberação do aplicativo em outros países. GOOGLE - APPLE](https://developers.onz.software/docs/guias/lojas-e-app/liberacao-outros-paises): Como liberar o aplicativo em outros países na App Store (iOS) e na Google Play Store (Android), incluindo o processo de estatuto de comerciante par... - [Guia de Integração Onz Finance](https://developers.onz.software/docs/intro): Bem-vindo ao guia de integração da Onz Finance! Aqui você encontrará informações detalhadas sobre como integrar sua aplicação com a API da Onz Fina... - [Autenticação](https://developers.onz.software/docs/pagamentos/autenticacao-api-contas): Uma vez obtido o token de acesso, você pode utilizá-lo para autenticar chamadas a API durante o período de validade especificado no campo "expires_... - [Bancarização de crédito](https://developers.onz.software/docs/pagamentos/bancarizacao/jornada): Bancarização é o fluxo em que a **conta autenticada origina uma operação de crédito** (CCB) para um devedor pessoa física. Nesta jornada a própria ... - [Gerenciando chaves Pix](https://developers.onz.software/docs/pagamentos/chaves-pix): A API de Contas (`/api/v2`) permite listar, criar e remover as chaves Pix da conta autenticada. - [Averbar consignado](https://developers.onz.software/docs/pagamentos/credito-trabalhador/emprestimo/averbar-consignado): Registra o empréstimo na Plataforma Crédito do Trabalhador e o desconto em folha do trabalhador. - [Consultar dados do trabalhador](https://developers.onz.software/docs/pagamentos/credito-trabalhador/emprestimo/consultar-dados-do-trabalhador): Consulta a margem consignável, a elegibilidade e os bloqueios do trabalhador antes de montar a operação. - [Consultar empréstimo](https://developers.onz.software/docs/pagamentos/credito-trabalhador/emprestimo/consultar-emprestimo): Devolve a situação completa de um contrato na Dataprev: dados da averbação, histórico de saldo devedor, pagamentos, escriturações e o kit do contra... - [Consultar garantias por janela de data](https://developers.onz.software/docs/pagamentos/credito-trabalhador/emprestimo/consultar-garantias): Varredura paginada das garantias FGTS dos empréstimos averbados pela instituição numa janela de data. - [Enviar informações do contrato (kit da CCB)](https://developers.onz.software/docs/pagamentos/credito-trabalhador/emprestimo/enviar-informacoes-do-contrato): Envia a CCB assinada e a prova de identidade de quem assinou. Exige contrato já averbado e pertencente à conta. - [Incluir saldo devedor em lote](https://developers.onz.software/docs/pagamentos/credito-trabalhador/emprestimo/incluir-saldo-devedor-em-lote): Envia o saldo devedor de vários contratos numa requisição. É o caminho recomendado para a atualização mensal da carteira. - [Incluir saldo devedor](https://developers.onz.software/docs/pagamentos/credito-trabalhador/emprestimo/incluir-saldo-devedor): Informa o saldo devedor do contrato. O MTE exige o saldo já no momento da averbação e atualizado mensalmente ao longo da vida do empréstimo. - [Empréstimo consignado CTPS (averbação e ciclo de vida)](https://developers.onz.software/docs/pagamentos/credito-trabalhador/emprestimo/): Sete operações que cobrem o ciclo de vida do empréstimo consignado do trabalhador CLT na Plataforma Crédito do Trabalhador (Dataprev): consulta de ... - [Crypto-as-a-Service (CaaS) na API de Contas](https://developers.onz.software/docs/pagamentos/crypto-caas/jornada): Esta jornada usa a **API de Contas** (`secureapi./api/v2`) para o parceiro BaaS ou a conta operarem compra e venda de criptoativos: regist... - [Carteiras, cotações e ordens](https://developers.onz.software/docs/pagamentos/crypto-caas/operacoes): **Scope:** `crypto-caas.write` para criar carteira, cotação e ordem; `crypto-caas.read` para listar carteiras e consultar/listar ordens. - [Webhook CRYPTO](https://developers.onz.software/docs/pagamentos/crypto-caas/webhook): Cadastre a URL com o tipo `CRYPTO`. O cadastro continua na API de Contas; a entrega dos eventos é feita pelo processador de webhooks. - [Analisar carteira](https://developers.onz.software/docs/pagamentos/crypto-risk/analises): **Scope:** `crypto-risk.write` para criar; `crypto-risk.read` para listar, detalhar e consultar ingestão. - [Risco de carteira cripto na API de Contas](https://developers.onz.software/docs/pagamentos/crypto-risk/jornada): Esta jornada usa a **API de Contas** (`secureapi./api/v2`) para consultar o risco de uma carteira cripto (Ethereum ou Tron) e obter um sna... - [Estatísticas DICT](https://developers.onz.software/docs/pagamentos/estatisticas-dict): A API de Contas (`/api/v2`) expõe as consultas de estatísticas antifraude do DICT, equivalentes às operações da [API DICT do Banco Central](https:/... - [Fila de Saída](https://developers.onz.software/docs/pagamentos/fila-saida): Caso todas as fichas do balde sejam usadas, o usuário ficará temporariamente impossibilitado de realizar as consultas de chaves, ocasionando um rat... - [Processo da Infração](https://developers.onz.software/docs/pagamentos/infracoes): Em casos de suspeita de fraude em uma transação, o processo para tentar recuperar os valores transferidos envolve as seguintes etapas: - [Emitir cobrança](https://developers.onz.software/docs/pagamentos/invoices/cobrancas): **Scope:** `invoices.write` para criar, emitir e cancelar; `invoices.read` para listar e detalhar. - [Cobranças Pix e boleto na API de Contas](https://developers.onz.software/docs/pagamentos/invoices/jornada): Esta jornada usa a **API de Contas** (`secureapi./api/v2`) para emitir cobranças Pix, boleto registrado ou as duas formas no mesmo título ... - [Pagadores](https://developers.onz.software/docs/pagamentos/invoices/pagadores): O `customerId` da cobrança aponta para este cadastro, isolado por conta. Não use o id de cliente do Finance. - [Webhook de cobrança](https://developers.onz.software/docs/pagamentos/invoices/webhook): Cadastre a URL com o tipo `INVOICE`. O cadastro continua na API de Contas (BancoDigitalAPI); a entrega dos eventos é feita pelo processador de webh... - [Mecanismo Especial de Devolução (MED)](https://developers.onz.software/docs/pagamentos/med): O **Mecanismo Especial de Devolução (MED)** é uma funcionalidade destinada a proteger o cliente em casos de fraude, golpes ou erros operacionais en... - [Pagamentos](https://developers.onz.software/docs/pagamentos/): Com a evolução dos sistemas de pagamento, diferentes métodos foram desenvolvidos para facilitar as transações financeiras, cada um com suas particu... - [Configurando Webhook](https://developers.onz.software/docs/pagamentos/webhook-api-contas): Cada chave Pix receptora pode ter um webhook associado. - [Perguntas Frequentes](https://developers.onz.software/docs/perguntas-frequentes): Conforme a Resolução BCB Nº 1, de 12 de agosto de 2020, na Seção II - "Do acesso", existem regras específicas sobre quem pode acessar as informaçõe... - [Roteiro de sugestão de integração](https://developers.onz.software/docs/roteiro-sugestao-integracao): - O certificado digital está sendo usado na conexão? - [Conectar à VPN no Android](https://developers.onz.software/docs/vpn/android): Este procedimento utiliza o aplicativo oficial **OpenVPN Connect**. - [Guia de conexão VPN](https://developers.onz.software/docs/vpn): Este guia explica como configurar o acesso à VPN ONZ a partir do e-mail **Acesso VPN criado**. - [Conectar à VPN no iPhone ou iPad](https://developers.onz.software/docs/vpn/ios): Este procedimento utiliza o aplicativo oficial **OpenVPN Connect**. - [Conectar à VPN no Linux](https://developers.onz.software/docs/vpn/linux): Este procedimento utiliza o cliente oficial **OpenVPN 3 Linux**, operado pelo terminal. - [Conectar à VPN no macOS](https://developers.onz.software/docs/vpn/macos): Este procedimento utiliza o aplicativo oficial **OpenVPN Connect**. - [Conectar à VPN no Windows](https://developers.onz.software/docs/vpn/windows): Este procedimento utiliza o aplicativo oficial **OpenVPN Connect**. - [Gerenciamento de Notificações](https://developers.onz.software/docs/webhook): Webhooks são uma poderosa ferramenta para receber informações sobre eventos de API à medida que eles acontecem. Um evento, como uma cobrança paga o...