PayZu PixRelatóriosArquivos CSV

Gerar um relatório de transações

POST/user/report

Confira o passo a passo → https://docs.payzu.com.br/docs/pix/request-a-report


Body Params

dateFromstringobrigatório
Início do período do relatório.
dateTostringobrigatório
Fim do período do relatório.
statusarray of strings
Status a incluir.
typearray of strings
Tipos a incluir.

Headers

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

Responses

202Relatório enfileirado
idstringIdentificador do relatório.
statusstringStatus do relatório.
PENDINGRUNNINGCOMPLETEDFAILED
createdAtstringData e hora do pedido.
updatedAtstringData e hora da última alteração.
paramsobjectFiltros usados no relatório.
writtenRowsinteger | nullLinhas escritas no arquivo.
expiresAtstring | nullData e hora em que o arquivo expira.
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.
422Nenhuma transação encontrada
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 POST \     --url https://pix.sandbox.payzu.dev/v1/user/report \     --header 'authorization: Bearer SEU_TOKEN' \     --header 'accept: application/json' \     --header 'content-type: application/json' \     --data '{}'
Resposta

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

application/json