Volumes de Depósitos (Cash-in)

Consulte volumes e valores de cobranças PIX por status em uma data específica.

Endpoint Disponível

Produção: https://api.pixtopay.com.br/v2/metrics/deposits

⚠️ Atenção: Este endpoint está disponível apenas em produção.

Consultar volumes de depósitos

Route

GET /v2/metrics/deposits

Headers

{
  "Authorization": "YOUR_API_KEY"
}

Query Parameters

Parâmetro	Tipo	Obrigatório	Descrição
`date`	string	Sim	Data para consulta no formato "YYYY-MM-DD" (ex: "2025-08-04")

Exemplo de requisição:

curl --location 'https://api.pixtopay.com.br/v2/metrics/deposits?date=2025-08-04' \
--header 'Authorization: API_KEY'

Resposta `200` - Sucesso:

{
  "date": "2025-08-04",
  "pending": {
    "qtd": 184,
    "amount": 12577.8
  },
  "expired": {
    "qtd": 6663,
    "amount": 1296962.97
  },
  "paid": {
    "qtd": 48600,
    "amount": 4168422.03
  },
  "refunded": {
    "qtd": 105,
    "amount": 10397.1
  }
}

Campos da Resposta

Parâmetro	Tipo	Descrição
`date`	string	Data da consulta
`pending`	object	Cobranças pendentes (status 0)
`pending.qtd`	integer	Quantidade de cobranças pendentes
`pending.amount`	number	Valor total das cobranças pendentes
`expired`	object	Cobranças expiradas (status 3)
`expired.qtd`	integer	Quantidade de cobranças expiradas
`expired.amount`	number	Valor total das cobranças expiradas
`paid`	object	Cobranças pagas (status 1)
`paid.qtd`	integer	Quantidade de cobranças pagas
`paid.amount`	number	Valor total das cobranças pagas
`refunded`	object	Cobranças devolvidas (status 4)
`refunded.qtd`	integer	Quantidade de cobranças devolvidas
`refunded.amount`	number	Valor total das cobranças devolvidas

Status de Cobranças

Status	Descrição
`0`	Cobrança criada, aguardando pagamento
`1`	Cobrança paga
`2`	Cobrança cancelada
`3`	Cobrança expirada
`4`	Cobrança devolvida

Casos de Uso

1. Dashboard diário de cobranças

async function getDailyDeposits(date) {
  const response = await fetch(
    `https://api.pixtopay.com.br/v2/metrics/deposits?date=${date}`,
    {
      headers: { Authorization: "YOUR_API_KEY" },
    }
  );
  const data = await response.json();
 
  return {
    total: data.paid.amount,
    count: data.paid.qtd,
    pending: data.pending.amount,
    expired: data.expired.amount,
  };
}

2. Taxa de conversão

async function getConversionRate(date) {
  const response = await fetch(
    `https://api.pixtopay.com.br/v2/metrics/deposits?date=${date}`,
    { headers: { Authorization: "YOUR_API_KEY" } }
  );
  const data = await response.json();
 
  const total = data.paid.qtd + data.expired.qtd + data.pending.qtd;
  const paid = data.paid.qtd;
  const conversionRate = ((paid / total) * 100).toFixed(2);
 
  return {
    total,
    paid,
    expired: data.expired.qtd,
    conversionRate: `${conversionRate}%`,
  };
}

3. Análise de perdas

async function getLossAnalysis(date) {
  const response = await fetch(
    `https://api.pixtopay.com.br/v2/metrics/deposits?date=${date}`,
    { headers: { Authorization: "YOUR_API_KEY" } }
  );
  const data = await response.json();
 
  return {
    expired: {
      count: data.expired.qtd,
      amount: data.expired.amount,
      percentage: (
        (data.expired.amount /
          (data.paid.amount + data.expired.amount + data.pending.amount)) *
        100
      ).toFixed(2),
    },
    refunded: {
      count: data.refunded.qtd,
      amount: data.refunded.amount,
    },
  };
}

Observações Importantes

🔒 Produção: Endpoint disponível apenas em produção
📊 Dados agregados: Métricas são pré-calculadas para performance
🕐 Atualização: Dados atualizados em tempo real
📅 Período: Consulte qualquer data a partir da criação da conta
💰 Moeda: Todos os valores em BRL (Real Brasileiro)
⏰ Timezone: Todas as datas em UTC-3 (Brasília)

Insights de Negócio

Análise de conversão

Use pending, paid e expired para calcular:

Taxa de conversão de cobranças
Taxa de abandono
Valor médio de cobranças

Performance diária

Monitore:

Volume de cobranças criadas
Taxa de expiração
Ticket médio por status
Períodos de maior conversão

Qualidade operacional

Acompanhe:

Taxa de devolução
Motivos de expiração
Performance por dia da semana

Limites Bancos dos Depósitos