# 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... - [Autenticação](https://developers.onz.software/docs/cobrancas/autenticacao-api-pix): > **Lembrando** que antes é necessário [configurar o certificado MTLS](../perguntas-frequentes.md#configurando-certificado-mtls). - [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 permite que usuários recebedores realizem cobranças periódicas de forma automatizada, com autorização prévia do usuário pagador. O... - [Configurando Webhook](https://developers.onz.software/docs/cobrancas/webhook-api-qrcodes): Cada chave Pix receptora pode ter um webhook associado. - [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. - [Consultar saldo FGTS](https://developers.onz.software/docs/pagamentos/credito-trabalhador/dataprev/consultar-saldo-fgts): Consulta as informações de saldo FGTS do trabalhador na Dataprev. Exige autorização com status `ACCEPTED`. - [Consultar status da autorização FGTS](https://developers.onz.software/docs/pagamentos/credito-trabalhador/dataprev/consultar-status-autorizacao): Consulte periodicamente o status até que o trabalhador aceite, recuse ou a autorização expire. - [Enviar autorização FGTS por e-mail](https://developers.onz.software/docs/pagamentos/credito-trabalhador/dataprev/enviar-autorizacao-fgts): Envia ao trabalhador o link para autorizar a consulta das informações do FGTS na Dataprev. - [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 ... - [Originação IF a partir do lead CLT](https://developers.onz.software/docs/pagamentos/credito-trabalhador/origination-if/jornada): Caminho da API de Contas equivalente ao botão **Cadastrar IF** da mesa Finance: listar o lead, cadastrar o trabalhador (`CREDIT_CONSIGNADO_WORKER`)... - [Enviar propostas a partir do lead](https://developers.onz.software/docs/pagamentos/credito-trabalhador/propostas-econsignado-clt/enviar-propostas): **Endpoint:** `POST /econsigado/employee/clt-leads/{id}/proposal` - [Listar leads do leilão CLT](https://developers.onz.software/docs/pagamentos/credito-trabalhador/propostas-econsignado-clt/listar-leads): Lista os leads do Crédito do Trabalhador disponíveis para a conta autenticada. - [Registrar desfecho da proposta](https://developers.onz.software/docs/pagamentos/credito-trabalhador/propostas-econsignado-clt/registrar-desfecho): Após acompanhar na CTPS Digital se o trabalhador aceitou ou recusou a proposta, registre o desfecho. - [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...