Área do cliente
Painel do doador
Documentação Técnica

API de transações: referência do JSON

A API de transações entrega, em JSON, o que a tela de Transações mostra: cada doação com doador, valores, forma, origem e recorrência. Serve para alimentar um ERP, um painel no Power BI ou Looker, uma planilha viva, ou qualquer sistema da organização. Este artigo é a referência: como autenticar, como consultar e o que significa cada campo.

8 min de leituraAtualizado em 7 de setembro de 2026Documentação Técnica
Em resumo
  • O token é gerado em Integrações › Credenciais para integração com a API.
  • Autenticação por Bearer token no cabeçalho Authorization.
  • Consultas com filtros de período, status, campanha e forma, paginadas em 100.
  • Cada transação traz 19 campos: identificação, doador, valores, forma, origem e UTMs.
  • Valores em decimal, datas em ISO 8601 com fuso, moeda em ISO 4217.
Neste artigo
  1. Token
  2. Consultar
  3. Os campos
  4. Exemplo

Gerar o token

painel.doare.org/dashboard/integrations
Instituto Semear
Dashboard
Gestão
Captação
Relacionamento
Finanças
Análise
Configurações
Personalizar Remetente
Usuários
Bloqueio de usuários
Integrações
Dados da Organização
Planos
Ajuda
DashboardIntegrações
PTMarinaM
Integrações
Credenciais para integração com a API de Transações (JSON)
Token gerado em 12/08/2026 · último uso hoje às 09:14 · 1.240 requisições nos últimos 7 dias
Token
dr_live_8f3k2m9pq7w1x4z8n2b6v5c3h9j4l1k7
Envie no cabeçalho Authorization: Bearer <token>. Guarde como senha.
Permissões do token
Ler transações
Ler assinaturas
Ler doadores
Ler campanhas e links
Copiar tokenGerar novo tokenRevogar
Limite: 600 requisições por minuto. Respostas paginadas em 100 itens.
Fechar
O card da API em Integrações: o token, as permissões, o uso recente e as ações.
  1. Em Configurações › Integrações, abra Credenciais para integração com a API de Transações

    Só administradores ou usuários com permissão de Configurações.

  2. Gere o token e copie

    Ele aparece uma vez inteiro. Guarde num cofre de segredos; nunca no código-fonte nem em planilha.

  3. Escolha as permissões

    Só leitura, por escopo: transações, assinaturas, doadores, campanhas.

  4. Use no cabeçalho Authorization

    Authorization: Bearer dr_live_…. Vazou? Revogue e gere outro; o antigo morre na hora.

Consultar transações

Exemplo de requisição
GET /v1/transacoes?data_inicio=2026-08-01&data_fim=2026-08-31&status=pago&pagina=1
Authorization: Bearer dr_live_8f3k…
Accept: application/json
ParâmetroO que faz
data_inicio, data_fimPeríodo pela data da transação (AAAA-MM-DD).
statuspago, pendente, cancelado, reembolsado, falhou.
campanhaId ou slug da campanha.
forma_pagamentopix, boleto, cartao_credito, paypal…
tipo_captacaolink_doacao, crowdfunding, evento, rifa, leilao.
recorrentetrue ou false.
atualizado_desdeSó o que mudou depois de uma data e hora: para sincronizações incrementais.
paginaPaginação em 100 itens; a resposta traz total e proxima_pagina.

Para manter um sistema sincronizado, consulte com atualizado_desde a cada hora, ou use os webhooks para ser avisado na hora e a API só para conferir.

Quais campos o JSON traz?

CampoDescriçãoFormato
idIdentificador único da transação na Doare.inteiro
doador_idIdentificador único do doador no CRM.inteiro
doador_nomeNome do doador conforme cadastrado.texto
doador_emailE-mail informado no momento da doação.texto
dataData e hora da transação, com fuso horário.ISO 8601
statusSituação da doação: pago, pendente, cancelado, reembolsado e demais.texto
moedaMoeda da transação: BRL, USD, EUR ou GBP.ISO 4217
valor_brutoValor pago pelo doador, antes das taxas.decimal
valor_liquidoValor após a dedução das taxas de processamento.decimal
forma_pagamentoMeio utilizado: pix, boleto, cartao_credito, paypal e demais.texto
gatewayProvedor que processou o pagamento.texto
tipo_captacaoOrigem da doação: link_doacao, crowdfunding, evento, rifa, leilao.texto
recorrenteIndica se a doação faz parte de uma assinatura.booleano
id_assinaturaIdentificador da assinatura vinculada. Nulo em doação única.inteiro ou nulo
campanhaCampanha à qual a doação pertence. Nulo quando não houver.texto ou nulo
utm_sourceOrigem de tráfego registrada no momento da doação.texto
utm_mediumMeio de tráfego registrado.texto
utm_campaignCampanha de tráfego registrada.texto

Exemplo de payload

Uma doação recorrente de R$ 60,00 no cartão de crédito, originada de um link de doação divulgado na bio do Instagram:

Uma transação
{
  "id": 4831207,
  "doador_id": 90214,
  "doador_nome": "Helena M. Vasques",
  "doador_email": "helena@exemplo.com.br",
  "data": "2026-07-14T10:32:08-03:00",
  "status": "pago",
  "moeda": "BRL",
  "valor_bruto": 60.00,
  "valor_liquido": 56.94,
  "forma_pagamento": "cartao_credito",
  "gateway": "principal",
  "tipo_captacao": "link_doacao",
  "recorrente": true,
  "id_assinatura": 7712,
  "campanha": null,
  "utm_source": "instagram",
  "utm_medium": "bio",
  "utm_campaign": "mensal-2026"
}
  • campanha nulo e tipo_captacao link_doacao: veio do link institucional.
  • recorrente true com id_assinatura: é uma cobrança de assinatura; consulte a assinatura pelo id.
  • valor_liquido é o que entrou no saldo; a diferença para o bruto é a taxa.

Este artigo respondeu sua dúvida?

Dúvidas rápidas

Perguntas frequentes

Não. A API é de leitura. Doações offline são registradas pelo painel.

Sim, com o mesmo padrão: /v1/assinaturas e /v1/doadores, com os campos das telas correspondentes e as permissões do token.

600 por minuto por token. Acima disso, a API responde 429; espere e tente de novo.

Ponto decimal, padrão JSON: 60.00. Formate na exibição.

Sim, um por sistema, para revogar um sem afetar os outros.

Pronto para captar mais com a Doare?

Sem compromisso · 30 min · Resposta em até 24h