Como verificar se uma cobrança PIX está realmente PAGA

[EliasCesar]

Você já teve dúvida no momento de verificar se a cobrança PIX gerada pela sua aplicação foi realmente paga?

Pois é, essa dúvida é mais comum do que imaginamos!

A primeira dica é ter a certeza que está armazenando as informações de identificação da cobrança/pagamento/devolução em seu sistema, pois são através desses campos que vc conseguirá utilizar as requisições de consulta dos endpoints.

A seguir vamos detalhar qual os campos indispensáveis para cada rotina.

• Cobrança (/cob): Ao criar uma cobrança é muito importante armazenar o campo txID. Através dele você conseguirá ter acesso a toda "vida" da cobrança e saber exatamente as ações que foram efetuadas(Pagamentos, Devoluções, etc); 
• Pagamento (/pix): Quando o pagamento de uma cobrança é efetuado, é gerado um campo chamado E2E (End to End). Esse campo também deve ser armazenado para que seja possível consultar esse pagamento posteriormente.
• Devolução (/pix/{e2eid}/devolucao} : Quando uma devolução é solicitada, é necessário informar o campo "ID da Devolução", esse campo é importante, caso seja necessário futuramente efetuar uma consulta a essa devolução.

A seguir, vamos realizar testes utilizando nosso demo do componente ACBrPIXCD configurado com o PSP Banco do Brasil em ambiente de Produção:

Ao consultar o txID de uma cobrança recém criada, podemos verificar que o status inicial dela é: "ATIVA"

Você tem acesso a essas informações através da propriedade:

ACBrPixCD1.PSP.epCob.CobCompleta

Quando o pagamento dessa cobrança é efetuado, ao consultá-la novamente temos o status "CONCLUIDA":

Também podemos perceber que existe um objeto PIX na resposta, que contém um campo chamado "endToEndID". É aqui que encontramos todas as informações referente ao pagamento. Com esse campo E2E podemos também consultar um pagamento específico, como mostra a imagem a seguir:

Essas informações são encontradas na propriedade:

ACBrPixCD1.PSP.epPix.Pix

Ao efetuar uma devolução e consultar novamente a nossa cobrança (utilizando ainda o txID), temos o seguinte cenário:

Vemos que a cobrança continua com o status "CONCLUIDA", porém existe uma devolução com status "DEVOLVIDO". Isso quer dizer o que o valor NÃO está na conta do recebedor, ou seja, a cobrança não está paga. 
Portanto é sempre importante avaliar a lista de pagamentos(Pix) que a cobrança possui e verificar também a lista de Devoluções que cada pagamento possui.