Documentacao API Protesto B C R 101

API PÚBLICA IEPTB-BR
Manual do Desenvolvedor – Webservice

Versão 1.01
Equipe de Tecnologia
INSTITUTO DE ESTUDOS DE PROTESTO DE TÍTULOS DO BRASIL – IEPTB-BR
Rua XV de Novembro, 184 – 4º andar
API IEPTB-BR - Manual do Desenvolvedor v1.01
Sumário
Introdução ..........................................................................................................................2
Descrição dos serviços .........................................................................................................2
Mapa de atualizações ..........................................................................................................2
Envio de arquivos ................................................................................................................3
O Base64 do Arquivo ................................................................................................................. 3
Envio de Remessa...................................................................................................................... 4
Nomenclatura do arquivo ..................................................................................................... 4
Método para envio de arquivos de Remessa ........................................................................ 4
Requisições:........................................................................................................................... 5
Mensagens – Códigos ............................................................................................................ 6
Confirmação e Retorno ............................................................................................................. 7
Nomenclatura dos arquivos .................................................................................................. 7
Método para envio de arquivos de Confirmação e Retorno................................................. 8
Requisições:........................................................................................................................... 9
Mensagens – Códigos .......................................................................................................... 10
1
Introdução
Este documento tem o objetivo de especificar o desenvolvimento de um WebService para envio
e recebimento de arquivos de protestos, integração com Instituto de Estudos de Protesto de
Títulos do Brasil (IEPTB-BR).
Descrição dos serviços

Todos os parâmetros de entrada devem ser informados via protocolo HTTPS.
O consumo do WebService deverá utilizar o método de Autenticação Básica, informando as
credenciais de usuário e senha fornecidas pelo IEPTB-BR. Todo desenvolvimento dessa
documentação foi criado com base no Layout Febraban 4.3.
Mapa de atualizações
Versão Data Alteração
0.1 10/12/20 Início de documentação do manual
1.0 16/12/20 Lançamento da documentação em versão 1.0
1.01 26/01/21 Adição de cod_ibge nos parâmetros de entrada de Remessa
2
Envio de arquivos
O conteúdo do arquivo foi desenvolvido com base no Layout XML da FEBRABAN. O arquivo
pode conter mais de uma remessa, agrupadas uma abaixo da outra, desde que esteja em
conformidade com o Padrão.
O Base64 do Arquivo
O arquivo implementa as regras do Layout Único – Versão 4.3.
0000EMPRESAS TESTE ENVIO 01102020BFOSDTTPR00292000020002000200000071 0431200401

0000
1000000910873500026EMPRESAS TESTE CREDOR LTDA EMPRESAS TESTE CREDOR

LTDA08039000000080V PRIMARIA 4 MOD 14-38 QD 12/13 GALPAO1 74993460APARECIDA DE GOIAN
GO777390000005251DMI000047820 17082020240920200000000000001122600000000011226RIO BRANCO
MN1LUCAS SOUZA VICENTE 03035072256 0002012145100009400000000000R BENJAMIN CONSTANT
CASA 235 69914356RIO BRANCO AC00 000000000000000000D00000000 CALAFATE
0000000000000000000000000000000000000000000000000 0000000000 0002
9000EMPRESAS TESTE ENVIO 0110202000006000000000000344166

0004
3
Envio de Remessa
Nomenclatura do arquivo
Remessa
BNNNDDMM.AAS
B Constante indicadora de arquivo de Remessa
NNN Código numérico do Apresentante
DD Dia de referência
MM Mês de referência
AA Ano de referência
S Sequencial do arquivo (mínimo 1, máximo 9)
Exemplo B0002401.141
(Remessa, Apresentante “000”, Data 24/01/14, 1º arquivo do dia)
Obs: o campo “NNN” pode ser alterado para mais posições no caso de apresentantes.
Método para envio de arquivos de Remessa

