Referência API
Contrato interativo das APIs públicas da Nuvende. Os exemplos usam a base de homologação https://api-h.nuvende.com.br. Produção: https://api.nuvende.com.br.
Autenticação padrão: Bearer token obtido no login, com scopes adequados. A conta da operação é a associada ao token: não envie header de conta.
No produto BaaS, a maioria dos endpoints exige também assinatura HMAC (X-Signature, X-Timestamp, X-Nonce). Veja Sobre o BaaS e Assinatura HMAC.
Guia de rotas: Mapa de endpoints. Fluxos narrativos: documentação técnica.
O que está documentado nesta referência
Autenticação: login, logout, refresh e usuário (/api/v2/auth/...).
BaaS: rotas sob /api/v2/baas/.... Dois contextos: plataforma (parceiro integrador) e conta (titular após onboarding). Não misture credenciais nem hmac_secret entre eles.
| Área na sidebar | Conteúdo | Guia |
|---|---|---|
| Onboarding | Propostas, cadastro PF e PJ | Onboarding |
| Contas | Catálogo de contratos, limites, encerramento, contrato da conta | Contratos · Conta titular |
| Relatórios | Status, saldo e extrato | Conta BaaS |
| Chaves Pix | Cadastro, OTP e exclusão (DICT) | Chaves Pix |
| Pix cash-in | QR Code para recebimento na conta | Cash-in |
| Pix pagamentos | Cash-out por chave ou QR | Pagamentos Pix |
| Boletos | Pagamento com saldo da conta | Boletos |
| Webhooks de conta | Eventos da conta titular (Pix, etc.) | Webhooks da conta |
| Webhooks da plataforma | Eventos da plataforma (AccountCredentials, AccountContract) | Webhooks da plataforma |
Contas (Mundo Digital): dados da conta, saldo, extrato e chaves Pix (/api/v2/contas/...).
Cobranças (Cob / QR Code dinâmico): criar e consultar cobranças Pix.
Webhooks de Cobrança: configuração por chave Pix. Evento recebimento (cash-in). Guia: Webhook de recebimento.
Pix > Pagamentos: cash-out sob /api/v2/pix/pagamentos (listar, manual, por chave, por QR Code e confirmar). Webhook de efetivação: evento pagamento em PUT /api/v2/cobranca/webhooks/{chave}. Guias: Pagamentos Pix · Webhook de pagamento.
Pagamentos via Terminais: estabelecimentos, terminais, transações e documentos.
KYC (Know Your Customer): background check de pessoa física e jurídica.
Parceiros: autenticação, aplicações e solicitações de autorização.
Como usar esta seção
- Selecione um endpoint na barra lateral para ver método, path, parâmetros, schemas e exemplos.
- Para BaaS, confira contexto (plataforma vs conta), scopes e HMAC em Sobre o BaaS.
- Para Mundo Digital, confira scopes e fluxos na documentação técnica e em Ambientes.
- Em caso de dúvida transversal: códigos de erro, rate limits e resolução de problemas.
Não sabe por onde começar? Mundo Digital: guia técnico de introdução. BaaS: Sobre o BaaS.