Depósitos
Acompanhe cada Pix que chega numa chave da sua conta sem cobrança, do aviso DEPOSIT_RECEIVED ao comprovante e, se preciso, à devolução ao pagador. A TED recebida também vira depósito, com method igual a TED.
Veja quem pagou, a chave que recebeu e quanto ainda pode voltar.
Comprovante do depósitoBaixe o PDF do Pix recebido.
Devolver um depósitoMande o valor de volta ao pagador, no total ou em parte.
Receba o aviso
Cadastre um webhook com DEPOSIT_RECEIVED em Cadastrar webhooks e guarde o depositId de cada aviso: é com ele que você consulta, baixa o comprovante e devolve. O corpo do evento está em Depósito recebido.
Se um aviso não chegar, Listar os depósitos traz os depósitos por período de recebimento ou pelo endToEndId, com os mesmos campos da consulta.
O depósito não tem callbackUrl.
Os avisos dele, inclusive os de devolução e de MED, vão só aos webhooks cadastrados.
Quando a devolução fica indisponível
| Situação | Na consulta do depósito |
|---|---|
| Valor retido por controle de depósito | blockedAmount mostra o valor retido. |
| Devolução em andamento | refundInProgressAmount mostra o valor pedido. |
| Infração MED aberta | openInfractionProtocol traz o protocolo. |
| TED recebida | method vem TED. A TED não aceita devolução. |
Nos quatro casos, refundableAmount vem 0.