Através deste endpoint é possível realizar a troca do assento/poltrona/cabine sem alteração de valores ou data de embarque de um bilhete previamente autorizado através da API.
URL
Produção: POST https://bpe.ns.eti.br/v1/bpe/alterpol
Dados de entrada
| Campo | Descrição | Ocorrência | Tipo | Observação |
|---|---|---|---|---|
| X-AUTH-TOKEN | Token de acesso do usuário | 0-1 | A | Pode ser enviado no cabeçalho da requisição |
| chBPe | Chave de acesso do BP-e | 1-1 | N | |
| tpAmb | Tipo do ambiente de autorização do BP-e 1 - Produção 2 - Homologação | 1-1 | N | |
| dhEvento | Data e hora da ocorrência do cancelamento | 1-1 | D | Padrão Sefaz AAAA-MM-DDTHH:MM:SS + UTC Ex.: 2016-06-13T15:04:10-02:00 |
| nProt | Número do protocolo de autorização do BP-e | 1-1 | N | |
| poltrona | Número da nova poltrona/assento/cabine do BP-e | 1-1 | N |
Exemplo de requisição
Requisição de cancelamento de BP-e
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"chBPe": "99999999999999999999999999999999999999999999",
"tpAmb": 2,
"dhEvento": "2017-05-15T12:00:00-03:00",
"nProt": "999999999999999",
"poltrona": "2"}'\
https://bpe.ns.eti.br/v1/bpe/alterpol
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 | |
| xMotivo | Descrição literal da situação do processamento na Sefaz | A | retEvento | |
| chBPe | Chave de acesso do BP-e | N | retEvento | Somente em cStat = 135 |
| dhRegEvento | Data e hora de registro do evento na Sefaz | D | retEvento | Padrão Sefaz AAAA-MM-DDTHH:MM:SS + UTCEx.: 2016-06-13T15:04:10-03:00 Somente em cStat = 135 |
| nProt | Número do protocolo de autorização do evento | N | retEvento | Somente em cStat = 135 |
| xml | XML de distribuição do evento de cancelamento | S | retEvento | Somente em cStat = 135 |
| erro | Objeto contendo as informações de erro caso o cancelamento não possa ser realizado com sucesso | O | Somente em status diferente de 200 | |
| cStat | Código de status do erro | N | erro | |
| xMotivo | Descrição literal do erro | A | erro |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Processamento de evento realizado com sucesso",
"retEvento": {
"cStat": 135,
"xMotivo": "Evento registrado e vinculado a BP-e",
"chBPe": "99999999999999999999999999999999999999999999",
"dhRegEvento": "2018-02-21T14:58:46-03:00",
"nProt": "999999999999999",
"xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?><procEventoBPe versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/bpe\">...</procEventoBPe>"
}
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Processamento de evento realizado com sucesso |
| -2 | Chave de acesso inválida |
| -3 | Não foi possível vincular o evento ao BP-e Verifique o objeto erro para maiores informações |