Links de envio de Remessa
Ambiente de Homologação http://homolog.cranacional.org.br/api-protesto/enviaRemessa
Ambiente de Produção https://cranacional.org.br/api-protesto/enviaRemessa
Parâmetros de Entrada:
Parâmetro Descrição
cod_apresentante Código do Apresentante na CRA Nacional
nome_arquivo Nome do arquivo enviado
cod_ibge Código IBGE da Comarca (7 dígitos)
arquivo_base64 Base64 do arquivo
Obs: Todos os parâmetros devem estar preenchidos.
Parâmetros de Retorno:
comarca IBGE da comarca de retorno
codigo Código da operação
ocorrencia Ocorrência da operação
4
Requisições:
Json de entrada:
{
"cod_apresentante":"999",
"nome_arquivo":"B9990101.211",
"cod_ibge":"9999999",
"arquivo_base64":"MEQ2N1JBWURBTiBDUkVES...”
}
Mensagem de sucesso na resposta:
{
"comarca":"",
"codigo":"000",
"ocorrencia":"Arquivo recebido com SUCESSO"
}
Mensagem de erro na resposta:
{
"comarca":"4300604",
"codigo":"008",
"ocorrencia":"Data do movimento inválida linha: 0001"
}
5
Mensagens – Códigos
Código Descrição
422 Erro(s) de validação da camada de negócio.
000 Arquivo recebido com sucesso.
001 Horário de envio excedido.
002 O arquivo não está em Base64.
003 Arquivo já importado.
004 Tamanho do arquivo excedido.
005 Arquivo corrompido ou fora do layout.
006 Código apresentante inválido linha: "$seq_linha”
007 Código IBGE inválido.
008 Data do movimento inválida.
009 Código apresentante inválido.
010 Nome do Sacador/Vendedor inválido.
011 Documento do Sacador inválido.
012 Data de Vencimento do Título inválida.
013 Saldo do Título inválido.
014 Nome do Devedor inválido.
015 Número de Identificação do Devedor inválido.
016 Data do movimento trailler do arquivo inválida.
017 Somatório de Segurança – Quantidade na Remessa inválida.
018 Somatório de Segurança – Valor da Remessa inválida.
019 Quantidade de registro inválido informado.
020 Nome do arquivo invalido.
6
Confirmação e Retorno
Nomenclatura dos arquivos
Confirmação
CNNNDDMM.AAS
C Constante indicadora de arquivo de Confirmação
Exemplo C0002401.141
(Confirmação, Apresentante “000”, Data 24/01/14, 1º arquivo do dia)
Obs: o campo “NNN” pode ser alterado para mais posições no caso de apresentantes conveniados que
não são bancos.
O arquivo de Confirmação somente deverá ser disponibilizado quando não existirem mais
arquivos de cartórios a serem processados. Deverá ser disponibilizado somente 01 (UM) arquivo
de confirmação por dia.
Retorno
RNNNDDMM.AAS
R Constante indicadora de arquivo de Retorno
Exemplo R0002401.141
(Retorno, Apresentante “000”, Data 24/01/14, 1º arquivo do dia)
Obs: o campo “NNN” pode ser alterado para mais posições no caso de apresentantes conveniados que
não são bancos.
O arquivo de Retorno somente deverá ser disponibilizado quando não existirem mais arquivos
de cartórios a serem processados. Deverá ser disponibilizado somente 01 (UM) arquivo de
retorno por dia.
7
Método para envio de arquivos de Confirmação e Retorno

Links de envio de Remessa
Ambiente de Homologação http://homolog.cranacional.org.br/api-protesto/confirmacaoRetorno
Ambiente de Produção https://cranacional.org.br/api-protesto/confirmacaoRetorno
Parâmetros de Entrada:
cod_apresentante Código do Apresentante na CRA Nacional
nome_arquivo Nome do arquivo enviado
Obs: Todos os parâmetros devem estar preenchidos.
Parâmetros de Retorno:
codigo Código da operação
ocorrencia Ocorrência da operação
arquivo_base64 Base64 do arquivo
8
Requisições:
Json de entrada arquivo de CONFIRMAÇÃO:
{
"nome_arquivo":" C9881011.201",
}
Json de entrada arquivo de RETORNO:
{
"nome_arquivo":" R9881011.201",
}
Mensagem de sucesso na resposta:
{
"codigo":"000",
"ocorrencia":"Arquivo recebido com SUCESSO"
“arquivo_base64":"MDk4OFBST0NVUkFET1JJQSBHRVJBTCBETyBFU1RBRE8gICAgICAgICAgICAxM
DExMjAyMFNEVEJGT0NSVDAwMDQxMzAwMDIwMDAyMDAwMDAwMDI5ODggICAwNDMyNjAy
OTAyICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICA...”
}
Mensagem de erro na resposta:
{
“codigo":"003",
"ocorrencia":" Arquivo indispon\u00edvel no momento"
“arquivo_base64":null
}
9
Mensagens – Códigos
Código Descrição
422 Erro(s) de validação da camada de negócio.
000 Arquivo recebido com sucesso.
002 Nome do arquivo inválido.
003 Arquivo indisponível no momento.
006 Código apresentante inválido.
10

Documentacao API Protesto B C R 101

Enviado por

Dados do documento

Descrição original:

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Documentacao API Protesto B C R 101

Enviado por

Direitos autorais:

Formatos disponíveis

API PÚBLICA IEPTB-BR

Manual do Desenvolvedor – Webservice

Descrição dos serviços

0000EMPRESAS TESTE ENVIO 01102020BFOSDTTPR00292000020002000200000071 0431200401

1000000910873500026EMPRESAS TESTE CREDOR LTDA EMPRESAS TESTE CREDOR

9000EMPRESAS TESTE ENVIO 0110202000006000000000000344166

Método para envio de arquivos de Remessa

Obs: Todos os parâmetros devem estar preenchidos.

Mensagem de sucesso na resposta:

Mensagem de erro na resposta:

Nomenclatura dos arquivos

Método para envio de arquivos de Confirmação e Retorno

Obs: Todos os parâmetros devem estar preenchidos.

Json de entrada arquivo de CONFIRMAÇÃO:

Json de entrada arquivo de RETORNO:

Mensagem de sucesso na resposta:

Mensagem de erro na resposta:

Você também pode gostar