PayZu Conta HubSaldo e extratoLimites e métricas

Consultar as métricas do período

GET/transactions/metrics

Confira o passo a passo → https://docs.payzu.com.br/docs/account-hub/metrics


Query Params

dateFromstring
Início do período.
dateTostring
Fim do período.

Headers

Authorizationstringobrigatório
Bearer seguido do token de API.
acceptstring
Formato da resposta.

Responses

200Métricas do período
periodobjectPeríodo usado no cálculo.
Campos do objeto 2
fromstringPrimeiro instante contado.
tostringÚltimo instante contado.
railsarray of objectsMétricas de cada meio de pagamento da conta.
Campos de cada item 15
methodstringMeio de pagamento.
PIXBOLETOCREDITCARD
createdintegerCobranças criadas no período.
paidintegerCobranças do período já pagas.
conversionRateinteger | nullPagas sobre criadas, em basis points.
paidAmountintegerTotal pago, em centavos.
feeAmountintegerTarifa das cobranças pagas, em centavos.
netAmountintegerValor creditado pelas cobranças pagas, em centavos.
averageTicketinteger | nullTicket médio, em centavos.
refundedAmountintegerTotal devolvido, em centavos.
refundRateinteger | nullProporção devolvida, em basis points.
disputedAmountintegerValor em contestação MED, em centavos.
disputeRateinteger | nullProporção contestada, em basis points.
pendingintegerCobranças do período ainda não pagas.
pendingAmountintegerTotal não pago, em centavos.
refundedintegerCobranças com devolução, total ou parcial.
withdrawalsobjectSaques do período que não falharam.
Campos do objeto 4
countintegerQuantidade de saques.
amountintegerTotal debitado com a tarifa, em centavos.
feeAmountintegerTarifa dos saques, em centavos.
netAmountintegerValor que chegou ao destino, em centavos.
depositsobjectPix recebidos sem cobrança, pela data em que caíram.
Campos do objeto 4
countintegerQuantidade de depósitos.
amountintegerValor bruto, em centavos.
feeAmountintegerTarifa dos depósitos, em centavos.
netAmountintegerValor creditado, em centavos.
refundsobjectDevoluções concluídas no período, pela data de conclusão.
Campos do objeto 4
countintegerQuantidade de devoluções.
amountintegerTotal debitado com a tarifa, em centavos.
feeAmountintegerTarifa das devoluções, em centavos.
netAmountintegerValor que voltou aos pagadores, em centavos.
infractionsobjectInfrações MED encerradas no período, pela data do desfecho.
Campos do objeto 4
countintegerQuantidade de infrações encerradas.
amountintegerDevolução ao pagador mais taxa de análise, em centavos.
feeAmountintegerTaxa de análise cobrada, em centavos.
netAmountintegerValor que voltou ao pagador, em centavos.
feesobjectTarifas do período.
Campos do objeto 1
totalintegerSoma das tarifas dos outros blocos, sem o pixInflow, em centavos.
pixInflowobject | nullEntradas por Pix, somando cobranças pagas e depósitos.
Campos do objeto 4
countintegerQuantidade de entradas.
amountintegerValor bruto, em centavos.
feeAmountintegerTarifa das entradas, em centavos.
netAmountintegerValor creditado, em centavos.
400Requisição inválida
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
401Credencial ausente ou inválida
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
403Acesso negado
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.

Linguagem

Credenciais Bearer

Token de API

curl --request GET \     --url https://api.sandbox.payzu.dev/api/v1/transactions/metrics \     --header 'authorization: Bearer SEU_TOKEN' \     --header 'accept: application/json'
Resposta

Clique em Try It! para enviar uma requisição e ver a resposta aqui. Ou escolha um exemplo:

application/json