10.6. Eventos do CT-e
10.6.14. Cancelamento Vinculação Pgto RT
10.6.13. Vinculação Pgto RT
« Anterior
10.7. Distribuição de DF-e
Próximo »

10.6.14. Cancelamento Vinculação Pgto RT

Cancelamento da Vinculação de Pagamento do DF-e (CT-e, CT-e Simp ou CT-e OS)

Assinatura

string CancelaVincPgto(string siglaWS, int tipoAmbiente, string nomeCertificado, string versao, out string msgDados, out string msgRetWS, out int cStat, out string msgResultado, int nroCancVincPgto, string chaveCTe, string nProt, string nProtVincPgto, string dhEvento, out string nProtocolo, out string dProtocolo, string proxy, string usuario, string senha, string licenca)

Descrição:

Evento para indicar o cancelamento de um evento de vinculação de pagamento do DF-e (CT-e, CT-e Simp ou CT-e OS) nas ocasiões em que ocorrer erro na geração do evento.

Autor do Evento: O autor do evento é o emissor do DFe. A mensagem XML do evento será assinada com o certificado digital que tenha o CNPJ base do Emissor.


Preenchimento da siglaWS

A identificação do WS será informada no parâmetro siglaWS, veja Tabela de siglaWS

Preenchimento do nomeCertificado

informar o Nome do titular (campo Assunto) do certificado digital a ser utilizado na conexão SSL, formas possíveis:

1. uso de certificado digital existente no repositório MY do CSP do usuário corrente (currentuser)

É a forma de mais comum de uso, cabe ressaltar que é a única forma de uso de certificado digital do tipo A3 que a DLL oferece.
O usuário deve passar como parâmetro o campo assunto do certificado no parâmetro NomeCertificado para que a DLL localize um certificado digital com mesmo assunto no repositório MY do currentuser do equipamento.
Esta forma de uso requer a prévia instalação do certificado digital na conta do usuário do Windows (logon) que irá utilizar o certificado digital.

2. uso de certificado digital em arquivo no formato pfx

Permite o de uso de certificado digital em arquivo formato pfx.
O caminho da localização (path) do arquivo pfx deve ser passado para a DLL no formato: ARQUIVO | [nome do arquivo pfx com caminho completo] | [senha do arquivo] no parâmetro NomeCertificado, ex.: "ARQUIVO|c:\certificado.pfx|senha".
Esta opção só funciona com certificado digital do tipo A1.

3. uso de certificado digital em string base64

Permite uso o arquivo do certificado digital em formato pfx convertido em uma string base64. O certificado digital em string base64 deve ser passado para a DLL no formato: CERTIFICADO | [string base64 do arquivo pfx] | [senha do arquivo] no parâmetro NomeCertificado, ex.: "CERTIFICADO|MIIGoDCCBYigAwIBAgIQep(arquivo pfx do certificado digital convertido em base64...)QQDExNBQy|senha".
Esta opção só funciona com certificado digital do tipo A1. É uma opção de uso que oferece maior versatilidade, pois permite o armazenamento do certificado digital em banco de dados na aplicação. É a forma mais indicada para uso em ASP.NET.


Parâmetros:

