Serviço de Aviso de status

Importante:

Para que o aviso de status funcione nas transações PIX REST, é necessário que a loja esteja configurada na versão 6. Em caso de dúvidas, entre em contato com a equipe de produção.

No cadastro da loja deve ser informada uma URL de Status, onde o Carat irá enviar um POST contendo o status da transação com os seguintes parâmetros:

ParâmetroDescriçãoFormato
nitNIT da transação= 64 A
pedidoCódigo do Pedido (na loja)< 20 A
nsuNúmero sequencial enviado pela loja< 12 N
nsuSitefNúmero sequencial único do SiTef< 10 A
nsuHostNúmero sequencial único da Autorizadora< 20 A
nsuesitefNSU do Carat= 15 A
statusStatus do pedido. Saiba mais.= 3 A
cupomCupom do pagamento (via do cliente) em caso de pagamento efetuado. Não contém quebras de linha, cada linha é separada por @ ao invés de quebra de linha.< 4000 A
cupomEstabelecimentoCupom do estabelecimento em caso de pagamento efetuado. Não contém quebras de linha, cada linha é separada por um @.< 4000 A
autorizadoraCódigo da Autorizadora (no Carat). Saiba mais.< 10 A
tipoPagamentoTipo do pagamento: C=Crédito, D=Débito, B=Boleto= 1 A
dataSitefData do pagamento no formato DD/MM/AAAA hh:mm:SS.
Atenção: este parâmetro só é enviado para transações confirmadas que foram roteadas pelo SiTef.
= 19 A
dataEfetivacaoData do pagamento no formato DD/MM/AAAA hh:mm:SS no caso de pagamentos que não forem via SiTef.
Atenção: este parâmetro só é enviado para transações confirmadas que não foram roteadas pelo SiTef.
= 19 A
mensagemMensagem da autorizadora< 1024 A
codigoRespostaAutorizadoraCódigo de Resposta da autorizadora< 1024 A
redeNome da rede pela qual o pagamento está sendo efetuado< 500 A
numeroAutorizacaoNúmero da autorização (gerado pela autorizadora)= 6 A

Importante:

Além dos parâmetros acima o Carat pode devolver outros sem aviso prévio. Por favor, esteja preparado para receber parâmetros extras além dos da tabela acima, que podem ser ignorados. Porém, em alguns casos parâmetros adicionais retornados por determinadas autorizadoras serão enviados juntamente.

Não é necessário devolver nada no POST, porém se o POST não for bem-sucedido (HTTP Status-Code 200: OK), o Carat tentará de novo até o número de vezes configurado no sistema, antes de desistir e deixar a transação como pendente de aviso, conforme as figuras abaixo.

O POST/HTTPS do Carat pode não ser imediato, mas sim, será assíncrono, com o tempo podendo variar conforme carga do servidor e da Internet. Caso haja algum problema no envio, o Carat tentará reenviar a mensagem após um determinado período de tempo, sendo 3 (três) tentativas.

Nem todos os parâmetros podem estar presentes em todas as transações, alguns parâmetros podem não ser enviados dependendo da forma de pagamento ou se a transação não for concluída, por exemplo.

Tentativas de aviso de mudança de status:

Tentativas sem sucesso de aviso de mudança de status:

POST de aviso de status:

Segue um exemplo de um post de aviso de status

curl -X POST \
https://www.lojateste.com.br/status.php \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'cache-control: no-cache' \
-d 'nsuSitef=315569&nit=9230d962f0afb40db64e082c37564f4b113c3e4fc6a5090c40813c4b0d80ca37&pedido=201808020001&status=CON'

Parâmetros enviados pelo post de aviso de status#

Na tabela abaixo está a descrição dos parâmetros enviados pelo Carat no POST de de aviso de status:

ParâmetroDescriçãoFormato
nsuSitefNúmero da Transação= 6 AN
nitIdentificador da transação de pagamento no Carat.= 64 AN
pedidoCódigo de identificação do pedido gerado pela loja< 20 AN
statusIndica o Status de uma transacao no e-SiTef.= 3 N

O Carat também pode enviar novos parâmetros sem aviso prévio, o que significa que a aplicação do lojista deve estar preparada para receber campos extras e simplesmente ignorá-los.