Através deste endpoint é possível realizar o Cancelamento da Vinculação de pagamento já autorizado.
URL
POST https://bpe.ns.eti.br/v1/bpe/cancvincpgto
Dados de entrada
| Campo | Descrição | Ocorrência | Tipo | Observação |
|---|---|---|---|---|
| X-AUTH-TOKEN | Token de Acesso do BPe | 0-1 | A | Pode ser enviado no cabeçalho da requisição |
| nSeqEvento | Número sequencial do evento | 1-1 | N | |
| chBPe | Chave de acesso do BPe | 1-1 | N | |
| tpAmb | Tipo do ambiente de autorização do BPe: 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 do BPe | 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
curl -X POST
\-H "Content-Type: application/json"
\-d '{
"chBPe": "43261007364617000135630450000000191868616240",
"nSeqEvento": "1",
"tpAmb": 2,
"dhEvento": "2026-10-02T15:25:00-03:00",
"nProt": "143260000098600",
"nProtVincPgto": "143260000100041"
}' \
https://bpe.ns.eti.br/v1/bpe/cancvincpgto
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 | |
| chBPe | Chave de acesso do BPe | |
| 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": "Processamento de evento realizado com sucesso",
"retEvento": {
"cStat": 135,
"xMotivo": "Evento registrado e vinculado a BP-e",
"chBPe": "43261007364617000135630450000000191868616240",
"dhRegEvento": "2026-10-02T15:26:59-03:00",
"nProt": "143260000100047",
"xml": "..."
}
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Cancelamento da Vinculação de pagamento vinculada ao BPe 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 |