Através deste endpoint é possível realizar o Cancelamento da Vinculação de pagamento já autorizado.
URL
POST https://gtve.ns.eti.br/v1/gtve/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 GTVe | 1-1 | N | |
| tpAmb | Tipo do ambiente de autorização da GTVe: 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 GTVe | 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
{
"chCTe": "43260807364617000135640670000000061000010500",
"tpAmb": 2,
"dhEvento": "2026-08-12T13:36:00-03:00",
"nProt": "143260000261445",
"nProtVincPgto": "143260000261448"
}
Dados retornados
| Campo | Descrição | Observação |
|---|---|---|
| status | Código de status do processamento | |
| motivo | Descrição literal do status de processamento | |
| retEvento | Objeto contendo os dados do processamento da GTVe da SEFAZ | Somente em status = 200 |
| cStat | Código de situação do processamento no Sefaz | |
| xMotivo | Descrição literal da situação do processamento na Sefaz | |
| chNFCom | Chave de acesso da GTVe | |
| dhRegEvento | Data e hora de registro do evento na Sefaz | Padrão Sefaz (com UTC): AAAA-MM-DDTHH:MM:SS + UTC Ex.: 2026-06-09T15:04:10-03:00 |
| nProt | Número de recibo do documento pela Sefaz | |
| xml | XML de distribuição do evento de comprovante de entrega | Somente em status = 200 |
| erros | Array contendo a lista de erros ocorridos durante a validação das informações do comprovante de acordo com o tipo de dados | Somente em status = -4 |
| codigo | Código do erro ocorrido | Somente em status = -5 |
| descricao | Descrição literal do erro ocorrido | Somente em status = -5 |
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 CT-e",
"idEvento": "11030143260807364617000135640670000000061000010500001",
"chCTe": "43260807364617000135640670000000061000010500",
"dhRegEvento": "2026-08-12T13:37:11-03:00",
"nProt": "143260000261449",
"xml": "..."
}
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Vinculação de pagamento vinculada a NFCom com sucesso |
| -2 | Campos obrigatórios não informados na requisição |
| -3 | Chave de acesso inválida |
| -4 | Erro de informações de acordo com o tipo de dados |
| -5 | Erro ou rejeição ao realizar vinculação do pagamento DFe |