Bem-vindo à documentação da API Pix da Dados Jah!
\nEsta API permite que o seu sistema (site, aplicativo, ERP, e-commerce ou qualquer outro software) crie cobranças Pix, receba pagamentos, consulte transações, faça devoluções e gerencie contas bancárias — tudo de forma automatizada, sem precisar acessar o internet banking do banco.
\n\n\nResumo : Pix é o sistema de pagamentos instantâneos do Banco Central. Com esta API, o seu programa \"conversa\" diretamente com os bancos e PSPs para emitir QR Codes, receber notificações de pagamento e movimentar dinheiro em tempo real.
\n
O Pix é um meio de pagamento eletrônico criado pelo Banco Central do Brasil. Ele permite transferir dinheiro de uma conta para outra em segundos, a qualquer dia e horário, incluindo fins de semana e feriados.
\nExistem duas formas principais de usar o Pix:
\nPara pagar: uma pessoa escaneia um QR Code ou usa a opção \"Pix Copia e Cola\" no aplicativo do banco.
\nPara receber: uma empresa gera um QR Code ou uma string Pix e envia para o cliente pagar.
\nA API da Dados Jah cuida de gerar esses QR Codes e strings, consultar se o pagamento foi feito e devolver o dinheiro quando necessário.
\nEm vez de você precisar integrar o seu sistema diretamente com cada banco (Bradesco, Itaú, Inter, etc.), você se comunica apenas com a API Dados Jah. Nós cuidamos da parte complexa da conversa com os bancos.
\nQuando usar: venda no e-commerce, checkout de loja, cobrança por serviço.
\nCaracterísticas:
\nTem uma data de expiração (ex: 1 hora, 24 horas).
\nPode ser pago apenas uma vez.
\nMostra o valor exato e informações do devedor.
\nIdeal para cobranças personalizadas.
\nEndpoint: POST /cob
Quando usar: substituir boletos, faturas mensais, carnês, parcelamentos.
\nCaracterísticas:
\nTem uma data de vencimento definida.
\nApós o vencimento, pode aplicar juros, multa e descontos por antecipação.
\nO valor pode mudar conforme a data de pagamento.
\nEndpoint: POST /cobv
Quando usar: doações, caixas de loja física, cobranças sem identificação do cliente.
\nCaracterísticas:
\nPode ser reutilizado infinitas vezes.
\nPode ter valor fixo ou deixar o cliente digitar o valor.
\nNão gera \"txid\" nem identifica o pagador automaticamente.
\nEndpoint: POST /cob/generate-static-qrcode
O ambiente (homologação ou produção) é definido por conta bancária através do campo tpAmb no cadastro da conta (POST /user/account). Isso permite que um mesmo usuário tenha contas em homologação e produção simultaneamente.
tpAmb: 0)O que é: um ambiente seguro que simula o banco real.
\nDinheiro real? Não. Todos os valores são fictícios.
\nObjetivo: testar a integração sem risco.
\nComo usar:
\nCadastre a conta com \"tpAmb\": 0.
Use as credenciais de teste fornecidas pelo PSP.
\nCrie cobranças, faça pagamentos simulados e valide os fluxos.
\nCuidados:
\nNão use certificados de produção.
\nNão envie CPF/CNPJ de clientes reais em testes desnecessários.
\nPSPs diferentes têm regras diferentes de sandbox; consulte a documentação do seu banco.
\ntpAmb: 1)O que é: o ambiente onde pagamentos reais acontecem.
\nDinheiro real? Sim. Todo pagamento e devolução movimenta valores reais.
\nComo usar:
\nSó libere após todos os testes em homologação estarem aprovados.
\nCadastre a conta com \"tpAmb\": 1.
Use certificados reais emitidos pelo PSP.
\nUse clientId e clientSecret reais.
Cuidados:
\nNunca exponha clientSecret, tokens ou certificados em código público.
Faça backup dos certificados em local seguro.
\nTenha um processo de conciliação diária.
\n\n\n⚠️ Atenção: uma única conta não pode misturar ambientes. Se precisar testar e operar ao mesmo tempo, crie duas contas: uma com
\ntpAmb: 0(homologação) e outra comtpAmb: 1(produção), cada uma com suas respectivas credenciais e certificados.
Na API Dados Jah existem dois atores principais:
\nSistema: quem administra a plataforma, cria usuários e gerencia contas.
\nUsuário (cliente): quem emite cobranças, recebe pagamentos e faz devoluções.
\nComo funciona na prática:
\nPrimeiro, você usa as rotas do Sistema (/auth/system/login, /system/user, etc.) para criar o usuário/
cliente que vai operar.
Depois que o usuário está criado, você passa a usar as rotas do Usuário (/auth/user/login, / cob, /pix, etc.) para emitir cobranças, receber pagamentos e fazer devoluções.
\n\nResumo: o Sistema é usado para \"fazer o cadastro inicial\". A partir daí, o dia a dia da operação financeira acontece pelas rotas do Usuário.
\n
Você precisa de:
\nUma conta na Dados Jah (sistema).
\nUma conta bancária com Pix habilitado no PSP escolhido.
\nAs credenciais do PSP (clientId, clientSecret, certificado, etc.).
Diferente de outras APIs que usam URLs diferentes para cada ambiente, aqui o ambiente é definido por conta bancária através do campo tpAmb:
0 = Sandbox / Homologação (testes)
1 = Produção (dinheiro real)
2 = Pré-Produção (se o PSP oferecer)
Isso permite que uma única aplicação opere contas de teste e contas reais ao mesmo tempo.
\nPara rotas administrativas: POST /auth/system/login.
Para rotas do cliente: POST /auth/user/login.
Guarde o accessToken retornado. Ele deve ser enviado no cabeçalho Authorization: Bearer {token}.
Use POST /user/account informando:
nome da conta;
\nPSP escolhido (ex: INTER, ITAU, BRADESCO);
tipo e valor da chave Pix;
\nclientId e clientSecret;
tpAmb: 0 para homologação, 1 para produção;
scopes necessários;
\nse a conta está ativa.
\nUse POST /certificate enviando o arquivo convertido para Base64 e a extensão correta (.pfx, .crt, .key). É possível enviar múltiplos certificados para uma mesma conta, desde que tenham extensões diferentes. Arquivos com a mesma extensão substituirão os existentes.
Use POST /cob para gerar um Pix Copia e Cola e testar o fluxo completo.
Imagine que você quer vender um produto de R$ 10,00.
\nPOST https://dadosjah-pix-api.jdmo92.easypanel.host/v1/auth/user/login\nContent-Type: application/json\n{\n \"email\": \"usuario@empresa.com\",\n \"password\": \"SuaSenhaSegura\"\n}\n\nResposta esperada:
\n{\n \"statusCode\": 201,\n \"data\": {\n \"accessToken\": \"eyJhbGciOiJIUzI1NiIs...\"\n }\n}\n\nGuarde esse token. Ele será usado em todas as próximas chamadas.
\nPOST https://dadosjah-pix-api.jdmo92.easypanel.host/v1/user/account\nAuthorization: Bearer \nContent-Type: application/json\n[\n {\n \"nameAccount\": \"Conta Principal\",\n \"psp\": \"INTER\",\n \"keyTypePIX\": \"EMAIL\",\n \"keyPIX\": \"financeiro@empresa.com\",\n \"clientId\": \"seu-client-id-do-inter\",\n \"clientSecret\": \"seu-client-secret-do-inter\",\n \"scopes\": [\"scCobWrite\", \"scCobRead\", \"scPixWrite\", \"scPixRead\"],\n \"active\": true\n }\n]\n\nDica: salve o idAccount retornado em uma variável de ambiente do Postman.
POST https://dadosjah-pix-api.jdmo92.easypanel.host/v1/cob\nAuthorization: Bearer \nContent-Type: application/json\n{\n \"async\": false,\n \"idAccount\": \"\",\n \"cobs\": [\n {\n \"reqOriginalValue\": \"10.00\",\n \"reqExpirationSeconds\": 3600,\n \"reqDebtorCPFCNPJ\": \"02598982000190\",\n \"reqDebtorName\": \"João Silva\"\n }\n ]\n}\n\nResposta esperada:
\n{\n \"statusCode\": 201,\n \"data\": {\n \"resTxIdCob\": \"...\",\n \"resPixCopyandPaste\": \"00020101021226860014br.gov.bcb.pix2567...\",\n \"resStatus\": \"ATIVA\"\n }\n}\n\nO campo resPixCopyandPaste contém uma string grande. Você pode:
mostrá-la como texto para o cliente copiar e colar no banco;
\ntransformá-la em imagem de QR Code na sua aplicação.
\nQuando o cliente pagar, você pode consultar da seguinte forma:
\nGET /cob com forceUpdate=true para confirmar o status.Os scopes definem o que cada token pode fazer. Quando você cadastra uma conta Pix (POST /user/account), deve informar quais scopes ela precisa.
\n\nDica prática: para a maioria dos casos, comece com
\n[\"scCobWrite\", \"scCobRead\", \"scPixWrite\", \"scPixRead\"].
Cada banco/PSP exige credenciais e certificados diferentes. Consulte abaixo o que é necessário para cada um:
\nPFX / P12: arquivo único que contém certificado + chave privada.
\nKEY: arquivo com a chave privada.
\nCRT: arquivo com o certificado público.
\nRoot: certificado raiz da autoridade certificadora.
\nClientID / ClientSecret: identificador e senha da aplicação fornecidos pelo banco.
\nAccessToken / Token: token de acesso direto fornecido por alguns PSPs.
\nValores monetários: sempre string com ponto decimal e duas casas.
\n✅ Correto: \"150.00\", \"10.50\", \"0.99\"
❌ Incorreto: 150.00 (número), \"150,00\" (vírgula)
Datas e horas: padrão ISO 8601 com fuso horário.
\n\"2026-06-26T17:00:29-03:00\"txid: de 26 a 35 caracteres, letras e números apenas.
\nBooleanos: true ou false, sem aspas.
Em caso de erro:
\n{\n \"statusCode\": 400,\n \"error\": \"Bad Request\",\n \"message\": [\"Campo reqOriginalValue é obrigatório\"]\n}\n\nPara listas, envie:
\npage: número da página (começa em 1).
pageSize: quantidade de itens por página.
A resposta trará:
\ncurrentPage: página atual.
totalPages: total de páginas.
totalItens: total de registros encontrados.
situation — status interno da API Dados JahresStatus — status oficial da cobrança no Banco CentralkeyTypePIX — tipos de chave PixCausas mais comuns:
\nToken não foi enviado no header Authorization.
Token expirado.
\nToken de sistema usado em rota de usuário, ou vice-versa.
\nComo resolver:
\nFaça login novamente e copie o novo accessToken.
Verifique se o header está no formato correto: Authorization: Bearer eyJhbG....
Confirma se está usando o token correto para a rota.
\nCausas mais comuns:
\nCampo obrigatório faltando.
\nValor enviado como número em vez de string.
\nCPF/CNPJ inválido.
\nData no formato errado.
\nComo resolver:
\nLeia a mensagem de erro retornada no campo message.
Compare o seu payload com os exemplos desta documentação.
\nValide CPF/CNPJ antes de enviar.
\nCausas mais comuns:
\nO token não tem o scope necessário para a operação.
\nA conta Pix usada não tem permissão para aquela ação.
\nComo resolver:
\nVerifique os scopes cadastrados em POST /user/account.
Inclua todos os scopes necessários para o fluxo.
\nCausas mais comuns:
\ntxid já foi usado em outra cobrança.
Usuário ou e-mail já cadastrado.
\nComo resolver:
\nGere um novo txid único.
Para usuários, verifique se o e-mail/CPF já existe.
\nCausas mais comuns:
\nO PSP rejeitou os dados.
\nCertificado incorreto ou expirado.
\nclientId/clientSecret inválidos.
Como resolver:
\nTeste as credenciais diretamente no portal do desenvolvedor do PSP.
\nVerifique se o certificado ainda é válido.
\nConfirme se está usando o ambiente correto (homologação vs produção).
\nCausas mais comuns:
\nFalha interna na API ou no PSP.
\nTimeout na comunicação com o banco.
\nComo resolver:
\nAguarde alguns segundos e tente novamente.
\nVerifique o campo situation: se for Error, leia a mensagem detalhada.
Se persistir, entre em contato com o suporte.
\nidBatch para acompanhamento.ATIVA até o prazo de expiração. Após isso, o PSP pode removê-la automaticamente.Na API Dados Jah, o ambiente é definido pelo campo tpAmb de cada conta bancária cadastrada. Consulte o valor do tpAmb na resposta do GET /user/account:
Na prática: se sua conta tem tpAmb: 0, você está em homologação (testes, sem dinheiro real). Se tem tpAmb: 1, está em produção (transações reais). As credenciais e certificados devem ser compatíveis com o ambiente da conta.
POST /user/account quantas vezes forem necessárias, desde que cada conta tenha uma chave Pix e credenciais válidas.Nunca compartilhe clientSecret, tokens JWT ou certificados.
Armazene segredos em variáveis de ambiente, nunca no código-fonte.
\nUse sempre HTTPS em produção.
\nRenove certificados antes do vencimento.
\nMonitore logs e transações regularmente.
\nSe ficou com dúvidas ou encontrou algum problema, nossa equipe está pronta para ajudar:
\nE-mail: cda@ctec.com.br
\nWhatsApp: (33) 3271-9900
\nSite: https://dadosjah.com.br
\nAutentica um usuário do sistema com suas credenciais (e-mail e senha), retornando um token de acesso para uso nas demais requisições protegidas.
\nPOST https://dadosjah-pix-api.jdmo92.easypanel.host/v1/auth/system/login
Encerra a sessão do sistema autenticado, invalidando o token de acesso atual.
\nPOST https://dadosjah-pix-api.jdmo92.easypanel.host/v1/auth/system/logout
Inicia o fluxo de recuperação de senha do sistema, enviando um e-mail com instruções e token para redefinição da senha ao endereço cadastrado.
\nPOST https://dadosjah-pix-api.jdmo92.easypanel.host/v1/auth/system/login
Redefine a senha do sistema a partir de um token de recuperação previamente enviado. Este endpoint conclui o fluxo de recuperação de senha iniciado pelo endpoint \"Esqueci a Senha\".
\nPOST https://dadosjah-pix-api.jdmo92.easypanel.host/v1/auth/system/reset
Atualiza parcialmente os dados cadastrais de um usuário específico, com permissões de nível sistema (administrador).
\nPATCH https://dadosjah-pix-api.jdmo92.easypanel.host/v1/user
Inativa um ou mais usuários do sistema, removendo seu acesso sem excluir permanentemente os dados cadastrais.
\nDELETE https://dadosjah-pix-api.jdmo92.easypanel.host/v1/user
Retorna uma lista paginada de todos os usuários cadastrados no sistema, permitindo visualização e gerenciamento dos registros.
\nGET https://dadosjah-pix-api.jdmo92.easypanel.host/v1/user/list
Busca e retorna usuários cadastrados no sistema com base em filtros ou parâmetros de pesquisa informados na requisição.
\nGET https://dadosjah-pix-api.jdmo92.easypanel.host/v1/user
Reativa usuários previamente inativados no sistema, restaurando seu acesso e status ativo.
\nPATCH https://dadosjah-pix-api.jdmo92.easypanel.host/v1/user/restore
Cria um novo usuário no sistema com os dados informados no corpo da requisição.
\nPOST https://dadosjah-pix-api.jdmo92.easypanel.host/v1/user
Atualiza parcialmente os dados da conta do sistema autenticado, como informações de perfil ou configurações.
\nPATCH https://dadosjah-pix-api.jdmo92.easypanel.host/v1/system
Retorna os dados da conta do sistema atualmente autenticado, como informações de perfil e configurações associadas.
\nGET https://dadosjah-pix-api.jdmo92.easypanel.host/v1/system
Autentica um usuário final (cliente) com suas credenciais, retornando um token de acesso para uso nas demais requisições protegidas do contexto de usuário.
\nPOST https://dadosjah-pix-api.jdmo92.easypanel.host/v1/auth/user/login
Encerra a sessão do usuário final autenticado, invalidando o token de acesso atual.
\nPOST https://dadosjah-pix-api.jdmo92.easypanel.host/v1/auth/user/logout
Inicia o fluxo de recuperação de senha do usuário final, enviando um e-mail com instruções e token para redefinição da senha ao endereço cadastrado.
\nPOST https://dadosjah-pix-api.jdmo92.easypanel.host/v1/auth/user/forget
Redefine a senha do usuário final a partir de um token de recuperação previamente enviado por e-mail. Este endpoint conclui o fluxo de recuperação de senha iniciado pelo endpoint \"Esqueci a Senha (Usuário)\".
\nPOST https://dadosjah-pix-api.jdmo92.easypanel.host/v1/auth/user/reset
O submódulo Autenticação - Usuário é responsável por gerenciar todas as operações relacionadas à autenticação e segurança dos usuários do sistema. Ele oferece funcionalidades essenciais, como login, recuperação de senha, modificação de dados e acesso à conta do usuário autenticado. Este submódulo garante o controle seguro do acesso ao sistema, utilizando tokens de autenticação para proteger as operações realizadas pelos usuários.
\n","_postman_id":"64673b8c-88e5-4d12-a92c-b67cb962840a"}],"id":"00d94ff8-d496-41d8-930a-5aeb9eaf2ac9","description":"O módulo de autenticação é responsável por gerenciar o acesso dos usuários ao sistema. Ele oferece recursos para acessar as informações da conta, acessar o sistema, recuperar credenciais e modificar informações do perfil.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"6b86710c-ebb1-4daf-918e-97c88b8de072"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":["",""],"id":"b5d3bd12-2a7a-4989-9809-2d6decfa82d6"}}],"_postman_id":"00d94ff8-d496-41d8-930a-5aeb9eaf2ac9"},{"name":"Cob","item":[{"name":"Criar Cobrança","event":[{"listen":"test","script":{"id":"24b28333-899c-4cb7-8ec5-5c3381113fad","exec":["// Transforma a resposta em JSON","const response = pm.response.json();","","// Verifica se a requisição foi um sucesso e se retornou a listagem de cobranças","if (response && response.data && response.data.cobs && response.data.cobs.length > 0) {"," "," // Pega a primeira cobrança (já que criamos apenas 1 neste teste)"," const cob = response.data.cobs[0];"," "," // Salva o ID da Transação (TxId)"," if (cob.resTxIdCob) {"," pm.environment.set(\"resTxIdCob\", cob.resTxIdCob);"," console.log(\"Variável 'txId' salva:\", cob.resTxIdCob);"," }"," "," // Salva o Pix Copia e Cola (qrCode)"," if (cob.resPixCopyandPaste) {"," pm.environment.set(\"qrCode\", cob.resPixCopyandPaste);"," console.log(\"Variável 'qrCode' salva:\", cob.resPixCopyandPaste);"," }","} else {"," console.error(\"Não foi possível encontrar cobranças na resposta para extrair as variáveis.\");","}",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"8615c3cc-0602-4015-b914-d5f6ce808423","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"async\": {{async}}, // async: Define se o processamento será assíncrono (true/false)\n \"idAccount\": \"\", // idAccount: Identificador da conta bancária de destino (UUID)\n \"cobs\": [ // cobs: Lista contendo os objetos de cobrança a serem criados\n {\n \"reqOriginalValue\": \"{{reqOriginalValue}}\", // reqOriginalValue: Valor original da cobrança (Ex: \"10.00\")\n \"reqExpirationSeconds\": {{reqExpirationSeconds}}, // reqExpirationSeconds: Tempo de expiração em segundos (Ex: 3600)\n \"reqRequestPayer\": \"{{reqRequestPayer}}\", // reqRequestPayer: Mensagem de solicitação ao pagador\n \"reqDebtorCPFCNPJ\": \"\", // reqDebtorCPFCNPJ: Documento (CPF/CNPJ) do devedor\n \"reqDebtorName\": \"{{reqDebtorName}}\", // reqDebtorName: Nome completo ou razão social do devedor\n \"reqModalityChange\": {{reqModalityChange}} // reqModalityChange: Permite que o pagador altere o valor (true/false)\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dadosjah-pix-api.jdmo92.easypanel.host/v1/cob","description":"Cria uma cobrança Pix imediata (COB) para um ou mais devedores, retornando o TxId e o QR Code (Pix Copia e Cola) para pagamento.
\nPOST https://dadosjah-pix-api.jdmo92.easypanel.host/v1/cob
Em caso de sucesso (201 Created), o script pós-resposta salva automaticamente as seguintes variáveis de ambiente a partir do primeiro item retornado em response.data.cobs[0]:
resTxIdCob — TxId da cobrança gerada, utilizado para consultas e confirmações posteriores.Atualiza ou revisa os dados de uma cobrança Pix imediata já existente. Permite alterar informações como valor, descrição ou dados do devedor antes que o pagamento seja efetuado.
\nPUT https://dadosjah-pix-api.jdmo92.easypanel.host/v1/cob
Pesquisa uma cobrança Pix imediata existente com base no TxId informado. Permite forçar a atualização do status da cobrança diretamente na instituição financeira.
\nGET https://dadosjah-pix-api.jdmo92.easypanel.host/v1/cob?resTxIdCob={{resTxIdCob}}&forceUpdate={{forceUpdate}}
Pesquisa uma cobrança Pix imediata específica utilizando o ID interno da cobrança (idCob). Diferente da busca por TxId, este endpoint utiliza o identificador interno do sistema.
GET https://dadosjah-pix-api.jdmo92.easypanel.host/v1/cob?idCob={{idCob}}
Lista todas as cobranças Pix imediatas associadas a uma conta específica. Útil para obter um panorama geral das cobranças geradas.
\nGET https://dadosjah-pix-api.jdmo92.easypanel.host/v1/cob/search?idAccount
Pesquisa e retorna todas as cobranças Pix imediatas que já foram finalizadas (pagas ou expiradas), forçando a atualização dos status junto à instituição financeira.
\nGET https://dadosjah-pix-api.jdmo92.easypanel.host/v1/cob/search?isFinished=true&forceUpdate=true
Cancela uma cobrança Pix imediata que ainda não foi paga. Após o cancelamento, a cobrança não poderá mais ser utilizada para pagamento.
\nPOST https://dadosjah-pix-api.jdmo92.easypanel.host/v1/cob/cancel
Cria uma nova cobrança Pix com vencimento (cobv). Diferente das cobranças imediatas (cob), este tipo de cobrança possui uma data de vencimento definida, sendo indicada para pagamentos agendados ou com prazo determinado.
\nPOST https://dadosjah-pix-api.jdmo92.easypanel.host/v1/cobv
Atualiza ou revisa os dados de uma cobrança Pix com vencimento (cobv) já existente. Permite alterar informações como valor, dados do devedor ou data de vencimento antes que o pagamento seja efetuado.
\nPUT https://dadosjah-pix-api.jdmo92.easypanel.host/v1/cobv
Pesquisa e retorna todas as cobranças Pix com vencimento (cobv) que já foram finalizadas (pagas ou expiradas), forçando a atualização dos status junto à instituição financeira.
\nGET https://dadosjah-pix-api.jdmo92.easypanel.host/v1/cobv/search?isFinished=true&forceUpdate=true
Pesquisa uma cobrança Pix com vencimento (cobv) específica, forçando a atualização do seu status junto à instituição financeira. Diferente das cobranças imediatas (cob), as cobranças com vencimento possuem data de vencimento definida.
\nGET https://dadosjah-pix-api.jdmo92.easypanel.host/v1/cobv?forceUpdate=true
Pesquisa cobranças Pix com vencimento (cobv) associadas a um lote específico, utilizando o ID do lote como filtro. Útil para rastrear cobranças geradas em conjunto.
\nGET https://dadosjah-pix-api.jdmo92.easypanel.host/v1/cobv?idBatch=
Lista e filtra cobranças Pix com vencimento (cobv) de uma conta, com suporte a múltiplos filtros como período, status, CPF/CNPJ do devedor e presença de location. Ideal para relatórios e consultas avançadas.
\nGET https://dadosjah-pix-api.jdmo92.easypanel.host/v1/cobv/search?idAccount=&reqStartDate={{reqStartDate}}&reqEndDate={{reqEndDate}}&resStatus={{resStatus}}&reqDebtorCPFCNPJ=&reqLocationPresent={{reqLocationPresent}}
Cancela uma cobrança Pix com vencimento (cobv) que ainda não foi paga. Diferente das cobranças imediatas (cob), as cobranças com vencimento possuem data de vencimento definida. Após o cancelamento, a cobrança não poderá mais ser utilizada para pagamento.
\nPOST https://dadosjah-pix-api.jdmo92.easypanel.host/v1/cobv/cancel
Envia e cadastra um certificado digital para autenticação mTLS (mutual TLS). O certificado é necessário para estabelecer comunicação segura com a API Pix, garantindo a identidade do cliente na camada de transporte.
\nPOST https://dadosjah-pix-api.jdmo92.easypanel.host/v1/certificate
Consulta o certificado digital cadastrado para uma conta específica, filtrando pelo tipo/extensão do certificado. Permite verificar se um certificado está ativo e válido para autenticação mTLS.
\nGET https://dadosjah-pix-api.jdmo92.easypanel.host/v1/certificate?idAccount=...&extension=crt
Consulta e lista todos os Pix recebidos em uma conta específica. Retorna o histórico de transações Pix recebidas, incluindo informações como valor, pagador e data/hora do recebimento.
\nGET https://dadosjah-pix-api.jdmo92.easypanel.host/v1/pix/recebidos?idAccount=
Consulta os detalhes de uma transação Pix específica utilizando o identificador end-to-end (endToEndId) e o ID da conta. Retorna informações completas sobre a transação, como valor, pagador, recebedor e status.
GET https://dadosjah-pix-api.jdmo92.easypanel.host/v1/pix/consultar?endToEndId={{endToEndId}}&idAccount=
Solicita a devolução total ou parcial de um Pix recebido. A devolução é iniciada pelo recebedor e deve ser solicitada dentro do prazo permitido pelo Banco Central.
\nPOST https://dadosjah-pix-api.jdmo92.easypanel.host/v1/pix/devolucao
Consulta o status e os detalhes de uma devolução Pix previamente solicitada, utilizando o identificador end-to-end da transação original, o ID da devolução e o ID da conta.
\nGET https://dadosjah-pix-api.jdmo92.easypanel.host/v1/pix/devolucao?endToEndId={{endToEndId}}&idDevolucao={{idDevolucao}}&idAccount=
Gera um QR Code Pix estático para recebimento de pagamentos. O QR Code estático pode ser configurado com ou sem valor fixo e pode ser reutilizado múltiplas vezes, sendo ideal para cobranças recorrentes ou pontos de venda.
\nPOST https://dadosjah-pix-api.jdmo92.easypanel.host/v1/cob/generate-static-qrcode
Vincula uma nova conta bancária/PIX ao usuário autenticado, permitindo que ela seja utilizada em operações de pagamento e recebimento via PIX.
\nPOST https://dadosjah-pix-api.jdmo92.easypanel.host/v1/user/account
f
\nGET https://dadosjah-pix-api.jdmo92.easypanel.host/v1/user/account
Atualiza parcialmente os dados de uma conta bancária/PIX vinculada ao usuário autenticado.
\nPATCH https://dadosjah-pix-api.jdmo92.easypanel.host/v1/user/account
O submódulo de Contas do Usuário permite gerenciar as configurações bancárias e de integração associadas aos perfis do sistema, oferecendo funcionalidades para listar, criar e atualizar as credenciais de pagamento de forma centralizada. Ele atua como o núcleo de configuração que conecta o sistema aos Provedores de Serviços de Pagamento (PSPs).
\nEste componente é essencial para a automação financeira, permitindo que o sistema realize a geração dinâmica de cobranças via PIX e a conciliação automática de recebíveis. Através do armazenamento seguro de credenciais como clientId, clientSecret e chaves PIX, o submódulo garante que a comunicação entre a plataforma e a instituição financeira seja direta e protegida.
Retorna os dados da conta do usuário final atualmente autenticado, como informações de perfil e dados cadastrais.
\nGET https://dadosjah-pix-api.jdmo92.easypanel.host/v1/user
Atualiza parcialmente os dados cadastrais do próprio usuário final autenticado, como nome, e-mail ou senha.
\nPATCH https://dadosjah-pix-api.jdmo92.easypanel.host/v1/user
Este submódulo é fundamental para organizar, controlar e manter as informações de usuários no sistema de maneira eficiente e estruturada.
\n","_postman_id":"e9e6753e-e0c8-4d35-9bdb-5e73c7ffd5f3"}],"id":"c5faf16e-5733-463a-9aed-6e029c14afca","_postman_id":"c5faf16e-5733-463a-9aed-6e029c14afca","description":""},{"name":"Status","item":[{"name":"Status - API","id":"744b0d27-4187-4962-8bb1-f87f1cc36af5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dadosjah-pix-api.jdmo92.easypanel.host/v1/health/api","urlObject":{"path":["health","api"],"host":["https://dadosjah-pix-api.jdmo92.easypanel.host/v1"],"query":[],"variable":[]}},"response":[{"id":"6cf967ce-c281-4769-ae22-1f203e7f2e46","name":"Status - API","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://dadosjah-pix-api.jdmo92.easypanel.host/v1/health/api"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": \"{{status}}\", // Status da API: \"ok\" ou error\" \n \"timestamp\": \"{{timestamp}}\", // ISO 8601 do momento da requisicao \n \"uptime\": {{uptime}}, // Segundos desde o inicio do processo Node \n \"service\": \"{{service}}\" // Nome identificador do servico \n}"}],"_postman_id":"744b0d27-4187-4962-8bb1-f87f1cc36af5"}],"id":"3d49ad89-dc60-4354-a3c9-2a501d2290cd","description":"Esta pasta agrupa os endpoints de verificação de saúde da API. Ela contém requisições utilizadas para verificar o status operacional da API, garantindo que o serviço está disponível e respondendo corretamente. Use estas requisições para validar rapidamente a conectividade e confirmar que o backend está ativo e funcionando antes de executar outros fluxos.
\nPágina de status: https://pool-uptime-kuma-003.cloud.pageup.dev.br/status/dados-jah-pix
\n","_postman_id":"3d49ad89-dc60-4354-a3c9-2a501d2290cd"},{"name":"Consultar Requisições","id":"9e2b920d-9182-4353-ad7b-3a81b318ffd1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"pageSize\": {{pageSize}}, // O número máximo de itens a serem retornados por página. Exemplo: 10, 20, 50.\r\n \"page\": {{page}} // O número da página solicitada (começando por 1). Exemplo: 1, 2, 3.\r\n}"},"url":"https://dadosjah-pix-api.jdmo92.easypanel.host/v1/request","description":"Lista e consulta o histórico de requisições realizadas na API. Útil para auditoria, rastreamento de operações e diagnóstico de problemas em integrações.
\nGET https://dadosjah-pix-api.jdmo92.easypanel.host/v1/request