nome tipo fluxo descrição
siglaWS string entrada A identificação do WS será informada no parâmetro siglaWS, veja Tabela de siglaWS
tipoAmbiente inteiro entrada informar o código do ambiente desejado: 1- produção ou 2-homologação
NomeCertificado string entrada informar o certificado digital que será utilizado para assinatura:
1. informar o assunto do certificado digital que deve existir no repositório MY do current user, ex.: "CN=NFe - Associacao NF-e:99999090910270, C=BR, L=PORTO ALEGRE, O=Teste Projeto NFe RS, OU=Teste Projeto NFe RS, S=RS".
2. informar: ARQUIVO | [nome do arquivo pfx com caminho completo] | [senha do arquivo] para uso do certificado digital em arquivo pfx, ex.: "ARQUIVO|c:\certificado.pfx|senha".
3. informar: CERTIFICADO | [string base64 do arquivo pfx] | [senha do arquivo] no parâmetro NomeCertificado para passar uma string contendo um certificado digital em base64, ex.:"CERTIFICADO|MIIGoDCCBYigAwIBAgIQep(arquivo pfx do certificado digital convertido em base64...)QQDExNBQy|senha".
(novas opções)
versao string entrada informar a versão da mensagem do WS: 4.00.
msgDados string saída retorna a mensagem XML do evento insuceso de entrega da carga criado pela DLL que foi enviado ao WS.
msgRetWS string saída retorna a mensagem XML de resposta do WS
cStat inteiro saída retorna o resultado da chamada do WS.
msgResultado string saída retorna a literal do resultado da chamada do WS
nroCancVincPgto inteiro entrada informar o número sequencial do cancelamento da vinculação de pagamento, deve ser iniciada com 1 e valor máximo é 99, campo de controle do usuário, o Web Service não permite a duplicidade de numeração e nem controla a ordem crescente.
chaveCTe string entrada informar a chave de acesso do DF-e (CT-e, CT-e Simp ou CT-e OS) objeto do cancelamento da vinculação de pagamento
nProt string entrada informar o número do protocolo de autorização do DF-e (CT-e, CT-e Simp ou CT-e OS)
nProtVincPgto string entrada informar o número do protocolo de autorização do evento de vinculação de pagamento que será cancelado
dhEvento string entrada informar a data e hora do evento cancelamento do insucesso de entrega no formato UTC (data e hora com fuso horário): "AAAA-MM-DDTHH:MM:SS-HH:00".
Exemplos:
2017-01-13T12:34:00-02:00 (fuso horário de Brasília no horário de verão).
2017-01-13T12:34:00-03:00 (fuso horário de Brasília).
Se nada for informado (""), a DLL utilizará a data e hora e fuso horário do equipamento.
nProtocolo string saída retorna o número do protocolo de registro do evento cancelamento do insucesso de entrega da carga.
dProtocolo string saída retorna a data e hora de registro do evento cancelamento do insucesso de entrega da carga pela SEFAZ.
proxy string entrada informar 'http://proxyserver:port' quando existir uso de proxy no ambiente. verificar com o cliente qual é o endereço do servidor proxy e a porta https, a porta padrão do https é 443, assim teríamos algo do tipo 'http://192.168.15.1:443'
usuario string entrada informar o usuário para autenticação no proxy, se necessário
senha string entrada informar a senha de autenticação no proxy, se necessário
licenca string entrada informar a chave da licenca de uso ou registro, esta funcionalidade pode ser utilizada sem qualquer restrição no ambiente de homologação. O uso em ambiente de produção requer o licenciamento, para maiores detalhes veja as condições de uso


Retorno:

O resultado da chamada do CancelaVincPgto é a mensagem XML composta pelo Evento do cancelamento de um evento de vinculação de pagamento do DF-e e respectivo protocolo de registro do evento se o cancelamento de um evento de vinculação de pagamento do DF-e for registrado e vinculado no DF-e (cStat=135).

