InserirLogCancelarPassagem
Através do serviço de cancelamento é possível realizar a inserção dos bilhetes de embarque cancelados durante o determinado período.
URL
Produção: POST https://antt.ns.eti.br/v1/antt/logcancelamento
Dados de entrada
| Campo | Ocorrência | Descrição |
|---|---|---|
| X-AUTH-TOKEN | 1-1 | Token de acesso do usuário |
| chPassagem | 1-1 | Chave de acesso do processamento realizado na ANTT |
| tpAmb | 1-1 | Tipo de Ambiente: 1 - Produção; 2 - Homologação |
| codigoMotivoCancelamento | 1-1 | Motivo do cancelamento do bilhete: 1 = Reembolso; 2 = Remarcação; 3 = Transferência de titularidade |
| dataHoraCancelamento | 1-1 | Data e hora do cancelamento |
Exemplo de requisição
Requisição do método InserirLogCancelarPassagem
{
"X-AUTH-TOKEN": "SEU_TOKEN_AQUI",
"chPassagem": "2021080869855400016500000002352000000015",
"tpAmb": 2,
"codigoMotivoCancelamento": 1,
"dataHoraCancelamento": "2021-08-24T11:14:00"
}
Dados retornados
| Campo | Descrição | Tipo | Pai | Observação |
|---|---|---|---|---|
| status | Código de status do processamento | N | ||
| motivo | Descrição literal do status de processamento | A | ||
| retEvento | Objeto contendo os dados de processamento do cancelamento na Sefaz | O | Somente em status = 200 | |
| cStat | Código de situação do processamento | C | retEvento | |
| chave | Chave de acesso do processamento do método | String ou Int | retEvento | Somente em cStat = 135 |
| idTransacao | ID da transação do método InserirLogVendaPassagem | String | retEvento | Somente em cStat = 135 |
| log_doc | Objeto contendo os dados que foram processados no método InserirLogVendaPassagem | Object | retEvento | Somente em cStat = 135 |
| idLog | Codigo Identificado do Log processado na ANTT | Int | log_doc | |
| cnpjEmpresaTransporte | CNPJ da empresa de Transporte | String | logEmissao | |
| numeroBilheteEmbarque | Número do Bilhete de passagem enviado. (nBP) | String | log_doc | |
| sequenciamento | Código sequencial de ordenação Min: 0; Max: 999999; | Int | logEmissao | |
| idViagem | Código Identificador da Viagem (Rodoviário Regular) Informações na sequência apresentada e separadas por hífen. Abaixo, a explicação de cada item que deverá ser incluído no idViagem. Data Programada da Viagem no ponto inicial da linha: AAAAMMDD Hora Programada da Viagem no ponto inicial da linha: HHMMSS Código Tipo de Viagem: NN 00 = Não atende à Regularidade Mínima; 01 = Atende à Regularidade Mínima Código Sentido da Linha: 0 = Volta; 1 = Ida Prefixo da Linha SGP/SIGMA: 8, 11 ou 12 caracteres Exemplo requisição: AAAAMMDD-HHMMSS-NN-N-PPPPPPPPPPPP | String | logEmissao | |
| identificacaoLinha | Identificação da linha; prefixo: rodoviário [8] ou itinerário; semiurbano [4], se aplicável (serviço diferenciado) | String | log_doc | |
| dataViagem | Data de viagem do bilhete. Padrão UTC: AAAAMMDD | String | log_doc | |
| horaViagem | Horário da Viagem do bilhete. Padrão UTC: HHMMSS | String | log_doc | |
| codigoMotivoCancelamento | Motivo do cancelamento do bilhete: 1 = Reembolso; 2 = Remarcação; 3 = Transferência de titularidade | Int | log_doc | |
| dataHoraCancelamento | Data e hora do cancelamento Padrão UTC: AAAA-MMDDTHH:MM:SS | String | log_doc | |
| xMotivo | Descrição litera do cStat | String | retEvento |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Log de Cancelamento processado com sucesso",
"retEvento": {
"cStat": "135",
"chave": "2021080895666800014511000002536000000010",
"idTransacao": "de2a37f6--8bcc-b657-3f7fc5403cd7",
"log_doc": {
"idLog": 11,
"numeroBilheteEmbarque": "000002536",
"identificacaoLinha": "00000001",
"dataViagem": "20210825",
"horaViagem": "093000",
"codigoMotivoCancelamento": 1,
"dataHoraCancelamento": "2021-08-25T14:20:00"
},
"xMotivo": "Ação executada com sucesso."
}
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Envio do log executado com sucesso. |
| -2 | Erro de validação de dados enviados. |
| -3 | Erros no processamento do log após enviar para o Core/ANTT |
| -4 | Erros no processamento do log após enviar para o Core/ANTT |
| -5 | Erros no processamento do log após enviar para o Core/ANTT |
| -6 | Documento ja processado anteriormente e autorizado. Consulta o nsNRec informado da resposta. |
Download do processamento do método InserirLogCancelarPassagem
Você pode fazer o download das informações completas do cancelamento em XML ou JSON. Para isso confira o método Download do Cancelamento.