This service is used to check the processing status of a BP-e previously sent for processing using the BP-e Issuance method
URL
Production: POST https://bpe.ns.eti.br/v1/bpe/issue/status
Input Data
| Field | Occurrence | Data Type | Description |
|---|---|---|---|
| X-AUTH-TOKEN | 1-1 | String | Software House access token |
| CNPJ | 1-1 | Int | CNPJ of the BP-e issuer |
| nsNRec | 1-1 | Int | Receipt log number for the issue process |
Request Example
Check Processing Status Request
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"X-AUTH-TOKEN":"SEU_TOKEN",
"CNPJ": "11111111111111",
"nsNRec": 1
}' \
https://bpe.ns.eti.br/v1/bpe/issue/status
Returned Data
| Field | Description | Occurrence | Data Type | Parent | Notes |
|---|---|---|---|---|---|
| Status | Processing status code | 1-1 | String | ||
| Motivo | Literal description of processing status | 1-1 | String | ||
| chBPe | BP-e access key | 1-1 | Int | ||
| cStat | BP-e processing status code at Sefaz | 0-1 | Int | Only in status = 200 | |
| xMotivo | Literal description of processing status at Sefaz | 0-1 | String | Only in status = 200 | |
| nProt | BP-e authorization protocol number at Sefaz | 0-1 | Int | Only in status = 200 | |
| dhRecbto | Date and time of receipt of BP-e by Sefaz | 0-1 | String ( Date and Time ) | Only in status = 200 | |
| xml | BP-e distribution XML | 0-1 | String | Only in status = 200 | |
| Erro | Object containing error information in case the request cannot be carried out successfully | 0-1 | Object | Only in status different than 200 | |
| cStat | Error status code | 1-1 | Int | erro | |
| xMotivo | Literal description of the error | 1-1 | String | erro |
Response Examples
Successful Return
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"chBPe": "43180107364617000135630000000000101000000085",
"cStat": "100",
"xMotivo": "Autorizado o uso do BP-e",
"nProt": "143180000001887",
"dhRecbto": "2018-01-31T19:46:20-02:00",
"xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?><bpeProc versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/bpe\"><BPe>...</bpeProc>"
}
Response with an error
{
"status": -2,
"motivo": "Nao foi possivel carregar o status do BP-e",
"erro": {
"cStat": 997,
"xMotivo": "Documento não Localizado em Nosso Banco de Dados"
}
}
Returned Codes
| Code | Description |
|---|---|
| 200 | Consultation made successfully |
| -2 | It was not possible to load the processing status of the BP-e. Check the "erro" object for more information |