Pagamentos

Histórico de pagamentos e recebimentos efetivados (baixas), incluindo estornos.

Listar pagamentos

GET /pagamentos

ParâmetroTipoDescrição
contaIdstringFiltra pelos pagamentos de uma conta específica
estornadobooleanUse false para ocultar pagamentos estornados
dataPagamento[min] / [max]dateIntervalo da data de pagamento (Y-m-d)
curl "https://api-aberta-prod.useimobia.com.br/api/v1/pagamentos?estornado=false&dataPagamento[min]=2026-07-01" \
  -H "API-KEY: SUA_CHAVE_AQUI"

Detalhes do pagamento

GET /pagamentos/{id}

Exemplo de resposta:

{
  "data": {
    "id": "eyJpdiI6I...",
    "contaId": "eyIxIjoiaVlY...",
    "caixa": { "nome": "Caixa Geral", "tipo": 1 },
    "tipo": "Dinheiro",
    "descricao": "Recebimento de aluguel",
    "transacao": "CREDITO",
    "valor": 1200.5,
    "status": "pago",
    "dataPagamento": "2025-12-29",
    "dataEstorno": null,
    "descricaoEstorno": null
  }
}

Estornos

Pagamentos estornados trazem dataEstorno e descricaoEstorno preenchidos. Por padrão eles aparecem nas listagens — use estornado=false para excluí-los.

📘

Uma conta pode ter múltiplos pagamentos (baixas parciais até ficar paga). Para conciliar o fluxo de caixa realizado, use esta listagem — não o valor da conta.



Did this page help you?