Introdução

Este material contém as orientações técnicas para utilizar nossas APIs e acessar todas as soluções que disponibilizamos para integração de pagamentos digitais.

Funcionalidades Disponíveis

Ambiente de Sandbox

Ambiente de testes para desenvolvimento e homologação de integrações.

• Ambientes de teste isolados
• Chaves de teste específicas
• Dados mockados para desenvolvimento

Autenticação

Autenticação com tokens JWT, refresh automático e controle de sessões.

• Login e logout
• Refresh token
• Usuário autenticado
• Rate limiting

Mundo Digital

APIs da conta digital e Pix (cash-out, cobranças e webhooks).

Conta

• Dados da conta
• Saldo
• Extrato
• Chaves Pix

PIX

Pagamentos (cash-out): listar, iniciar por chave, QR Code ou dados manuais, e confirmar.

• Listar
• Manual
• Por chave
• Por QR Code
• Confirmar

Cobranças: emitir e consultar QR Codes dinâmicos.

• Criar QR Code
• Consultar QR Code

Webhooks: notificações de recebimento Pix.

• Webhooks

BaaS

Banking as a Service: onboarding, gestão de contas, relatórios e Pix.

• Sobre o BaaS
• Criação de contas (onboarding)
• Gestão de contas
• Relatórios (saldo e extrato)
• Pix (cash-out e gerenciamento de chaves)

Pagamentos via Terminais

Gestão de estabelecimentos, terminais e transações de pagamento.

• Estabelecimentos
• Terminais
• Transações

Mundo Físico (POS)

Integração com terminais de pagamento presenciais.

• Ativar POS
• Realizar Pagamento
• Cancelar Venda
• Impressão de Comprovante

Integração com Parceiros

APIs para integração de parceiros e subadquirentes.

• Autenticação de Parceiros
• Autorizações de Parceiros
• Webhooks de Parceiros

Homologação Técnica

Fluxo para homologar a integração antes de produção.

• Casos de Uso
• Envio de Evidências

Exemplos e Recursos

Bibliotecas e materiais práticos para acelerar a integração.

• Exemplos e SDKs
• SDK Node.js, Python e Java
• Collections Postman

Referência Técnica

Guias transversais da API pública.

• Códigos de Erro
• Rate Limits
• Mapa de endpoints
• Resolução de problemas

Como Navegar

Para desenvolvedores iniciantes

1. Comece com Ambientes de Sandbox
2. Configure a Autenticação
3. Explore Conta e PIX

Para desenvolvedores experientes

1. Consulte a Referência da API
2. Use o Mapa de endpoints
3. Configure Webhooks Pix e revise Rate Limits e Códigos de Erro

Para homologação

1. Revise os Casos de Uso
2. Prepare as Evidências
3. Execute os testes no ambiente de sandbox

Ambientes Disponíveis

Sandbox (Homologação)

• URL: https://api-h.nuvende.com.br
• Ambiente para testes e desenvolvimento
• Dados fictícios para validação

Produção

• URL: https://api.nuvende.com.br
• Ambiente para uso em produção
• Acesso mediante aprovação

Como Começar

1. Obtenha suas credenciais de acesso através do suporte da Nuvende
2. Configure o ambiente de sandbox para testes
3. Implemente a autenticação (login com token JWT)
4. Teste as funcionalidades no sandbox
5. Configure webhooks quando aplicável
6. Migre para produção após homologação

Suporte

• Documentação técnica: consulte sempre a documentação oficial antes de implementar
• Referência da API: detalhes de contrato em /reference
• Suporte técnico: entre em contato com a equipe para dúvidas específicas