Web Service - Eventos Específicos
1. Evento de Vinculação da Transação de Pagamento no DFe
O evento deve ser gerado pelo emitente do DFe sempre que se pretenda vincular uma ou mais transações financeiras a documento fiscal previamente autorizado.
Observação: a transação financeira vinculada pode estar iniciada, ainda pendente de pagamento e/ou liquidação, como boleto emitido ou QR Code Pix gerado.
Função: evento destinado ao atendimento de solicitações de vinculação do pagamento do DFe.
Autor do Evento: emissor do DFe. A mensagem XML será assinada com certificado digital que tenha o CNPJ base do Emissor.
Código do Tipo de Evento: 110300.
Schema XML: evVincPgto_v9.99.xsd.
1.1. Leiaute do Evento
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| # | evVincPgto | Raiz | detEvento | G | 1-1 | - | Schema XML de validação do evento de vinculação da transação de pagamento com o DFe - 110300. |
| 1 | descEvento | E | evVincPgto | E | 1-1 | 20 | Descrição do Evento - “Vinculação Pagamento”. |
| 2 | nProt | E | evVincPgto | E | 1-1 | 15 | Número do protocolo de autorização do DFe. |
| 3 | pgto | E | pgtoVinc | G | 1-1 | - | Dados de cada pagamento previsto para o DFe. |
| 4 | nPag | A | pgto | N | 1-1 | 3 | Atributo numerador único de cada ocorrência de pagamento. |
| 5 | idTransacao | A | pgto | C | 1-1 | 2-35 | Identificador específico da transação financeira. O próprio schema impede que se repita dentro do grupo. |
| 6 | tpMeioPgto | E | pgto | N | 1-1 | 2 | Código do meio de pagamento utilizado. Ver IT DFe 2026.001, que divulgará os códigos aceitos conforme a tabela nacional de Meios de Pagamento da NFe. |
| 7 | CNPJReceb | E | pgto | C | 1-1 | 14 | CNPJ completo do recebedor do pagamento, como fornecedor, plataforma ou outra entidade que receba o pagamento do adquirente. Observação: o CNPJ do recebedor pode ser diferente do CNPJ do fornecedor constante no documento fiscal. |
| 8 | CNPJBasePSP | E | pgto | C | 1-1 | 8 | CNPJ base da instituição financeira ou de pagamento utilizada pelo recebedor do pagamento. |
1.2. Validação das Regras Específicas
| # | Regra de Validação | Aplic. | cStat | Efeito | Mensagem |
|---|---|---|---|---|---|
| L01 | Verificar se a UF da Chave de Acesso difere da UF do Web Service. | Obrig. | 249 | Rej. | Rejeição: UF da Chave de Acesso diverge da UF autorizadora. |
| L02 | Verificar se o nSeqEvento é maior que o valor permitido (1 a 999). | Obrig. | 636 | Rej. | Rejeição: O número sequencial do evento é maior que o permitido. |
| L03 | Emitente deve estar habilitado na base de dados para emissão do DFe. | Obrig. | 203 | Rej. | Rejeição: Emissor não habilitado para emissão de NF3e. |
| L04 | Verificar se DFe já está cancelado. | Obrig. | 218 | Rej. | Rejeição: NF3e já está cancelado na base de dados da SEFAZ. [nProt:999999999999999][dhCanc: AAAA-MM-DDTHH:MM:SS TZD]. |
| L06 | Verificar se DFe foi substituído. | Obrig. | 224 | Rej. | Rejeição: NF3e já está substituído na base de dados da SEFAZ. [nProt:999999999999999][dhSubst: AAAA-MM-DDTHH:MM:SS TZD]. |
| L10 | Verificar se número do Protocolo informado difere do número do Protocolo do DFe. | Obrig. | 222 | Rej. | Rejeição: Protocolo de Autorização de Uso difere do cadastrado. |
| L11 | Se informado grupo de vinculação com a transação de pagamento (grupo: gPgtoVinc), validar para cada pagamento o CNPJ do Recebedor (dígito de controle, zeros e CNPJ Alfanumérico). Observação: informar na mensagem o numerador do pagamento que ocasionou a rejeição. | Obrig. | 1001 | Rej. | Rejeição: CNPJ do recebedor do pagamento inválido [nPag: XXX]. |
| L12 | Verificar se o código informado em tpMeioPgto é válido. Observação: os códigos válidos serão publicados no Informe Técnico dos DFe 2006.001 e correspondem à tabela nacional de Meios de Pagamento da NFe publicada no Ambiente Nacional. | Obrig. | 1003 | Rej. | Rejeição: Meio de pagamento inválido [nPag: XXX]. |
1.3. Final do Processamento
Se o evento de vinculação de pagamento do DFe for homologado, o status de retorno deverá ser cStat=135.
2. Evento de Cancelamento da Vinculação de Pagamento
Função: indicar o cancelamento de um evento de vinculação de pagamento do DFe quando ocorrer erro na geração do evento.
Autor do Evento: emissor do DFe. A mensagem XML será assinada com certificado digital que tenha o CNPJ base do Emissor.
Código do Tipo de Evento: 110301 (exige a existência do DFe em situação autorizado).
Schema XML: evCancVincPGto_v9.99.xsd.
2.1. Leiaute do Evento
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| IP01 | evCancVincPgto | G | - | - | - | - | TAG raiz. |
| IP02 | descEvento | E | IP01 | C | 1-1 | 44 | Descrição do Evento: “Cancelamento da Vinculação do Pagamento”. |
| IP03 | nProt | E | IP01 | N | 1-1 | 15 | Informar o número do protocolo de autorização do DFe. |
| IP04 | nProtVincPgto | E | IP01 | N | 1-1 | 15 | Informar o número do protocolo de autorização do evento de vinculação de pagamento que será cancelado. |
2.2. Validação das Regras Específicas
| # | Regra de Validação | Aplic. | cStat | Efeito | Mensagem |
|---|---|---|---|---|---|
| Q01 | Verificar se a UF da Chave de Acesso difere da UF do Web Service. | Obrig. | 249 | Rej. | Rejeição: UF da Chave de Acesso diverge da UF autorizadora. |
| Q02 | Verificar se o nSeqEvento é maior que o valor permitido (1 a 999). | Obrig. | 636 | Rej. | Rejeição: O número sequencial do evento é maior que o permitido. |
| Q03 | Emitente deve estar habilitado na base de dados para emissão do DFe. | Obrig. | 203 | Rej. | Rejeição: Emissor não habilitado para emissão de NF3e. |
| Q04 | Verificar se número do Protocolo informado difere do número do Protocolo do DFe. | Obrig. | 222 | Rej. | Rejeição: Protocolo de Autorização de Uso difere do cadastrado. |
| Q05 | Verificar se o número do Protocolo do evento de vinculação de pagamento a ser cancelado existe para o DFe e encontra-se na situação autorizado. | Obrig. | 1002 | Rej. | Rejeição: Protocolo do evento a ser cancelado não existe, não está associado ao DFe ou já está cancelado. |
2.3. Final do Processamento
Se o evento de Cancelamento da vinculação do pagamento do DFe for homologado, o status de retorno deverá ser cStat=135 e o evento cancelado passará à condição de anulado.