Transmissão de arquivo de títulos XML entre o distribuidor/cartório de protesto e o CRA21

Descrever a realização da tramitação de arquivos de Títulos entre os Distribuidores / Cartórios de Protesto e o CRA21.

• Homologação (ambiente de testes):

craUF.cra21.com.br/craUF/xml/protestos_cartorio.php?wsdl

Ex: https://cradf.cra21.com.br/cradf/xml/protestos_cartorio.php?wsdl

• Produção (ambiente de funcionamento do sistema):

craUF.crabr.com.br/craUF/xml/protestos_cartorio.php?wsdl

Ex: https://cradf.crabr.com.br/cradf/xml/protestos_cartorio.php?wsdl

• Os dados (parâmetros) devem ser enviados via protocolo SOAP

Todos os arquivos enviados ou recebidos nos serviços devem estar em conformidade com o padrão FEBRABAN XML.

• 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	Download do arquivo de remessa.
    RemessaPendente	Download de arquivo de remessa ainda não baixado.
    Confirmacao	Upload do arquivo de confirmação.
    Retorno	Upload do arquivo de retorno.
    Desistencia	Download do arquivo de desistência.
    Cancelamento	Download do arquivo de cancelamento.
    Autorizacao	Download do arquivo de autorização (desistência e cancelamento).
    BuscarApresentante	Download de apresentantes ativos no município.
    SalvarSituacao	Salva os dados da situação do título na CRA.
    BuscarSituacao	Busca a situação do título na CRA.
    Imagem	Upload das imagens dos instrumentos de protesto.
    ConsultaSlip	Serviço para consulta do código/nome da agência do cedente.
    CustasTitulo	Serviço para informar os emolumentos dos títulos. Mais informações nesse link.
    ConsultaAutorizacao	Consulta uma autorização específica de um título.
    ConsultaImagem	Consulta os arquivos de imagem de um título.

• 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.
      downloadImagem	Parâmetro opcional utilizado somente no serviço de “Remessa". Indica se a remessa retornará com as imagens dos títulos.

    • SalvarSituacao / BuscarSituacao
      

      protocoloCartorio	Informar o código do cartório.
      dataOcorrencia	Informar a data de ocorrência.
      ocorrência	Informar a ocorrência.
      codigoPraca	Informar o código IBGE do município.
      codigoCartorio	Informar o código do cartório.

    • ConsultaSlip
      

      protocolo	Número do protocolo informado na confirmação.
      dataProtocolo	Data do protocolo informado na confirmação.

    • ConsultaAutorizacao
      

      userArq	Nome do arquivo no formato FEBRABAN (AD ou AC).
      protocolo	Número do protocolo informado na confirmação.
      dataProtocolo	Data do protocolo informado na confirmação.
      marcarBaixado	Parâmetro que define se a autorização será marcada como baixada.

    • ConsultaImagem
      

      nossoNumero	Informar o Nosso Número.
      numeroTitulo	Informar o número de identificação do título.
      documentoDevedor	Informar o número do documento do devedor (CPF/CNPJ).
      saldoTitulo	Informar o saldo do título. (Opcional)
      vencimento	Informar a data de vencimento do título. (Opcional)
      remessa	Informar o número sequencial da remessa. (Opcional)

  • O encoding do XML deve estar de acordo com ISO-8859-1.
  • O conteúdo dos arquivos enviados para CRA devem seguir o padrão de codificação ASCII
  • Assim como no HTML, o XML possui entidades, que devem ser substituídas conforme tabela abaixo:

    • De	Para
      <	& lt;
      >	& gt;
      &	& amp;
      ‘	& apos;
      “	& quot;

REMESSA

CONFIRMAÇÃO

RETORNO

DESISTENCIA

CANCELAMENTO

AUTORIZAÇÃO DE CANCELAMENTO

AUTORIZAÇÃO DE DESISTÊNCIA

IMAGEM

REGISTRO HEADER – ARQUIVO REMESSA (Tag hd)

