Documentacao API Protesto CP AC DP

API PROTESTO IEPTB-BR - Manual do Desenvolvedor v1.
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
Método para envio dos arquivos 3
Envio de Autorização de Cancelamento de Protesto 4
Nomenclatura do arquivo 4
Requisições 6
Envio de Cancelamento de Protesto 8
Nomenclatura dos arquivos 8
Requisições 10
Envio de Desistência de Protesto 12
Nomenclatura dos arquivos 12
Requisições 14
Códigos de ocorrência 16
Ocorrências do Arquivo 16
Ocorrências dos Títulos 16
1
API PROTESTO IEPTB-BR - Manual do Desenvolvedor v1.0
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.
Mapa de atualizações
Versão Data Alteração
1.0 04/01/20 Lançamento da documentação em versão 1.0
2
Envio de arquivos
O conteúdo do arquivo foi desenvolvido com base nos Layouts FEBRABAN. O arquivo pode
conter mais de um bloco de conteúdo, agrupados um abaixo do outro, desde que estejam em
conformidade com o Padrão.
O Base64 do Arquivo
O arquivo implementa as regras dos Layouts individuais FEBRABAN para cada processo.
0999EMPRESAS TESTE LTDA 161020200000100001 00001
101000015208707 00002
200068520011310202068159-C NOME DEVEDOR ME 00000000664900S

00003
801000025208707 00004
9999EMPRESAS TESTE LTDA 161020200000200000000664900 00005
Método para envio dos arquivos

Links de envio do arquivo (método POST)
Ambiente de Homologação http://homolog.cranacional.org.br/api-protesto/enviaAnuencias
Ambiente de Produção https://cranacional.org.br/api-protesto/enviaAnuencias
3
Envio de Autorização de Cancelamento de Protesto
Nomenclatura do arquivo
Autorização de Cancelamento
ACNNNDDMM.AAS
AC Constante indicadora de arquivo de Autorização de Cancelamento
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 AC0002401.141
(Autorização de Cancelamento, 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.
Parâmetros de Entrada:
Parâmetro Descrição
cod_apresentante Código do Apresentante na CRA Nacional
nome_arquivo Nome do arquivo enviado
arquivo_base64 Base64 do arquivo
Obs: Todos os parâmetros devem estar preenchidos.
4
Parâmetros de retorno do Arquivo:
nome_arquivo Nome do arquivo
titulos Retorno dos títulos contidos no arquivo
codigo Código da operação
ocorrencia Ocorrência da operação
Parâmetros de retorno do Título:

cod_apresentante Código do apresentante
cod_cartorio Código do cartório referente
protocolo Protocolo do título
codigo Código de recepção do título
ocorrencia Ocorrência de recepção do título
5
Requisições
Json de entrada arquivo de Autorização de Cancelamento:
{
"cod_apresentante":"999",
"nome_arquivo":"ACMNN1907.191",
"arquivoBase64": “MEQ2N1JBWURBTiBDUkVESVRPIEUgQ09CUkFOQ0EgTFREQSAgICAgICAgI..."
}
Mensagem de sucesso na resposta:
{
"nome_arquivo": " ACMNN1907.191",
"titulos": [
{
"cod_municipio": "2610707",
"cod_cartorio": "01",
"protocolo": "2020217772",
"codigo": "000",
"ocorrencia": "Arquivo enviado com SUCESSO"
},
{
"protocolo": "2020217772",
"codigo": "000",
}
],
"codigo":"000",
"ocorrencia":"Arquivo recebido com SUCESSO"
}
6
Mensagem de erro na resposta:
{
"nome_arquivo": " ACMNN1907.191",
"titulos": [
{
"protocolo": "2020217772",
"codigo": "006",
"ocorrencia": "Operação não pode ser realizada. Título não encontrado"
},
{
"protocolo": "2020217772",
"codigo": "006",
}
],
"codigo": "004",
"ocorrencia": "Nenhum título recepcionado"
}
7
Envio de Cancelamento de Protesto
Nomenclatura dos arquivos
Cancelamento de Protesto
CPNNNDDMM.AAS
CP Constante indicadora de arquivo de Cancelamento de Protesto
Exemplo CP0002401.141
(Cancelamento de Protesto, 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.
8

9
Requisições
Json de entrada arquivo de Cancelamento de Protesto:
{
"nome_arquivo":"CPMNN1907.191",
}
{
"nome_arquivo": " CPMNN1907.191",
"titulos": [
{
"protocolo": "2020217772",
"codigo": "000",
},
{
"protocolo": "2020217772",
"codigo": "000",
}
],
"codigo":"000",
}
10
{
"nome_arquivo": " CPMNN1907.191",
"titulos": [
{
"protocolo": "2020217772",
"codigo": "006",
},
{
"protocolo": "2020217772",
"codigo": "006",
}
],
"codigo": "004",
}
11
Envio de Desistência de Protesto
Nomenclatura dos arquivos
Desistência de Protesto
DPNNNDDMM.AAS
DP Constante indicadora de arquivo de Desistência de Protesto
Exemplo CP0002401.141
(Desistência de Protesto, 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.
12

13
Requisições
Json de entrada arquivo de Desistência de Protesto:
{
"nome_arquivo":"DPMNN1907.191",
}
{
"nome_arquivo": " DPMNN1907.191",
"titulos": [
{
"protocolo": "2020217772",
"codigo": "000",
},
{
"protocolo": "2020217772",
"codigo": "000",
}
],
"codigo":"000",
}
14
{
"nome_arquivo": " DPMNN1907.191",
"titulos": [
{
"protocolo": "2020217772",
"codigo": "006",
},
{
"protocolo": "2020217772",
"codigo": "006",
}
],
"codigo": "004",
}
15
Códigos de ocorrência
Ocorrências do Arquivo
Código Descrição
000 Título enviado com sucesso.
004 Nenhum Título recepcionado.
Ocorrências dos Títulos

Código Descrição
422 Erro(s) de validação da camada de negócio.
001 Nome do arquivo inválido.
002 O arquivo não está em Base64.
003 Código apresentante inválido.
005 Operação não pode ser realizada. Título Irregular.
006 Operação não pode ser realizada. Título não encontrado.
16

Documentacao API Protesto CP AC DP

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 CP AC DP

Enviado por

Direitos autorais:

Formatos disponíveis

API PROTESTO IEPTB-BR - Manual do Desenvolvedor v1.

Descrição dos serviços

0999EMPRESAS TESTE LTDA 161020200000100001 00001

200068520011310202068159-C NOME DEVEDOR ME 00000000664900S

9999EMPRESAS TESTE LTDA 161020200000200000000664900 00005

Método para envio dos arquivos

Ambiente de Produção https://cranacional.org.br/api-protesto/enviaAnuencias

Obs: Todos os parâmetros devem estar preenchidos.

Parâmetros de retorno do Título:

Json de entrada arquivo de Autorização de Cancelamento:

Mensagem de sucesso na resposta:

Mensagem de erro na resposta:

Nomenclatura dos arquivos

Obs: Todos os parâmetros devem estar preenchidos.

Parâmetros de retorno do Título:

Json de entrada arquivo de Cancelamento de Protesto:

Mensagem de sucesso na resposta:

Mensagem de erro na resposta:

Nomenclatura dos arquivos

Obs: Todos os parâmetros devem estar preenchidos.

Parâmetros de retorno do Título:

Json de entrada arquivo de Desistência de Protesto:

Mensagem de sucesso na resposta:

Mensagem de erro na resposta:

Ocorrências dos Títulos

Você também pode gostar