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âmetro | Descrição | Formato |
---|---|---|
nit | NIT da transação | = 64 A |
pedido | Código do Pedido (na loja) | < 20 A |
nsu | Número sequencial enviado pela loja | < 12 N |
nsuSitef | Número sequencial único do SiTef | < 10 A |
nsuHost | Número sequencial único da Autorizadora | < 20 A |
nsuesitef | NSU do Carat | = 15 A |
status | Status do pedido. Saiba mais. | = 3 A |
cupom | Cupom 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 |
cupomEstabelecimento | Cupom do estabelecimento em caso de pagamento efetuado. Não contém quebras de linha, cada linha é separada por um @ . | < 4000 A |
autorizadora | Código da Autorizadora (no Carat). Saiba mais. | < 10 A |
tipoPagamento | Tipo do pagamento: C =Crédito, D =Débito, B =Boleto | = 1 A |
dataSitef | Data 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 |
dataEfetivacao | Data 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 |
mensagem | Mensagem da autorizadora | < 1024 A |
codigoRespostaAutorizadora | Código de Resposta da autorizadora | < 1024 A |
rede | Nome da rede pela qual o pagamento está sendo efetuado | < 500 A |
numeroAutorizacao | Nú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
#
Parâmetros enviados pelo post de aviso de statusNa tabela abaixo está a descrição dos parâmetros enviados pelo Carat no POST de de aviso de status:
Parâmetro | Descrição | Formato |
---|---|---|
nsuSitef | Número da Transação | = 6 AN |
nit | Identificador da transação de pagamento no Carat. | = 64 AN |
pedido | Código de identificação do pedido gerado pela loja | < 20 AN |
status | Indica 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.