Web Service - BPeRecepcao
cStat prevista na NT 2025.001. As regras de negócio completas serão reunidas na página própria de Regras de Validação.O Serviço de Recepção de BP-e é oferecido pelos Portais das Secretarias da Fazenda dos Estados para a recepção dos documentos emitidos pelos contribuintes credenciados em sua unidade federada.
O processamento é síncrono e não utiliza lotes. O contribuinte transmite um BP-e e recebe o resultado do processamento na mesma conexão.
- Função: recepção de mensagens de envio de BP-e.
- Processo: síncrono.
- Método:
bpeRecepcao. - Parâmetro da mensagem da área de dados: compactado utilizando GZip e convertido para Base64.
1. Leiaute da Mensagem de Entrada
Entrada: estrutura XML do Bilhete de Passagem Eletrônico definida no Anexo I do MOC.
Schema XML: BPe_v9.99.xsd.
2. Leiaute da Mensagem de Retorno
Retorno: estrutura XML com o resultado do envio do BP-e.
Schema XML: retBPe_v9.99.xsd.
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| AR01 | retBPe | Raiz | - | - | - | - | TAG raiz da resposta. |
| AR02 | versao | A | AR01 | N | 1-1 | 1-4 | Versão do leiaute. |
| AR03 | tpAmb | E | AR01 | N | 1-1 | 1 | Identificação do ambiente: 1 - Produção; 2 - Homologação. |
| AR04 | cUF | E | AR01 | N | 1-1 | 2 | Código da UF que atendeu à solicitação. |
| AR05 | verAplic | E | AR01 | C | 1-1 | 1-20 | Versão do aplicativo que recebeu o BP-e. |
| AR06 | cStat | E | AR01 | N | 1-1 | 3-4 | Código do status da resposta. |
| AR07 | xMotivo | E | AR01 | C | 1-1 | 1-255 | Descrição literal do status da resposta. |
| AR08 | protBPe | G | AR01 | - | 0-1 | - | Resposta ao processamento do BP-e. |
3. Leiaute de BP-e Processado
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| PR01 | protBPe | Raiz | - | - | - | - | TAG raiz da resposta de processamento. |
| PR02 | versao | A | PR01 | N | 1-1 | 2v2 | Versão do leiaute. |
| PR03 | infProt | G | PR01 | - | 1-1 | - | Informações do protocolo de resposta. |
| PR04 | Id | A | PR03 | C | 0-1 | - | Identificador da TAG a ser assinada. Se a UF assinar a resposta, preencher com o número do protocolo precedido do literal “ID”. |
| PR05 | tpAmb | E | PR03 | N | 1-1 | 1 | Identificação do ambiente: 1 - Produção; 2 - Homologação. |
| PR06 | verAplic | E | PR03 | C | 1-1 | 1-20 | Versão do aplicativo que recebeu o BP-e. |
| PR07 | chBPe | E | PR03 | N | 1-1 | 44 | Chave de acesso do BP-e. |
| PR08 | dhRecbto | E | PR03 | D | 1-1 | - | Data e hora do processamento, no formato AAAA-MM-DDTHH:MM:SS TZD. Em autorização, corresponde à gravação no banco de dados; em rejeição, ao recebimento do arquivo. |
| PR09 | nProt | E | PR03 | N | 0-1 | 15 | Número do protocolo de autorização do BP-e. |
| PR10 | digVal | E | PR03 | C | 0-1 | 28 | Digest Value do BP-e processado, utilizado para conferir a integridade com o documento original. |
| PR11 | cStat | E | PR03 | N | 1-1 | 3-4 | Código do status da resposta para o BP-e. |
| PR12 | xMotivo | E | PR03 | C | 1-1 | 1-255 | Descrição literal do status da resposta para o BP-e. |
| PR13 | infFisco | G | PR01 | - | 0-1 | - | Grupo reservado para mensagem do Fisco ao contribuinte. |
| PR14 | cMsg | E | PR13 | N | 1-1 | 3 | Código de status da mensagem do Fisco. |
| PR15 | xMsg | E | PR13 | C | 1-1 | 1-255 | Mensagem do Fisco para o contribuinte. |
| PR16 | Signature | G | PR01 | XML | 0-1 | - | Assinatura XML do grupo identificado pelo atributo “ID”. A decisão de assinar a mensagem fica a critério da UF. |
4. Regras de Validação Básicas do Serviço
| Grupo | Descrição |
|---|---|
| A | Validação do Certificado Digital do Transmissor no protocolo TLS. |
| B-0 | Validação da compactação da mensagem. |
| B | Validação inicial da mensagem no Web Service. |
| C | Validação da área de dados da mensagem. |
A mensagem da área de dados é descompactada antes das demais validações. O XML descompactado está sujeito ao limite de 1024 Kbytes, à validação de formação, disponibilidade do serviço, Schema, namespace, caracteres de edição, prefixos e codificação UTF-8.
5. Validação das Regras de Negócio do BP-e
As regras de negócio aplicadas ao documento estão descritas no capítulo próprio do MOC e nas Notas Técnicas posteriores. Elas serão consolidadas na página Regras de Validação.
6. Final do Processamento do BP-e
A validação pode resultar em:
- Rejeição: o BP-e é descartado e não é armazenado no banco de dados, podendo ser corrigido e transmitido novamente.
- Autorização de uso: o BP-e é armazenado no banco de dados.
| Validação de forma | Situação do BP-e | Para o contribuinte | Banco de Dados |
|---|---|---|---|
| Inválida | Rejeição | Corrigir BP-e | Não gravar |
| Válida | Autorização de uso | Autorizado | Gravar |
Para cada BP-e é atribuído um número de protocolo do Ambiente Autorizador.