- Objetivo
- URL
- Parâmetros de envio
- Nomenclatura de arquivos
- Estrutura de arquivos
- Envio de Imagens
- Download e consulta
- Códigos de Ocorrências e Irregularidades
- Mensagens
Descrever a realização da tramitação de arquivos de Títulos entre os Apresentantes de Protesto e o CRA21.
- Homologação (ambiente de testes):
craUF.cra21.com.br/craUF/xml/protestos.php?wsdl
Ex: https://cradf.cra21.com.br/cradf/xml/protestos.php?wsdlATENÇÃO: no ambiente de homologação utilizar o protocolo HTTPS - Produção (ambiente de funcionamento do sistema):
craUF.crabr.com.br/craUF/xml/protestos.php?wsdl
Ex: https://cradf.crabr.com.br/cradf/xml/protestos.php?wsdlATENÇÃO: no ambiente de produção utilizar o protocolo HTTPS
Observação:
As configurações do servidor, para transações, estão definidas como:
- 100 MB – média tamanho de arquivos;
- 30 Min – tempo de espera do upload.
Caso retorne timeout antes desse tempo, verifique as configurações de espera da resposta pela sua aplicação.
- Os dados (parâmetros) devem ser enviados via protocolo SOAP
- Ao consumir o WebService, em todos os serviços, a autenticação deverá ser realizada utilizando autenticação básica.
- Deverão ser passados os parâmetros de usuário e senha, fornecidos pela CRA.
- Após a autenticação serão validados os parâmetros de entrada e por último a crítica do arquivo
- Serviços disponíveis:
-
Remessa upload do arquivo de remessa Confirmacao download do arquivo de confirmação Retorno download do arquivo de retorno Desistencia upload de desistência Cancelamento upload de cancelamento Autorizacao_Cancelamento upload de autorização de cancelamento Autorizacao_Desistencia upload de autorização de desistência BoletoAutorizacao consulta de boletos de autorização. Os detalhes desse serviço podem ser conferidos nesse link. Homologadas download de comarcas homologadas Consulta consulta de título Consulta_Slip consulta de dados do slip Instrumento consulta dos instrumentos eletrônicos. Imagem upload de imagens do título após o envio da remessa.
-
- Parâmetros dos serviços disponíveis:
-
- Upload
user_arq nome do arquivo no formato FEBRABAN user_dados conteúdo do arquivo XML - Download
user_arq nome do arquivo no formato FEBRABAN - Homologadas
codapres informar o código do apresentante - Consulta
nosso_numero nosso número do título no CRA21 numero_titulo número do título no CRA21 - Consulta_Slip
cod_municipio nome do arquivo no formato FEBRABAN cod_cartorio conteúdo do arquivo XML protocolo conteúdo do arquivo XML data_protocolo conteúdo do arquivo XML - Instrumento
userArq formato informado em Download e Consulta - Imagem
userArq nome do arquivo no formato FEBRABAN userDados conteúdo do arquivo XML em Envio de Imagens
- Upload
- O encoding do XML deve estar de acordo com ISO-8859-1.
- Assim como no HTML, o XML possui entidades, que devem ser substituídas conforme tabela abaixo:
-
De Para < & lt; > & gt; & & amp; ‘ & apos; “ & quot;
-
REMESSA
|
IMAGEM
|
DESISTÊNCIA
|
CANCELAMENTO
|
AUTORIZAÇÃO DE CANCELAMENTO
|
AUTORIZAÇÃO DE DESISTÊNCIA
|
CONFIRMAÇÃO
|
RETORNO
|
Arquivo de Remessa
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.
REGISTRO HEADER – ARQUIVO REMESSA (Tag hd)
Atributo | Descrição | Tam | Tipo | Casas Decimais |
h01 | Identifica o registro header no arquivo – Constante 0 | 001 | Numérico | Nenhuma |
h02 | Código do apresentante – Informar “999” caso tenha mais de 3 dígitos | 003 | Alfanumérico | Nenhuma |
h03 | Nome do apresentante | 040 | Alfabético | |
h04 | Data do envio do arquivo de remessa | 008 | Numérico | Nenhuma |
h05 | Identificação de Transação – Remetente Preencher com a sigla do remetente do arquivo: BFO – Banco, Instituição Financeira e Outros. |
003 | Alfanumérico | |
h06 | Identificação de Transação – Destinatário Preencher com a sigla do destinatário do arquivo: SDT – Serviço de Distribuição de Títulos. |
003 | Alfanumérico | |
h07 | Identificação de Transação – Tipo Preencher com a sigla de identificação da transação: TPR – Remessa de títulos para protesto. |
003 | Alfanumérico | |
h08 | Sequencial da remessa | 006 | Numérico | Nenhuma |
h09 | Quantidade de registros na transação | 004 | Numérico | Nenhuma |
h10 | Quantidade de títulos na remessa | 004 | Numérico | Nenhuma |
h11 | Quantidade de indicações – tipo: DMI, DRI e CBI | 004 | Numérico | Nenhuma |
h12 | Quantidade de títulos originais na remessa | 004 | Numérico | Nenhuma |
h13 | Número de identificação do apresentante (opcional) | 006 | Alfanumérico | |
h14 | Versão do Layout | 003 | Numérico | Nenhuma |
h15 | Código do município | 007 | Alfanumérico | |
h16 | Preencher em caso de código do apresentante com mais de 3 dígitos | 497 | Alfanumérico | |
h17 | Sequencial do registro | 004 | Numérico | Nenhuma |
REGISTRO DE TRANSAÇÃO – ARQUIVO REMESSA (Tag tr)
Atributo | Descrição | Tam | Tipo | Casas Decimais |
t01 | Identifica o registro transação no arquivo – Constante 1 | 001 | Numérico | Nenhuma |
t02 | Código do apresentante | 003 | Alfanumérico | Nenhuma |
t03 | Código do cedente do título | 015 | Alfanumérico | |
t04 | Nome do Cedente/Favorecido | 045 | Alfanumérico | |
t05 | Nome do Sacador | 045 | Alfanumérico | |
t06 | Número do CNPJ do Sacador | 014 | Alfanumérico | |
t07 | Endereço do Sacador | 045 | Alfanumérico | |
t08 | CEP do Sacador | 008 | Numérico | Nenhuma |
t09 | Cidade do Sacador | 020 | Alfanumérico | |
t10 | UF do Sacador | 002 | Alfabético | |
t11 | Nosso número | 015 | Alfanumérico | |
t12 | Espécie do título | 003 | Alfabético | |
t13 | Número do título | 011 | Alfanumérico | |
t14 | Data da emissão do título | 008 | Numérico | Nenhuma |
t15 | Data de vencimento do título Para casos de vencimento à vista preencher com “99999999" |
008 | Numérico | Nenhuma |
t16 | Tipo de moeda – 001 – Real | 003 | Numérico | Nenhuma |
t17 | Valor do título | 014 | Numérico | 2 |
t18 | Saldo do título – Valor a protestar | 014 | Numérico | 2 |
t19 | Praça de Pagamento | 020 | Alfanumérico | |
t20 | Tipo de endosso – Fixo Branco | 001 | Alfabético | |
t21 | Informação sobre aceite – Preencher com N | 001 | Alfabético | |
t22 | Número de controle de devedores – Sequencial dos devedores do título | 001 | Numérico | Nenhuma |
t23 | Nome do devedor | 045 | Alfanumérico | |
t24 | Tipo de documento do devedor – 001= CNPJ ou 002 = CPF | 003 | Numérico | Nenhuma |
t25 | Número do documento do devedor – Para CPF informar zero à esquerda | 014 | Numérico | Nenhuma |
t26 | R.G. – Não informar | 011 | Alfanumérico | |
t27 | Endereço do devedor | 045 | Alfanumérico | |
t28 | CEP do devedor | 008 | Numérico | Nenhuma |
t29 | Cidade do devedor | 020 | Alfanumérico | |
t30 | UF do devedor | 002 | Alfabético | |
t31 | Código do Cartório Uso restrito do Serviço de Distribuição – Preencher com Zero |
002 | Numérico | Nenhuma |
t32 | Número do Protocolo do Cartório Uso restrito do Serviço de Distribuição – Preencher com Branco |
010 | Alfanumérico | |
t33 | Tipo de Ocorrência Uso restrito do Serviço de Distribuição – Preencher com Branco (Vide aba “Códigos de ocorrência e irregularidade") |
001 | Alfanumérico | |
t34 | Data do Protocolo Uso restrito do Serviço de Distribuição – Preencher com Zero |
008 | Numérico | Nenhuma |
t35 | Valor das Custas do Cartório Uso restrito do Serviço de Distribuição – Preencher com Zero |
010 | Numérico | 2 |
t36 | Declaração do Portador (PREENCHIMENTO DE ACORDO COM A ESPÉCIE, CONTATE A CRA PARA ESCLARECIMENTO) Informe o tipo de declaração, exemplo: D: Para DMI ou DSI onde o apresentante/credor declara estar de posse da documentação que comprova a dívida A: Para títulos que exigem a apresentação física do documento original G: Dispensa documentação I: Envia imagem Campo opcional. |
001 | Alfanumérico | |
t37 | Data da Ocorrência Uso restrito do Serviço de Distribuição – Preencher com Zero |
008 | Numérico | Nenhuma |
t38 | Código de Irregularidade Uso restrito do Serviço de Distribuição – Preencher com Branco (Vide aba “Códigos de ocorrência e irregularidade") |
002 | Alfanumérico | |
t39 | Bairro do devedor | 020 | Alfanumérico | |
t40 | Valor das Custas do Cartório Distribuidor Uso restrito do Serviço de Distribuição – Preencher com Zero |
010 | Numérico | 2 |
t41 | Registro de Distribuição Uso restrito do Serviço de Distribuição – Preencher com Zero |
006 | Numérico | Nenhuma |
t42 | Valor da gravação eletrônica e demais despesas Uso restrito da Centralizadora (CRA) – Preencher com Zero |
010 | Numérico | 2 |
t43 | Número da Operação do Banco Fixo – 0 |
005 | Numérico | Nenhuma |
t44 | Número do Contrato do Banco Fixo – 0 |
015 | Numérico | Nenhuma |
t45 | Número da Parcela do Contrato Fixo – 0 |
003 | Numérico | Nenhuma |
t46 | Tipo da Letra de Câmbio Fixo – 0 |
001 | Alfanumérico | |
t47 | Complemento Código de Irregularidade Uso restrito do Serviço de Distribuição – Preencher com Branco |
008 | Alfanumérico | |
t48 | Protesto por Motivo de Falência Fixo – Branco |
001 | Alfabético | |
t49 | Instrumento de Protesto Fixo – Branco |
001 | Alfabético | |
t50 | Valor das demais despesas Uso restrito dos cartórios – Preencher com zeros |
010 | Numérico | 2 |
t51 | Imagens dos documentos zipados e convertidos em base64 (Não inserir em co-devedores) |
|||
t52 | Sequencial do registro | 004 | Numérico |
REGISTRO DE TRAILLER – ARQUIVO REMESSA (Tag tl)
Atributo |
Descrição |
Tam |
Tipo | Casas Decimais |
t01 |
Identifica o registro trailler no arquivo – Constante 9 |
001 |
Numérico | Nenhuma |
t02 |
Código do apresentante |
003 |
Alfanumérico | Nenhuma |
t03 |
Nome do apresentante |
040 |
Alfabético | |
t04 |
Data do envio do arquivo de remessa |
008 |
Numérico | Nenhuma |
t05 |
Somatório de Segurança (somar as tags h09+h10+h11+h12 do registro HEADER) |
005 |
Numérico | Nenhuma |
t06 |
Somatório do campo t18 do registro de transação |
018 |
Numérico | 2 |
t07 |
Fixo – Branco |
521 |
Alfanumérico | |
t08 |
Sequencial do registro |
004 |
Numérico | Nenhuma |
Arquivo desistência, cancelamento, autorização de cancelamento e de desistência (Tags)
Descrição | Tam | Tipo | Casas Decimais | Atributo |
Tag de Desistência | < desistencia> | |||
Tag de Cancelamento | < cancelamento | |||
Tag de Autorização de Cancelamento | < autoriza_cancelamento> | |||
Tag de Autorização de Desistência | < autoriza_desistencia> | |||
Código do Município da Praça de Pagamento | 007 | Alfanumérico | < CodMun> | |
Número do Cartório | 002 | Numérico | Nenhuma | < numero_cartorio> |
Número do Protocolo do Cartório | 010 | Numérico | Nenhuma | < numero_protocolo> |
Data do Protocolo | 008 | Numérico | Nenhuma | < data_protocolo> |
Número do Título | 011 | Alfanumérico | < numero_titulo> | |
Nome do Devedor | 045 | Alfanumérico | < nome_devedor> | |
Valor do Título | 014 | Numérico | 2 | < valor_titulo> |
Imagem:
|
< imagem> |
Imagens da remessa
Descrição | Tam | Tipo | Casas Decimais | Atributo |
Tag de Remessas | < remessas> | |||
Tag de Remessa | < remessa> | |||
Número sequencial da remessa | 006 | Numérico | Nenhuma | < sequencial> |
Código do Município da Praça de Pagamento | 007 | Alfanumérico | < municipio> | |
Tag de títulos da remessa | < titulos> | |||
Tag de título na remessa | < titulo> | |||
Documento do devedor | 014 | Numérico | Nenhuma | < documento_devedor> |
Nosso número | 015 | Alfanumérico | < nosso_numero> | |
Número do Título | 011 | Alfanumérico | < numero_titulo> | |
Saldo do Título | 011 | Numérico | 2 | < saldo> |
Imagem – arquivo compactado em formato .zip convertido em base 64. Extensões .pdf, .jpg, .png e .p7s | < imagem> |
Imagem do título no arquivo de remessa
- As imagens podem ser assinadas opcionalmente.
- Compactar os arquivos de imagens para a extensão *.zip.
- Converter o arquivo compactado para base64.
- Inserir o código gerado no atributo t51 da tag < tr / > do XML.
- O restante do conteúdo do arquivo deve estar de acordo com o Layout pré-estabelecido. Exemplo:
Imagem do título em arquivo de imagem
- As imagens podem ser assinadas opcionalmente.
- Compactar os arquivos de imagens para a extensão *.zip.
- Converter o arquivo compactado para base64.
- Inserir o código gerado na tag < imagem > do XML:
- O restante do conteúdo do arquivo deve estar de acordo com o Layout pré-estabelecido. Exemplo:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | <?xml version="1.0" encoding="ISO-8859-1" standalone="no" ?> <remessas> <remessa> <sequencial>000249</sequencial> <municipio>3100203</municipio> <titulos> <titulo> <documento_devedor>10964681668</documento_devedor> <nosso_numero>1350100099999</nosso_numero> <numero_titulo>13501000999</numero_titulo> <saldo>5114.85</saldo> <imagem>UEsDBBQAAAAIALdVXVMk==</imagem> </titulo> </titulos> </remessa> </remessas> |
Cancelamento/Desistência
- As imagens podem ser assinadas opcionalmente.
- Compactar os arquivos de imagens para a extensão *.zip.
- Converter o arquivo compactado para base64.
- Inserir o código gerado na tag < imagem > do XML:
1 2 3 4 5 6 7 8 9 10 | <?xml version="1.0" encoding="ISO-8859-1" standalone="no" ?> <desistencia> <comarca> <cartorio> <titulo> <imagem>YBIFAEZ0BQAcA==</imagem> </titulo> </cartorio> </comarca> </desistencia> |
Autorização
- IMPORTANTE: Ao enviar imagens pelo serviço, a aplicação não gerará a carta de autorização, ou seja, o apresentante deverá gerar e enviar a carta de autorização.
- As imagens devem ser assinadas se o parâmetro “exige autorização assinada” estiver cadastrado na CRA.
- Converter o arquivo PDF ou assinado para base64.
- Inserir o código gerado na tag < imagem > do XML:
1 2 3 4 5 6 7 8 9 10 | <!--?xml version="1.0" encoding="ISO-8859-1" standalone="no" ?--> <autoriza_cancelamento> <comarca> <cartorio> <titulo> <imagem>YBIFAEZ0BQAcA==</imagem> </titulo> </cartorio> </comarca> </autoriza_cancelamento> |
CONFIRMAÇÃO E RETORNO
- Informar somente o parâmetro “user_arq”.
- Serão retornados todos os arquivos de confirmação/retorno conforme a data informada no nome do arquivo.
Por exemplo, ao requisitar a CONFIRMAÇÃO com o nome do arquivo C3412401.141 será retornada a CONFIRMAÇÃO de 24/01/2014 independente da data de envio da REMESSA, tendo como base a data de envio da confirmação pelo cartório.
A mesma regra se aplica para o download de RETORNO.
OBSERVAÇÃO
Quando há centavos no valor, esses são separados por ponto.
Então ficaria assim no download do retorno:
R$ 274,00 = “274"
R$ 134,80 = “134.8"
R$ 27,01 = “27.01"
COMARCAS HOMOLOGADAS
- Informar os parâmetros:
- “codapres” – Serão retornados todos os municípios que estão habilitados para o apresentante informado.
- “cartorios” – Informe “x" para consultar os dados dos cartórios que o apresentante está habilitado a enviar títulos.
CONSULTA
- Informar os parâmetros “nossoNumero" e “numeroTitulo".
CONSULTA SLIP
- Informar os parâmetros “cod_municipio“, “cod_cartorio“, “protocolo" e “data_protocolo“.
- Informar a “data_protocolo" no padrão brasileiro. Ex.: 02/05/2016.
INSTRUMENTO
Informar o parâmetro “userDados" com a seguinte estrutura:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 | <instrumento> <municipios> <municipio> <codigoMunicipio>3100203</codigoMunicipio> <cartorios> <cartorio> <codigoCartorio>01</codigoCartorio> <titulos> <titulo> <protocolo>0000038317</protocolo> <dataProtocolo>28/12/2018</dataProtocolo> </titulo> <titulo> <protocolo>1020304050</protocolo> <dataprotocolo>01/03/2018</dataprotocolo> </titulo> </titulos> </cartorio> </cartorios> </municipio> <municipio> <codigoMunicipio>3100209</codigoMunicipio> <cartorios> <cartorio> <codigoCartorio>02</codigoCartorio> <titulos> <titulo> <protocolo>5040302010</protocolo> <dataProtocolo>28/12/2018</dataProtocolo> </titulo> <titulo> <protocolo>1738544625</protocolo> <dataProtocolo>28/12/2018</dataProtocolo> </titulo> </titulos> </cartorio> </cartorios> </municipio> </municipios> </instrumento> |
Dessa forma, o apresentante poderá fazer a consulta de mais de um instrumento por município e cartório.
Códigos de ocorrência (t33)
CÓDIGO |
DESCRIÇÃO |
---|---|
1 |
Pago. |
2 |
Protestado. |
3 |
Retirado. |
4 |
Sustado. |
5 |
Devolvido pelo Cartório por irregularidade – Sem custas.
Quando o cartório não cobrar custas quando da devolução do título por irregularidade. |
6 |
Devolvido pelo Cartório por irregularidade – Com custas. |
7 |
Liquidação em Condicional – Utilizada para os títulos liquidados em Cartório com cheque do próprio devedor |
8 |
Título Aceito – Utilizado para Letras de Câmbio e Duplicatas, para aceite do sacado. |
9 |
Edital, apenas nos Estados da Bahia e Rio de Janeiro. |
A |
Protesto do banco cancelado |
B |
Protesto já efetuado |
C |
Protesto por edital |
D |
Retirada por edital |
E |
Protesto de terceiro cancelado |
F |
Desistência do protesto por liquidação bancária |
G |
Sustado Definitivo |
I |
Emissão da 2ª via do Instrumento do Protesto |
J |
Cancelamento já efetuado anteriormente |
X |
Cancelamento não efetuado |
Z |
Retirada por falta de prazo para o repasse da guia de recolhimento = devolução com código 98 |
Códigos de irregularidades (t38)
CÓDIGO | DESCRIÇÃO |
---|---|
00 | Remessa Cancelada (CRA-AC) |
01 | Data da apresentação inferior à data de vencimento. |
02 | Falta de comprovante da prestação de serviço. |
03 | Nome do sacado incompleto/incorreto. |
04 | Nome do cedente incompleto/incorreto. |
05 | Nome do sacador incompleto/incorreto. |
06 | Endereço do sacado insuficiente. |
07 | CNPJ/CPF do sacado inválido/incorreto. |
08 | CNPJ/CPF incompatível c/ o nome do sacado/sacador/avalista |
09 | CNPJ/CPF do sacado incompatível com o tipo de documento. |
10 | CNPJ/CPF do sacador incompatível com a espécie. |
11 | Título aceito sem a assinatura do sacado. |
12 | Título aceito rasurado ou rasgado. |
13 | Título aceito – falta título (ag ced: enviar). |
14 | CEP incorreto. |
15 | Praça de pagamento incompatível com endereço. |
16 | Falta número do título. |
17 | Título sem endosso do cedente ou irregular. |
18 | Falta data de emissão do título. |
19 | Título aceito: valor por extenso diferente do valor por numérico. |
20 | Data de emissão posterior ao vencimento. |
21 | Espécie inválida para protesto. |
22 | CEP do sacado incompatível com a praça de protesto. |
23 | Falta espécie do título. |
24 | Saldo maior que o valor do título. |
25 | Tipo de endosso inválido. |
26 | Devolvido por ordem judicial |
27 | Dados do título não conferem com disquete |
28 | Sacado e Sacador/Avalista são a mesma pessoa |
29 | Corrigir a espécie do título |
30 | Aguardar um dia útil após o vencimento para protestar |
31 | Data do vencimento rasurada |
32 | Vencimento – extenso não confere com número |
33 | Falta data de vencimento no título |
34 | DM/DMI sem comprovante autenticado ou declaração |
35 | Comprovante ilegível para conferência e microfilmagem |
36 | Nome solicitado não confere com emitente ou sacado |
37 | Confirmar se são 2 emitentes. Se sim, indicar os dados dos 2 |
38 | Endereço do sacado igual ao do sacador ou do portador |
39 | Endereço do apresentante incompleto ou não informado |
40 | Rua / Número inexistente no endereço |
41 | Informar a qualidade do endosso (M ou T) |
42 | Falta endosso do favorecido para o apresentante |
43 | Data da emissão rasurada |
44 | Protesto de cheque proibido – motivo 20/25/28/30 ou 35 |
45 | Falta assinatura do emitente no cheque |
46 | Endereço do emitente no cheque igual ao do banco sacado |
47 | Falta o motivo da devolução no cheque ou motivo ilegível |
48 | Falta assinatura do sacador no título |
49 | Nome do apresentante não informado/incompleto/incorreto |
50 | Erro de preenchimento do título |
51 | Título com direito de regresso vencido |
52 | Título apresentado em duplicidade |
53 | Título já protestado |
54 | Letra de Câmbio vencida – falta aceite do sacado |
55 | Título – falta tradução por tradutor público |
56 | Falta declaração de saldo assinada no título |
57 | Contrato de Câmbio – falta conta gráfica |
58 | Ausência do Documento Físico |
59 | Sacado Falecido. |
60 | Sacado Apresentou Quitação do Título |
61 | Título de outra jurisdição territorial |
62 | Título com emissão anterior à concordata do sacado |
63 | Sacado consta na lista de falência |
64 | Apresentante não aceita publicação de edital |
65 | Dados do sacador em branco ou inválido |
66 | Titulo sem autorização para protesto por edital |
67 | Valor divergente entre título e comprovante |
68 | Condomínio não pode ser protestado para fins falimentares |
69 | Vedada a intimação por edital para protesto falimentar |
70 | Dados do Cedente em branco ou inválido |
71 | CNPJ/CPF do beneficiário incompatível com a espécie (CRA-SC) |
73 | Valor da CDA difere do valor da guia de recolhimento (CRA-SC) |
98 | Retirada por falta de prazo para o repasse da guia de recolhimento |
98 | Retirada por falta de tempo hábil para intimação – PGFN (CRA-ES) |
98 | Retirada por falta de tempo hábil para o repasse do dinheiro (CRA-RO e CRA-RJ) |
98 | Devolução por impossibilidade recolhimento da Guia (CRA-SE e CRA-MG) |
99 | Apresentante em duplicidade (CRA-AC) |
99 | Outros (CRA-DF e CRA-RJ) |
99 | Falta de depósito prévio (CRA-PA) |
99 | Título sem solução (CRA-PI) |
Estrutura da resposta do serviço
Atributos
Atributo | Descrição |
---|---|
nome_arquivo | Nome do arquivo no processamento |
datahora | Data e hora do processamento no WebService |
dataoperacao | Data do movimento considerada pelo sistema da CRA |
codigo | Código da mensagem |
ocorrencia | Descrição da mensagem |
registro | Linha do registro do arquivo com erro |
total_registros | Total de registros que foram processados com sucesso |
Exemplos de respostas
Envio de remessa com sucesso
1 2 3 4 5 6 7 8 9 10 11 | <!--?xml version="1.0" encoding="ISO-8859-1" standalone="no" ?--> <relatorio> <nome_arquivo>B9901308.121</nome_arquivo> <comarca codmun="3550308"> <datahora>201208131020</datahora> <dataoperacao>20120814</dataoperacao> <codigo>0000</codigo> <ocorrencia>REGISTROS OK</ocorrencia> <total_registros>10</total_registros> </comarca> </relatorio> |
Envio de remessa com exceção
Como um arquivo de remessa pode conter títulos para várias comarcas, o serviço de upload pode recusar uma remessa parcialmente ou completamente, em caso de erros no preenchimento do XML.
- Envio com recusa parcial
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | <!--?xml version="1.0" encoding="ISO-8859-1" standalone="no" ?--> <relatorio> <nome_arquivo>B9901308.121</nome_arquivo> <comarca codmun="3550308"> <datahora>201208131020</datahora> <codigo>0000</codigo> <ocorrencia>REGISTROS OK</ocorrencia> <total_registros>10</total_registros> </comarca> <comarca codmun="3509502"> <datahora>201208101020</datahora> <dataoperacao>20120814</dataoperacao> <registro>10</registro> <codigo>1217</codigo> <ocorrencia>APRESENTANTE NÃO AUTORIZADO A ENVIAR TÍTULOS PARA O MUNICÍPIO (3509502 - PIRACURUCA)</ocorrencia> <total_registros>0</total_registros> </comarca> </relatorio> |
- Envio com recusa completa
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | <!--?xml version="1.0" encoding="ISO-8859-1" standalone="no" ?--> <relatorio> <nome_arquivo>B9901008.121</nome_arquivo> <comarca codmun="3550308"> <datahora>201804181559</datahora> <total_registros>0</total_registros> </comarca> <comarca codmun="3509502"> <datahora>201208101020</datahora> <registro>10</registro> <codigo>1217</codigo> <ocorrencia>Campo 17 TRANSAÇÃO - VALOR DO TITULO DEVE SER NUMERICO</ocorrencia> <total_registros>0</total_registros> </comarca> </relatorio> |
- Envio com erro no arquivo
1 2 3 4 5 6 | <!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?--> <relatorio> <nome_arquivo> B9901008.121</nome_arquivo> <codigo>1001</codigo> <ocorrencia>ARQUIVO JA TRANSMITIDO</ocorrencia> </relatorio> |
Envio de remessa com imagem
Esse modo de mensagem é ativado por parâmetro interno do sistema devido ao impacto no tempo da resposta.
A mensagem considera as imagens no registro do primeiro devedor.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 | <relatorio> <nome_arquivo>B9991001.186</nome_arquivo> <comarca codmun="2200202"> <datahora>201901101714</datahora> <dataoperacao>20190110</dataoperacao> <total_registros>10</total_registros> <titulos> <titulo> <nome_devedor>SR. AARON CORTS</nome_devedor> <documento_devedor>28891000141</documento_devedor> <saldo>692.91</saldo> <numero_titulo>35468930037</numero_titulo> <nosso_numero>802150541451059</nosso_numero> <imagem>Corrompida</imagem> </titulo> <titulo> <nome_devedor>RICARDO CALDEIRA</nome_devedor> <documento_devedor>06572000199</documento_devedor> <saldo>60.23</saldo> <numero_titulo>33922734313</numero_titulo> <nosso_numero>426048244534158</nosso_numero> <imagem>Sem imagem</imagem> </titulo> <titulo> <nome_devedor>DR. ZIRALDO PACHECO COLAO FILHO</nome_devedor> <documento_devedor>37015000185</documento_devedor> <saldo>766.11</saldo> <numero_titulo>89975829217</numero_titulo> <nosso_numero>741775808168472</nosso_numero> <imagem>Gravada</imagem> </titulo> </titulos> <codigo>0000</codigo> <ocorrencia>REGISTROS OK</ocorrencia> </comarca> </relatorio> |
Envio de imagem do título após envio da remessa
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | <!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?--> <remessas> <remessa> <sequencial>33</sequencial> <titulos> <titulo> <documento_devedor>39346889187</documento_devedor> <nosso_numero>2087753600052</nosso_numero> <numero_titulo>1412650</numero_titulo> <saldo>2442.86</saldo> <mensagem> <codigo>2196</codigo> <descricao>Título não encontrado.</descricao> </mensagem> </titulo> </titulos> </remessa> </remessas> |
Download retorno
1 2 3 4 5 6 | <!--?xml version="1.0" encoding="ISO-8859-1" standalone="no" ?--> <relatorio> <datahora>201208151509</datahora> <codigo>0003</codigo> <ocorrencia>NÃO HÁ REGISTROS DE RETORNO NESTA DATA</ocorrencia> </relatorio> |
Envio de Desistência/Cancelamento/Autorização
- Envio com sucesso
1 2 3 4 5 6 7 8 9 10 11 12 13 | <!--?xml version="1.0" encoding="ISO-8859-1" standalone="no" ?--> <relatorio> <nome_arquivo>DP9901308.121</nome_arquivo> <titulo> <datahora>201208101020</datahora> <numero_cartorio>01</numero_cartorio> <numero_titulo>00345468</numero_titulo> <numero_protocolo>1234</numero_protocolo> <data_protocolo>13082012</data_protocolo> <codigo>0000</codigo> <ocorrencia> SOLICITAÇÃO RECEBIDA COM SUCESSO </ocorrencia> </titulo> </relatorio> |
- Envio com erro
1 2 3 4 5 6 7 8 9 10 11 12 13 | <!--?xml version="1.0" encoding="ISO-8859-1" standalone="no" ?--> <relatorio> <nome_arquivo>DP9901008.121</nome_arquivo> <titulo> <datahora>201208101020</datahora> <numero_cartorio>01</numero_cartorio> <numero_titulo>003454689</numero_titulo> <numero_protocolo>12345</numero_protocolo> <data_protocolo>14082012</data_protocolo> <codigo>2007</codigo> <ocorrencia>DATA DO PROTOCOLO (DDMMAAAA) INVÁLIDA</ocorrencia> </titulo> </relatorio> |
Download confirmação
1 2 3 4 5 6 7 | <!--?xml version="1.0" encoding="ISO-8859-1" standalone="no" ?--> <relatorio> <nome_arquivo>C9901308.111</nome_arquivo> <datahora>201208131430</datahora> <codigo>0002</codigo> <ocorrencia>NOME DO ARQUIVO INVÁLIDO</ocorrencia> </relatorio> |
Download retorno
1 2 3 4 5 6 7 | <!--?xml version="1.0" encoding="ISO-8859-1" standalone="no" ?--> <relatorio> <nome_arquivo>R9901508.121</nome_arquivo> <datahora>201208151509</datahora> <codigo>0003</codigo> <ocorrencia>NÃO HÁ REGISTROS DE RETORNO NESTA DATA</ocorrencia> </relatorio> |
Consulta título
- Quando o título não for encontrado
1 2 3 4 | <!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?--> <consulta> <data_consulta>30/09/2016</data_consulta> </consulta> |
Mensagens retornadas
Remessa
CÓDIGO |
RECUSA | DESCRIÇÃO | |
---|---|---|---|
0000 |
REGISTROS OK | ||
0001 |
COMPLETO | FALHA NA AUTENTICAÇÃO | |
0002 |
COMPLETO | NOME DO ARQUIVO INVÁLIDO | |
2139 |
COMPLETO | JÁ PASSOU DO HORÁRIO LIMITE PARA ENVIO DA REMESSA | |
0004 |
COMPLETO | ARQUIVO XML INVÁLIDO. (Caracteres inválidos, erros na estrutura do XML, etc.) | |
0009 |
COMPLETO | A INSTITUIÇÃO (XXX) DO USUÁRIO ESTÁ INATIVA | |
2117 |
PARCIAL | MUNICÍPIO: XXXXX – XXXXX. SEQUENCIAL (XXX) JÁ ENVIADO: ÚLTIMO SEQUENCIAL: (XXX). | |
1001 |
COMPLETO | ARQUIVO JA TRANSMITIDO | |
1101 |
COMPLETO | Campo 01 HEADER – FALTOU HEADER (TRANSACAO) | |
1102 |
PARCIAL | Campo 02 HEADER – CODIGO DO APRESENTANTE INVALIDO | |
1105 |
COMPLETO | Campo 05 HEADER – CONTEUDO PERMITIDO: ‘BFO’ | |
1106 |
COMPLETO | Campo 06 HEADER – CONTEUDO PERMITIDO: ‘SDT’ | |
1107 |
COMPLETO | Campo 07 HEADER – CONTEUDO PERMITIDO: ‘TPR’ | |
1109 |
COMPLETO | Campo 09 HEADER – QUANTIDADE DE REGISTROS INVALIDA | |
1305 |
COMPLETO | Campo 10 HEADER – TRAILLER – SOM.SEGURANCA-QTDE – INFORMADO Y / CALCULADO X | |
1305 |
COMPLETO | Campo 11 HEADER – TRAILLER – SOM.SEGURANCA-QTDE – INFORMADO Y / CALCULADO X | |
1305 |
COMPLETO | Campo 12 HEADER – TRAILLER – SOM.SEGURANCA-QTDE – INFORMADO Y / CALCULADO X | |
2103 |
PARCIAL | Campo 15 HEADER – Município: (XXX) não cadastrado na CRA. | |
1102 |
COMPLETO | Campo 16 HEADER – CAMPO 02 HEADER – CODIGO DO APRESENTANTE INVALIDO | |
1117 |
COMPLETO | Campo 17 HEADER – ARQUIVO FORA DE SEQUENCIA | |
1201 |
COMPLETO | Campo 01 TRANSAÇÃO – CONTEUDO PERMITIDO: 1 – ATRIBUTO T01 | |
1202 |
COMPLETO | Campo 02 TRANSAÇÃO- CODIGO DO APRESENTANTE INVALIDO | |
2137 |
COMPLETO | Campo 04 TRANSAÇÃO – CAMPO (NOME DO CEDENTE) INVÁLIDO | |
1211 |
COMPLETO | Campo 11 TRANSAÇÃO – NOSSO NUMERO EM BRANCO | |
1212 |
COMPLETO | Campo 12 TRANSAÇÃO – ESPECIE DO TITULO EM BRANCO | |
2137 |
COMPLETO | Campo 14 TRANSAÇÃO – CAMPO (DATA DE EMISSÃO) INVÁLIDO | |
2137 |
COMPLETO | Campo 15 TRANSAÇÃO – CAMPO (DATA DE VENCIMENTO) INVÁLIDO | |
1217 |
COMPLETO | Campo 17 TRANSAÇÃO – VALOR DO TITULO DEVE SER NUMERICO | |
1218 |
COMPLETO | Campo 18 TRANSAÇÃO – VALOR DO SALDO DEVE SER NUMERICO | |
2111 |
COMPLETO | Campo 22 TRANSAÇÃO – SEQUENCIAL DO DEVEDOR INVÁLIDO | |
2112 |
COMPLETO | Campo 23 TRANSAÇÃO – INFORMAR O NOME DO DEVEDOR. | |
2113 |
COMPLETO | Campo 25 TRANSAÇÃO – INFORMAR O DOCUMENTO DO DEVEDOR | |
1238 |
COMPLETO | Campo 38 TRANSAÇÃO – CONTEUDO PERMITIDO: BRANCO | |
1252 |
COMPLETO | Campo 52 TRANSAÇÃO – NUM. SEQUENCIAL DO REGISTRO INVALIDO | |
1301 |
COMPLETO | Campo 01 TRAILLER – CONTEUDO PERMITIDO: 9 | |
1302 |
COMPLETO | Campo 02 TRAILLER – CODIGO DO APRESENTANTE INVALIDO | |
1305 |
COMPLETO | Campo 05 TRAILLER – SOM.SEGURANCA-QTDE – INFORMADO Y / CALCULADO X | |
1306 |
COMPLETO | Campo 06 TRAILLER – SOM.SEGURANCA-VLR.REMESSA – INFORMADO Y / CALCULADO X | |
1308 |
COMPLETO | Campo 08 TRAILLER – NUM. SEQUENCIAL DO REGISTRO INVALIDO | |
2105 |
PARCIAL | Apresentante não autorizado a enviar títulos para o município (XXX – XXX). | |
2110 |
COMPLETO | Arquivo corrompido. Soma de originais existentes no arquivo (XX) não confere com total informado no header (XX). | |
2160 |
COMPLETO | REMESSA NÃO PODE SER ENVIADA APÓS O DIA LIMITE | |
2181 |
PARCIAL | REMESSAS DE XXX (XXX) DEVEM SER ENVIADAS PARA XXX (XXX). | |
2182 |
COMPLETO | ARQUIVO CORROMPIDO. TIPO DO REGISTRO NÃO ENCONTRADO. | |
2101 |
PARCIAL | Arquivo contém caractere que não está no padrão ASCII. Linha: XXXX – COLUNA(s): XXXX. | |
2102 |
PARCIAL | Arquivo corrompido. Tamanho da linha inválido. Tamanho: XXXX – Linha: XXXX. | |
2104 |
PARCIAL | Município: XXXX – XXXX não possui cartório na CRA. | |
2106 |
PARCIAL | Município: XXXX – XXXX não está ativo | |
2107 |
COMPLETO | Sequencial do devedor inválido (XXXX) | |
2108 |
COMPLETO | Arquivo corrompido. Soma de títulos existentes no arquivo (XXXX) não confere com total informado no header (XXXX). | |
2109 |
COMPLETO | Arquivo corrompido. Soma de indicações existentes no arquivo (XXXX) não confere com total informado no header (XXXX). | |
1253 |
COMPLETO | TÍTULO NÃO PODE SER ENVIADO COM SALDO (X) SUPERIOR AO PERMITIDO (Y) PARA O APRESENTANTE. | |
2200 |
COMPLETO | TÍTULOS APRESENTADOS EXCEDEM A QUANTIDADE MÁXIMA PERMITIDA NO MÊS PARA O MUNICÍPIO (XXXXXXX – XXXXXXX). ENVIADOS: XXXX – LIMITE: XXXX LINHA: XXXX. | |
2201 |
COMPLETO | TÍTULOS APRESENTADOS EXCEDEM A QUANTIDADE MÁXIMA PERMITIDA NO DIA PARA O MUNICÍPIO (XXXXXXX – XXXXXXX). ENVIADOS: XXXX – LIMITE: XXXX LINHA: XXXX | |
2222 |
COMPLETO | TÍTULOS APRESENTADOS EXCEDEM A QUANTIDADE MÁXIMA PERMITIDA NO MÊS. ENVIADOS: XXXX – LIMITE: XXXX. | |
2212 |
COMPLETO | REMESSA POSSUI DEVEDOR QUE NÃO PODE SER PROTESTADO. DOCUMENTO: XXXX. | |
2219 |
COMPLETO | O SALDO DO TÍTULO É MENOR QUE O MÍNIMO PERMITIDO XXXX PARA APRESENTAR A ESPÉCIE XXXX. SALDO: XXXX. NÚMERO: XXXX. LINHA: XXXX. | |
2220 |
COMPLETO | A DATA DE VENCIMENTO DO TÍTULO É SUPERIOR AO PRAZO MÁXIMO PREMITIDO PARA APRESENTAR A ESPÉCIE XXXX. NÚMERO: XXXX. LINHA: XXXX. | |
2231 |
COMPLETO | A ÚLTIMA LINHA PRECISA SER UM TRAILLER (9) | |
2229 |
COMPLETO | A LINHA QUE ANTECEDE O TRAILLER PRECISA SER UMA TRANSAÇÃO (1) | |
2305 |
COMPLETO | Documento do devedor inválido. (999.999.999-99) | |
10000 |
COMPLETO | 1.5 ARQUIVO XML CORROMPIDO. |
Imagem no arquivo de remessa
DESCRIÇÃO |
---|
Gravada |
Sem imagem |
Corrompida |
Imagem do título após envio da remessa
CÓDIGO |
DESCRIÇÃO |
---|---|
2225 |
CAMPOS OBRIGATÓRIOS NÃO PREENCHIDOS (xxxxxx). |
2226 |
ARQUIVO INVÁLIDO. EXISTEM ERROS NA ESTRUTURA DO XML. |
2232 |
EXTENSÃO DO ARQUIVO INVÁLIDO. SÃO PERMITIDOS APENAS ARQUIVOS NO FORMATO (.PDF, .JPG, .PNG E .P7S) |
Desistência/Cancelamento/Autorização
CÓDIGO |
DESCRIÇÃO |
---|---|
0000 |
SOLICITAÇÃO RECEBIDA COM SUCESSO |
0001 |
FALHA NA AUTENTICAÇÃO |
0009 |
A INSTITUIÇÃO (XXX) DO USUÁRIO ESTÁ INATIVA |
0002 |
NOME DO ARQUIVO INVÁLIDO |
2141 |
JÁ PASSOU DO HORÁRIO LIMITE PARA ENVIO DE DESISTÊNCIA |
2140 |
JÁ PASSOU DO HORÁRIO LIMITE PARA ENVIO DE CANCELAMENTO |
2024 |
FALTOU INFORMAR A TAG: DESISTENCIA |
2023 |
FALTOU INFORMAR A TAG: CANCELAMENTO |
0007 |
FALTA A TAG: COMARCA NO XML |
2001 |
COMARCA NÃO CONVENIADA |
2002 |
CARTORIO XX INVÁLIDO / NÃO EXISTE |
2004 |
NUMERO DO PROTOCOLO EM BRANCO |
2005 |
NUMERO DO PROTOCOLO INVÁLIDO |
2006 |
NUMERO DO PROTOCOLO DEVE CONTER NO MAXIMO 10 DIGITOS |
2007 |
DATA DO PROTOCOLO (DDMMAAAA) INVÁLIDA |
2008 |
NUMERO DO TITULO EM BRANCO |
2008 |
NUMERO DO TITULO DEVE CONTER NO MAXIMO 11 DIGITOS |
2009 |
NOME DO DEVEDOR EM BRANCO |
2010 |
VALOR DO TITULO INVÁLIDO |
2159 |
APRESENTANTE NÃO AUTORIZADO A ENVIAR PEDIDO DE CANCELAMENTO |
2012 |
TITULO NAO ENCONTRADO |
2013 |
TITULO NAO FOI PROTESTADO |
2014 |
AUTORIZAÇÃO EM DUPLICIDADE |
2015 |
TÍTULO PERTENCE A OUTRO APRESENTANTE |
2016 |
O TÍTULO JÁ POSSUI CANCELAMENTO. PROTOCOLO: (XX) |
2017 |
O TITULO JÁ POSSUI AUTORIZACAO DE CANCELAMENTO |
2018 |
IMAGEM INVÁLIDA OU ASSINADA INCORRETAMENTE |
2019 |
FALTOU INFORMAR A TAG: CODMUN |
2020 |
FALTOU INFORMAR A TAG: NUMERO_CARTORIO |
2021 |
FALTOU INFORMAR A TAG: TITULO |
2022 |
FALTOU INFORMAR A TAG: CARTORIO |
2023 |
FALTOU INFORMAR A TAG: CANCELAMENTO |
2024 |
FALTOU INFORMAR A TAG: DESISTENCIA |
2025 |
FALTOU INFORMAR A TAG: AUTORIZACAO |
2026 |
FALTOU INFORMAR A TAG: AUTORIZA_DESISTENCIA |
2027 |
TAG NUMERO_CARTORIO INFORMADA EM DUPLICIDADE |
2028 |
TÍTULO JÁ POSSUI RETORNO |
2191 |
NÃO CONSTA PEDIDO DE CANCELAMENTO EM ARQUIVO ASSINADO COM CERTIFICADO DIGITAL PARA O TÍTULO |
Confirmação
CÓDIGO |
DESCRIÇÃO |
---|---|
0001 |
FALHA NA AUTENTICAÇÃO |
0002 |
NOME DO ARQUIVO INVÁLIDO |
0005 |
NÃO EXISTE CONFIRMAÇÃO NA DATA INFORMADA. |
0009 |
A INSTITUIÇÃO (XXX) DO USUÁRIO ESTÁ INATIVA |
Retorno
CÓDIGO |
DESCRIÇÃO |
---|---|
0001 |
FALHA NA AUTENTICAÇÃO |
0002 |
NOME DO ARQUIVO INVÁLIDO |
0004 |
NÃO EXISTE RETORNO NA DATA INFORMADA. |
0009 |
A INSTITUIÇÃO (XXX) DO USUÁRIO ESTÁ INATIVA |
2163 |
Já foi enviado arquivo de retorno com o sequencial (XXXX) para o apresentante XXXX (XXXX) |
Consulta slip
CÓDIGO | DESCRIÇÃO |
---|---|
2183 | CÓDIGO DO MUNICÍPIO NÃO INFORMADO. |
2184 | CÓDIGO DO CARTÓRIO NÃO INFORMADO. |
2185 | DATA INVÁLIDA. |
2187 | PROTOCOLO NÃO INFORMADO. |
2188 | TÍTULO NÃO ENCONTRADO OU NÃO RETORNADO. |