PayZu PixRelatóriosExtrato

Listar os lançamentos do extrato

GET/user/bank-statements

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


Query Params

createdAtFromstringobrigatório
Início do período.
createdAtTostringobrigatório
Fim do período.
idstring
ID do lançamento.
operationstring enum
Crédito ou débito no saldo.INCREMENTDECREMENT
reasonstring
Motivo do lançamento.
transactionIdstring
ID da transação.
amountFromnumber
Valor mínimo do lançamento.
amountTonumber
Valor máximo do lançamento.
pageintegerPadrão: 1
Número da página.
limitintegerPadrão: 10
Itens por página.
sortBystring enumPadrão: createdAt
Campo de ordenação.createdAtamount
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 lançamentos
paginationobjectDados da paginação.
Campos do objeto 3
pageintegerPágina retornada.
limitintegerItens por página.
hasNextPagebooleanIndica se há uma próxima página.
bankStatementsarray of objectsLançamentos da página.
Campos de cada item 13
idstringIdentificador do lançamento.
amountnumberValor do lançamento.
operationstringCrédito ou débito no saldo.
INCREMENTDECREMENT
reasonstringMotivo do lançamento.
balanceTypestringSaldo movimentado.
AVAILABLEBLOCKED
previousBalanceAvailablenumberSaldo disponível antes do lançamento.
previousBalanceBlockednumberSaldo bloqueado antes do lançamento.
newBalanceAvailablenumberSaldo disponível depois do lançamento.
newBalanceBlockednumberSaldo bloqueado depois do lançamento.
transactionIdstring | nullTransação que gerou o lançamento.
infractionIdstring | nullInfração ligada ao lançamento.
createdAtstringData e hora do registro.
updatedAtstringData e hora da última alteração.
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/bank-statements \     --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