Cancelamento REST

Visão Geral#

O Carat disponibiliza serviços para cancelamento (estorno) de um pagamento.

Por questões de segurança, este fluxo exige uma etapa de autenticidade, onde o Carat faz um POST na URL de autenticidade cadastrada da loja com os dados necessários para dar continuidade ao fluxo e realizar o estorno de fato.

E para saber mais sobre essas nomenclaturas (Bin, Software Express, Carat, e-Sitef) Saiba mais

Descrição do fluxo:

  • 1. O lojista inicia um cancelamento passando o esitef_usn da transação desejada (campo retornado pelo Carat após aprovar o pagamento). Em caso de sucesso, o Carat retornará código e mensagem correspondentes.
    • 1.1. Durante a chamada de criação de estorno, o Carat fará um POST na URL de autenticidade cadastrada da loja com o NIT da transação de cancelamento. A loja deve então responder a esse POST com um código HTTP 200 (OK). Caso esse código não seja devolvido, o Carat interpretará como uma falha nessa operação e invalidará o NIT.
  • 2. A loja virtual prossegue o fluxo chamando o serviço de cancelamento, passando o NIT obtido no POST de autenticidade e dados adicionais que podem ser necessários dependendo da adquirente em questão (como o número do cartão, em caso de pagamentos via SiTef). Caso nenhum problema ocorra, o Carat retornará uma mensagem de sucesso e os dados da transação de estorno.

Consulta dos cancelamentos#

As informações das transações de cancelamento podem ser consultadas através do mesmo serviço utilizado pela interface de Pagamento REST. Saiba mais.