PayZu PixRelatóriosTransações

Listar as transações

GET/user/transactions

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


Query Params

dateFromstring
Início do período.
dateTostring
Fim do período.
limitintegerPadrão: 10
Itens por página.
pageintegerPadrão: 1
Número da página.
idstring
ID da transação.
statusstring
Status da transação.
typestring
Tipo da transação.
methodstring
Meio de pagamento.
amountnumber
Valor da transação.
documentstring
CPF ou CNPJ a buscar.
namestring
Nome a buscar.
endToEndIdstring
ID end-to-end do Pix.
sortBystring enumPadrão: createdAt
Campo de ordenação.createdAtupdatedAt
sortDirectionstring enumPadrão: desc
Direção da ordenação.ascdesc
clientReferencestring
Seu identificador, enviado na criação.
virtualAccountstring
Subconta usada na criação.
hasQrCodeboolean
Transações com ou sem QR Code.

Headers

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

Responses

200Lista de transações
totalintegerTotal de transações que atendem aos filtros.
pagesintegerTotal de páginas.
transactionsarray of objectsTransações da página.
Campos de cada item 37
idstringIdentificador da transação na PayZu.
statusstringStatus da transação.
PENDINGCOMPLETEDCANCELEDWAITING_FOR_REFUNDREFUNDEDEXPIREDERROR
amountnumberValor em reais, antes da tarifa.
typestringTipo da transação.
DEPOSITWITHDRAWCOMMISSIONLIQUIDATIONADJUSTMENT
qrCodeTextstring | nullCódigo Pix copia e cola.
qrCodeBase64string | nullImagem PNG do QR Code em base64, sem prefixo.
qrCodeUrlstring | nullRota autenticada que retorna o PNG do QR Code.
generatedNamestring | nullNome usado na cobrança.
generatedDocumentstring | nullCPF ou CNPJ usado na cobrança.
generatedEmailstring | nullE-mail usado na cobrança.
payerNamestring | nullTitular da conta que pagou.
payerDocumentstring | nullCPF ou CNPJ de quem pagou.
payerInstitutionIspbstring | nullISPB da instituição de origem.
payerInstitutionNamestring | nullInstituição de origem do Pix.
payerAccountNumberstring | nullConta PayZu do pagador.
serviceFeeChargednumber | nullTarifa PayZu, que pode ter mais de 2 casas decimais.
withdrawPixKeystring | nullChave de destino do saque, normalizada.
withdrawPixTypestring | nullTipo da chave de destino (evp é a chave aleatória).
cpfcnpjemailphoneevp
receiverNamestring | nullTitular da conta que recebe.
receiverDocumentstring | nullCPF ou CNPJ de quem recebe.
receiverInstitutionIspbstring | nullISPB da instituição de destino.
receiverInstitutionNamestring | nullInstituição de destino do Pix.
receiverAccountNumberstring | nullConta PayZu do recebedor.
endToEndIdstring | nullID end-to-end do Pix.
createdAtstringData e hora do registro.
updatedAtstringData e hora da última alteração.
paidAtstring | nullData e hora da liquidação.
clientReferencestring | nullSeu identificador, enviado na criação.
refundEndToEndIdstring | nullID end-to-end da devolução.
refundAmountnumber | nullValor devolvido.
refundStatusstring | nullStatus da devolução.
PENDINGCOMPLETEDCANCELED
refundReasonstring | nullMotivo: seu pedido, MED, depósito de CNPJ recusado ou ação da PayZu.
CUSTOMER_REQUESTINFRACTIONDENY_COMPANY_DEPOSITADMIN_REQUEST
refundDescriptionstring | nullDescrição da devolução.
refundedAtstring | nullData e hora da devolução.
cancellationReasonstring | nullMotivo do cancelamento.
virtualAccountstring | nullSubconta informada na criação.
methodstringMeio de pagamento.
PIXINTERNAL_TRANSFERBANK_SLIPTED
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/transactions \     --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