PayZu Conta HubDepósitos

Consultar um depósito

GET/transactions/deposit/{depositId}

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


Path Params

depositIdstringobrigatório
ID do depósito.

Headers

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

Responses

200Depósito encontrado
idstringID do depósito.
blockedAmountintegerValor retido por controle de depósito, em centavos.
blockedAtstring | nullData e hora da retenção.
releasedAtstring | nullData e hora em que a PayZu liberou a retenção.
methodstringComo o dinheiro entrou.
PIXTED
amountintegerValor que o pagador enviou, em centavos.
serviceFeeintegerTarifa do recebimento em centavos, descontada do valor.
netAmountintegerValor creditado na conta em centavos, já sem a tarifa.
endToEndIdstring | nullID end-to-end do Pix. Nulo na TED, que não tem.
receiverPixKeystring | nullChave da sua conta que recebeu o Pix.
payerobjectQuem de fato pagou, segundo o banco.
Campos do objeto 3
namestring | nullNome de quem pagou.
documentstring | nullCPF ou CNPJ de quem pagou, com o CPF mascarado.
bankobject | nullInstituição de origem do Pix.
Campos do objeto 2
namestring | nullNome da instituição.
ispbstring | nullISPB da instituição, com 8 dígitos.
paidAtstringData e hora do pagamento.
createdAtstringData e hora do registro.
refundedAmountintegerTotal de devoluções concluídas, em centavos.
refundInProgressAmountintegerValor de devolução em andamento, em centavos.
refundableAmountintegerQuanto ainda pode ser devolvido, em centavos. Na TED, sempre 0.
openInfractionProtocolstring | nullProtocolo da infração MED aberta sobre o depósito.
refundsarray of objectsDevoluções do depósito, da mais recente à mais antiga.
Campos de cada item 10
idstringID da devolução, o refundId dos webhooks.
statusstringStatus da devolução.
PROCESSINGSETTLEDRELEASED
amountintegerValor devolvido ao pagador, em centavos.
serviceFeeintegerTarifa da devolução, em centavos.
totalDebitedintegerTotal que sai da conta, com a tarifa, em centavos.
endToEndIdstring | nullID end-to-end da devolução.
rejectedReasonstring | nullMotivo da recusa do banco, para exibir.
requestedAtstringData e hora do pedido de devolução.
settledAtstring | nullData e hora da devolução.
releasedAtstring | nullData e hora em que o valor voltou ao saldo, após recusa.
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.
404Depósito não encontrado
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/deposit/{depositId} \     --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