REGISTRO DE TRANSAÇÃO – ARQUIVO REMESSA (Tag tr)

REGISTRO DE TRAILLER – ARQUIVO REMESSA (Tag tl)

• O conteúdo do arquivo deve estar de acordo com o Layout XML da FEBRABAN. O arquivo pode conter mais de uma confirmação/retorno, agrupadas uma abaixo da outra (uma remessa para cada apresentante). Desde que esteja em conformidade com o Padrão.

• Exemplo do arquivo XML de CONFIRMAÇÃO (formato FEBRABAN):
• Exemplo do arquivo XML de RETORNO (formato FEBRABAN) com 2 apresentantes:

REMESSA:

• Informar o parâmetro “user_arq” ( Nome do arquivo no no formato FEBRABAN)
• Informar o parâmetro “downloadImagem”, opcionalmente, para baixar as imagens dos títulos na remessa ou para consultar se os títulos possuem imagem.  Preencha o parâmetro com “1" caso seja necessário o download das imagens ou “2" para que o sistema informe se os títulos possuem imagens para serem baixadas. Caso contrário, ele não deve ser informado.
• Serão retornadas todas as remessas da data informada e as pendentes de download das datas anteriores.
• Será validado o inicio do nome do arquivo, B, e a data informada. O código do apresentante não é considerado para o download.
• Por exemplo, ao requisitar a REMESSA com o nome do arquivo B0002401.141, será retornada a REMESSA de 24/01/2014 tendo como base a data de envio da remessa pelo apresentante. Serão retornadas remessas de todos apresentantes na data informada e as pendentes das datas anteriores.

REMESSA PENDENTE:

• Informar o parâmetro “user_arq” ( Nome do arquivo no no formato FEBRABAN)
• Informar o parâmetro “downloadImagem”, opcionalmente, para baixar as imagens dos títulos na remessa ou para consultar se os títulos possuem imagem. Preencha o parâmetro com “1" caso seja necessário o download das imagens ou “2" para que o sistema informe se os títulos possuem imagens para serem baixadas. Caso contrário, ele não deve ser informado.
• Serão retornadas todas as remessas  pendentes de download.
• Será validado o inicio do nome do arquivo, B, e a data informada. O código do apresentante não é considerado para o download.
  • Por exemplo, ao requisitar a REMESSA com o nome do arquivo B0002401.141, serão retornadas as REMESSAS pendentes de download independente do apresentante ou data.

DESISTENCIA:

• Informar o parâmetro “user_arq” ( Nome do arquivo no no formato FEBRABAN)
• Serão retornadas todas as desistências  da data informada e as pendentes de download das datas anteriores.
• Será validado o inicio do nome do arquivo, DP, e a data informada. O código do apresentante não é considerado para o download.
• Por exemplo, ao requisitar a DESISTENCIA com o nome do arquivo DP0002401.141, será retornada a DESISTÊNCIA de 24/01/2014 tendo como base a data de envio da DESISTENCIA pelo apresentante. Serão retornadas desistências de todos apresentantes na data informada e os pendentes das datas anteriores.

CANCELAMENTO:

• Informar o parâmetro “user_arq” ( Nome do arquivo no no formato FEBRABAN)
• Informar o parâmetro “downloadImagem”, opcionalmente, para baixar as imagens das solicitações de cancelamento. Preencha o parâmetro com 1 caso seja necessário o download das imagens, caso contrário, ele não deve ser informado.
• Serão retornados todos os cancelamentos da data informada e os pendentes de download das datas anteriores.
• Será validado o inicio do nome do arquivo, CP, e a data informada. O código do apresentante não é considerado para o download.
• Por exemplo, ao requisitar o CANCELAMENTO com o nome do arquivo CP0002401.141, será retornado o CANCELAMENTO de 24/01/2014 tendo como base a data de envio do cancelamento pelo apresentante. Serão retornados cancelamentos de todos apresentantes na data informada e os pendentes das datas anteriores.