Exemplo do XML cancelamento de um evento de vinculação de pagamento do DF-e:

 
<?xml version="1.0" encoding="UTF-8"?>
<procEventoCTe xmlns="http://www.portalfiscal.inf.br/cte" versao="4.00">
   <eventoCTe xmlns="http://www.portalfiscal.inf.br/cte" versao="4.00">
      <infEvento Id="ID11030135221202449691000130570010000000291000796813001">
         <cOrgao>35</cOrgao>
         <tpAmb>2</tpAmb>
         <CNPJ>02449691000130</CNPJ>
         <chCTe>35221202449691000130570010000000291000796813</chCTe>
         <dhEvento>2026-04-21T18:59:21-03:00</dhEvento>
         <tpEvento>110301</tpEvento>
         <nSeqEvento>1</nSeqEvento>
         <detEvento versaoEvento="4.00">
            <evCancVincPgto>
               <descEvento>Cancelamento da vinculacao do pagamento</descEvento>
               <nProt>135220018025398</nProt>
               <nProtVincPgto>135260000881505</nProtVincPgto>
            </evCancVincPgto>
         </detEvento>
      </infEvento>
      <Signature xmlns="http://www.w3.org/2000/09/xmldsig#">
         <SignedInfo>
            <CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
            <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/>
            <Reference URI="#ID11030135221202449691000130570010000000291000796813001">
               <Transforms>
                  <Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/>
                  <Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
               </Transforms>
               <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
               <DigestValue>Mn5YDR6PDbtqBvp+/6qL1kw9GHQ=</DigestValue>
            </Reference>
         </SignedInfo>
         <SignatureValue>uK4moF5kIY87LZi5ISRWYASV84qhcDYT(...)jmqlsAJUurcXR+YdWEKA==</SignatureValue>
         <KeyInfo>
            <X509Data>
               <X509Certificate>MIIH3jCCBcagAwIBAgIIcl2Ceg/5CW0wD(...)OucWnapIPwNDzo=</X509Certificate>
            </X509Data>
         </KeyInfo>
      </Signature>
   </eventoCTe>
   <retEventoCTe xmlns="http://www.portalfiscal.inf.br/cte" versao="4.00">
      <infEvento>
         <tpAmb>2</tpAmb>
         <verAplic>SP-CTe-2026-04-06-1</verAplic>
         <cOrgao>35</cOrgao>
         <cStat>135</cStat>
         <xMotivo>Evento registrado e vinculado a CT-e.</xMotivo>
         <chCTe>35221202449691000130570010000000291000796813</chCTe>
         <tpEvento>110301</tpEvento>
         <xEvento>Cancelamento da Vinculação do Pagamento</xEvento>
         <nSeqEvento>1</nSeqEvento>
         <dhRegEvento>2026-04-21T18:59:21-03:00</dhRegEvento>
         <nProt>135260000881510</nProt>
      </infEvento>
   </retEventoCTe>
</procEventoCTe>

O parâmetro cStat retorna um código numérico com os seguintes significados:

