Através deste endpoint é possível realizar o Cancelamento da Vinculação de pagamento já autorizado.
URL
POST https://nf3e.ns.eti.br/v1/nf3e/cancvincpgto
Dados de entrada
| Campo | Descrição | Ocorrência | Tipo | Observação |
|---|---|---|---|---|
| X-AUTH-TOKEN | Token de Acesso | 0-1 | A | Pode ser enviado no cabeçalho da requisição |
| chCTe | Chave de acesso da NF3e | 1-1 | N | |
| tpAmb | Tipo do ambiente de autorização da NF3e: 1 – Produção, 2 – Homologação | 1-1 | N | |
| dhEvento | Data e hora da ocorrência do cancelamento | 1-1 | D | Padrão Sefaz (com UTC): AAAA-MM-DDTHH:MM:SS Ex.: 2026-06-09T15:04:10-03:00 |
| nProt | Número do protocolo de autorização da NF3e | 1-1 | N | |
| nProtVincPgto | Informar o número do protocolo de autorização do evento de vinculação de pagamento que será cancelado | 1-1 | N |
Exemplo de requisição
Requisição de cancelamento da Vinculação de Pagamento
{
"chNF3e": "43260807364617000135660490000000171000000019",
"tpAmb": 2,
"dhEvento": "2026-08-10T16:04:00-03:00",
"nProt": "1432600014524737",
"nProtVincPgto": "1432600014524738"
}
Dados retornados
| Campo | Descrição | Observação |
|---|---|---|
| status | Código de status de processamento | |
| motivo | Descrição literal do status de processamento | |
| retEvento | Objeto contendo os dados de processamento do cancelamento na Sefaz | Somente em status = 200 |
| cStat | Código de situação do evento na Sefaz | |
| xMotivo | Descrição literal da situação do evento na Sefaz | |
| chCTe | Chave de acesso da NF3e | |
| dhRegEvento | Data e hora de registro do evento na Sefaz | Padrão Sefaz: AAAA-MM-DDTHH:MM:SS + UTC Ex.: 2026-06-13T15:04:10-03:00 |
| nProt | Número do protocolo de autorização do evento pela Sefaz | |
| xml | XML do evento | |
| erro | Objeto contendo as informações de erro caso o cancelamento não obteve sucesso | Somente em status diferentes de 200 |
| erro.cStat | Código do erro | |
| erro.xMotivo | Descrição literal do erro |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Cancelamento da Vinculação do pagamento DFe gerado com sucesso",
"retEvento": {
"cStat": "135",
"xMotivo": "Evento registrado e vinculado a NF3e",
"idEvento": "1103014326080736461700013566049000000017100000001901",
"chNF3e": "43260807364617000135660490000000171000000019",
"dhRegEvento": "2026-08-10T16:05:58-03:00",
"nProt": "1432600014524739",
"xml": "..."
}
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Cancelamento da Vinculação de pagamento vinculada a NF3e com sucesso |
| -2 | Campos obrigatórios da requisição não informado |
| -3 | Chave de acesso inválida |
| -4 | Evento invalido de acordo com a validacao contra schema |
| -5 | Erro ou rejeição ao realizar o cancelamento da vinculação do pagamento DFe |