• • Ao requisitar o download do arquivo de autorização, serão retornadas todas as autorizações de desistência e cancelamento referente a data informada e as que estão pendentes de download de datas anteriores.
  • A requisição pode ser feita usando AC ou AD na sigla do nome do arquivo
  • Informar o parâmetro “downloadImagem”, opcionalmente, para baixar as imagens das autorizações. Preencha o parâmetro com “1" caso seja necessário o download das imagens, caso contrário, informe “0".
  • O conteúdo da carta de anuência estará disponível no atributo t10 ()
  • A imagem é compactada e convertida em base64. Se houver arquivo assinado, o ZIP conterá um arquivo PDF e outro P7S.
  • A atributo “t07" indicará o tipo da autorização

• Informar o parâmetro “user_arq” ( Nome do arquivo no no formato FEBRABAN), “numeroProtocolo","dataProtocolo" e “marcarBaixado".
• Quando informo “0” ou “false” no parâmetro marcarBaixado o serviço retorna os dados sem marcar a autorização como baixada.
• Quando informo qualquer outra string ou não informo nada no parâmetro, a consulta marca a autorização como baixada.

Retorno

• 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 > do XML.
• O restante do conteúdo do arquivo deve estar de acordo com o Layout pré-estabelecido. Exemplo

Envio de instrumento eletrônico

• As imagens podem ser assinadas opcionalmente.
• Nome do arquivo INNNDDMM.AAS
• Compactar os arquivos de imagens para a extensão *.zip
• Converter o arquivo compactado para base64
• Inserir o código gerado no conteúdo da tag 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

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<relatorio>
    <nome_arquivo>B0001911.141</nome_arquivo>
    <datahora>201411191158</datahora>
    <codigo>0003</codigo>
    <ocorrencia>NÃO EXISTE REMESSA NA DATA INFORMADA.</ocorrencia>
</relatorio>

1
2
3
4
5
6
7

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<relatorio>
    <nome_arquivo>DP0001911.141</nome_arquivo>
    <datahora>201411191201</datahora>
    <codigo>0006</codigo>
    <ocorrencia>NÃO EXISTE DESISTÊNCIA NA DATA INFORMADA.</ocorrencia>
</relatorio>

1
2
3
4
5
6
7

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<relatorio>
    <nome_arquivo>CP0001911.141</nome_arquivo>
    <datahora>201411191200</datahora>
    <codigo>0007</codigo>
    <ocorrencia>NÃO EXISTE CANCELAMENTO NA DATA INFORMADA.</ocorrencia>
</relatorio>

1
2
3
4
5
6
7
8
9
10
11

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<relatorio>
    <nome_arquivo>C3411811.141</nome_arquivo>
    <comarca codmun="5300108">
        <datahora>201411181628</datahora>
        <dataoperacao>20141118</dataoperacao>
        <total_registros>2</total_registros>
        <codigo>0000</codigo>
        <ocorrencia>APRESENTANTE: ITAÚ (341) - SEQUENCIAL REMESSA: 000353 (2 TÍTULOS).</ocorrencia>
    </comarca>
</relatorio>

1
2
3
4
5
6
7
8
9
10
11

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<relatorio>
    <nome_arquivo>C0001811.141</nome_arquivo>
    <comarca codmun="5300108">
        <datahora>201411181708</datahora>
        <dataoperacao>20141118</dataoperacao>
        <total_registros>0</total_registros>
        <codigo>2117</codigo>
        <ocorrencia>JÁ• FOI ENVIADA REMESSA COM O MESMO SEQUENCIAL (000353) PARA O MUNICÍPIO (5300108).</ocorrencia>
    </comarca>
</relatorio>

1
2
3
4
5
6

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<relatorio>
    <nome_arquivo>C3411811.141</nome_arquivo>
    <codigo>2116</codigo>
    <ocorrencia>O ARQUIVO C3411811.141 JÁ• FOI ENVIADO EM 18/11/2014.</ocorrencia>