código Mensagem origem regra
5001 Erro: Falha na conexão: [MENSAGEM DE ERRO DO WINDOWS] (Causa provável: o certificado cliente: 1.não é ICP-Brasil; 2.fora do prazo de validade; 3.revogado; 4.certificado cliente não confiável para o Web Service acessado, contatar a SEFAZ) DLL -
5002 Erro: Falha na conexão: [MENSAGEM DE ERRO DO WINDOWS] (Causa provável: a cadeia de certificação do Web Service acessado ou do certificado cliente inexistente no repositório de certificados do usuário corrente do Windows) DLL -
5003 Erro: Falha na conexão: [MENSAGEM DE ERRO DO WINDOWS] (Causa provável: serviço inexistente, verifique se o nome do serviço da url acessada está correto no arquivo ws2.xml) DLL -
5004 Erro: Falha na conexão: [MENSAGEM DE ERRO DO WINDOWS] (Causa provável: método não permitido) DLL -
5005 Erro: Falha na conexão: [MENSAGEM DE ERRO DO WINDOWS] (Causa provável: a url não encontrada, verifique se o nome do domínio da url acessada está correto no arquivo ws2.xml) DLL -
5006 Erro: Falha na conexão: [MENSAGEM DE ERRO DO WINDOWS] (Causa provável: Time-Out, o WS não respondeu a solicitação no tempo estabelecido: [{1:0}]) DLL -
5007 Erro: Falha na conexão: [MENSAGEM DE ERRO DO WINDOWS] (Causa provável: mensagem maior que a permitida) DLL -
5008 Erro: Falha na conexão: [MENSAGEM DE ERRO DO WINDOWS] (Causa provável: Servidor com problemas) DLL -
5009 Erro: Falha na conexão: [MENSAGEM DE ERRO DO WINDOWS] (Causa provável: Serviço não implementado) DLL -
5010 Erro: Falha na conexão: [MENSAGEM DE ERRO DO WINDOWS] (Causa provável: Serviço temporariamente indisponível, servidor sem recursos para atender a solicitação) DLL -
5011 Erro: Falha na conexão: [MENSAGEM DE ERRO DO WINDOWS] (Causa provável: Causa provável da falha na conexão: Rede indisponível) DLL -
5012 Erro: Falha na conexão: [MENSAGEM DE ERRO DO WINDOWS] (Causa provável: Versão do SOAP não suportada DLL -
5013 Erro: Falha na conexão: [MENSAGEM DE ERRO DO WINDOWS] (Causa provável: Web Service não consumido, não houve nenhum retorno ou resposta) DLL -
5014 Erro: Falha na conexão: [MENSAGEM DE ERRO DO WINDOWS] (Causa provável: Web Service não consumido, falha desconhecida) DLL -
5015 Erro: Falha na conexão: Tempo limite de time-out alcançado [TEMPO DE TIME OUT UTILIZADO ms] - [MENSAGEM DE ERRO DO WINDOWS] DLL -
5016 Erro: Falha na conexão: Falha da Biblioteca Criptografica: [MENSAGEM DE ERRO DO WINDOWS] DLL -
5017 Erro: Falha ao tratar o XML de retorno do WS: [MENSAGEM DE ERRO DO WINDOWS] DLL -
5101 Erro: A mensagem de retorno do WS não é um XML válido: [MENSAGEM DE ERRO DO WINDOWS] DLL -
5102 Erro: Tag cStat inexistente na mensagem de retorno [MENSAGEM DE ERRO DO WINDOWS] DLL -
5103 Erro: Tag xMotivo inexistente na mensagem de retorno [MENSAGEM DE ERRO DO WINDOWS] DLL -
5104 Erro: Tag [NOME TAG] inexistente na mensagem de retorno [MENSAGEM DE ERRO DO WINDOWS] DLL -
5105 Erro: O WS não devolveu nenhum resultado DLL -
5201 Erro: O código do tipo de ambiente [CODIGO RECEBIDO PELA DLL] informado diferente de 1 - produção e 2 - homologação DLL -
5202 Erro: A sigla da UF [SIGLA RECEBIDA PELA DLL] informada é inválida DLL -
5203 Erro: Inexiste url para a UF [SIGLA UF] informada no ambiente [AMBIENTE] desejado, verifique se existe atualização do arquivo [NOME ARQUIVO] disponível. DLL -
5204 Erro: Arquivo que contem a URL do WS não localizado em [CAMINHO DA APLICACAO] DLL -
5205 Erro: Ocorreu um erro inesperado no processamento da URL (NOME URL) : [MENSAGEM DE ERRO DO WINDOWS] DLL -
5206 Erro: Ocorreu um erro de validação do XML (NOME XML) : [MENSAGEM DE ERRO DO WINDOWS] DLL -
5403 Erro: Falha ao acessar certificado digital [mensagem de ERRO DO WINDOWS] DLL -
5404 Erro: Nenhum certificado digital selecionado DLL
5405 Erro: Nenhum certificado válido foi encontrado com o nome [NomeCertificado] informado no repositório [MY do CurrentUser] DLL -
5406 Erro: Falha no tratamento do parâmetro nome: [nome informado] DLL -
5407 Erro: Quantidade de parâmetos inválido: [nome informado] DLL -
5408 Erro: Falha na criação do objeto certificate: [mensagem do ERRO DO WINDOWS] DLL -
6101 Erro: O parâmetro versao não foi informado DLL -
6102 Erro: O conteúdo do parâmetro sigla da UF: [CONTEÚDO] é inválido DLL -
6103 Erro: O conteúdo do parâmetro versao informado é inválido: [CONTEUDO] DLL -
6105 Erro: O tamanho [TAMANHO DO PARAMETRO] do parâmetro chaveCTe informado não tem 44 caracteres DLL -
6106 Erro: As posições correspondentes (1,2) ao código da UF [POSIÇÃO DA CHAVE] do parâmetro chaveCTe não é um código de UF válido DLL -
6107 Erro: A chave de acesso deve ter 44 posições: [POSIÇÃO DA CHAVE] DLL -
6110 Erro: O nome do titular do certificado deve ser informado DLL -
6120 Erro: O parâmetro chave de acesso deve ser informado DLL -
6123 Erro: O parâmetro tipoAmbiente deve ser informado DLL -
6124 Erro: O parâmetro tipoAmbiente [CONTEUDO] deve ser 1 ou 2 DLL -
6141 Erro: O parâmetro siglaWS deve ser informado DLL -
6158 Erro: O parâmetro dhEvento é inválido:[dhEvento] DLL -
6260 Erro: O parâmetro nroCancVincPgto (número sequencial do evento cancela Vincula Pgto) deve ser informado DLL -
6261 Erro: O parâmetro nroCancVincPgto (número sequencial do evento cancela Vincula Pgto) informado: [CONTEUDO] fora da faixa permitida 1-999 DLL -
6262 Erro: O parâmetro nProt (número do protocolo do CT-e) deve ser informado DLL -
6263 Erro: O parâmetro nProt (número do protocolo do CT-e) deve ter 15 caracteres: [CONTEUDO] DLL -
6264 Erro: O parâmetro nProtVincPgto (número do protocolo de autorização do evento a ser cancelado) deve ser informado DLL -
6265 Erro: O parâmetro nProtVincPgto (número do protocolo de autorização do evento a ser cancelado) deve ter 15 caracteres: [CONTEUDO] DLL -
7001 Erro: A licença não foi informada DLL -
7002 Erro: A licença informada: [CONTEUDO] tem tamanho:[TAMANHO] diferente de 128 DLL -
7003 Erro: A licença informada: [CONTEUDO] não pertence ao CNPJ:[TAMANHO] DLL -
108 Serviço Paralisado Momentaneamente (curto prazo) WS B03
109 Serviço Paralisado sem Previsão WS B04
135 Evento registrado e vinculado ao CT-e WS -
203 Rejeição: Emissor não habilitado para emissão do CT-e WS Q03
213 Rejeição: CNPJ-Base do Emitente difere do CNPJ-Base do Certificado Digital WS F03
214 Rejeição: Tamanho da mensagem excedeu o limite estabelecido WS B01
215 Rejeição: Falha no schema XML WS D01
218 Rejeição: CT-e já está cancelado na base de dados da SEFAZ [nProt:999999999999999][dhCanc: AAAA-MMDDTHH:MM:SS TZD] WS L04
222 Rejeição: Protocolo de Autorização de Uso difere do cadastrado WS Q04
224 Rejeição: CTe já está substituído na base de dados da SEFAZ. [nProt:999999999999999][dhSubst: AAAA-MMDDTHH:MM:SS TZD] WS L06
236 Rejeição: Chave de Acesso com dígito verificador inválido WS L09
238 Rejeição: Cabeçalho - Versão do arquivo XML superior a Versão vigente WS C06
239 Rejeição: Cabeçalho - Versão do arquivo XML não suportada WS C07
242 Rejeição: Cabeçalho - Falha no Schema XML WS C01
243 Rejeição: XML Mal Formado WS B02
249 Rejeição: UF da Chave de Acesso diverge da UF autorizadora WS Q01
252 Rejeição: Ambiente informado diverge do Ambiente de recebimento WS L01
280 Rejeição: Certificado Transmissor inválido WS A01
281 Rejeição: Certificado Transmissor Data Validade WS A02
282 Rejeição: Certificado Transmissor sem CNPJ WS A07
283 Rejeição: Certificado Transmissor - erro Cadeia de Certificação WS A03
284 Rejeição: Certificado Transmissor revogado WS A05
285 Rejeição: Certificado Transmissor difere ICP-Brasil WS A06
286 Rejeição: Certificado Transmissor erro no acesso a LCR WS A04
290 Rejeição: Certificado Assinatura inválido WS E01
291 Rejeição: Certificado Assinatura Data Validade WS E02
292 Rejeição: Certificado Assinatura sem CNPJ WS E03
293 Rejeição: Certificado Assinatura - erro Cadeia de Certificação WS E04
294 Rejeição: Certificado Assinatura revogado WS E06
295 Rejeição: Certificado Assinatura difere ICP-Brasil WS E07
296 Rejeição: Certificado Assinatura erro no acesso a LCR WS E05
297 Rejeição: Assinatura difere do calculado WS F02
298 Rejeição: Assinatura difere do padrão do Projeto WS F01
402 Rejeição: XML da área de dados com codificação diferente de UTF-8 WS D05
404 Rejeição: Uso de prefixo de namespace não permitido WS D04
409 Rejeição: Campo cUF inexistente no elemento cteCabecMsg do SOAP Header WS C02
410 Rejeição: UF informada no campo cUF não é atendida pelo Web Service WS C03
513 Rejeicao: UF nao atendida pela SVC-[SP/RS] WS C04
516 Rejeição: O tpEmis informado é incompatível com SVC-[SP/RS] WS L07
592 Rejeição: Chave de acesso inválida (Ano < 2009 ou Ano maior que Ano corrente WS L10
593 Rejeição: Chave de acesso inválida (Mês = 0 ou Mês > 12) WS L11
594 Rejeição: Chave de acesso inválida (CNPJ zerado ou digito inválido) WS L12
595 Rejeição: Chave de acesso inválida (modelo diferente de 57) WS L13
596 Rejeição: Chave de acesso inválida (numero CT = 0) WS L14
598 Rejeição: Usar somente o namespace padrão do CT-e WS D02
599 Rejeição: Não é permitida a presença de caracteres de edição no início/fim da mensagem ou entre as tags da mensagem WS D03
600 Rejeicao: Chave de Acesso difere da existente em BD WS L20
627 Rejeição: CNPJ do autor do evento inválido WS L04
628 Rejeição: Erro Atributo ID do evento não corresponde a concatenação dos campos (“ID” + tpEvento + chCTe + nSeqEvento) WS L05
629 Rejeição: O tpEvento informado inválido WS L06
630 Rejeição: Falha no Schema XML específico para o evento WS L08
632 Rejeição: O autor do evento diverge do emissor do CT-e WS L19
633 Rejeição: O autor do evento não é um órgão autorizado a gerar o evento WS L20
634 Rejeição: A data do evento não pode ser menor que a data de emissão do CT-e WS L21
635 Rejeição: A data do evento não pode ser maior que a data do processamento WS L23
636 Rejeição: O numero sequencial do evento é maior que o permitido WS Q02
637 Rejeição: A data do evento não pode ser menor que a data de autorização do CT-e WS L22
721 Rejeição: Chave de acesso inválida (modelo diferente de 67) WS L16
926 Rejeição: Justificativa do insucesso é obrigatória para motivo outros WS O18
999 Rejeição: Erro não catalogado (mensagem) WS -
1002 Rejeição: Rejeição: Protocolo do evento a ser cancelado não existe, não está associado ao DFe ou já está cancelado WS L11

Tratamento de Erro:

Caso ocorra algum erro na chamada do WS (5001-6145) ou a requisição não seja atendida pelo WS (203-999), será gravado um log na pasta log, com as seguintes informações que devem ser úteis para identificação do problema:

Os erros com código > 5000 são erros tratados pela DLL e ocorrem nas seguintes situações:

Histórico de atualização:

10.6.14. Cancelamento Vinculação Pgto RT
10.6. Eventos do CT-e
« Anterior
10.6.13. Vinculação Pgto RT
Próximo »
10.7. Distribuição de DF-e