PayZu PixDepósitos

Listar depósitos via chave Pix

GET/user/deposit-pending

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


Query Params

statusstring
Status do depósito.
documentstring
CPF ou CNPJ a buscar.
namestring
Nome do pagador ou recebedor.
endToEndIdstring
ID end-to-end do Pix.
amountMinnumber
Valor mínimo do depósito.
amountMaxnumber
Valor máximo do depósito.
createdAtFromstring
Registrados a partir desta data.
createdAtTostring
Registrados até esta data.
pageintegerPadrão: 1
Número da página.
limitintegerPadrão: 20
Itens por página.

Headers

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

Responses

200Lista de depósitos
pageintegerPágina retornada.
limitintegerItens por página.
hasNextPagebooleanIndica se há uma próxima página.
dataarray of objectsDepósitos da página, do mais recente ao mais antigo.
Campos de cada item 23
idstringIdentificador do depósito.
statusstringStatus do depósito.
PENDINGAPPROVEDREJECTEDEXPIREDCOMPLETED
amountnumberValor recebido.
payerDocumentstringCPF ou CNPJ de quem pagou.
payerNamestring | nullTitular da conta que pagou.
payerAccountNumberstring | nullConta PayZu do pagador.
payerInstitutionIspbstring | nullISPB da instituição de origem.
payerInstitutionNamestring | nullInstituição de origem do Pix.
receiverDocumentstring | nullCPF ou CNPJ de quem recebe.
receiverNamestring | nullTitular da conta que recebe.
receiverAccountNumberstring | nullSua conta PayZu, que recebe o crédito na aprovação.
receiverInstitutionIspbstring | nullISPB da instituição de destino.
receiverInstitutionNamestring | nullInstituição de destino do Pix.
endToEndIdstringID end-to-end do Pix.
paidAtstring | nullData e hora da liquidação.
pixKeystring | nullChave Pix do depósito.
descriptionstring | nullDescrição enviada com o Pix.
approvedAtstring | nullData e hora da aprovação.
rejectedAtstring | nullData e hora da recusa.
rejectionReasonstring | nullMotivo da recusa.
transactionIdstring | nullTransação de depósito criada na aprovação.
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/deposit-pending \     --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