</relatorio>

1
2
3
4
5
6
7
8
9
10
11

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<relatorio>
    <nome_arquivo>R0001811.141</nome_arquivo>
    <comarca codmun="5300108">
        <datahora>201411181631</datahora>
        <dataoperacao>20141118</dataoperacao>
        <total_registros>5</total_registros>
        <codigo>0000</codigo>
        <ocorrencia>APRESENTANTE: 341 – ITAÚ (5 TÍTULOS).</ocorrencia>
    </comarca>
</relatorio>

1
2
3
4
5
6
7
8
9
10
11

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<relatorio>
    <nome_arquivo>R0001911.141</nome_arquivo>
    <comarca codmun="5500108">
        <datahora>201411191350</datahora>
        <total_registros>0</total_registros>
        <codigo>2142</codigo>
        <ocorrencia>CÓDIGO DO MUNICÍPIO INFORMADO NO ARQUIVO (5500108) NÃO CORRESPONDE AO SEU MUNICÍPIO.</ocorrencia>
        <codigo>2151</codigo>
    </comarca>
</relatorio>

1
2
3
4
5
6

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<relatorio>
    <nome_arquivo>R0001811.141</nome_arquivo>
    <codigo>2116</codigo>
    <ocorrencia>O ARQUIVO R0001811.141 JÁ• FOI ENVIADO EM 18/11/2014.</ocorrencia>
</relatorio>

• Envio com imagem no arquivo

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
41
42
43

<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<relatorio>
  <nome_arquivo>R9992606.181</nome_arquivo>
  <comarca CodMun="1234567">
    <datahora>201806221505</datahora>
    <dataoperacao>20180622</dataoperacao>
    <total_registros>5</total_registros>
    <titulos>
      <titulo>
        <protocolo>0000012345</protocolo>
        <data_protocolo>10052018</data_protocolo>
        <situacao>Não gravado</situacao>
        <imagem>Não gravada</imagem>
      </titulo>
      <titulo>
        <protocolo>0000012346</protocolo>
        <data_protocolo>10052018</data_protocolo>
        <situacao>Gravado</situacao>
        <imagem>Corrompida</imagem>
      </titulo>
      <titulo>
        <protocolo>0000012347</protocolo>
        <data_protocolo>10052018</data_protocolo>
        <situacao>Gravado</situacao>
        <imagem>Gravada</imagem>
      </titulo>
      <titulo>
        <protocolo>0000012348</protocolo>
        <data_protocolo>10052018</data_protocolo>
        <situacao>Gravado</situacao>
        <imagem>Sem imagem</imagem>
      </titulo>
      <titulo>
        <protocolo>0000012349</protocolo>
        <data_protocolo>10052018</data_protocolo>
        <situacao>Não gravado</situacao>
        <imagem>Sem imagem</imagem>
      </titulo>
    </titulos>
    <codigo>0000</codigo>
    <ocorrencia>APRESENTANTE: 999 - TESTE (5 TÍTULOS).</ocorrencia>
  </comarca>
</relatorio>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<relatorio>
    <nome_arquivo>I0001810.171</nome_arquivo>
<imagem>
    <protocolo>0011038370</protocolo>
    <data_protocolo>07/02/2017</data_protocolo>
    <codigo>2191</codigo>
    <ocorrencia>IMAGEM SALVA COM SUCESSO.</ocorrencia>
</imagem>
<imagem>
    <protocolo>0003550308</protocolo>
    <data_protocolo>18/10/2017</data_protocolo>
    <codigo>2192</codigo>
    <ocorrencia>RETORNO NÃO ENCONTRADO.</ocorrencia>
</imagem>
<imagem>
    <protocolo>0003550308</protocolo>
    <data_protocolo>18/10/2017</data_protocolo>
    <codigo>2193</codigo>
    <ocorrencia>IMAGEM CORROMPIDA.</ocorrencia>
</imagem>
</relatorio>

Buscar Apresentante: Exemplo de resposta