PayZu PixRelatóriosArquivos CSV

Listar os relatórios gerados

GET/user/report

Confira o passo a passo → https://docs.payzu.com.br/docs/pix/list-reports


Query Params

pageintegerPadrão: 1
Número da página.
limitintegerPadrão: 10
Itens por página.
statusstring
Status do relatório.
createdAtFromstring
Criados a partir desta data.
createdAtTostring
Criados até esta data.
updatedAtFromstring
Alterados a partir desta data.
updatedAtTostring
Alterados até esta data.
sortBystring enumPadrão: createdAt
Campo de ordenação.createdAtupdatedAt
sortDirectionstring enumPadrão: desc
Direção da ordenação.ascdesc

Headers

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

Responses

200Lista de relatórios
totalintegerTotal de relatórios que atendem aos filtros.
pagesintegerTotal de páginas.
reportsarray of objectsRelatórios da página.
Campos de cada item 7
idstringIdentificador do relatório.
statusstringStatus do relatório.
PENDINGRUNNINGCOMPLETEDFAILED
createdAtstringData e hora do pedido.
updatedAtstringData e hora da última alteração.
expiresAtstring | nullData e hora em que o arquivo expira.
paramsobjectFiltros usados no relatório.
writtenRowsinteger | nullLinhas escritas no arquivo.
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/report \     --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