PayZu Conta HubConta
Métricas
Acompanhe o desempenho da conta num período, com números calculados a cada chamada, sem cache.
Consulte as métricas
- Período:
dateFromedateToaceitam ISO 8601 ouAAAA-MM-DD. Sem os dois, valem os últimos 30 dias, eperiodmostra o intervalo calculado. - Data que conta: as cobranças contam pela data de criação, e os depósitos, pela data em que caíram.
- Unidades: valores em centavos e proporções em basis points.
bash
curl --request GET \
--url 'https://api.sandbox.payzu.dev/api/v1/transactions/metrics?dateFrom=2026-09-01&dateTo=2026-09-30' \
--header 'Authorization: Bearer SEU_TOKEN'json
{
"period": { "from": "2026-09-01T03:00:00.000Z", "to": "2026-10-01T02:59:59.999Z" },
"rails": [
{
"method": "PIX",
"created": 120,
"paid": 96,
"conversionRate": 8000,
"paidAmount": 480000,
"feeAmount": 10080,
"netAmount": 469920,
"averageTicket": 5000,
"refundedAmount": 10000,
"refundRate": 208,
"disputedAmount": 0,
"disputeRate": 0,
"pending": 10,
"pendingAmount": 50000,
"refunded": 2
}
],
"withdrawals": { "count": 4, "amount": 401000, "feeAmount": 6000, "netAmount": 395000 },
"deposits": { "count": 3, "amount": 30000, "feeAmount": 300, "netAmount": 29700 },
"refunds": { "count": 2, "amount": 10200, "feeAmount": 200, "netAmount": 10000 },
"infractions": { "count": 0, "amount": 0, "feeAmount": 0, "netAmount": 0 },
"fees": { "total": 16580 },
"pixInflow": { "count": 99, "amount": 510000, "feeAmount": 10380, "netAmount": 499620 }
}Referência: Consultar as métricas do período
| Bloco | O que traz |
|---|---|
rails | Os números das cobranças por meio de pagamento. No exemplo, 96 pagas de 120 criadas dão conversionRate de 8000, ou 80%. |
withdrawals, deposits, refunds, infractions, pixInflow | O resumo das saídas e das entradas do período. |
feeAmount, netAmount | Em cada bloco, a tarifa e o valor sem ela. |
fees.total | A soma das tarifas de rails, withdrawals, deposits, refunds e infractions. |
O Pix sem cobranças no período vem com os números zerados.
As proporções ficam null quando não há base de cálculo, e rails traz só os meios de pagamento da conta que têm métricas.