Consultar status do Pix

Pré requisitos para implementação:

  • Possuir uma chave api da Celcoin, para mais informações acessar esse link

  • Ter familiaridade com apis Rest usando o protocolo OAuth 2.0.

  • Ter o produto/solução contratada, caso queira usar a funcionalidade em ambiente produtivo, por favor entre em contato com a nossa equipe comercial através do e-mail [email protected] Para dúvidas técnicas, basta entrar em contato com o suporte através do link.

Criamos essa API com objetivo de facilitar a vida de nossos clientes, pois sabemos que não é possível garantir que seu ambiente esteja 100% disponível para receber todas os gatilhos de transferências, ou pagamentos da API de Pix Celcoin. Fora isso, tambem recomendamos o uso dessa api, caso ao tentar realizar uma requisição, a nossa api retorne algum erro desconhecido como um 5xx.

Desta forma um caso de uso seria:

Como fintech quero construir do lado da minha aplicação uma medida preditiva de busca, com objetivo de validar se um ou alguns pagamentos ocorrem com sucesso, para que meu usuário final não tenha problemas com seus pagamentos, ou transferências e com isso consigo fazer sem problemas minha conciliação bancária.

Buscar status dos pagamentos

Para realizar essa busca disponibilizamos a api Verificar o status de um pagamento Pix. Nesta consulta é possível passar os seguintes parâmetros de busca:

transactionId - Identificador da transação retornado na requisição de payment
endtoendId - identificador ponta-a-ponta da transação. O mesmo utilizado no DICT GET ou no retorno da v1/payment.
clientCode - Identificador unico fornecido pelo cliente durante a requisição de payment.

📘

É necessário informar pelo menos um dos campos para realizar a consulta.

Modelo de request:

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/pix/v1/payment/pi/status?transactionId=9162909' \
--header 'accept: application/json' \
--header 'Authorization: Bearer [acess_token]'

Modelo de retorno:

{
    "transactionId": 9162909,
    "clientCode": "1458854123678",
    "endToEndId": "E1393589320220307125800721814129",
    "status": "CONFIRMED",
    "error": null
}

No resultado, serão apresentado até 3 tipos de status diferentes:

PROCESSING: Transação ainda em processamento;
CONFIRMED: Transação confirmada com sucesso;
ERROR: Transação com erro.

As consultas de status realizadas neste endpoint, só terão um status válido a partir de 20 segundos após o recebimento da resposta de sucesso da requisição de pagamento.

🚧

Atenção!

Caso ocorra algum erro da familia 5xx ao tentar realizar um pagamento, ou transfêrencia Pix e, ao consultar nossa api o status da transação esteja PROCESSING, recomendamos que aguarde até receber o disparo do gatilho com o novo status da transação. Sendo assim, não recomendamos o cancelamento da transação, pois o mesmo pode acarretar problemas em sua integração.


Did this page help you?