PayZu Conta HubDepósitos
Solicitar a devolução de um depósito
POST/transactions/deposit/{depositId}/refund
Confira o passo a passo → https://docs.payzu.com.br/docs/account-hub/refund-a-deposit
Requisições recentes
Path Params
depositIdstringobrigatório
ID do depósito.
Body Params
amountinteger
Valor a devolver, em centavos.
Headers
Authorizationstringobrigatório
Bearer seguido do token de API.
Idempotency-Keystring
Chave única da operação, para repetir sem duplicar.
acceptstring
Formato da resposta.
Responses
200Devolução pedida
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.
400Requisição inválida
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
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.
409Idempotency-Key já usada
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
412Pré-requisito pendente
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
detailsobjectContexto do erro, como valores e limites.
422Devolução recusada
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
detailsobjectContexto do erro, como valores e limites.
429Limite de requisições atingido
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
detailsobjectContexto do erro, como valores e limites.
502Falha na instituição financeira
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
detailsobjectContexto do erro, como valores e limites.
503Serviço indisponível
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
Esta página ajudou?