PayZu Conta HubDepósitos
Listar os depósitos
GET/transactions/deposit
Confira o passo a passo → https://docs.payzu.com.br/docs/account-hub/deposits
Requisições recentes
Query Params
limitintegerPadrão: 20
Itens por página.
cursorstring
nextCursor da página anterior.
endToEndIdstring
ID end-to-end do Pix.
dateFromstring
Início do período, pela data do recebimento.
dateTostring
Fim do período, pela data do recebimento.
Headers
Authorizationstringobrigatório
Bearer seguido do token de API.
acceptstring
Formato da resposta.
Responses
200Lista de depósitos
dataarray of objectsDepósitos, do mais recente ao mais antigo.
Campos de cada item 18
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.
PIXTEDamountintegerValor 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.
PROCESSINGSETTLEDRELEASEDamountintegerValor 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.
nextCursorstringCursor da próxima página, ausente na última.
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.
Esta página ajudou?