PayZu PixDepósitos

Consultar depósito via chave Pix

GET/user/deposit-pending/{id}

Confira o passo a passo → https://docs.payzu.com.br/docs/pix/look-up-a-deposit


Path Params

idstringobrigatório
ID do depósito.

Headers

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

Responses

200Depósito encontrado
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.
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.
404Depósito não encontrado
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/{id} \     --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