1. Inicio
  2. Documentos
  3. NS BPe (English)
  4. BPe Events
  5. Non-boarding


Through the non-boarding event service, it is possible to inform the non-boarding of a BP-e on a trip.

Note: This event has rules and deadlines defined by the Secretariat of Finance that must be considered and respected. For more information click here and check the most up-to-date version of the Sefaz Taxpayer Guidance Manual.


Production: POST https://bpe.ns.eti.br/v1/bpe/naoemb

Input Data
FIeldDescriptionOccurrenceData TypeSizeNotes
X-AUTH-TOKENSoftware House access token0-1StringCan be sent in the request header
chBPeBP-e Access Key1-1Int44
tpAmbType of BP-e authorization environment:
1 - Production,
2 - Homologation ( test environment)
dhEventoDate and time the cancellation occurred1-1String ( Date and Time format )25Sefaz Standard YYYY-MM-DDTHH: MM: SS + UTC
Ex .: 2016-06-13T15: 04: 10-02: 00
nProtBP-e authorization protocol number1-1Int15
xJustLiteral description of the reason for not boarding1-1String1-225
Request Examples

Non-boarding request example

curl -X POST \
    -H "Content-Type: application/json" \
    -d '{
      "chBPe": "43180207364617000135630000000000311000000089", 
      "tpAmb": 2, 
      "dhEvento": "2017-05-15T12:00:00-03:00", 
      "nProt": "443170000037618", 
      "xJust": "Nao compareceu"
Returned Data
FIeldDescriptionData TypeParentNotes
statusProcessing status codeInt
motivoLiteral description of processing statusString
Object containing the processing data of the non-boarding event at Sefaz
ObjectOnly when status = 200
cStatProcessing status codeIntretEvento
xMotivoLiteral description of the processing situation at SefazStringretEvento
chBPeBP-e access keyIntretEventoOnly with cStat = 135
dhRegEventoDate and time of the event registration at SefazString ( date and time format )retEventoSefaz Standard YYYY-MM-DDTHH: MM: SS + UTC.
Ex .: 2016-06-13T15: 04: 10-03: 00 Only in cStat = 135
nProtEvent authorization protocol numberIntretEventoOnly with cStat = 135
xmlEvent distribution XMLStringretEventoOnly with cStat = 135
erroObject containing the error information in case the cancellation cannot be carried out successfullyObjectOnly when status is different than 200
cStatError status codeInterro
xMotivoLiteral description of the errorStringerro
Responses examples

Successful response

    "status": 200,
    "motivo": "Processamento de evento realizado com sucesso",
    "retEvento": {
        "cStat": 135,
        "xMotivo": "Evento registrado e vinculado a BP-e",
        "chBPe": "43180207364617000135630000000000301000000081",
        "dhRegEvento": "2018-02-21T14:58:46-03:00",
        "nProt": "143180000002623",
        "xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?><procEventoBPe versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/bpe\">...</procEventoBPe>"
Returned Data
200Successfully linked event
-2Invalid access key
-3It was not possible to link the event.
Check the error object for more information
Non-Boarding Event Download

You can download the complete event distribution information in XML or JSON. To do this, check the Download Events method in the NS BP-e API.

Como podemos ajudar?