API de Doações - Integração via JSON
Esta documentação detalha os parâmetros disponíveis na integração com a API da Doare. Cada campo representa informações relativas às doações realizadas, permitindo que sistemas terceiros possam consultar, armazenar ou integrar esses dados em seus fluxos.
Parâmetros Disponíveis
| Parameter | Description | Example | Format |
|---|---|---|---|
| id | Identificador único da transação de doação. | 6e603abb-5437-4f66-b75e-ff631dae5e44 | String (UUID) |
| doador_id | Identificador único do doador. | b5c4191f-e719-485b-a5f6-d1ebf2dbc098 | String (UUID) |
| data | Data de criação da doação. | 28/04/2025 | Date (dd/MM/yyyy) ou Null |
| datapagamento | Data do pagamento (se realizado). | null ou 28/04/2025 | Date (dd/MM/yyyy) ou Null |
| nome | Nome completo do doador. | Nome Sobrenome | String |
| E-mail de contato do doador. | nome-sobrenome@email.com | String (Email) | |
| anonimo | Se o doador optou por ser anônimo. | Nao | String (sim ou Nao) |
| newsletter | Se o doador aceitou receber a newsletter. | Nao | String (sim ou Nao) |
| tipo | Tipo da doação. | Assinatura | String |
| telefone | Telefone do doador. | null | String ou Null |
| numero_endereco | Número do endereço. | null | String ou Null |
| complemento | Complemento do endereço. | null | String ou Null |
| cidade | Cidade do doador. | null | String ou Null |
| estado | Estado do doador. | null | String ou Null |
| cep | CEP do doador. | null | String ou Null |
| documento | Documento (CPF/CNPJ) do doador. | 86409611668 | String (somente números) |
| status | Status da doação. | Pendente | String (Pendente, Pago, etc.) |
| moeda | Moeda utilizada. | BRL | String (ISO 4217) |
| valor_bruto | Valor bruto da doação. | 150.00 | Float |
| valor_liquido | Valor líquido após taxas. | 134.35 | Float |
| cotacao | Cotação da moeda usada. | 1.00 | Float |
| forma_de_pagamento | Forma de pagamento escolhida. | Pix | String |
| gateway | Gateway de pagamento utilizado. | pagarme-v4 | String |
| campanha | Nome da campanha relacionada. | null | String ou Null |
| embaixador | Nome do embaixador relacionado. | null | String ou Null |
| data_de_registro | Data de registro da doação. | 28/04/2025 | Date (dd/MM/yyyy) |
| data_de_vencimento | Data de vencimento para pagamento. | 28/04/2025 | Date (dd/MM/yyyy) |
| data_de_pagamento | Data do pagamento efetivo. | null ou 28/04/2025 | Date ou Null |
| quota | Quota de pagamento (parcelas). | "" (vazio) | String |
| batch_id | Identificador de lote de pagamentos. | "" (vazio) | String |
| tag | Tag de classificação. | null | String ou Null |
| motivo | Motivo adicional do pagamento. | null | String ou Null |
| fonte | Fonte da origem da doação. | Site Oficial | String |
| data_de_nascimento | Data de nascimento do doador. | null | Date (dd/MM/yyyy) ou Null |
| data_customizada | Data customizada no formato ano-mês. | 2025-04 | String (yyyy-MM) |
| origem | Origem da transação. | subscription | String |
| mala | Se o doador aceitou mala direta. | Nao | String (Sim ou Nao) |
| hora_do_pagamento | Hora que o pagamento foi registrado. | null | Time (HH:mm:ss) |
| data_do_estorno | Data em que ocorreu estorno (se houver). | null | Date ou Null |
| hora_do_estorno | Hora em que ocorreu estorno. | null | Time (HH:mm:ss) ou Null |
| utm_source | Fonte UTM da doação. | Site Oficial | String |
| utm_medium | Meio UTM da doação. | null | String ou Null |
| utm_campaign | Campanha UTM da doação. | null | String ou Null |
Exemplos
Exemplo de Registro de Doação
{
"id": "6e605bab-5437-4f06-b750-ff68134e5e44",
"doador_id": "b5c4191f-e719-4f85-a5f6-d1ebf2dbc098",
"data": "28/04/2025",
"nome": "Nome Sobrenome",
"email": "nome-sobrenome@email.com",
"anonimo": "Nao",
"newsletter": "",
"tipo": "Assinatura",
"telefone": null,
"documento": "86409611668",
"status": "Pendente",
"moeda": "BRL",
"valor_bruto": "150.00",
"valor_liquido": "134.35",
"forma_de_pagamento": "Pix",
"gateway": "pagarme-v4",
"fonte": "Site Oficial"
}
Todos os direitos reservados © 2025
DOARE SERVICOS FINANCEIROS LTDA - ME / CNPJ: 28.229.013/0001-56
