PayZu PixRelatóriosTransações

Consultar o resumo das transações

GET/user/summary

Confira o passo a passo → https://docs.payzu.com.br/docs/pix/period-summary


Query Params

dateFromstring
Início do período.
dateTostring
Fim do período.
groupBystring enumPadrão: day
Unidade de agrupamento da série.day
groupedboolean
Retorna também a série agrupada por data.

Headers

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

Responses

200Resumo do período
totalTransactionsintegerQuantidade de transações no período.
depositobjectTotais dos depósitos.
Campos do objeto 4
totalAmountnumberSoma dos valores no período.
totalTransactionsintegerQuantidade de transações deste tipo no período.
statusesobjectTotais por status.
Campos do objeto 5
pendingobjectTransações pendentes.
Campos do objeto 3
countintegerQuantidade de transações.
amountnumberSoma dos valores.
serviceFeeChargednumberSoma das tarifas cobradas.
completedobjectTransações concluídas.
Campos do objeto 3
countintegerQuantidade de transações.
amountnumberSoma dos valores.
serviceFeeChargednumberSoma das tarifas cobradas.
canceledobjectTransações canceladas.
Campos do objeto 3
countintegerQuantidade de transações.
amountnumberSoma dos valores.
serviceFeeChargednumberSoma das tarifas cobradas.
expiredobjectTransações expiradas.
Campos do objeto 3
countintegerQuantidade de transações.
amountnumberSoma dos valores.
serviceFeeChargednumberSoma das tarifas cobradas.
refundedobjectTransações devolvidas.
Campos do objeto 3
countintegerQuantidade de transações.
amountnumberSoma dos valores.
serviceFeeChargednumberSoma das tarifas cobradas.
groupedarray of objectsSérie agrupada por data.
Campos de cada item 2
datestringDia, no fuso America/Sao_Paulo.
amountnumberSoma das transações concluídas no dia.
withdrawobjectTotais dos saques.
Campos do objeto 4
totalAmountnumberSoma dos valores no período.
totalTransactionsintegerQuantidade de transações deste tipo no período.
statusesobjectTotais por status.
Campos do objeto 5
pendingobjectTransações pendentes.
Campos do objeto 3
countintegerQuantidade de transações.
amountnumberSoma dos valores.
serviceFeeChargednumberSoma das tarifas cobradas.
completedobjectTransações concluídas.
Campos do objeto 3
countintegerQuantidade de transações.
amountnumberSoma dos valores.
serviceFeeChargednumberSoma das tarifas cobradas.
canceledobjectTransações canceladas.
Campos do objeto 3
countintegerQuantidade de transações.
amountnumberSoma dos valores.
serviceFeeChargednumberSoma das tarifas cobradas.
expiredobjectTransações expiradas.
Campos do objeto 3
countintegerQuantidade de transações.
amountnumberSoma dos valores.
serviceFeeChargednumberSoma das tarifas cobradas.
refundedobjectTransações devolvidas.
Campos do objeto 3
countintegerQuantidade de transações.
amountnumberSoma dos valores.
serviceFeeChargednumberSoma das tarifas cobradas.
groupedarray of objectsSérie agrupada por data.
Campos de cada item 2
datestringDia, no fuso America/Sao_Paulo.
amountnumberSoma das transações concluídas no dia.
commissionobjectTotais das comissões.
Campos do objeto 4
totalAmountnumberSoma dos valores no período.
totalTransactionsintegerQuantidade de transações deste tipo no período.
statusesobjectTotais por status.
Campos do objeto 5
pendingobjectTransações pendentes.
Campos do objeto 3
countintegerQuantidade de transações.
amountnumberSoma dos valores.
serviceFeeChargednumberSoma das tarifas cobradas.
completedobjectTransações concluídas.
Campos do objeto 3
countintegerQuantidade de transações.
amountnumberSoma dos valores.
serviceFeeChargednumberSoma das tarifas cobradas.
canceledobjectTransações canceladas.
Campos do objeto 3
countintegerQuantidade de transações.
amountnumberSoma dos valores.
serviceFeeChargednumberSoma das tarifas cobradas.
expiredobjectTransações expiradas.
Campos do objeto 3
countintegerQuantidade de transações.
amountnumberSoma dos valores.
serviceFeeChargednumberSoma das tarifas cobradas.
refundedobjectTransações devolvidas.
Campos do objeto 3
countintegerQuantidade de transações.
amountnumberSoma dos valores.
serviceFeeChargednumberSoma das tarifas cobradas.
groupedarray of objectsSérie agrupada por data.
Campos de cada item 2
datestringDia, no fuso America/Sao_Paulo.
amountnumberSoma das transações concluídas no dia.
adjustmentobjectTotais dos ajustes.
Campos do objeto 4
totalAmountnumberSoma dos valores no período.
totalTransactionsintegerQuantidade de transações deste tipo no período.
statusesobjectTotais por status.
Campos do objeto 5
pendingobjectTransações pendentes.
Campos do objeto 3
countintegerQuantidade de transações.
amountnumberSoma dos valores.
serviceFeeChargednumberSoma das tarifas cobradas.
completedobjectTransações concluídas.
Campos do objeto 3
countintegerQuantidade de transações.
amountnumberSoma dos valores.
serviceFeeChargednumberSoma das tarifas cobradas.
canceledobjectTransações canceladas.
Campos do objeto 3
countintegerQuantidade de transações.
amountnumberSoma dos valores.
serviceFeeChargednumberSoma das tarifas cobradas.
expiredobjectTransações expiradas.
Campos do objeto 3
countintegerQuantidade de transações.
amountnumberSoma dos valores.
serviceFeeChargednumberSoma das tarifas cobradas.
refundedobjectTransações devolvidas.
Campos do objeto 3
countintegerQuantidade de transações.
amountnumberSoma dos valores.
serviceFeeChargednumberSoma das tarifas cobradas.
groupedarray of objectsSérie agrupada por data.
Campos de cada item 2
datestringDia, no fuso America/Sao_Paulo.
amountnumberSoma das transações concluídas no dia.
400Requisição inválida
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.
detailsarray of objectsErros de validação por campo.
Campos de cada item 2
fieldstringCampo rejeitado.
messagestringMotivo da rejeição.
401Token ausente ou inválido
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.
403Acesso negado
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.

Linguagem

Credenciais Bearer

Token de API

Gerar credencial de sandbox

curl --request GET \     --url https://pix.sandbox.payzu.dev/v1/user/summary \     --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