Este grupo de informações deverá ser informado sempre que a transação de pagamento for iniciada antes da emissão do DFe. Exemplos: boleto gerado antes da emissão do DFe; QR Code dinâmico Pix gerado antes da emissão do DFe.
Neste caso, o DFe deverá reportar os dados das transações financeiras previamente iniciadas, ainda que estejam pendentes de efetivo pagamento e liquidação.
URL
POST https://bpe.ns.eti.br/v1/bpe/vincpgto
Dados de entrada
| Campos | Descrição | Ocorrência | Tipo | Observação |
|---|---|---|---|---|
| Campos | Descrição | Ocorrência | Tipo | Observação |
| X-AUTH-TOKEN | Token de acesso do usuário | 0-1 | A | Pode ser enviado no cabeça |
| nSeqEvento | Número sequencial do evento. | 1-1 | N | Na maioria dos casos será 1. No entanto quando mais de um evento do mesmo tipo for gerado para o mesmo CT-e, esta numeração deverá ser incrementada de forma sequencial. |
| chBPe | Chave de acesso do BPe | 1-1 | N | |
| tpAmb | Tipo do ambiente de autorização do Bè | 1-1 | N | 1 - Produção 2 - Homologação |
| dhEvento | Data e Hora da emissão do evento | 1-1 | D | Padrão Sefaz (com UTC) AAAA-MM-DDTHH:MM:SS TZD Ex.: 2026-08-09T15:04:10-03:00 |
| nProt | Número do protocolo de autorização do BPe | 1-1 | N | |
| tpMeioPgto | Código do meio de pagamento utilizado | 1-1 | N | 15 = Boleto 17 = Pix QRCode 18 = TED 20 = PIX chave ou QRCode estático 23 = Pix Automático 24 = 24 TEF/booktransfer |
| cnpjReceb | CNPJ completo do recebedor do pagamento (fornecedor, plataforma, ou outra entidade que receba o pagamento do adquirente) | 1-1 | C | Observação: indicar o CNPJ responsável por receber dinheiro do adquirente na transação de pagamento. É possível que o CNPJ do recebedor seja diferente do CNPJ do fornecedor constante no documento fiscal. |
| cnpjBasePSP | CNPJ base da instituição financeira ou de pagamento utilizada pelo recebedor do pagamento (fornecedor, plataforma, ou outra entidade que receba o pagamento do adquirente). | 1-1 | C | |
| nPag | Atributo numerador único de cada ocorrência de pagamento | 1-1 | N | |
| idTransacao | Atributo Identificador específico da transação financeira, de acordo com a transação de pagamento. O próprio schema impede que se repita dentro do grupo | 1-1 | C |
Exemplo de requisição
Requisição de vinculação de pagamento
curl -X POST
\-H "Content-Type: application/json"
\-d '{
"chBPe": "43261007364617000135630450000000191868616240",
"nSeqEvento": "1",
"tpAmb": 2,
"dhEvento": "2026-10-01T10:45:00-03:00",
"nProt": "143260000098600",
"tpMeioPgto": "15",
"cnpjReceb": "46028383000107",
"cnpjBasePSP": "07364617",
"nPag": "990",
"idTransacao": "123456"
}' \
https://bpe.ns.eti.br/v1/bpe/vincpgto
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 do BPe na 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 | |
| chBPe | Chave de acesso do BPe | |
| 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": "Processamento de evento realizado com sucesso",
"retEvento": {
"cStat": 135,
"xMotivo": "Evento registrado e vinculado a BP-e",
"chBPe": "43261007364617000135630450000000191868616240",
"dhRegEvento": "2026-10-02T15:03:35-03:00",
"nProt": "143260000100041",
"xml": "..."
}
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Vinculação de pagamento vinculada ao BP-e 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 |