Total de Usuários PIX
––
Usuários ativos no sistema
Total de Transações
––
Todas as recorrências criadas
Transações Ativas
––
Recorrências processando pagamentos
Pendentes
––
Aguardando processamento
Rejeitadas/Canceladas
––
Transações com erro
Valor Total (R$)
R$ ––
Soma de todas as recorrências
Tendência de Transações
Evolução por status ao longo do tempo
Distribuição por Status
Breakdown das transações
Alertas & Insights
Transações Recentes
Últimas 10 transações criadas
| TXID | Devedor | Valor | Status | Data | Ações |
|---|---|---|---|---|---|
| Carregando... | |||||
Total de Usuários
–
Usuários cadastrados no sistema
Usuários Ativos
–
Usuários habilitados para uso
Total de Transações
–
Transações vinculadas a usuários
📚 Documentação: Como Cadastrar Usuário PIX
Guia completo para cadastrar credenciais do Banco do Brasil
O que é um Usuário PIX?
Um usuário PIX representa um conjunto de credenciais do Banco do Brasil (BB) que permite criar e gerenciar recorrências PIX.
Cada usuário pode ter múltiplas transações associadas.
📋 Campos Obrigatórios
CNPJ: CNPJ da empresa (somente números, 14 dígitos)
Nome/Identificação: Nome descritivo para identificar o usuário (ex: "Loja Principal", "Sandbox Teste")
GW App Key: Chave de aplicação fornecida pelo Banco do Brasil no portal do desenvolvedor
Basic Auth (Base64): Credenciais no formato
clientId:secret codificadas em Base64📝 Campos Opcionais
Chave PIX Recebedor: Chave PIX que receberá os pagamentos (CPF, CNPJ, e-mail, telefone ou chave aleatória)
Nome Recebedor: Nome que aparecerá no QR Code PIX (máx. 140 caracteres)
Cidade Recebedor: Cidade do recebedor (máx. 140 caracteres)
⚠️ Como Obter as Credenciais
1. Portal do Desenvolvedor BB: Acesse o portal do desenvolvedor do Banco do Brasil e crie uma aplicação.
2. GW App Key: Após criar a aplicação, você receberá a GW App Key. Copie e cole no campo correspondente.
3. Basic Auth: Você receberá um Client ID e Client Secret. Para gerar o Basic Auth Base64:
No terminal:
Ou use um conversor online de Base64.
echo -n "clientId:secret" | base64Ou use um conversor online de Base64.
4. Ambiente Sandbox vs Produção: Use credenciais de sandbox para testes e credenciais de produção para ambiente real.
💡 Dicas Importantes
• Mantenha as credenciais seguras e nunca as compartilhe
• Use nomes descritivos para facilitar a identificação (ex: "Produção - Loja A", "Sandbox - Testes")
• Você pode desativar um usuário sem deletá-lo (soft delete)
• Cada usuário pode ter múltiplas API Keys associadas
Cadastrar Novo Usuário PIX
Preencha os dados abaixo para cadastrar um novo usuário PIX
| ID | CNPJ | Nome | Chave PIX | Status | Transações | Ações |
|---|---|---|---|---|---|---|
| Carregando usuários PIX... | ||||||
📭
Nenhum usuário encontrado
Cadastre seu primeiro usuário PIX para começar
Total de Transações
–
Transações cadastradas
Valor Total (R$)
–
Soma de todas as recorrências
Taxa de Sucesso
–
% de transações ativas
Filtros de Busca e Gerenciamento
Use os filtros abaixo para encontrar transações específicas
Mostrando 0 de 0 transações
| TXID ↕ | Devedor ↕ | Valor Recorrência ↕ | Status ↕ | Usuário PIX | Data ↕ | Ações |
|---|---|---|---|---|---|---|
| Carregando transações... | ||||||
📭
Nenhuma transação encontrada
Ajuste os filtros ou crie uma nova transação
Página 1 de 1
Total de API Keys
–
Chaves geradas
Chaves Ativas
–
Chaves em uso
Base URL da API
–
Endpoint principal
Gerar Nova API Key
Crie uma chave de API para integrar sistemas externos
A API Key será vinculada a este usuário PIX
Nome descritivo para identificar a integração
API Key gerada com sucesso!
⚠️ Copie agora, ela não será exibida novamente
📚 Documentação Completa de Integração
Base URL da API
Use esta URL como base para todas as requisições
🔐 Autenticação
Todas as requisições devem incluir o header
X-API-Key com sua chave de API.
X-API-Key:
📡 Endpoints Disponíveis
1. Criar Recorrência PIX (Gerar Pagamento)
POST /jornada3
Cria uma nova recorrência PIX e retorna o QR Code
Ver exemplo completo
cURL:
Body JSON:
2. Consultar Recorrência
GET /recorrencia/:idRec?pixUserId=:userId&txid=:txid
Consulta o status e detalhes de uma recorrência específica
Ver exemplo completo
cURL:
3. Obter QR Code de uma Transação
GET /qrcode/:txid
Retorna o QR Code (imagem base64) e código PIX copia e cola de uma transação
Ver exemplo completo
cURL:
4. Listar Transações (Gerenciar)
GET /transactions?pixUserId=:userId&status=:status&limit=:limit&offset=:offset
Lista todas as transações com filtros opcionais (status, paginação)
Ver exemplo completo
cURL:
Parâmetros opcionais: status (ATIVA, PENDENTE, REJEITADA, etc), limit, offset
🚀 Passo a Passo de Integração
1. Configure a Base URL: Use
2. Adicione o Header de Autenticação: Inclua
X-API-Key: sua-chave-aqui em todas as requisições.
3. Para Gerar Pagamentos: Use POST
/api/v1/pix/jornada3 com os dados do devedor e valores.
4. Para Gerenciar Transações: Use GET
/api/transactions para listar, filtrar e consultar transações.
5. Para Obter QR Codes: Use GET
/api/pix/qrcode/:txid para recuperar QR Codes de transações existentes.
📋 Campos Obrigatórios para Criar Recorrência
pixUserId: ID do usuário PIX (já vinculado à sua API Key)
cpfDevedor: CPF do devedor (11 dígitos, somente números)
nomeDevedor: Nome completo do devedor (máx. 140 caracteres)
contrato: Número do contrato (máx. 35 caracteres)
dataInicial: Data do primeiro pagamento (formato: YYYY-MM-DD)
periodicidade: DIARIA, SEMANAL, QUINZENAL, MENSAL ou ANUAL
politicaRetentativa: PERMITE_3R_7D (padrão) ou PADRAO
valorRec: Valor da recorrência (decimal, ex: 99.90)
valorPrimeiroPagamento: Valor do primeiro pagamento (decimal)
chavePixRecebedor: Chave PIX do recebedor (CPF, CNPJ, e-mail, etc)
nomeRecebedor: Nome do recebedor (máx. 140 caracteres)
cidadeRecebedor: Cidade do recebedor (máx. 140 caracteres)
Opcional: convenio (máx. 35 caracteres)
📥 Estrutura de Resposta
Todas as respostas seguem o formato:
{
"success": true,
"data": { ... }
}
Em caso de erro:
{
"success": false,
"error": "Mensagem de erro"
}
💡 Dicas Importantes
• Mantenha sua API Key segura e nunca a exponha em código frontend
• Use HTTPS em produção para proteger as requisições
• O QR Code é gerado automaticamente após criar a recorrência
• Você pode consultar o status de uma recorrência a qualquer momento
• Use filtros na listagem de transações para melhor performance
• A API retorna imagens QR Code em formato base64 (data URL)
API Keys Cadastradas
Gerencie suas chaves de API
| Nome | Chave (parcial) | Status | Último Uso | Criada em | Ações |
|---|---|---|---|---|---|
| Selecione um usuário PIX acima para listar as chaves. | |||||
Teste PIX - Gerar QR Code
Preencha os dados abaixo para gerar uma recorrência PIX e obter o QR Code e PIX Copia e Cola.