Métricas
Bancos dos Depósitos

Bancos dos Depósitos

Liste os bancos mais utilizados pelos seus pagadores em um período específico.

Endpoint Disponível

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

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

Consultar bancos dos depósitos

Route

GET /v2/metrics/deposits/banks

Headers

{
  "Authorization": "YOUR_API_KEY"
}

Query Parameters

ParâmetroTipoObrigatórioDescrição
startstringSimData/hora inicial no formato "YYYY-MM-DD HH:MM:SS"
endstringSimData/hora final no formato "YYYY-MM-DD HH:MM:SS"

Exemplo de requisição:

curl --location 'https://api.pixtopay.com.br/v2/metrics/deposits/banks?start=2025-08-04%2016:00:00&end=2025-08-04%2017:00:00' \
--header 'Authorization: API_KEY'

Resposta 200 - Sucesso:

[
  {
    "count": 23130,
    "ispb": "18236120",
    "bank_name": "NU PAGAMENTOS - IP"
  },
  {
    "count": 6985,
    "ispb": "22896431",
    "bank_name": "PICPAY"
  },
  {
    "count": 6191,
    "ispb": "00360305",
    "bank_name": "CAIXA ECONOMICA FEDERAL"
  },
  {
    "count": 5439,
    "ispb": "00416968",
    "bank_name": "BANCO INTER"
  },
  {
    "count": 5027,
    "ispb": "90400888",
    "bank_name": "BCO SANTANDER (BRASIL) S.A."
  },
  {
    "count": 4078,
    "ispb": "60701190",
    "bank_name": "ITAÚ UNIBANCO S.A."
  }
]

Campos da Resposta

ParâmetroTipoDescrição
countintegerNúmero de transações do banco
ispbstringISPB do banco
bank_namestringNome do banco

Nota: A resposta é ordenada por count em ordem decrescente (bancos com mais transações primeiro).

Casos de Uso

1. Top 10 bancos mais utilizados

async function getTopBanks(start, end) {
  const response = await fetch(
    `https://api.pixtopay.com.br/v2/metrics/deposits/banks?start=${start}&end=${end}`,
    { headers: { Authorization: "YOUR_API_KEY" } }
  );
  const banks = await response.json();
 
  const total = banks.reduce((sum, b) => sum + b.count, 0);
 
  // Top 10 bancos
  return banks.slice(0, 10).map((bank) => ({
    name: bank.bank_name,
    ispb: bank.ispb,
    transactions: bank.count,
    percentage: ((bank.count / total) * 100).toFixed(2) + "%",
  }));
}

2. Análise: Bancos digitais vs tradicionais

async function analyzeBankTypes(start, end) {
  const response = await fetch(
    `https://api.pixtopay.com.br/v2/metrics/deposits/banks?start=${start}&end=${end}`,
    { headers: { Authorization: "YOUR_API_KEY" } }
  );
  const banks = await response.json();
 
  const digitalBanks = [
    "18236120", // Nubank
    "22896431", // PicPay
    "00416968", // Inter
    "10573521", // Mercado Pago
    "08561701", // PagSeguro
    "20855875", // Neon
    "31872495", // C6
  ];
 
  const digital = banks
    .filter((b) => digitalBanks.includes(b.ispb))
    .reduce((sum, b) => sum + b.count, 0);
 
  const traditional = banks
    .filter((b) => !digitalBanks.includes(b.ispb))
    .reduce((sum, b) => sum + b.count, 0);
 
  const total = digital + traditional;
 
  return {
    digital: {
      count: digital,
      percentage: ((digital / total) * 100).toFixed(2) + "%",
    },
    traditional: {
      count: traditional,
      percentage: ((traditional / total) * 100).toFixed(2) + "%",
    },
  };
}

3. Diversificação de bancos

async function getBankDiversity(start, end) {
  const response = await fetch(
    `https://api.pixtopay.com.br/v2/metrics/deposits/banks?start=${start}&end=${end}`,
    { headers: { Authorization: "YOUR_API_KEY" } }
  );
  const banks = await response.json();
 
  const total = banks.reduce((sum, b) => sum + b.count, 0);
  const top5 = banks.slice(0, 5).reduce((sum, b) => sum + b.count, 0);
 
  return {
    totalBanks: banks.length,
    top5Concentration: ((top5 / total) * 100).toFixed(2) + "%",
    longTail: banks.length - 5,
  };
}

4. Exportar relatório de bancos

async function exportBankReport(start, end) {
  const response = await fetch(
    `https://api.pixtopay.com.br/v2/metrics/deposits/banks?start=${start}&end=${end}`,
    { headers: { Authorization: "YOUR_API_KEY" } }
  );
  const banks = await response.json();
 
  const total = banks.reduce((sum, b) => sum + b.count, 0);
 
  // Gerar CSV
  const csv = [
    "Posição,Banco,ISPB,Transações,Percentual",
    ...banks.map((bank, index) => {
      const percentage = ((bank.count / total) * 100).toFixed(2);
      return `${index + 1},${bank.bank_name},${bank.ispb},${
        bank.count
      },${percentage}%`;
    }),
  ].join("\n");
 
  return csv;
}

Insights de Negócio

Preferências dos clientes

Com os dados de bancos, identifique:

  • Bancos digitais vs tradicionais: Perfil dos seus clientes
  • Concentração: Dependência de poucos bancos
  • Tendências: Crescimento de novos bancos digitais
  • Regional: Bancos específicos por região

Otimização de integrações

Use os dados para:

  • Priorizar integrações com bancos mais utilizados
  • Identificar problemas em bancos específicos
  • Planejar features baseadas no perfil dos usuários

Marketing direcionado

Insights para campanhas:

  • Criar materiais específicos para usuários de bancos digitais
  • Campanhas para atrair usuários de bancos tradicionais
  • Parcerias estratégicas com os top bancos

Observações Importantes

  • 🔒 Produção: Endpoint disponível apenas em produção
  • 📊 Ordenação: Resultados ordenados por volume (decrescente)
  • 🕐 Período flexível: Consulte qualquer período (hora, dia, mês)
  • 🏦 Cobertura completa: Inclui todos os bancos do sistema PIX brasileiro
  • 💡 ISPB: Use o ISPB para identificar bancos de forma única
  • ⏰ Timezone: Datas/horas em UTC-3 (Brasília)

Bancos Mais Comuns

Bancos Digitais (Top)

  • Nubank (ISPB: 18236120) - NU PAGAMENTOS
  • PicPay (ISPB: 22896431) - PICPAY
  • Inter (ISPB: 00416968) - BANCO INTER
  • Mercado Pago (ISPB: 10573521) - MERCADO PAGO IP
  • C6 Bank (ISPB: 31872495) - BCO C6 S.A.

Bancos Tradicionais (Top)

  • Caixa (ISPB: 00360305) - CAIXA ECONOMICA FEDERAL
  • Santander (ISPB: 90400888) - BCO SANTANDER
  • Itaú (ISPB: 60701190) - ITAÚ UNIBANCO S.A.
  • Bradesco (ISPB: 60746948) - BCO BRADESCO S.A.
  • Banco do Brasil (ISPB: 00000000) - BCO DO BRASIL S.A.
Volumes de DepósitosVolumes de Pagamentos