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

Referência do JSON da API de Doações

A API de Doações entrega cada transação como um objeto JSON. Os campos cobrem identificação da doação e do doador, data, status, moeda, valores bruto e líquido, gateway de pagamento, parâmetros de UTM e o vínculo com a assinatura quando a doação é recorrente. Abaixo está a referência de cada campo e um exemplo de payload.

8 min de leituraAtualizado em 6 de agosto de 2026Documentação Técnica
Em resumo
  • Cada transação chega como um objeto JSON com identificadores, valores, status e origem.
  • Os campos de UTM permitem atribuir a doação à campanha de origem.
  • Doações recorrentes trazem o vínculo com a assinatura, para conciliar o ciclo.
  • Os valores vêm separados em bruto e líquido, com o gateway identificado.
Neste artigo
  1. Referência dos campos
  2. Exemplo de payload

Quais campos o JSON traz?

Cada transação é entregue como um objeto JSON. Os campos abaixo cobrem identificação, valores, origem e o vínculo com a assinatura quando a doação é recorrente.

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

Sempre leia moeda junto de valor_bruto. A plataforma opera em quatro moedas, e somar valores sem conferir a moeda produz relatório errado.

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:

transacao.json
{
  "id": 4831207,
  "doador_id": 90214,
  "doador_nome": "Ana Paula Ribeiro",
  "doador_email": "ana.ribeiro@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": "pagarme",
  "tipo_captacao": "link_doacao",
  "recorrente": true,
  "id_assinatura": 7712,
  "campanha": null,
  "utm_source": "instagram",
  "utm_medium": "bio",
  "utm_campaign": "mensal-2026"
}

Para conferir o que cada status significa na prática, consulte a tabela de status em gestão de doações e assinaturas.

Este artigo respondeu sua dúvida?

Dúvidas rápidas

Perguntas frequentes

Os valores vêm em formato decimal, com a moeda identificada no campo correspondente. Sempre leia a moeda junto do valor — a plataforma opera em real, dólar e libra.

Pelo campo que traz o identificador da assinatura. Doações únicas não têm esse vínculo preenchido.

O bruto é o que o doador pagou. O líquido é o que sobra depois das taxas de processamento. Para prestação de contas, use o bruto; para fluxo de caixa, o líquido.

Pronto para captar mais com a Doare?

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