PayZu Conta HubSaldo e extratoSaldo e lançamentos

Listar os lançamentos do extrato

GET/transactions/statement

Confira o passo a passo → https://docs.payzu.com.br/docs/account-hub/list-the-statement


Query Params

limitintegerPadrão: 20
Itens por página.
cursorstring
nextCursor da página anterior.
dateFromstring
Início do período, pela data de criação.
dateTostring
Fim do período, pela data de criação.
amountinteger
Valor em centavos, sem sinal.
endToEndIdstring
ID end-to-end do Pix.
documentstring
Documento de quem pagou; nas saídas, a chave de destino.
namestring
Nome de quem pagou; nas saídas, a chave de destino.
statusstring enum
Status da operação de origem, não o da linha.
sortBystring enumPadrão: createdAt
Campo de ordenação.postedAtcreatedAt
sortDirectionstring enumPadrão: desc
Direção da ordenação.ascdesc

Headers

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

Responses

200Página do extrato
dataarray of objectsLinhas do extrato.
Campos de cada item 14
idstringID da linha, usado como cursor.
amountintegerValor em centavos, positivo na entrada e negativo na saída.
balanceAfterintegerSaldo disponível depois da linha, em centavos.
descriptionstring | nullRótulo fixo do lançamento; o estado atual fica em status.
endToEndIdstring | nullID end-to-end do Pix de origem.
infractionProtocolstring | nullProtocolo da infração, nas linhas de MED.
grossinteger | nullValor cheio da operação, em centavos.
feeinteger | nullTarifa da operação, em centavos.
statusstring | nullStatus atual de saque, devolução ou transferência.
PROCESSINGSETTLEDRETURNED
statusReasonstring | nullMotivo da recusa do banco, para exibir.
statusAtstring | nullData e hora da conclusão ou do retorno.
payoutOperationstring | nullSaque para chave ou pagamento de QR Code.
WITHDRAWEXTERNAL_PAYMENT
counterpartyobject | nullCom quem foi a operação.
Campos do objeto 5
namestring | nullNome de quem pagou, nas entradas, ou de quem recebeu, nas saídas.
documentstring | nullDocumento da outra parte, mascarado no depósito e nas saídas.
bankobject | nullInstituição da outra parte.
Campos do objeto 2
namestring | nullNome da instituição.
ispbstring | nullISPB da instituição, com 8 dígitos.
pixKeystring | nullChave de destino mascarada, nas saídas por Pix.
accountobject | nullAgência e número da outra conta, na transferência entre contas.
Campos do objeto 2
branchstring | nullAgência da conta.
numberstring | nullNúmero da conta, completo.
postedAtstringData e hora em que o dinheiro se moveu.
nextCursorstringCursor da próxima página, ausente na última.
balanceintegerSaldo disponível agora, em centavos.
400Requisição inválida
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
detailsobjectContexto do erro, como valores e limites.
401Credencial ausente ou inválida
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
403Acesso negado
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.

Linguagem

Credenciais Bearer

Token de API

curl --request GET \     --url https://api.sandbox.payzu.dev/api/v1/transactions/statement \     --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