Skip to main content
A API de pagadores e bancos permite visualizar quem pagou e por qual instituicao financeira, ordenados por valor confirmado. E util para analise de comportamento e concentracao de recebimentos.
Requer escopo payments:read.

Consultar pagadores e bancos

Envie GET /v1/customers com o periodo desejado.
number
Periodo em dias: 7, 30 (padrao) ou 90.
curl

Resposta

A resposta contem ate 100 pagadores identificados, ordenados por valor confirmado, e a lista de bancos agrupados pelos pagamentos recebidos no periodo.
array
required
Lista de pagadores (maximo 100).
string
required
Identificador pseudonimizado do pagador.
string
Nome do pagador, quando disponivel.
string
Nome do banco, quando disponivel.
integer
required
Quantidade de pagamentos confirmados deste pagador no periodo.
integer
required
Valor total confirmado deste pagador em centavos de BRL.
string
required
Data/hora do ultimo pagamento confirmado (ISO 8601).
array
required
Lista de bancos agrupados.
string
required
Identificador do banco.
string
required
Nome do banco.
integer
required
Quantidade de pagamentos recebidos por este banco no periodo.
integer
required
Valor total recebido por este banco em centavos de BRL.
integer
required
Total de pagadores distintos no periodo.
integer
required
Total de pagadores recorrentes (que ja haviam pagado antes) no periodo.
integer
required
Periodo consultado (7, 30 ou 90).
integer
required
Limite de itens retornados: 100.

Interpretacao dos dados

  • Pagadores sao pseudonimizados; o identificador nao expoe dados pessoais diretos.
  • A ordenacao por amountCents ajuda a identificar os maiores pagadores do periodo.
  • O campo returningPayers indica fidelizacao: quantos pagadores ja haviam feito pelo menos um pagamento anterior.
  • Bancos sao agrupados automaticamente com base nos recebimentos processados.
A consulta le o estado persistido no periodo indicado. Nao e possivel filtrar por carteira individual nesta versao.