O método de download do BP-e é responsável por retornar o JSON, XML e o DABPE (Documento Auxiliar de Bilhete de Passagem Eletrônico) a partir do fornecimento da chave de acesso de um BP-e autorizado pela NS BP-e API.
URL
Produção: POST https://bpe.ns.eti.br/v1/bpe/get
Dados de entrada
| Campo | Ocorrência | Descrição |
|---|---|---|
| X-AUTH-TOKEN | 1-1 | Token de acesso do usuário |
| chBPe | 1-1 | Chave de acesso do BP-e |
| tpDown | 1-1 | Tipo do download: X - XML J - JSON P - PDF XP - XML e PDF JP - JSON e PDF |
| tpAmb | 1-1 | Tipo de Ambiente: 1 - Produção 2 - Homologação |
Exemplo de requisição
Requisição de download
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"X-AUTH-TOKEN":"SEU_TOKEN",
"chBPe":"44444444444444444444444444444444444444444444",
"tpDown":"XP",
"tpAmb":"2"
}' \
https://bpe.ns.eti.br/v1/bpe/get
Dados retornados
| Campo | Descrição | Ocorrência | Tipo | Pai | Observação |
|---|---|---|---|---|---|
| status | Código de status do processamento | 1-1 | N | ||
| motivo | Descrição literal do status de processamento | 1-1 | A | ||
| chBPe | Chave da BP-e | 0-1 | N | ||
| xml | XML de distribuição da NF-e autorizada | 0-1 | A | Somente em quando tipo = X ou XP Apenas com status = 200 | |
| nfeProc | Objeto JSON com os dados de distribuição da NF-e autorizada | 0-1 | A | Somente em quando tipo = J ou JP Apenas com status = 200 | |
| PDF da DABPE | 0-1 | A | Base64 do PDF do DABPE Somente em quando tipo = P, JP ou XP Apenas com status = 200 | ||
| erro | Objeto contendo informações de erro ao carregar o CT-e | 0-1 | O | Apenas com status diferente de 200 | |
| cStat | Código do status de erro | 1-1 | N | erro | |
| xMotivo | Descrição literal do erro | 1-1 | A | erro |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
,
"chBPe": "43180107364617000135630000000000101000000085",
"xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?><bpeProc versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/bpe\"><BPe>...</bpeProc>",
"pdf: "JVBERi0xLjQKJeLjz..."}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Download realizado com sucesso |
| -2 | Tipo de download inválido Obs.: Quando o tipo for diferente X, P, XP ou PX (case-insensitive). |
| -3 | Chave de acesso inválida |
| -4 | BP-e não encontrada com a chave de acesso informada |