Cobranca Online v2.5

Cobrança Online
Versão 2.5 – Agosto/2021
1
Sumário
1. Introdução ...................................................................... 5
2. Requisitos para Cobrança Online via XML ............................. 6
2.1. Certificado digital ........................................................ 6
2.1.1. Certificados de validação de domínio (site) ................ 7
2.1.2. Certificados emitidos para e-CNPJ (Tipo A1) .............. 8
2.1.3. Certificados emitidos para e-CPF (Tipo A1) ................ 9
2.1.4. Renovação dos certificados ................................... 10
2.1.4.1. Certificado Banrisul ........................................... 10
2.1.4.2. Certificado Cliente ............................................ 10
2.2. Habilitação cadastral ................................................. 11
2.3. Homologação ........................................................... 12
2.4. Produção ................................................................. 13
3. Serviços........................................................................ 14
3.1. RegistrarTitulo .......................................................... 16
3.1.1. XML de entrada ................................................... 16
3.1.2. Exemplo de entrada ............................................. 22
3.1.3. XML de saída ...................................................... 23
3.1.4. Retorno de sucesso.............................................. 23
3.1.5. Exemplo de sucesso ............................................. 26
3.1.6. Arquivo XSD ....................................................... 27
3.2. AlterarTitulo ............................................................. 28
3.2.1. XML de entrada ................................................... 28
3.2.2. Exemplos de entrada ........................................... 29
3.2.3. XML de saída ...................................................... 30
3.2.6. Arquivo XSD ....................................................... 32
3.3. BaixarTitulo ............................................................. 33
3.3.1. XML de entrada ................................................... 33
3.3.3. XML de saída ...................................................... 35
3.3.6. Arquivo XSD ....................................................... 37
3.4. ConsultarTitulo ......................................................... 38
3.4.1. XML de entrada ................................................... 38
3.4.3. XML de saída ...................................................... 40
2
3.4.6. Arquivo XSD ....................................................... 49
3.5. EmitirBoleto ............................................................. 50
3.5.1. XML de entrada ................................................... 50
3.5.3. XML de saída ...................................................... 53
3.5.6. Arquivo XSD ....................................................... 54
3.5.7. Boleto de Teste ................................................... 55
4. Retorno de falha ............................................................ 56
4.1. Exemplos de falha ..................................................... 56
4.2. Código de ocorrência ................................................. 59
4.3. Possíveis erros e soluções .......................................... 61
5. Tabela comparativa ......................................................... 63
6. Descrições das notas ...................................................... 66
7. Detalhamento Técnico ..................................................... 69
7.1. Acesso ao Web Service .............................................. 69
7.1.1. C# via Soap Client............................................... 69
7.1.2. C# via Web Request ............................................ 70
7.1.3. PHP via CURL ...................................................... 71
7.1.4. Java via HttpsURLConnection ................................ 72
7.1.5. Java via JAX-WS .................................................. 73
7.2. Impressão do Boleto ................................................. 74
7.2.1. C# .................................................................... 74
8. Anexo I – Leiaute do boleto ............................................. 75
8.1. Especificações técnicas .............................................. 75
8.2. Definição dos Campos do Boleto .................................. 75
8.2.1. Número de Vias .................................................. 75
8.2.2. Disposição das partes .......................................... 75
8.3. Instruções de preenchimento do boleto ........................ 75
8.3.1. Ficha de Compensação ......................................... 75
8.3.2. Ficha de caixa (opcional) ...................................... 76
8.3.3. Recibo do Pagador ............................................... 76
8.4. Modelo de boleto ...................................................... 77
8.4.1. Formato envelope – Recibo do pagador ................... 77
8.4.2. Formato envelope – Ficha de compensação ............. 77
9. Anexo II – Cálculo do Nosso Número ................................. 78
9.1. Cálculo do Número de Controle do Nosso Número .......... 78
9.1.1. Módulo10: cálculo do primeiro dígito verificador ....... 78
3
9.1.2. Módulo 11: cálculo do segundo dígito verificador ...... 79
10. Anexo III – Emissão de Segunda Via .............................. 80
11. Anexo IV – Extração de certificado ................................. 81
11.1. Comandos para extrair certificado e chave privada de um
arquivo PKCS#12 (.pfx/.p12) .............................................. 81
11.2. Comando para criar um arquivo PKCS #12 (.pfx/.p12) . 81
12. Controle de alterações do documento ............................. 82
4
1. Introdução
A partir da Nova Plataforma de Cobrança (NPC) e a obrigatoriedade de
centralização dos títulos, houve a necessidade de criação de novos produtos que
atendessem as novas exigências.
Dentre estes novos produtos, está a possibilidade de registro on-line

de títulos. Esta nova opção visa atender aos clientes que desejam realizar o
pagamento logo após a emissão do título, como lojas virtuais, por exemplo.
Também cumpre as determinações da Nova Plataforma de Cobrança que não
prevê mais a possibilidade de pagamento de títulos não registrados e,
consequentemente, não centralizados à Plataforma Centralizada de Recebíveis
(PCR).
Com o intuito de atender a este novo cenário, o Banrisul oferece aos

seus clientes diversas possibilidades de registrar títulos de forma on-line:
através do Office Banking, Mobile, CNAB 240 – versão 10.3, ou ainda, via
chamada Web Service. Abaixo o detalhamento de cada uma destas modalidades.
Registro de títulos via Office Banking
Através do office banking ou mobile, beneficiários devidamente

cadastrados podem emitir títulos, de forma on-line. A emissão ocorre através da
inclusão de título único, podendo conter instruções e mensagens, de acordo com
os parâmetros definidos pelo beneficiário.
Registro através do CNAB 240 – versão 10.3
O registro de título pelo CNAB 240, versão 10.3 (ou mais) permite o
registro de diversos títulos através de remessas com processamento de hora em
hora ao longo do dia. Esta versão do CNAB 240 também conta com a vantagem
de possuir um retorno com mais informações.
Registro através de chamadas XML
Nesta modalidade cliente beneficiário deverá desenvolver uma solução

que integrará seu sistema ao do Banco, realizando chamadas através do
protocolo XML. O Banrisul irá validar e devolver o retorno de modo online.
Além do registro, beneficiário também poderá contar com a emissão de

boleto pelo mesmo protocolo, ou ainda, ser direcionado para a página de
emissão de segunda via do Banco.
A utilização do registro online via XML será apresentada nos próximos

capítulos deste documento.
5
2. Requisitos para Cobrança Online via XML
2.1. Certificado digital

Para conexão ao web service da Cobrança Online via XML, o servidor
do Banrisul exige a apresentação de um certificado de cliente. A cada
autenticação da comunicação com o serviço, deverá ser utilizado o certificado
instalado na máquina que realizará a chamada. O mesmo deverá estar
cadastrado junto ao banco.
Este certificado digital deve ser emitido por uma Autoridade de

Certificação confiável, cuja AC Raiz seja reconhecida no ambiente Microsoft. Para
o estabelecimento de canal seguro com o servidor do Banrisul, todo o tráfego de
rede deverá utilizar apenas o protocolo criptográfico TLS (Transport Layer
Security), sem suporte para protocolos anteriores como o protocolo SSL (Secure
Sockets Layer).
Poderá ser aceito qualquer um dos três tipos de certificados abaixo

para conexão com ao web service:
I. Validação de domínio (site);
II. Emitido para e-CNPJ (tipo A1);
III. Emitido para e-CPF (tipo A1).
6
2.1.1. Certificados de validação de domínio (site)
O certificado digital para a autenticação do cliente emitido para
validação de domínio deve atender aos seguintes requisitos:
I. O Common Name do certificado deverá ser igual ao DNS (Domain

Name System) do servidor, composto pelo FQDN (Fully-Qualified
Domain Name);
II. Deve utilizar chaves criptográficas RSA, no mínimo, de 2048 bits e

algoritmo de hash SHA-256;
III. O certificado deve conter o Uso Avançado de Chave “Autenticação de

Cliente” (OID 1.3.6.1.5.5.7.3.2) e deve possuir uma chave privada
correspondente instalada no servidor que está iniciando a conexão com
o web service. A existência de outras opções no Uso Avançado de
Chave não afetará a autenticação com o servidor Banrisul.
Exemplo de certificado emitido por uma AC Internacional para validação de domínio.
7
2.1.2. Certificados emitidos para e-CNPJ (Tipo A1)
O certificado digital para a autenticação do cliente do tipo e-CNPJ deve
ser emitido por Autoridade Certificadora da ICP-Brasil e deve atender aos
seguintes requisitos:
I. O Common Name do certificado deverá ser composto do nome

empresarial da pessoa jurídica, com comprimento máximo de 49
(quarenta e nove) caracteres, acrescido do sinal de dois pontos (:)
mais o número de inscrição no Cadastro Nacional de Pessoa Jurídica
(CNPJ) composto por 14 (quatorze) caracteres;
II. O certificado deve conter o Uso Avançado de Chave “Autenticação de

Exemplo de certificado emitido por uma AC da ICP-Brasil
8
2.1.3. Certificados emitidos para e-CPF (Tipo A1)
O certificado digital para a autenticação do cliente do tipo e-CPF deve
ser emitido por Autoridade Certificadora da ICP-Brasil e deve atender aos
seguintes requisitos:
I. O Common Name do certificado deverá ser composto do nome da

pessoa física, com comprimento máximo de 52 (cinquenta e dois)
caracteres, acrescido do sinal de dois pontos (:) mais o número de
inscrição no Cadastro de Pessoa Física (CPF) composto por 11 (onze)
caracteres;
II. O certificado deve conter o Uso Avançado de Chave “Autenticação de

Exemplo de certificado e-CPF emitido por uma AC da ICP-Brasil
9
2.1.4. Renovação dos certificados
2.1.4.1. Certificado Banrisul
Todos os certificados digitais para os domínios do Banco do Estado do

Rio Grande do Sul SA (banrisul.com.br) são emitidos por uma Autoridade
Certificadora confiável, reconhecida ao menos em ambiente Microsoft, e são
inscritos em registros públicos de Certificate Transparency.
Apesar disso, sistemas operacionais e navegadores web podem confiar
em um conjunto de Autoridades Certificadoras distintas.
Sempre que houver mudanças na cadeia de certificação, previamente
à ativação/renovação de novos certificados digitais nos servidores do serviço de
registro online, os clientes serão comunicados por meio de mensageria no Office
Banking. Por essa razão, é importante que o cliente esteja cadastrado no Office
Banking, pois, além de acompanhar os movimentos de cobrança, poderá
acompanhar os comunicados referentes Cobrança Online via XML.
Caso o cliente precise instalar os certificados de Autoridade
Certificadora Raiz ou Intermediária em seu ambiente, poderá baixa-los no site
do banco (www.banrisul.com.br), em “Banrisul em um clique”, “Cobrança de
Títulos”, “Links Relacionados Ordenados”, “Certificado Banrisul Cobrança Online
– AC Raiz” e “Certificado Banrisul Cobrança Online – AC Intermediária”.
2.1.4.2. Certificado Cliente
Para que o Banrisul possa verificar e validar a autenticidade do

certificado do cliente é necessário que os servidores do serviço de registro online
tenham os certificados de Autoridade Certificadora Raiz ou Intermediária
instalados em seus repositórios de certificados confiáveis.
Por isso, sempre que houver mudanças referentes ao domínio, à cadeia
de certificação ou à data de validade de seu certificado, o cliente deverá contatar
a sua agência de relacionamento para atualização dos dados do certificado no
Sistema de Cobrança.
Caso o Banrisul não tenha os devidos certificados instalados em seus
servidores, haverá falha de comunicação entre as entidades.
Nestas situações, faz-se necessário o contato com o departamento de
suporte por meio da chave de correio eletrônico
[email protected] .
Atenção: O Banrisul não solicita o envio de chave privada. Este tipo

de arquivo é protegido por senha e geralmente possui a extensão .PFX ou .P12.
Apenas o proprietário do certificado deve ter posse desta chave. Caso haja
dúvidas de como enviar apenas o certificado digital (.CER ou .CRT), podem ser
utilizados os comandos citados no item 11.1 deste documento.
10
2.2. Habilitação cadastral
Para a utilização do serviço de Cobrança Online via XML (web service),
o cliente deverá se dirigir a sua agência de relacionamento para habilitar o uso
deste serviço.
Para esta habilitação, será necessário que o cliente tenha em mãos os

seguintes dados para o cadastro:
I. Domínio (URL) do site de onde serão feitas as chamadas ao serviço de

Cobrança Online via XML.
Caso o certificado utilizado seja de validação de domínio (site), o

domínio informado deve ser o mesmo do certificado, conforme mostrado abaixo
no campo “Emitido para”.
Exemplo de certificado emitido por uma AC Internacional para validação de domínio
11
II. CNPJ ou CPF do beneficiário.
Caso o certificado utilizado seja do tipo e-CNPJ ou e-CPF, o CNPJ/CPF

informado deve ser igual ao utilizado no certificado, assim como o
nome da empresa/nome do cliente, conforme mostrado abaixo no
campo “Emitido para”, após o nome da pessoa física ou jurídica.
Exemplo de certificados e-CNPJ e e-CPF emitidos por uma AC da ICP-Brasil
2.3. Homologação
Antes de iniciar uma chamada via XML, será necessário o cliente passar
por um processo de homologação.
Para acessar o ambiente de homologação utilize a seguinte url:
https://ww20.banrisul.com.br/boc/link/Bocswsxn_CobrancaOnlineWS.asmx
A partir de uma solicitação retornada com sucesso, é necessário

encaminhar cinco diferentes chamadas (XML de entrada e de saída, com o
retorno dos dados dos títulos, da linha digitável e do código de barras) para
verificação e validação das informações de registro, bem como os boletos de
12
teste, para homologação do leiaute junto ao departamento “Atendimento Teste
Cobrança”, através da chave de correio eletrônico
[email protected]. O leiaute do boleto deve seguir
o padrão Febraban, conforme especificações e modelos constantes no Anexo I
deste manual.
Se o beneficiário não desejar desenvolver o seu leiaute próprio do

boleto, poderá realizar uma chamada XML para geração de boleto PDF ou emitir
uma segunda via na página do Banco. Se optar pela emissão de boleto PDF
através de uma chamada XML, deverão ser observadas as orientações do
capítulo específico da emissão via XML. Destacamos que no processo de
homologação para a emissão de boleto via Web Service será retornando ao
cliente um boleto PDF genérico em caso de chamada com dados corretos, sem
consulta efetiva a base de títulos registrados. Este boleto genérico tem por
objetivo validar os dados de entrada da chamada e o conversor de PDF do cliente
beneficiário, devendo ser enviado para a chave
[email protected] para liberação do beneficiário em
produção.
Se optar pela emissão de segunda via pela página do Banco, não é

necessário realizar teste de arquivos e boletos, basta solicitar a url de produção
para o e-mail [email protected], informando que os
boletos serão gerados somente através de segundas vias. Instruções para
inclusão do link de segunda via no site da empresa, podem ser verificadas no
Anexo III deste manual.
É de responsabilidade do beneficiário o controle sobre os boletos

emitidos.
Para receber arquivos de retorno, o beneficiário deverá informar o

leiaute desejado (CNAB 240) no e-mail enviado para o endereço informado
anteriormente. Dúvidas relativas a este assunto deverão ser encaminhadas para
esta mesma chave.
2.4. Produção
Após cumpridos os requisitos anteriores, o beneficiário estará apto a
registrar os títulos, através da url de produção que será informada pelo
departamento “Atendimento Teste Cobrança”, após validação das chamadas e
boletos de teste.
Mesmo no ambiente de produção, é possível validar o registro de um

título informando ambiente de teste, conforme será descrito no próximo
capítulo.
13
3. Serviços
Os serviços da Cobrança Online serão acessados através de chamada

ao web service utilizando o protocolo de comunicação SOAP. A especificação
SOAP é escrita usando tags estilo documento XML que segue um conjunto de
regras mais rígido. Os nomes dos serviços disponíveis são:
 RegistrarTitulo
 AlterarTitulo
 BaixarTitulo
 ConsultarTitulo
 EmitirBoleto
Todos eles possuem o mesmo padrão de dados de entrada e de saída

do tipo XML. O parâmetro de entrada se chama xmlEntrada e a saída
xmlRetorno. Os dados do título deverão ser enviados dentro da tag <dados>,
que será detalhada em cada serviço, nos próximos itens.
Abaixo exemplo da especificação da chamada ao serviço para registrar

um título:
<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<RegistrarTitulo xmlns="Bergs.Boc.Bocswsxn">
<xmlEntrada>
<dados>
...
</dados>
</xmlEntrada>
</RegistrarTitulo>
</soap:Body>
</soap:Envelope>
Todas as tags e atributos devem ser minúsculos. O validador do XML

de entrada é case sensitive, ou seja, diferencia maiúsculas de minúsculas.
O formato Numérico (X,Y) significa que são X dígitos no total, sendo Y
casas decimais. Por exemplo: Numérico (5,2) significa que são 5 dígitos no total,
3 inteiros e 2 casas decimais.
Utilizar o ponto (.) para separar os dígitos inteiros dos decimais. Não
utilizar vírgula (,).
Evitar chamadas em lote em paralelo. Ou seja, realizar uma nova
14
requisição somente após o término da anterior. Também devem ser evitadas
chamadas em lote entre 23h e 6h, em razão de processamentos diários ocorridos
na madrugada.
As letras são sempre convertidas automaticamente para maiúsculo.

Não é permitido o uso de acentos e caracteres especiais, ou seja,
qualquer caractere diferente dos informados abaixo, apresentará erro. Os
caracteres aceitos são:
A-Z
a-z
0-9
!#$%'()*+,-./:;=?@[\]^_`{|}~
15
3.1. RegistrarTitulo
3.1.1. XML de entrada

O XML de entrada possui uma tag <dados> e dentro dela uma tag
<titulo> com as informações do título em forma de atributos (como
nosso_numero e data_vencimento) ou em forma de novas tags (como
<beneficiario> e <pagador>), seguindo a hierarquia definida abaixo:
<dados ... >

<titulo ... >
<beneficiario ... />
<pagador ... />
<instrucoes>
<juros ... />
<multa ... />
<desconto ... />
<abatimento ... />
<protesto ... />
<baixa ... />
</instrucoes>
<pag_parcial ... />
<mensagens>
<mensagem ... />
</mensagens>
<rateio ... >
<beneficiarios>
<beneficiario ... />
</beneficiarios>
</rateio>
</titulo>
</dados>
3.1.1.1. Tag <dados>

Dentro da tag <dados> deverá ser preenchido o atributo ambiente
indicando se o cliente deseja executar no ambiente de Produção ou de Testes.
No caso de enviar com ambiente = ‘T’, será executada apenas a validação do
XML, ou seja, o título não será registrado.
O cliente só poderá passar a enviar para ambiente de produção após a
devida contratação do serviço e homologação da documentação junto ao Banco,
conforme detalhado no capítulo 2 deste documento.
Atributo Formato Conteúdo Notas

ambiente Alfanumérico (1) P = Produção
T = Testes
16
3.1.1.2. Tag <titulo>
Tag única e obrigatória, com informações básicas do título nos
atributos. Segue campos na tabela abaixo:
nosso_numero Numérico (10) (Campo opcional) Número de identificação do 11
título no banco.
seu_numero Alfanumérico Identificador do título para o cliente. 21
(13)
data_vencimento Data Data de vencimento do título. 19
(AAAA-MM-DD)
valor_nominal Numérico Valor nominal do título com 2 casas decimais.
(15,2)
especie Numérico (2) 02 = Duplicata Mercantil
04 = Duplicata de Serviço
31 = Cartão de Crédito
32 = Boleto de Proposta
99 = Outros
data_emissao Data Data de Emissão do título. 23
(AAAA-MM-DD)
valor_iof Numérico (Campo opcional) Valor do IOF. 20
(15,2)
id_titulo_empresa Alfanumérico (Campo opcional) Identificação do título para a 22
(25) empresa beneficiária.
3.1.1.3. Tag <beneficiario>

Tag única e obrigatória, com informações do beneficiário nos atributos.
Segue campos na tabela abaixo:
codigo Numérico (13) Código completo do beneficiário. 1
3.1.1.4. Tag <pagador>

Tag única e obrigatória, com informações do pagador nos atributos.
tipo_pessoa Alfanumérico (1) F = Pessoa Física
J = Pessoa Jurídica
cpf_cnpj Numérico (11 ou 14) CPF = Pessoa Física
CNPJ = Pessoa Jurídica
nome Alfanumérico (40) Nome completo do pagador.
endereco Alfanumérico (35) Endereço do pagador.
cep Numérico (8) CEP do endereço do pagador.
17
cidade Alfanumérico (15) Cidade do endereço do pagador.
uf Alfanumérico (2) Estado do endereço do pagador.
aceite Alfanumérico (1) A = Sim
N = Não
3.1.1.5. Tag <instrucoes>

Tag única e obrigatória, com outras tags dentro dela: <juros>,
<multa>, <desconto>, <abatimento>, <protesto> e <baixa>.
A) Tag <juros>
Tag única e obrigatória, com informações dos juros nos atributos.
codigo Numérico (1) 1 = Valor por dia
2 = Taxa mensal
3 = Isento
data Data (Campo opcional) Data de início da cobrança de 2
(AAAA-MM-DD) juros.
valor Numérico (15,2) (Campo opcional) Valor a ser cobrado de juros. 3
taxa Numérico (5,2) (Campo opcional) Percentual sobre o valor do 4
título a ser cobrado de juros.
B) Tag <multa>
Tag única e opcional, com informações da multa nos atributos. Segue
campos na tabela abaixo:
codigo Numérico (1) 1 = Valor Fixo
2 = Percentual
data Data (Campo Opcional) Data de início da cobrança de 15
(AAAA-MM-DD) multa.
valor Numérico (15,2) (Campo opcional) Valor a ser cobrado de multa. 16
taxa Numérico (5,1) (Campo opcional) Percentual sobre o valor do 17
título a ser cobrado de multa.
C) Tag <desconto>
Tag única e opcional, com informações de desconto nos atributos.
18
codigo Numérico (1) 1 = Valor fixo até a data
2 = Percentual até a data
3 = Valor por antecipação dia corrido
5 = Percentual sobre o valor nominal dia corrido
data Data (Campo opcional) Data limite para conceder o 5
(AAAA-MM-DD) desconto.
valor Numérico (15,2) (Campo opcional) Valor de desconto a ser 6
concedido sobre o título.
taxa Numérico (5,2) (Campo opcional) Percentual de desconto a ser 7
D) Tag <abatimento>
Tag única e opcional, com informações de abatimento nos atributos.
valor Numérico (15,2) Valor do abatimento.
E) Tag <protesto>
Tag única e opcional, com informações de protesto nos atributos.
codigo Numérico (1) 1 = Protestar dias corridos
3 = Não protestar
prazo Numérico (2) (Campo opcional) Número de dias corridos após 8
a data de vencimento para inicialização do
processo de cobrança via protesto.
F) Tag <baixa>
Tag única e opcional, com informações da baixa nos atributos. Segue
codigo Numérico (1) 1 = Baixar / Devolver
prazo Numérico (2) Número de dias corridos após a data de
vencimento, que deverá ser baixado/devolvido
para o Beneficiário.
3.1.1.6. Tag <pag_parcial>

Tag única e obrigatória, com informações sobre pagamento parcial nos
atributos. Segue campos na tabela abaixo:
19
autoriza Numérico (1) 1 = Não autoriza pagamento parcial 14
2 = Autoriza pagamento parcial
codigo Numérico (1) 1 = Aceita qualquer valor
2 = Valor entre mínimo e máximo
3 = Não aceita valor divergente
quantidade Numérico (2) (Campo opcional) 13
Quantidade de pagamentos parciais possíveis.
tipo Numérico (1) (Campo opcional) 12
1 = Percentual
2 = Valor
valor_min Numérico (15,2) (Campo opcional) 9
Valor mínimo para pagamento parcial.
valor_max Numérico (15,2) (Campo opcional) 9
Valor máximo para pagamento parcial.
percentual_min Numérico (5,2) (Campo opcional) Percentual mínimo sobre o 10
valor do título para pagamento parcial.
percentual_max Numérico (5,2) (Campo opcional) Percentual máximo sobre o 10
3.1.1.7. Tag <mensagens>

Tag única e opcional, com uma lista de mensagens em novas tags
<mensagem>.
A) Tag <mensagem>
Tag múltipla (no máximo 9) e opcional, com informações de cada
mensagem nos atributos. Segue campos na tabela abaixo:
linha Numérico (2) Linha da mensagem. Valores entre 01 e 09. 18
texto Alfanumérico (75) Texto da mensagem.
3.1.1.8. Tag <rateio>

Tag única e opcional, com uma lista de beneficiários em novas tags
<beneficiario> dentro de outra tag <beneficiarios>, além de alguns
atributos obrigatórios.

codigo Numérico (1) 1 = Valor cobrado do pagador
2 = Valor registrado do título
20
tipo_valor Numérico (1) 1 = Percentual 24
2 = Valor
A) Tag <beneficiario>
Tag múltipla (no máximo 3) e opcional, com informações do
beneficiário secundário e valores de rateio nos atributos. Segue campos na
tabela abaixo:
codigo Numérico (13) Código completo do beneficiário secundário. 1
valor Numérico (15,2) (Campo opcional) Valor do rateio. 25
percentual Numérico (6,3) (Campo opcional) Percentual do rateio. 26
percela Numérico (4) (Campo opcional) Número da parcela do
rateio.
21
3.1.2. Exemplo de entrada

<soap:Body>
<xmlEntrada>
<dados ambiente="T">
<titulo nosso_numero="9999999999"
seu_numero="AAAAAAA999999"
data_vencimento="2016-12-31"
valor_nominal="9999999999999.99"
especie="02"
data_emissao="2016-12-31"
valor_iof="9999999999999.99"
id_titulo_empresa="999999"
>
<beneficiario codigo="9999999999999" />
<pagador tipo_pessoa="F"
cpf_cnpj="9999999999"
nome="AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
endereco="AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
cep="99999999"
cidade="AAAAAAAAAAAAAAA"
uf="AA"
aceite="A"
/>
<instrucoes>
<juros codigo="1" data="2016-12-31" valor="9999999999999.99" />
<multa codigo="2" data="2016-12-31" taxa="999.9" />
<desconto codigo="5" valor="999.99" />
<abatimento valor="9999999999999.99" />
<protesto codigo="1" prazo="5" />
<baixa codigo="1" prazo="30" />
</instrucoes>
<pag_parcial autoriza="2"
codigo="2"
tipo="2"
quantidade="99"
valor_min="9999999999999.99"
valor_max="9999999999999.99"
/>
<mensagens>
<mensagem linha="01" texto="AAAAAAAAAAAAAAAAAAAAAAAAAAA" />
</mensagens>
<rateio codigo="2" tipo_valor="2">
<beneficiarios>
<beneficiario codigo="9999999999999" valor="9999999999999.99" />
<beneficiario codigo="9999999999999" valor="9999999999999.99"
parcela="9999" />
</beneficiarios>
</rateio>
</titulo>
</dados>
</xmlEntrada>
</RegistrarTitulo>
</soap:Body>
</soap:Envelope>
22
3.1.3. XML de saída
O XML de saída poderá retornar de duas maneiras: uma em caso de
sucesso e outra em caso de falha. O atributo retorno dentro da tag <dados>
que exibirá esta informação para identificar o tipo de retorno da solicitação. São
4 diferentes tipos de retorno:
Código Descrição
01 Sucesso, boleto registrado Banrisul
02 Sucesso, boleto registrado Banrisul e centralizado
03 Falha
04 Homologado
O código de retorno ‘01’ significa que a comunicação com base a

centralizada de títulos para pagamento interbancário está lenta e sua inclusão
será realizada assim que a comunicação com o ambiente for restabelecida.
O código ‘04’ significa que os testes foram efetuados com sucesso. O
próximo passo é realizar os testes dos boletos, conforme item 2.3.
O retorno de sucesso será visto no próximo item e retorno de falha
está descrito no Capítulo 4, pois segue o mesmo padrão para todos os serviços.
3.1.4. Retorno de sucesso

O XML de saída em caso de sucesso retorna a mesma tag <dados>
de entrada, além de preencher alguns novos campos.
<xmlRetorno>
<dados ... >
<titulo ... />
</dados>
</xmlRetorno>
23
Tag única, com as mesmas informações de entrada além do novo
campo descrito na tabela abaixo:
retorno Numérico (2) Código de retorno para identificar o resultado do processo
do registro online:
01 = Sucesso, boleto registrado Banrisul
02 = Sucesso, boleto registrado Banrisul e centralizado
03 = Falha
04 = Homologado

Tag única, com as mesmas informações de entrada além do campo
nosso_numero (caso não tenha sido enviado na entrada) e de novos campos
descritos na tabela abaixo:
nosso_numero Numérico (10) Número de identificação do título no banco. 11
codigo_barras Numérico (44) Código de barras do título.
linha_digitavel Numérico (47) Linha digitável do título.

Tag única, com as informações do beneficiário preenchidas além do
campo codigo que foi enviado na entrada, segue abaixo os novos campos
descritos na tabela abaixo:
nome Alfanumérico (60) Nome/Razão Social do beneficiário.
nome_fantasia Alfanumérico (60) Nome Fantasia do beneficiário.
3.1.4.4. Tag <beneficiario> dentro da tag <rateio>

Tag múltipla, com as informações dos beneficiários secundários
preenchidas além dos campos que foram enviados na entrada, segue abaixo os
novos campos descritos na tabela abaixo:
24
As demais tags serão retornadas igual ao XML de entrada.
25
3.1.5. Exemplo de sucesso

<soap:Body>
<RegistrarTituloResponse xmlns="Bergs.Boc.Bocswsxn">
<RegistrarTituloResult>
<xmlRetorno>
<dados retorno="02">
seu_numero="AAAAAAA999999"
valor_nominal="9999999999999.99"
especie="02"
data_emissao="2016-12-31"
valor_iof="9999999999999.99"
id_titulo_empresa="9999999"
codigo_barras="..."
linha_digitavel="..." >
<beneficiario codigo="9999999999999"
tipo_pessoa="F"
cpf_cnpj="99999999999"
nome="AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
nome_fantasia="AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
/>
cpf_cnpj="9999999999"
cep="99999999"
uf="AA"
aceite="A"
/>
<instrucoes>
</instrucoes>
<pag_parcial autoriza="2" codigo="2" tipo="2" quantidade="99"
valor_min="9999999999999.99" valor_max="9999999999999.99" />
<mensagens>
<mensagem linha="01" texto="AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"/>
</mensagens>
<beneficiarios>
parcela="9999" />
</beneficiarios>
</rateio>
</titulo>
</dados>
</xmlRetorno>
</RegistrarTituloResult>
</RegistrarTituloResponse>
</soap:Body>
</soap:Envelope>
26
3.1.6. Arquivo XSD
O arquivo XSD (XML Schema Definition) serve para descrever o
formato que o arquivo XML (tanto de entrada, quanto de saída) deve seguir.
Nele são descritos todas as tags e atributos que podem conter, além
de informar se é obrigatório e qual o tipo de dado que deve ser atribuído, assim
como está detalhado nos itens 3.1.1 e 3.1.4.
Está disponível no endereço abaixo, o arquivo XSD para validação do
XML de entrada e saída para registrar um título.
https://ww20.banrisul.com.br/boc/data/Bocjwsen_RegistrarTitulo.xsd
27
3.2. AlterarTitulo
A Cobrança Online também permite através de chamadas XML a
alteração de vencimento de títulos que já estejam registrados. Abaixo são
detalhados os requisitos de chamada e os tipos de retorno para o serviço.

Assim como no serviço para registrar um título, o XML de entrada
possui uma tag <dados> e dentro dela uma tag <titulo> com as informações
do título necessárias para realizar uma alteração. Há 3 opções de entrada:
informando o Código do Beneficiário e Nosso Número; informando o Código de
Barras; ou informando a Linha Digitável.

Para realizar uma alteração no boleto deve ser informado o atributo
“ambiente”. No caso de enviar com ambiente = ‘T’, será executada apenas
a validação do XML, ou seja, o título não será alterado.
T = Testes
tipo_alteracao Numérico (2) 06 = Data de vencimento

Tag única e obrigatória, com informações para identificar um título,
além dos campos a serem alterados. Segue campos na tabela abaixo:
nosso_numero Numérico (10) (Campo opcional) Número de identificação do
título no banco.
data_vencimento Data Nova data de vencimento do título. 19
(AAAA-MM-DD)
codigo_barras Numérico (44) (Campo opcional) Código de barras do título.
linha_digitavel Numérico (47) (Campo opcional) Linha digitável do título.

Tag única e opcional, com informação do beneficiário no atributo.
Segue campo na tabela abaixo:
28
3.2.2. Exemplos de entrada
3.2.2.1. Beneficiário e Nosso Número

<soap:Body>
<AlterarTitulo xmlns="Bergs.Boc.Bocswsxn">
<xmlEntrada>
<dados ambiente="T" tipo_alteracao="06">
<titulo nosso_numero="9999999999" data_vencimento="2019-12-31" >
</titulo>
</dados>
</xmlEntrada>
</AlterarTitulo>
</soap:Body>
</soap:Envelope>
3.2.2.2. Código de Barras

<soap:Body>
<xmlEntrada>
<titulo data_vencimento="2019-12-31"
codigo_barras="99999999999999999999999999999999999999999999" />
</dados>
</xmlEntrada>
</AlterarTitulo>
</soap:Body>
</soap:Envelope>
29
3.2.2.3. Linha Digitável

<soap:Body>
<xmlEntrada>
<titulo data_vencimento="2019-12-31"
linha_digitavel="99999999999999999999999999999999999999999999999" />
</dados>
</xmlEntrada>
</AlterarTitulo>
</soap:Body>
</soap:Envelope>

O XML de saída também segue no mesmo padrão para os demais
serviços, ou seja, poderá retornar de duas maneiras: uma em caso de sucesso
e outra em caso de falha. O atributo retorno dentro da tag <dados> que
exibirá esta informação para identificar o tipo de retorno da solicitação:
Código Descrição
01 Sucesso, alteração solicitada
02 Sucesso, alteração efetivada
03 Falha
04 Homologado
 O código de retorno ‘01’ significa que a comunicação com a Base

Centralizada de Pagamentos – CIP está lenta e sua alteração será realizada
assim que a comunicação com o ambiente for restabelecida.
 O código ‘02’ indica que a alteração no título foi registrada e
centralizado na Base Centralizada de Pagamentos – CIP corretamente.
 O código ‘03’ refere-se a falha ou erro na chamada XML.
 O código ‘04’ significa que os testes foram efetuados com sucesso.
30
O XML de saída em caso de sucesso retorna a tag <dados> com a tag
<titulo>.

Tag única, com um único campo descrito na tabela abaixo:
retorno Numérico (2) Código de retorno para identificar o resultado do
processo da alteração do boleto:
01 = Sucesso, alteração solicitada
02 = Sucesso, alteração efetivada
03 = Falha
04 = Homologado

Tag única, com as informações de identificação do título e com a data
de vencimento alterada:

nosso_numero Numérico (10) Número de identificação do título no banco.
data_vencimento Data Nova data de vencimento do título.
(AAAA-MM-DD)

Tag única, com informações do beneficiário nos atributos. Segue
codigo Numérico (13) Código completo do beneficiário.
31

<soap:Body>
<AlterarTituloResponse xmlns="Bergs.Boc.Bocswsxn">
<AlterarTituloResult>
<xmlRetorno>
codigo_barras="99999999999999999999999999999999999999999999"
linha_digitavel="99999999999999999999999999999999999999999999999" >
</titulo>
</dados>
</xmlRetorno>
</AlterarTituloResult>
</AlterarTituloResponse>
</soap:Body>
</soap:Envelope>
3.2.6. Arquivo XSD

XML de entrada e saída para alterar um título.
https://ww20.banrisul.com.br/boc/data/Bocjwsen_AlterarTitulo.xsd
32
3.3. BaixarTitulo
A Cobrança Online também oferece a baixa de títulos que já estejam
registrados. Esta baixa será um pedido de devolução do título por instrução do
beneficiário, sendo efetivada na madrugada, contudo, com bloqueio imediato do
título para pagamento na CIP a partir da solicitação. Em seguida são detalhados
os requisitos de chamada e os tipos de retorno para o serviço.

Assim como no serviço para alterar um título, o XML de entrada possui
uma tag <dados> e dentro dela uma tag <titulo> com as informações do título
necessárias para realizar uma baixa. Há 3 opções de entrada: informando o
Código do Beneficiário e Nosso Número; informando o Código de Barras; ou
informando a Linha Digitável.

Para realizar uma baixa no boleto deve ser informado o atributo
a validação do XML, ou seja, o título não será baixado.
T = Testes

Tag única e obrigatória, com informações para identificar um título.
título no banco.

33

<soap:Body>
<BaixarTitulo xmlns="Bergs.Boc.Bocswsxn">
<xmlEntrada>
<titulo nosso_numero="9999999999">
</titulo>
</dados>
</xmlEntrada>
</BaixarTitulo>
</soap:Body>
</soap:Envelope>

<soap:Body>
<xmlEntrada>
<titulo codigo_barras="99999999999999999999999999999999999999999999" />
</dados>
</xmlEntrada>
</BaixarTitulo>
</soap:Body>
</soap:Envelope>
34

<soap:Body>
<xmlEntrada>
<titulo linha_digitavel="99999999999999999999999999999999999999999999999" />
</dados>
</xmlEntrada>
</BaixarTitulo>
</soap:Body>
</soap:Envelope>

Código Descrição
02 Sucesso
03 Falha
04 Homologado
 O código de retorno ‘02’ indica que a solicitação de baixa para o

título foi executada corretamente, e será efetivada na madrugada.
 O código ‘04’ significa que os testes foram efetuados com sucesso.
35
<titulo>.

processo de baixa do boleto:
02 = Sucesso
03 = Falha
04 = Homologado

Tag única, com as informações de identificação do título:

Tag única, com informação do beneficiário no atributo. Segue campo
na tabela abaixo:
36

<soap:Body>
<BaixarTituloResponse xmlns="Bergs.Boc.Bocswsxn">
<BaixarTituloResult>
<xmlRetorno>
codigo_barras="99999999999999999999999999999999999999999999"
linha_digitavel="99999999999999999999999999999999999999999999999" >
</titulo>
</dados>
</xmlRetorno>
</BaixarTituloResult>
</BaixarTituloResponse>
</soap:Body>
</soap:Envelope>
3.3.6. Arquivo XSD

XML de entrada e saída para baixar um título.
https://ww20.banrisul.com.br/boc/data/Bocjwsen_BaixarTitulo.xsd
37
3.4. ConsultarTitulo
Outro serviço disponível pela Cobrança Online é a consulta de títulos
registrados que ainda estão ativos ou de títulos já baixados. A seguir são
detalhados os requisitos de chamada e os tipos de retorno para o serviço.

Assim como nos demais serviços, para consultar as informações de um
título, o XML de entrada possui uma tag <dados> e dentro dela uma tag
<titulo> com os identificadores do título. Há 3 opções de entrada: informando
o Código do Beneficiário e Nosso Número; informando o Código de Barras; ou
informando a Linha Digitável.

Tag única, obrigatória e sem nenhum atributo.

título no banco.

38

<soap:Body>
<ConsultarTitulo xmlns="Bergs.Boc.Bocswsxn">
<xmlEntrada>
</titulo>
</dados>
</xmlEntrada>
</ConsultarTitulo>
</soap:Body>
</soap:Envelope>

<soap:Body>
<xmlEntrada>
</dados>
</xmlEntrada>
</ConsultarTitulo>
</soap:Body>
</soap:Envelope>
39

<soap:Body>
<xmlEntrada>
</dados>
</xmlEntrada>
</ConsultarTitulo>
</soap:Body>
</soap:Envelope>

Código Descrição
01 Sucesso, título não centralizado
02 Sucesso, título centralizado
03 Falha
 O código de retorno ‘01’ indica que a consulta do título retornou com

sucesso, mas ele não está disponível na base centralizada de títulos para
pagamento interbancário, portanto o seu pagamento só poderá ser realizado no
Banrisul caso ainda esteja com a situação ativa.
 O código ‘02’ significa que a consulta do título retornou com sucesso
e poderá ser pago em qualquer rede bancária caso ainda esteja com a situação
ativa.
40
<titulo>.

processo de consulta do boleto:
01 = Sucesso, título não centralizado
02 = Sucesso, título centralizado
03 = Falha

Tag única, com as principais informações do título:
seu_numero Alfanumérico Identificador do título para o cliente.
(13)
data_vencimento Data Data de vencimento do título.
(AAAA-MM-DD)
valor_nominal Numérico Valor nominal do título com 2 casas decimais.
(15,2)
especie Numérico (2) 02 = Duplicata Mercantil
04 = Duplicata de Serviço
31 = Cartão de Crédito
32 = Boleto de Proposta
99 = Outros
data_emissao Data Data de Emissão do título.
(AAAA-MM-DD)
valor_iof Numérico (Campo opcional) Valor do IOF.
(15,2)
id_titulo_empresa Alfanumérico (Campo opcional) Identificação do título para a
(25) empresa beneficiária.
situacao_banrisul Alfanumérico A = Ativo
(1) B = Baixado por pagamento
D = Baixado por devolução
L = Liquidado
R = Reembolsado
T = Transferido para CL
P = Protestado
41
situacao_cip Alfanumérico A = Aprovado
(1) R = Rejeitado
P = Pendente
E = Enviado
N = Não centralizado
situacao_pagamento Numérico (1) 1 = Apto para pagamento 27
2 = Pagamento em processamento
3 = Crédito retido
4 = Baixado no dia
5 = Em processo de devolução automática
6 = Em cartório
7 = Pagamento indisponível, entre em contato
com sua agência
carteira Numérico (1) 1 = Cobrança Simples
2 = Cobrança Vinculada
3 = Cobrança Caucionada
4 = Desconto
5 = Vendor

Tag única, com informações do beneficiário nos atributos. Segue
3.4.4.1. Tag <pagador>

Tag única, com informações do pagador nos atributos. Segue campos
na tabela abaixo:
nome Alfanumérico (40) Nome completo do pagador.
endereco Alfanumérico (35) Endereço do pagador.
cep Numérico (8) CEP do endereço do pagador.
42
cidade Alfanumérico (15) Cidade do endereço do pagador.
uf Alfanumérico (2) Estado do endereço do pagador.
aceite Alfanumérico (1) A = Sim
N = Não
3.4.4.2. Tag <instrucoes>

Tag única, com outras tags dentro dela: <juros>, <multa>,
<desconto>, <abatimento>, <protesto> e <baixa>.
A) Tag <juros>
Tag única, com informações dos juros nos atributos. Segue campos na
tabela abaixo:
codigo Numérico (1) 1 = Valor por dia
2 = Taxa mensal
3 = Isento
data Data (Campo opcional) Data de início da cobrança de
(AAAA-MM-DD) juros.
valor Numérico (15,2) (Campo opcional) Valor a ser cobrado de juros.
taxa Numérico (5,2) (Campo opcional) Percentual sobre o valor do
título a ser cobrado de juros.
B) Tag <multa>
Tag única e opcional, com informações da multa nos atributos. Segue
codigo Numérico (1) 1 = Valor Fixo
2 = Percentual
data Data (Campo Opcional) Data de início da cobrança de
(AAAA-MM-DD) multa.
valor Numérico (15,2) (Campo opcional) Valor a ser cobrado de multa.
taxa Numérico (5,1) (Campo opcional) Percentual sobre o valor do
título a ser cobrado de multa.
C) Tag <desconto>
Tag única e opcional, com informações de desconto nos atributos.
43
codigo Numérico (1) 1 = Valor fixo até a data
2 = Percentual até a data
3 = Valor por antecipação dia corrido
5 = Percentual sobre o valor nominal dia corrido
data Data (Campo opcional) Data limite para conceder o
(AAAA-MM-DD) desconto.
valor Numérico (15,2) (Campo opcional) Valor de desconto a ser
taxa Numérico (5,2) (Campo opcional) Percentual de desconto a ser
D) Tag <abatimento>
Tag única e opcional, com informações de abatimento nos atributos.
valor Numérico (15,2) Valor do abatimento.
E) Tag <protesto>
Tag única e opcional, com informações de protesto nos atributos.
codigo Numérico (1) 1 = Protestar dias corridos
3 = Não protestar
prazo Numérico (2) (Campo opcional) Número de dias corridos após
a data de vencimento para inicialização do
processo de cobrança via protesto.
F) Tag <baixa>
Tag única e opcional, com informações da baixa nos atributos. Segue
codigo Numérico (1) 1 = Baixar / Devolver
prazo Numérico (2) Número de dias corridos após a data de
vencimento, que deverá ser baixado/devolvido
para o Beneficiário.
44
3.4.4.3. Tag <pag_parcial>
Tag única, com informações sobre pagamento parcial nos atributos.
autoriza Numérico (1) 1 = Não autoriza pagamento parcial
2 = Autoriza pagamento parcial
codigo Numérico (1) 1 = Aceita qualquer valor
2 = Valor entre mínimo e máximo
3 = Não aceita valor divergente
quantidade Numérico (2) (Campo opcional)
Quantidade de pagamentos parciais possíveis.
tipo Numérico (1) (Campo opcional)
1 = Percentual
2 = Valor
valor_min Numérico (15,2) (Campo opcional)
Valor mínimo para pagamento parcial.
valor_max Numérico (15,2) (Campo opcional)
Valor máximo para pagamento parcial.
percentual_min Numérico (5,2) (Campo opcional) Percentual mínimo sobre o
percentual_max Numérico (5,2) (Campo opcional) Percentual máximo sobre o
3.4.4.4. Tag <mensagens>

Tag única e opcional, com uma lista de mensagens em novas tags
<mensagem>.
A) Tag <mensagem>
Tag múltipla (no máximo 9) e opcional, com informações de cada
mensagem nos atributos. Segue campos na tabela abaixo:
linha Numérico (2) Linha da mensagem. Valores entre 01 e 09.
texto Alfanumérico (75) Texto da mensagem.
3.4.4.5. Tag <rateio>

Tag única e opcional, com uma lista de beneficiários em novas tags
<beneficiario> dentro de outra tag <beneficiarios>, além de alguns
atributos obrigatórios.
45
codigo Numérico (1) 1 = Valor cobrado do pagador
2 = Valor registrado do título
tipo_valor Numérico (1) 1 = Percentual
2 = Valor
A) Tag <beneficiario>
Tag múltipla (no máximo 3) e opcional, com informações do
beneficiário secundário e valores de rateio nos atributos. Segue campos na
tabela abaixo:
codigo Numérico (13) Código completo do beneficiário secundário.
valor Numérico (15,2) (Campo opcional) Valor do rateio.
percentual Numérico (6,3) (Campo opcional) Percentual do rateio.
percela Numérico (4) (Campo opcional) Número da parcela do
rateio.
3.4.4.6. Tag <operacoes>

Tag única e opcional, com informações sobre operações realizadas
sobre o título. Serão retornadas informações sobre a última data (mais recente)
com ocorrência.

data_baixa Data (Campo opcional) Data de baixa do
(AAAA-MM-DD) título.
data_pagamento Data (Campo opcional) Data de
(AAAA-MM-DD) pagamento do título.
data_credito Data (Campo opcional) Data de crédito na
(AAAA-MM-DD) conta do beneficiário.
data_reembolso Data (Campo opcional) Data de reembolso
(AAAA-MM-DD) na conta do beneficiário.
valor_juros_recebido Numérico (Campo opcional) Valor de juros
(15,2) acrescido do pagador e recebido pelo
beneficiário.
valor_juros_pago Numérico (Campo opcional) Valor de juros
46
(15,2) pago pelo beneficiário.
valor_multa_recebido Numérico (Campo opcional) Valor de multa
(15,2) acrescido do pagador e recebido pelo
beneficiário.
valor_desconto_utilizado Numérico (Campo opcional) Valor de desconto
(15,2) utilizado pelo pagador.
valor_abatimento_utilizado Numérico (Campo opcional) Valor de
(15,2) abatimento utilizado pelo pagador.
valor_iof Numérico (Campo opcional) Valor de IOF.
(15,2)
custas_cartorio Numérico (Campo opcional) Custas de cartório
(15,2) cobradas do beneficiário.
ressarcimento_cartorio Numérico (Campo opcional) Ressarcimento de
(15,2) cartório ao beneficiário.
tarifa_registro Numérico (Campo opcional) Tarifa de registro
(15,2) do título.
tarifa_baixa_liquidacao Numérico (Campo opcional) Tarifa de
(15,2) baixa/liquidação do título.
tarifa_aponte_cartorio Numérico (Campo opcional) Tarifa de aponte
(15,2) ao cartório do título.
tarifa_interbancaria Numérico (Campo opcional) Tarifa
(15,2) interbancária (título pago via
compensação).
tarifa_manutencao_mensal Numérico (Campo opcional) Tarifa de
(15,2) manutenção mensal do título.
tarifa_sustacao Numérico (Campo opcional) Tarifa de sustação
(15,2) de título.
tarifas_diversas Numérico (Campo opcional) Tarifas de cartório,
(15,2) baixa/liquidação ou interbancária do
título agrupadas.
valor_pagamento Numérico (Campo opcional) Valor de
(15,2) pagamento do título, referente ao
valor nominal.
valor_reembolso Numérico (Campo opcional) Valor de
(15,2) reembolso do título.
valor_cobrado Numérico (Campo opcional) Valor cobrado do
(15,2) pagador.
valor_creditado_debitado Numérico (Campo opcional) Valor
(15,2) creditado/debitado do beneficiário.
47
<soap:Body>
<ConsultarTituloResult>
<xmlRetorno>
<titulo nosso_numero="9999999999" seu_numero="AAAAAAA999999"
data_vencimento="2016-12-31" data_emissao="2016-12-31"
valor_nominal="9999999999999.99" especie="02"
valor_iof="9999999999999.99" id_titulo_empresa="9999999"
codigo_barras="..." linha_digitavel="..."
situacao_banrisul="A" situacao_cip="A"
situacao_pagamento="1" carteira="1" >
<beneficiario codigo="9999999999999"
tipo_pessoa="F"
cpf_cnpj="99999999999"
nome="AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
nome_fantasia="AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
/>
cpf_cnpj="9999999999"
cep="99999999"
uf="AA"
aceite="A"
/>
<instrucoes>
</instrucoes>
<pag_parcial autoriza="2" codigo="2" tipo="2" quantidade="99"
valor_min="9999999999999.99" valor_max="9999999999999.99" />
<mensagens>
</mensagens>
<beneficiarios>
parcela="9999" />
</beneficiarios>
</rateio>
<operacoes data_pagamento="2016-12-31" data_credito="2016-12-31"
valor_cobrado="9999999999999.99" />
</titulo>
</dados>
</xmlRetorno>
</ConsultarTituloResult>
</soap:Body>
</soap:Envelope>
48
3.4.6. Arquivo XSD
XML de entrada e saída para consultar um título.
https://ww20.banrisul.com.br/boc/data/Bocjwsen_ConsultarTitulo.xsd
49
3.5. EmitirBoleto
A Cobrança Online também permite a emissão do boleto através de
chamadas XML. Para tanto, deve-se realizar uma chamada após o registro do
título, utilizando o Código de Beneficiário e Nosso Número; ou Código de Barras
ou a Linha Digitável do título. A partir desta chamada será retornado o boleto
em formato PDF codificado (alfanumérico de Base64), que deverá ser convertido
pelo beneficiário para geração ao pagador. A seguir são detalhadas as
especificidades dos dados da chamada de emissão.

Assim como nos demais serviços, o XML de entrada possui uma tag
<dados> e dentro dela uma tag <titulo> com as informações do título
necessárias para emitir um boleto. Há 3 opções de entrada: informando o Código
do Beneficiário e Nosso Número; informando o Código de Barras; ou informando
a Linha Digitável.

Para realizar uma emissão de boleto deve ser informado o atributo
a validação do XML de entrada e será retornado um boleto genérico. Caso seja
enviado ambiente = ‘P’, o boleto será impresso normalmente.
T = Testes

título no banco.
50

51

<soap:Body>
<EmitirBoleto xmlns="Bergs.Boc.Bocswsxn">
<xmlEntrada>
<dados>
</titulo>
</dados>
</xmlEntrada>
</EmitirBoleto>
</soap:Body>
</soap:Envelope>

<soap:Body>
<xmlEntrada>
<dados>
</dados>
</xmlEntrada>
</EmitirBoleto>
</soap:Body>
</soap:Envelope>

<soap:Body>
<xmlEntrada>
<dados>
</dados>
</xmlEntrada>
</EmitirBoleto>
</soap:Body>
</soap:Envelope>
52
Código Descrição
02 Sucesso
03 Falha

<titulo>.

processo da emissão do boleto:
02 = Sucesso
03 = Falha

boleto Alfanumérico (*) Boleto PDF codificado em Base64.
É nesse campo boleto que se encontra o boleto em formato PDF

codificado em Base64 (https://pt.wikipedia.org/wiki/Base64) que deverá ser
decodificado pelo beneficiário para exibir ao pagador. Exemplos de código fonte
nas principais linguagens de programação para decodificar texto em Base64
estão no Capítulo 7 (Detalhamento Técnico).
A quantidade de caracteres que irá retornar no campo boleto é de
tamanho variável, pois depende das informações impressas no arquivo. Poderá
ter entre 40 mil e 60 mil caracteres.
53

<soap:Body>
<EmitirBoletoResponse xmlns="Bergs.Boc.Bocswsxn">
<EmitirBoletoResult>
<xmlRetorno>
<titulo boleto="JVBERi0xLj+QKJeLjz9MKMSAwIG9iag8PC/9UeXlL1BhZ2Vz ... " />
</dados>
</xmlRetorno>
</EmitirBoletoResult>
</EmitirBoletoResponse>
</soap:Body>
</soap:Envelope>
3.5.6. Arquivo XSD

XML de entrada e saída para emissão do boleto.
https://ww20.banrisul.com.br/boc/data/Bocjwsen_EmitirBoleto.xsd
54
3.5.7. Boleto de Teste
Ao enviar uma emissão de boleto com o parâmetro ambiente = ‘T’, será
gerado um boleto de teste ao invés de um boleto com os dados enviados. O
boleto de teste serve para novos clientes que ainda não possuem nenhum título
registrado em produção e queiram testar o serviço para Emissão de Boletos.
Este boleto deverá ser enviado para a chave
[email protected] para liberação do cliente em
produção. Segue abaixo o modelo do boleto que será retornado para esses
casos:
55
4. Retorno de falha
O XML de saída em caso de falha segue o mesmo padrão para todos
os serviços. Retorna a tag <dados> com o atributo retorno indicando “03”
(falha), além da tag <ocorrências> que podem haver outras novas tags
<ocorrência> dentro dela (no máximo 5), seguindo a hierarquia definida
abaixo:
<xmlRetorno>
<dados retorno="03" >
<ocorrencias>
<ocorrencia ... />
<ocorrencia ... />
<ocorrencia ... />
<ocorrencia ... />
<ocorrencia ... />
</ocorrencias>
</dados>
</xmlRetorno>
4.1. Exemplos de falha
RegistrarTitulo

<soap:Body>
<RegistrarTituloResponse xmlns="Bergs.Boc.Bocswsxn">
<RegistrarTituloResult>
<xmlRetorno>
<ocorrencias>
<ocorrencia codigo="16" mensagem="..." />
</ocorrencias>
</dados>
</xmlRetorno>
</RegistrarTituloResult>
</RegistrarTituloResponse>
</soap:Body>
</soap:Envelope>
56
AlterarTitulo

<soap:Body>
<AlterarTituloResponse xmlns="Bergs.Boc.Bocswsxn">
<AlterarTituloResult>
<xmlRetorno>
<ocorrencias>
</ocorrencias>
</dados>
</xmlRetorno>
</AlterarTituloResult>
</AlterarTituloResponse>
</soap:Body>
</soap:Envelope>
BaixarTitulo

<soap:Body>
<BaixarTituloResult>
<xmlRetorno>
<ocorrencias>
</ocorrencias>
</dados>
</xmlRetorno>
</BaixarTituloResult>
</soap:Body>
</soap:Envelope>
57
ConsultarTitulo

<soap:Body>
<ConsultarTituloResponse xmlns="Bergs.Boc.Bocswsxn">
<ConsultarTituloResult>
<xmlRetorno>
<ocorrencias>
</ocorrencias>
</dados>
</xmlRetorno>
</ConsultarTituloResult>
</ConsultarTituloResponse>
</soap:Body>
</soap:Envelope>
EmitirBoleto

<soap:Body>
<EmitirBoletoResponse xmlns="Bergs.Boc.Bocswsxn">
<EmitirBoletoResult>
<xmlRetorno>
<ocorrencias>
</ocorrencias>
</dados>
</xmlRetorno>
</EmitirBoletoResult>
</EmitirBoletoResponse>
</soap:Body>
</soap:Envelope>
58
4.2. Código de ocorrência
Código adotado pela FEBRABAN para identificar as ocorrências em
registro detalhe de títulos de cobrança. Poderão ser informados até cinco
ocorrências distintas, incidente sobre o título.
Código Descrição
00 Mensagem de erro específica. *
01 Código do banco inválido.
02 Código do registro detalhe inválido.
03 Código do segmento inválido.
06 Tipo/Número de inscrição do beneficiário inválidos.
07 Agência/Conta/DV inválido.
08 Nosso número inválido.
09 Nosso número duplicado.
12 Tipo de documento inválido.
13 Identificação da emissão do boleto de pagamento inválida.
16 Data de vencimento inválida.
17 Data de vencimento anterior à data de emissão.
18 Vencimento fora do prazo de operação.
19 Título a cargo de bancos correspondentes com vencimento inferior
a XX dias.
20 Valor do título inválido.
21 Espécie do título inválida.
22 Espécie do título não permitida para a carteira.
23 Aceite inválido.
24 Data da emissão inválida.
25 Data da emissão posterior a data de entrada.
26 Código de juros de mora inválido.
27 Valor/Taxa de juros de mora inválido.
28 Código do desconto inválido.
29 Valor do desconto maior ou igual ao valor do título.
30 Desconto a conceder não confere.
32 Valor do IOF inválido.
33 Valor do abatimento inválido.
59
34 Valor do abatimento maior ou igual ao valor do título.
35 Valor a conceder não confere.
37 Código para protesto inválido.
38 Prazo para protesto inválido.
39 Pedido de protesto não permitido para o título.
42 Código para baixa/devolução inválido.
43 Prazo para baixa/devolução inválido.
44 Código da moeda inválido.
45 Nome do pagador não informado.
46 Tipo/Número de inscrição do pagador inválidos.
47 Endereço do pagador não informado.
48 CEP inválido.
49 CEP sem praça de cobrança (não localizado).
50 CEP referente a um banco correspondente.
51 CEP incompatível com a Unidade da Federação.
52 Unidade da Federação inválida.
53 Tipo/Número de inscrição do sacador/avalista inválidos.
54 Sacador/Avalista não informado.
57 Código da multa inválido.
58 Data da multa inválida.
59 Valor/Percentual da multa inválido.
61 Alteração da agência cobradora/DV inválida.
63 Entrada para título já cadastrado.
64 Número da linha inválido.
86 Seu número inválido.
A4 Pagador DDA.
A5 Registro rejeitado – título já liquidado.
A6 Código do convenente inválido ou encerrado.
A8 Valor do abatimento inválido para cancelamento.
A9 Não autoriza pagamento parcial.
B1 Autoriza pagamento parcial.
B2 Valor nominal do título conflitante.
B3 Tipo de pagamento inválido.
60
B4 Valor máximo/percentual inválido.
B5 Valor mínimo/percentual inválido.
* Descrição do código ‘00’ conterá o motivo do erro específico.
4.3. Possíveis erros e soluções
a. Erro “(500) Erro Interno do Servidor.”:

- Utilizar protocolo SOAP de comunicação;
- Utilizar nome correto do Web Method “RegistrarTitulo” ou “EmitirBoleto”;
b. Erro “(404) Não Localizado.”:

- Utilizar URL correta;
c. Erro “(403) Proibido.”:

- Utilizar HTTPS na URL;
- Utilizar um certificado válido;
- Verificar se o Emissor do Certificado está cadastrado no servidor do banco.
Enviar o certificado (arquivo .cer) para verificação da área de suporte;
- Verificar se o certificado atualizado do banco está instalado no servidor do
cliente;
- Utilizar ContentType = “text/xml”;
d. Erro “(400) Solicitação Incorreta.”:

- Não utilizar o caractere ‘&’;
- Corrigir o XML de entrada, as tags devem estar fechando corretamente;
e. Erro “Server Error in ‘/BOC’ Application.”:

- Utilizar URL correta;
f. Erro “A conexão subjacente estava fechada: Erro inesperado em um envio.”:

- Utilizar protocolo criptográfico TLS;
g. Erro “Certificado inexistente.”:

- Adicionar um certificado válido na chamada do serviço;
- Solicitar a instalação da cadeia de certificados no servidor do banco;
- Verificar se o certificado atualizado do banco está instalado no servidor do
cliente;
h. Erro “Certificado sem permissão.”:

- Realizar o cadastro do certificado junto ao Banco;
i. Erro “Formato do XML inválido.”:
61
- Corrigir os dados do XML de entrada;
- Verificar namespace do XML de entrada “Bergs.Boc.Bocswsxn”;
j. Erro “Certificado não cadastrado; vencido; ou não liberado para produção.”:

- Certificado não está cadastrado para o Beneficiário;
- Certificado cadastrado para o Beneficiário já está vencido;
- Certificado cadastrado para o Beneficiário não está liberado para utilizar
em produção;
62
5. Tabela comparativa
Segue abaixo tabela comparativa das tags e atributos que podem estar presentes no XML de entrada, no
XML de saída com retorno de sucesso e no XML de saída com retorno de falha.
RegistrarTitulo AlterarTitulo BaixarTitulo ConsultarTitulo EmitirBoleto

Retorno
Tag Atributo Entrada Retorno Entrada Retorno Entrada Retorno Entrada Retorno Entrada Retorno
Falha
Sucesso Sucesso Sucesso Sucesso Sucesso
dados - Sim Sim Sim Sim Sim Sim Sim Sim Sim Sim Sim
- ambiente Sim Não Sim Não Sim Não Não Não Sim Não Não
- tipo_alteracao Não Não Sim Não Não Não Não Não Não Não Não
- retorno Não Sim Não Sim Não Sim Não Sim Não Sim Sim
titulo - Sim Sim Sim Sim Sim Sim Sim Sim Sim Sim Não
- nosso_numero Sim Sim Sim Sim Sim Sim Sim Sim Sim Não Não
- seu_numero Sim Sim Não Não Não Não Não Sim Não Não Não
- data_vencimento Sim Sim Sim Sim Não Não Não Sim Não Não Não
- valor_nominal Sim Sim Não Não Não Não Não Sim Não Não Não
- especie Sim Sim Não Não Não Não Não Sim Não Não Não
- data_emissao Sim Sim Não Não Não Não Não Sim Não Não Não
- valor_iof Sim Sim Não Não Não Não Não Sim Não Não Não
- id_titulo_empresa Sim Sim Não Não Não Não Não Sim Não Não Não
- codigo_barras Não Sim Sim Sim Sim Sim Sim Sim Sim Não Não
- linha_digitavel Não Sim Sim Sim Sim Sim Sim Sim Sim Não Não
- situacao_banrisul Não Não Não Não Não Não Não Sim Não Não Não
- situacao_cip Não Não Não Não Não Não Não Sim Não Não Não
- situacao_ Não Não Não Não Não Não Não Sim Não Não Não
pagamento
- carteira Não Não Não Não Não Não Não Sim Não Não Não
- boleto Não Não Não Não Não Não Não Não Não Sim Não
beneficiario - Sim Sim Sim Sim Sim Sim Sim Sim Sim Não Não
- codigo Sim Sim Sim Sim Sim Sim Sim Sim Sim Não Não
- tipo_pessoa Não Sim Não Não Não Não Não Sim Não Não Não
- cpf_cnpj Não Sim Não Não Não Não Não Sim Não Não Não
- nome Não Sim Não Não Não Não Não Sim Não Não Não
- nome_fantasia Não Sim Não Não Não Não Não Sim Não Não Não
pagador - Sim Sim Não Não Não Não Não Sim Não Não Não
instrucoes - Sim Sim Não Não Não Não Não Sim Não Não Não
juros - Sim Sim Não Não Não Não Não Sim Não Não Não
63
RegistrarTitulo AlterarTitulo BaixarTitulo ConsultarTitulo EmitirBoleto Retorno
Falha
multa - Sim Sim Não Não Não Não Não Sim Não Não Não
desconto - Sim Sim Não Não Não Não Não Sim Não Não Não
abatimento - Sim Sim Não Não Não Não Não Sim Não Não Não
protesto - Sim Sim Não Não Não Não Não Sim Não Não Não
baixa - Sim Sim Não Não Não Não Não Sim Não Não Não
pag_parcial - Sim Sim Não Não Não Não Não Sim Não Não Não
mensagens - Sim Sim Não Não Não Não Não Sim Não Não Não
mensagem - Sim Sim Não Não Não Não Não Sim Não Não Não
rateio - Sim Sim Não Não Não Não Não Sim Não Não Não
beneficiarios - Sim Sim Não Não Não Não Não Sim Não Não Não
beneficiario - Sim Sim Não Não Não Não Não Sim Não Não Não
- codigo Sim Sim Não Não Não Não Não Sim Não Não Não
- valor Sim Sim Não Não Não Não Não Sim Não Não Não
- percentual Sim Sim Não Não Não Não Não Sim Não Não Não
- parcela Sim Sim Não Não Não Não Não Sim Não Não Não
- tipo_pessoa Não Sim Não Não Não Não Não Sim Não Não Não
- cpf_cnpj Não Sim Não Não Não Não Não Sim Não Não Não
- nome Não Sim Não Não Não Não Não Sim Não Não Não
- nome_fantasia Não Sim Não Não Não Não Não Sim Não Não Não
operacoes - Não Não Não Não Não Não Não Sim Não Não Não
- data_baixa Não Não Não Não Não Não Não Sim Não Não Não
- data_pagamento Não Não Não Não Não Não Não Sim Não Não Não
- data_credito Não Não Não Não Não Não Não Sim Não Não Não
- data_reembolso Não Não Não Não Não Não Não Sim Não Não Não
- valor_juros_ Não Não Não Não Não Não Não Sim Não Não Não
recebido
- valor_juros_ Não Não Não Não Não Não Não Sim Não Não Não
pago
- valor_multa_ Não Não Não Não Não Não Não Sim Não Não Não
recebido
- valor_desconto_ Não Não Não Não Não Não Não Sim Não Não Não
utilizado
- valor_abatimento_ Não Não Não Não Não Não Não Sim Não Não Não
utilizado
- valor_iof Não Não Não Não Não Não Não Sim Não Não Não
- custas_cartorio Não Não Não Não Não Não Não Sim Não Não Não
- ressarcimento_ Não Não Não Não Não Não Não Sim Não Não Não
cartorio
64
RegistrarTitulo AlterarTitulo BaixarTitulo ConsultarTitulo EmitirBoleto Retorno
Falha
- tarifa_registro Não Não Não Não Não Não Não Sim Não Não Não
- tarifa_baixa_ Não Não Não Não Não Não Não Sim Não Não Não
liquidacao
- tarifa_aponte_ Não Não Não Não Não Não Não Sim Não Não Não
cartorio
- tarifa_ Não Não Não Não Não Não Não Sim Não Não Não
interbancaria
- tarifa_ Não Não Não Não Não Não Não Sim Não Não Não
manutencao_mensal
- tarifa_sustacao Não Não Não Não Não Não Não Sim Não Não Não
- tarifas_diversas Não Não Não Não Não Não Não Sim Não Não Não
- valor_pagamento Não Não Não Não Não Não Não Sim Não Não Não
- valor_reembolso Não Não Não Não Não Não Não Sim Não Não Não
- valor_cobrado Não Não Não Não Não Não Não Sim Não Não Não
- valor_creditado_ Não Não Não Não Não Não Não Sim Não Não Não
debitado
ocorrencias - Não Não Não Não Não Não Não Não Não Não Sim
ocorrencia - Não Não Não Não Não Não Não Não Não Não Sim
- codigo Não Não Não Não Não Não Não Não Não Não Sim
- mensagem Não Não Não Não Não Não Não Não Não Não Sim
As tags <pagador>, <juros>, <multa>, <desconto>, <abatimento>, <protesto>, <baixa>,

<pag_parcial>, <mensagem>, <rateio> representam também seus respectivos atributos na tabela
comparativa para indicar se podem ou não estar presentes nos XML de entrada e saída.
65
6. Descrições das notas
Nota 1: Código do Beneficiário

Código completo do Beneficiário, composto por: Número da agência (4 dígitos),
código do beneficiário (7 dígitos) e número de controle (2 dígitos). Preencher
com zeros à esquerda cada complemento.
Nota 2: Data Juros

Quando não houver indicação de data, a cobrança dos juros ocorrerá a partir do
dia seguinte ao vencimento.
Deve ser maior que a data de vencimento.
Nota 3: Valor Juros

Deve ser preenchido quando código de Juros for 1.
Deve ser menor ou igual a 17% sobre o valor nominal.
Nota 4: Taxa Juros

Deve ser preenchido quando código de Juros for 2.
Deve ser menor ou igual a 17%.
Nota 5: Data Desconto

Quando não houver indicação de data, a concessão do desconto ocorrerá até o
dia do vencimento.
Deve ser menor ou igual a Data de Vencimento.
Deve ser maior ou igual a data de emissão.
Nota 6: Valor Desconto

Deve ser preenchido quando o código de Desconto for 1 ou 3.
Nota 7: Taxa Desconto

Deve ser preenchido quando o código de Desconto for 2 ou 5.
Nota 8: Prazo Protesto

Deve ser preenchido quando o código do Protesto for 1.
Prazo 0 é protesto imediato e só será aceito para títulos já vencidos.
Para títulos que ainda não venceram o Prazo tem de ser maior ou igual a 3.
Nota 9: Valor mínimo e Valor máximo

Devem ser preenchidos quando o código do Pagamento Parcial for 2 e tipo for 2.
Nota 10: Percentual mínimo e percentual máximo

Devem ser preenchidos quando o código do Pagamento Parcial for 2 e tipo for 1.
Nota 11: Nosso Número

Caso o Nosso Número não seja enviado no XML de entrada para o serviço
66
RegistrarTitulo, será gerado um número automaticamente pelo sistema que
será retornado no XML de saída.
Para o mesmo beneficiário, o Nosso Número somente poderá ser reutilizado no
dia seguinte após a baixa do antigo título.
Instruções para o cálculo do número de controle do nosso número constam no
Anexo II deste manual.
Nota 12: Tipo do Pagamento Parcial

Deve ser preenchido quando o código do Pagamento Parcial for 2.
Nota 13: Quantidade de Pagamento Parcial

Deve ser preenchido quando autoriza Pagamento Parcial for 2.
Nota 14: Autoriza Pagamento Parcial

Deve ser sempre preenchido com 1 (não autoriza pagamento parcial), exceto
quando a espécie for 31 (cartão de crédito).
Nota 15: Data Multa

Quando não houver indicação de data, a cobrança da multa ocorrerá a partir do
dia seguinte ao vencimento.
Deve ser maior que a Data de Vencimento.
Nota 16: Valor Multa

Deve ser preenchido quando código de Multa for 1.
Deve ser menor ou igual a 20% sobre o Valor Nominal.
Nota 17: Taxa Multa

Deve ser preenchido quando código de Multa for 2.
Deve ser menor ou igual a 20%.
Nota 18: Linha Mensagem

O boleto poderá apresentar no máximo 9 linhas no campo “observações”. Desta
forma, caso sejam cadastradas instruções no título ou existam instruções
permanentes cadastradas para o beneficiário, estas terão prioridade na exibição.
As mensagens serão informadas posteriormente, conforme houver espaço
disponível.
Nota 19: Data de Vencimento

Para títulos registrados entre 23h30min e 23h59min, a data de vencimento
informada deverá ser sempre superior à data de registro.
Para títulos registrados entre 00h e 05h59min, a data de vencimento informada
deverá ser sempre igual ou superior à data de registro.
Deve ser preenchido no serviço AlterarTitulo para o Tipo de Alteração 06 (Data
de vencimento).
Nota 20: Valor IOF

Se informado valor de IOF, o boleto será registrado na carteira 8051 – Cobrança
67
Simples Seguradoras.
Informação de IOF não permitida para as espécies 31- Cartão de crédito e 32 –
Boleto de proposta
Nota 21: Seu número

São permitidos apenas os caracteres: A-Z a-z 0-9 $ % * +, - . /
Nota 22: Identificação do título na empresa

São permitidos apenas os caracteres: A-Z a-z 0-9 $ % * +, - . /
Nota 23: Data de emissão

O prazo máximo para data de emissão é de trinta anos retroativos, considerando
a data atual.
Nota 24: Tipo Valor do Rateio

Deve ser 1 (Percentual) quando Código do Rateio for 1 (Valor cobrado do
Pagador).
Nota 25: Valor do Rateio

Deve ser preenchido quando o Tipo Valor do Rateio for 2 (Valor).
Nota 26: Percentual do Rateio

Deve ser preenchido quando o Tipo Valor do Rateio for 1 (Percentual).
Nota 27: Situação Pagamento

A Situação Pagamento do título apresenta se título está apto para pagamento
ou se há algum bloqueio para sua liquidação. Importante: títulos com
“pagamento em processamento” apenas demonstram que houve um registro de
pagamento na rede bancária, contudo, este pagamento somente é confirmado
na compensação noturna. Esta conciliação não é de responsabilidade do Banco
Emissor (Banrisul), com isso, não há garantias que este pagamento será
efetivado na madrugada.
68
7. Detalhamento Técnico
7.1. Acesso ao Web Service

Segue abaixo exemplos de códigos com chamadas ao Web Service
utilizando o certificado nas principais linguagens:
7.1.1. C# via Soap Client

using System.ServiceModel;
using System.Security.Cryptography.X509Certificates;
XmlDocument xmlDoc = new XmlDocument();

xmlDoc.LoadXml("<xmlEntrada><dados ambiente=\"T\"><titulo> ...
</titulo></dados></xmlEntrada>");
String url = "https://ww20.banrisul.com.br/boc/link/Bocswsxn_CobrancaOnlineWS.asmx";
EndpointAddress endpoint = new EndpointAddress(url);
BasicHttpBinding binding = new BasicHttpBinding();
binding.Security.Mode = BasicHttpSecurityMode.Transport;
binding.Security.Transport.ClientCredentialType = HttpClientCredentialType.Certificate;
CobrancaOnlineWSSoapClient ws = new CobrancaOnlineWSSoapClient(binding, endpoint);

ws.ClientCredentials.ClientCertificate.SetCertificate(
StoreLocation.LocalMachine, StoreName.My, X509FindType.FindBySubjectName,
"<NomeCertificado>");
XmlNode xmlEntrada = xmlDoc.SelectSingleNode("xmlEntrada");

XmlNode xmlRetorno = ws.RegistrarTitulo(xmlEntrada);
É necessário adicionar a Web Reference no projeto.
69
7.1.2. C# via Web Request
using System.Net;
using System.Security.Cryptography.X509Certificates;
String certPath = @"C:\client_certificate.cer";

String url = "https://ww20.banrisul.com.br/boc/link/Bocswsxn_CobrancaOnlineWS.asmx";
String xmlEntrada = "<dados ambiente=\"T\"><titulo> ... </titulo></dados>";
String envelopeSoap = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
"<soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" " +
"xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" " +
"xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">" +
"<soap:Body>" +
"<RegistrarTitulo xmlns=\"Bergs.Boc.Bocswsxn\">" +
"<xmlEntrada>" + xmlEntrada + "</xmlEntrada>" +
"</RegistrarTitulo>" +
"</soap:Body>" +
"</soap:Envelope>";
HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls;
request.ContentType = "text/xml; charset=\"utf-8\"";
request.Method = "POST";
request.ClientCertificates.Add(X509Certificate.CreateFromCertFile(certPath));
using (Stream stream = request.GetRequestStream())

{
using (StreamWriter writer = new StreamWriter(stream))
{
writer.Write(envelopeSoap);
}
}
using (WebResponse response = request.GetResponse())
{
using (StreamReader responseStream = new StreamReader(response.GetResponseStream()))
{
xmlRetorno = responseStream.ReadToEnd();
}
}
70
7.1.3. PHP via CURL
$url = 'https://ww20.banrisul.com.br/boc/link/Bocswsxn_CobrancaOnlineWS.asmx';
$xmlEntrada = '<dados ambiente=\"T\"><titulo> ... </titulo></dados>';
$envelopeSoap = '<?xml version="1.0" encoding="utf-8"?>

<soap:Body>
<xmlEntrada>'.$xmlEntrada.'</xmlEntrada>
</RegistrarTitulo>
</soap:Body>
</soap:Envelope>';
$headers = array('Content-type: text/xml;charset="utf-8"',

'Host: ww20.banrisul.com.br',
'SOAPAction: Bergs.Boc.Bocswsxn/RegistrarTitulo',
'Content-length: '.strlen($envelopeSoap));
$ch = curl_init();
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POSTFIELDS, $envelopeSoap);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_SSLCERT, 'C:/client_certificate.cer');
curl_setopt($ch, CURLOPT_SSLKEY, 'C:/private_key.pem');
$response = curl_exec($ch);
71
7.1.4. Java via HttpsURLConnection
System.setProperty("javax.net.ssl.keyStore", "C:/cert/client_certificate.jks");
System.setProperty("javax.net.ssl.keyStorePassword", "password");
String address = "https://ww20.banrisul.com.br/boc/link/Bocswsxn_CobrancaOnlineWS.asmx";

URL url = new URL(address);
HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
connection.setRequestMethod("POST");
connection.setRequestProperty("Content-type", "text/xml; charset=\"utf-8\"");
connection.setDoOutput(true);
connection.setDoInput(true);
String xmlEntrada = "<dados ambiente=\"T\"><titulo> ... </titulo></dados>";

String servico = "RegistrarTitulo";
String envelopeSoap = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
"<soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" " +
"xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" " +
"xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">" +
"<soap:Body>" +
"<" + servico + " xmlns=\"Bergs.Boc.Bocswsxn\">" +
"<xmlEntrada>" + xmlEntrada + "</xmlEntrada>" +
"</" + servico + ">" +
"</soap:Body>" +
"</soap:Envelope>";
PrintWriter printWriter = new PrintWriter(connection.getOutputStream(), true);

printWriter.println(envelopeSoap);
printWriter.close();
StringBuilder response = new StringBuilder();

BufferedReader bufferedReader =
new BufferedReader(new InputStreamReader(connection.getInputStream(), "UTF-8"));
for (String line = bufferedReader.readLine(); line != null; line =

bufferedReader.readLine()) {
response.append(line);
response.append(System.getProperty("line.separator"));
}
System.out.println("Response: " + response);
Para gerar o arquivo .jks por linha de comando a partir do arquivo .pfx:
%JAVA_HOME%\bin\keytool -importkeystore -srckeystore <Arquivo PFX> -srcstoretype pkcs12

–destkeystore <Arquivo JKS destino> -deststoretype JKS
Por exemplo:
%JAVA_HOME%\bin\keytool -importkeystore -srckeystore client_certificate.pfx -

srcstoretype pkcs12 –destkeystore client_certificate.jks -deststoretype JKS
72
7.1.5. Java via JAX-WS
Com esta abordagem, não se lida diretamente com envelope SOAP, e
não é necessário lidar com código XML. A interação com Web Service se dá
através de instâncias de classes geradas por ferramenta (wsimport).
System.setProperty("javax.net.ssl.keyStore", "C:/cert/client_certificate.jks");
System.setProperty("javax.net.ssl.keyStorePassword", "password");
URL wsdlLocation = new

URL("https://ww20.banrisul.com.br/boc/link/Bocswsxn_CobrancaOnlineWS.asmx?WSDL");
CobrancaOnlineWS cobrancaOnlineWs = new CobrancaOnlineWS(wsdlLocation);
CobrancaOnlineWSSoap cobrancaOnlineWSSoap = cobrancaOnlineWs.getCobrancaOnlineWSSoap();
RegistrarTitulo.XmlEntrada xmlEntrada = new RegistrarTitulo.XmlEntrada();
TypeDados dados = criarDadosTeste(); // instancia objetos da hierarquia um a um, setando
atributos
xmlEntrada.setDados(dados);
RegistrarTituloResult result = cobrancaOnlineWSSoap.registrarTitulo(xmlEntrada);
// * EXTRAS JAXB *
// se quiser visualizar hierarquia de objetos como código XML (não é imprescindível para
utilização):
JAXBContext jaxbContext = JAXBContext.newInstance(RegistrarTituloResponse.class);
Marshaller marshaller = jaxbContext.createMarshaller();
marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE);
RegistrarTituloResponse response = new RegistrarTituloResponse();
response.setRegistrarTituloResult(result);
ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream(4096);
marshaller.marshal(result, byteArrayOutputStream);
String xmlResponse = new String(byteArrayOutputStream.toByteArray(), "UTF-8");
System.out.println(xmlResponse);
// se quiser gerar hierarquia de objetos a partir de código XML (não é imprescindível

para utilização):
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
response = (RegistrarTituloResponse) unmarshaller.unmarshal(
new ByteArrayInputStream(byteArrayOutputStream.toByteArray()));
Para gerar o arquivo .jks por linha de comando a partir do arquivo .pfx,
consulte o item 7.1.4.
Para gerar hierarquia de classes a partir de arquivo WSDL contendo,
entre outras, as informações de XML Schema utilizadas em entrada e saída de
Web Service:
%JAVA_HOME%\bin\wsimport <Arquivo WSDL> -s <Caminho de destino> -p <Nome do pacote das
classes geradas>
Por exemplo:
%JAVA_HOME%\bin\wsimport Bocvwsem_CobrancaOnlineWS_EX.wsdl -s . -p bergs.boc.bocpwsjm
73
7.2. Impressão do Boleto
Segue abaixo exemplos de códigos nas principais linguagens para
converter o código Base64 do boleto num arquivo PDF.
7.2.1. C#
using System.IO;
String boletoBase64 = " JVBERi0xLj+QKJeLjz9MKMSAwIG9iag8PC/9UeXlL1BhZ2Vz ...";

Byte[] bytes = Convert.FromBase64String(boletoBase64);
String caminhoFisico = @"C:\temp";
String caminhoBoleto = String.Format(@"{0)\boleto.pdf", caminhoFisico);
if (!Directory.Exists(caminhoFisico))
{
Directory.CreateDirectory(caminhoFisico);
}
File.WriteAllBytes(caminhoBoleto, bytes);
System.Diagnostics.Process.Start(caminhoBoleto);
74
8. Anexo I – Leiaute do boleto
8.1. Especificações técnicas
Gramatura do papel: mínimo 50 g/m2;
Dimensões: Formato envelope - 95 a 108 mm de altura por 170 a 216
mm de comprimento
Cor da impressão: fundo branco/impressão preto ou azul;
8.2. Definição dos Campos do Boleto

8.2.1. Número de Vias
Uma (1) podendo ser subdividida em até três (3) partes: Recibo do
Pagador, Ficha de Compensação e Ficha de Caixa (opcional).
8.2.2. Disposição das partes
Formato envelope: Recibo do Pagador na parte superior, Ficha de Caixa

(se houver) na parte central e Ficha de Compensação na parte inferior.
8.3. Instruções de preenchimento do boleto

8.3.1. Ficha de Compensação
a) Parte superior esquerda: nome ou logotipo do Banco e, a sua direita o

número-código de compensação com dígito verificador 041-8, em negrito,
com caractere de 5 mm e traços ou fios de 1,2 mm;
b) Parte superior direita: representação numérica do conteúdo do código
de barras (linha digitável) cujos caracteres devem ser 3,5 mm a 4 mm de
altura e com traços ou fios de 0,3 mm de espessura. A linha digitável
utilizada deve ser a retornada no XML de saída, após confirmado o registro.
c) Código de Barras:
 Utilizar o código de barras retornado no XML, após confirmado o
registrado;
 Posição: 12 mm desde a margem inferior da Ficha de Compensação
até o centro do código de barras e 5 mm da lateral esquerda do
formulário até o início do código de barras;
 Dimensão: 103 mm de comprimento por 13 mm de altura;
 Identificação: na margem inferior direita com dimensão máxima de 2
mm e traços ou fios de 0,3 mm com a expressão “AUTENTICAÇÃO
MECÂNICA - FICHA DE COMPENSAÇÃO.
d) Quadro de Impressão: deverá apresentar grade/denominação dos

campos do modelo do item 8.4.2.
75
e) Boleto de proposta: deverá conter a redação abaixo:
“ Este boleto se refere a uma proposta já feita a você e o seu
pagamento não é obrigatório. Deixar de pagá-lo não dará causa a protesto, a
cobrança judicial ou extrajudicial, nem a inserção de seu nome em cadastro de
restrição ao crédito. Pagar até a data de vencimento significa aceitar a proposta.
Informações adicionais sobre a proposta e sobre o respectivo contrato poderão
ser solicitadas a qualquer momento ao beneficiário, por meio de seus canais de
atendimento. ”
8.3.2. Ficha de caixa (opcional)
Seguir instruções do item 8.3.3.
8.3.3. Recibo do Pagador
a) Devem ser impressas, no mínimo, as seguintes informações:

 Nome, endereço e CPF/CNPJ do beneficiário;
 Nome do pagador;
 Nosso número;
 Número do documento;
 Data de vencimento;
 Valor do documento;
 Telefones SAC Banrisul: 0800-646-1515 e Ouvidoria Banrisul:
0800-644-2200.
b) Identificação do Banrisul (Conter um ou mais itens a seguir):

 Nome; Logotipo; Linha digitável.
c) Quadro de Impressão: preferencialmente observar o modelo constante

no item 8.4.1.
76
8.4. Modelo de boleto
8.4.1. Formato envelope – Recibo do pagador
8.4.2. Formato envelope – Ficha de compensação
77
9. Anexo II – Cálculo do Nosso Número
9.1. Cálculo do Número de Controle do Nosso Número

O nosso número no Banrisul possui 10 dígitos, sendo os 8 primeiros de
livre escolha do beneficiário e os dois últimos calculados, respectivamente, pelo
módulo 10 e 11.
9.1.1. Módulo10: cálculo do primeiro dígito verificador
Atribuir a cada dígito, da direita para a esquerda, os pesos 2 e 1

(respectivamente).
Multiplicar cada dígito pelo respectivo peso e, se o resultado for
superior a 9, subtrair 9 do resultado.
(N1*1-9) + (N2*2-9) + (N3*1-9) + (N4*2-9) + (N5*1-9) + (N6*2-9)

+ (N7*1-9) + (N8*2-9)
Somar todos os resultados, dividir por 10 e guardar o resto.

O primeiro DV será o resultado da operação 10 – resto.
Observações:
 Quando o somatório for menor que 10, o resto da divisão por 10
será o próprio somatório;
 Quando o resto for 0, o primeiro DV é igual a 0, ou seja, o último
passo não é necessário.
Exemplo:
Tomemos por base o Nosso Número = 00189274:
Somatório, atribuindo-se os pesos 2 e 1, respectivamente, sempre da
direita para a esquerda.
(0*1)+(0*2)+(0*1)+(8*2-9)+(9*1)+(2*2)+(7*1)+(4*2)
Nosso Número 0 0 1 8 9 2 7 4
Pesos 1 2 1 2 1 2 1 2
Resultado Multiplicação 0 0 1 16 9 4 7 8
Subtração de 9 (se 0 0 1 7 9 4 7 8
necessário)
Somatório = 36
Quociente = 36 / 10 = 3 e Resto = 6
Primeiro DV = 10 – 6 = 4
Para o cálculo do segundo DV, o primeiro DV é agregado ao Nosso
Número original (na última posição), ou seja: 00189274.4.
78
9.1.2. Módulo 11: cálculo do segundo dígito verificador
Atribuir a cada um dos 9 dígitos pesos de 2 a 7, respectivamente, da

direita para a esquerda.
Multiplicar cada dígito pelo seu peso e somar todos os resultados.
Dividir o somatório por 11 e calcular o resto.
O segundo DV será o resultado de 11 – resto.
(N1*4)+(N2*3)+(N3*2)+(N4*7)+(N5*6)+(N6*5)+(N7*4)+(N8*3)+
(N9*2)
Observações:
 Se o somatório obtido for menor que 11, considerar como resto da
divisão o próprio somatório.
 Se o resto obtido no cálculo do módulo 11 for 0, o segundo NC será
igual ao próprio resto.
 Se o resto obtido no cálculo do módulo 11 for igual a 1, considera-
se o DV inválido. Neste caso, soma-se 1 ao DV obtido do módulo 10 e refaz-se
o cálculo do módulo 11. No caso do primeiro DV ser 9, considera-se então o DV
inválido (pois 9+1=10). Neste caso, o DV do módulo 10 automaticamente será
igual a 0 e procede-se assim novo cálculo pelo módulo 11.
Exemplo:
Continuando o exemplo anterior, segue o cálculo do segundo DV de
00189274.4
Nosso Número 0 0 1 8 9 2 7 4 4
Pesos 4 3 2 7 6 5 4 3 2
Resultado Multiplicação 0 0 2 56 54 10 28 12 8
Somatório = 170
Quociente = 170 / 11 = 15 e Resto = 5
Segundo DV = 11 – 5 = 6
Portanto, o número de controle procurado é 46.
79
10. Anexo III – Emissão de Segunda Via
A inclusão do link de emissão de segunda via no site do beneficiário,
possibilita a geração do boleto para impressão desde que o título esteja
devidamente registrado no Sistema de Cobrança Banrisul.
O beneficiário deverá utilizar seguinte URL:
https://ww8.banrisul.com.br/brb/link/Brbw2Lhw_Bloqueto_Titulos_Internet.aspx?
Origem=CA&CodCedente=****&NossoNumero=****&CpfCnpjPagador=****&Segun
daVia=1
Onde ‘****’ seguido ao campo, corresponde:
Campo Bytes Conteúdo e Características

CodCedente 13 Numérico, obrigatório;
Código do beneficiário;
NossoNumero 10 Numérico, obrigatório;
Nosso Número informado no XML de
saída;
CpfCnpjPagador 11/14 Numérico, obrigatório;
CPF do Pagador (Pessoa Física) ou CNPJ
do Pagador (Pessoa Jurídica);
SegundaVia 1 Numérico, obrigatório;
Conteúdo fixo e contendo o dígito “1”;
Após recebido o XML de saída confirmando o registro do título, poderá

ser chamado o link informado, a fim de apresentar o boleto em PDF ao usuário.
80
11. Anexo IV – Extração de certificado
Seguem algumas sugestões de comandos em OpenSSL, a fim de
auxiliar a realizar as conversões necessárias para utilizar os arquivos referentes
ao certificado digital (e sua respectiva chave privada).
11.1. Comandos para extrair certificado e chave privada de um arquivo

PKCS#12 (.pfx/.p12)
Para extrair o certificado digital (.cer) e sua respectiva chave privada

(.key) de um arquivo PKCS#12 (.pfx/.p12) pode-se utilizar os seguintes
comandos em OpenSSL:
a) Exportar certificado do arquivo PFX:
openssl pkcs12 -in certname.pfx -nokeys -out nome_certificado.cer
b) Exportar chave privada do arquivo PFX
openssl pkcs12 -in certname.pfx -nocerts -out chave_privada.key –nodes
c) Remover senha de proteção da chave privada (caso seja necessário)
openssl rsa -in chave_privada.key -out chave_privada_decriptada.key
d) Verificar se certificado e chave privada são correspondentes
openssl x509 -noout -modulus -in nome_certificado.cer | openssl sha1

openssl rsa -noout -modulus -in chave_privada.key | openssl sha1
Obs: os resultados do item “d” devem ser iguais para ambos os comandos.
11.2. Comando para criar um arquivo PKCS #12 (.pfx/.p12)
openSSL pkcs12 –export –in nome_certificado.cer –inkey chave_privada.key

–out certname.pfx
81
12. Controle de alterações do documento
21/10/2016 Versão inicial do documento.

v0.1
30/11/2016 Alteração do formato dos campos de data para ‘AAAA-MM-DD’.
v0.2 Inclusão da url do ambiente de homologação.
23/01/2017 Inclusão de nova observação na Nota 8.
v0.3 Inclusão do protocolo criptográfico TLS.
Inclusão da tag <ocorrencias> no XML de retorno.
Inclusão de novo código de retorno ‘01’.
Alteração do nome do web method e namespace do item 3.1.
Alteração do atributo barra para codigo_barras no XML de
retorno.
22/02/2017 Remoção das Espécies 03, 04, 05, 07, 12, 20, 21, 22.
v0.4 Inclusão da Espécie 99 – Outros.
Inclusão de novo código de retorno ‘04’.
Inclusão de uma observação sobre a descrição para o código de
ocorrência ‘00’.
26/04/2017 Alteração da observação na Nota 8.
v0.5 Inclusão da Espécie 04 – Duplicata de Serviço.
Inclusão de novas notas: 11, 12 e 13.
Alteração da nomenclatura de todas as tags para minúsculas.
Criação da tag <beneficiario> dentro da tag <titulo>.
Remoção do atributo beneficiario da tag <titulo>.
Alteração do atributo tipo da tag <pagador> para
tipo_pessoa.
Alteração do atributo numero da tag <pagador> para
cpf_cnpj.
Alteração nos atributos codigo_barras e linha_digitavel,
foram removidos da tag <dados> e adicionados na tag
<titulo>.
O atributo nosso_numero da tag <titulo> não é mais
obrigatório.
Os atributos tipo e quantidade da tag <pag_parcial> não são
mais obrigatórios.
82
Incluído os dados do XML de saída.
Criação de Tabela Comparativa entre o XML de entrada e o XML
de saída.
25/07/2017 Inclusão da nota 14.
v0.6
13/10/2017 Alteração no item 2.1: Obrigatoriedade do uso de certificado na
autenticação da comunicação com o Web Service.
v0.7
Alteração no item 2.3.
Alteração no item 3.2.1.3: Alteração do tamanho do atributo
endereco da tag <pagador> de 40 para 35 caracteres.
Alteração no item 3.2.1.4.C: Correção do atributo Taxa para
taxa.
Inclusão no item 3.2.3 (Novos Produtos).
Inclusão no item 3.3.5 (Possíveis erros e soluções).
Alteração no item 3.3.6: Correção do atributo código_barras
para codigo_barras.
Alteração das notas 2, 3, 4, 5 e 11.
Inclusão das notas 15, 16, 17 e 18.
27/11/2017 Alteração do item 2.3.: Homologação.
v1.0 Inclusão do item 2.4.: Produção.
Alteração do item 3.1.: Inclusão dos caracteres especiais.
Alteração das notas 9 e 10.
Inclusão do item 3.6.: Detalhamento Técnico
01/06/2018 Inclusão do item 2.1.4: Comandos para extrair arquivos do
certificado.
v1.1
Alteração do item 3.2.3.2: Mensagem obrigatória boleto de
proposta.
Inclusão das notas 19 e 20.
Criação do atributo id_titulo_empresa da tag <titulo>.
Remoção dos caracteres válidos “<” e “>”.
Inclusão do erro “i” no item 3.3.5.
12/09/2018 Substituição do item 2.1.4: Renovação de certificados.
v1.2 Alteração do item 2.3.: Homologação.
Alteração do item 3.3.5, “c” e “f”.
Inclusão do item 3.5: Arquivo XSD.
83
Alteração da nota 11.
Inclusão dos anexos I, II, III e IV.
08/03/2019 Atualização do item 2.3.: Homologação.
v1.3 Atualização do item 2.1.4.2.: Certificado Cliente.
Alteração do item 3.1.: exclusão do caractere disponível “&”.
Alteração do item 3.2.1.4: alteração do formato dos atributos
taxa de (5,2) para (5,1).
Alteração do item 3.2.3.1: alteração de “valor nominal pode ser
R$0,00” para “valor nominal deve ser R$0,00”.
Alteração do item 3.2.3.2.: inclusão da proibição do uso de
instruções e informação do prazo de recebimento.
Alteração das notas 9 e 10: exclusão da limitação de informação
de taxa/percentual mínimo 15 vezes menor e máximo até 20
vezes maior que o valor nominal.
Inclusão do erro “j” no item 3.3.5.
Alteração nota 19: alteração do horário “22h e 23h59min” para
“23:30h e 23h59min”.
03/05/2019 Inclusão das notas: 21 e 22.
v1.4 Alteração do item 3.1.: exclusão do caractere disponível “ (aspas
duplas).
Alteração do item 3.2.: inclusão de observação sobre chamadas
em lote.
Alteração dos itens 3.3.6., 3.3.7. e 3.4.: exclusão do atributo
ambiente do XML de retorno.
18/06/2019 Alteração das notas: 2, 5 e 15.
v1.5 Alteração do atributo data da tag <multa> para campo
opcional.
Alteração da url do Anexo III.
25/11/2019 Alteração do Capítulo 3: inclusão do serviço EmitirBoleto e
reestruturação do capítulo.
v2.0
Alteração do item 3.4: enviado para o Capítulo 5 e inclusão do
serviço EmitirBoleto na tabela comparativa.
Alteração do item 3.5: alteração no nome do arquivo XSD e
enviado para o item 3.1.6.
Alteração do item 3.6: enviado para o Capítulo 6.
Alteração do item 3.7: enviado para o Capítulo 7.
84
Criação do item 7.2: Impressão do Boleto.
Alteração da url do Anexo III: inclusão do parâmetro
CpfCnpjPagador.
13/02/2020 Inclusão do serviço AlterarTitulo.
v2.1 Alteração do item 3.3.1: Inclusão do parâmetro ambiente na
tag <dados> no XML de entrada do serviço EmitirBoleto.
Alteração do item 5: Inclusão do serviço AlterarTitulo na tabela
comparativa.
06/03/2020 Alteração do item: 2.3. Homologação
v2.2 Alteração do item: 3.3.7. Boleto de Teste
06/11/2020 Alteração do item 3.1.1: Inclusão da tag <rateio> no XML de
entrada do serviço RegistrarTitulo.
v2.3
Alteração do item 3.1.2: Inclusão da tag <rateio> no Exemplo
de entrada.
Criação do item 3.1.4.4: Inclusão da tag <beneficiario> no
Retorno de sucesso.
Alteração do item 3.1.5: Inclusão da tag <rateio> no Exemplo
de sucesso.
Alteração do item 5: Inclusão da tag <rateio> na tabela
comparativa.
Alteração do item 6: Inclusão das notas 24, 25 e 26.
31/05/2021 Inclusão do serviço BaixarTitulo.
v2.4 Inclusão do serviço ConsultarTitulo.
Alteração do item 5: Inclusão dos serviços BaixarTitulo e
ConsultarTitulo na tabela comparativa.
Alteração do item 6: Inclusão da Nota 27.
05/08/2021 Alteração do item 3.1.1.5.A: Alteração no formato do campo
v2.5 taxa da tag <juros> para Numérico (5,2).
Alteração do item 3.1.1.5.C: Alteração no formato do campo
taxa da tag <desconto> para Numérico (5,2).
Alteração do item 3.4.4.2.A: Alteração no formato do campo
taxa da tag <juros> para Numérico (5,2).
Alteração do item 3.4.4.2.C: Alteração no formato do campo
taxa da tag <desconto> para Numérico (5,2).
85

Cobranca Online v2.5

Enviado por

Direitos autorais:

Formatos disponíveis

Cobranca Online v2.5

Enviado por

Dados do documento

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

Cobranca Online v2.5

Enviado por

Direitos autorais:

Formatos disponíveis

Cobrança Online

Versão 2.5 – Agosto/2021

Dentre estes novos produtos, está a possibilidade de registro on-line

Com o intuito de atender a este novo cenário, o Banrisul oferece aos

Registro de títulos via Office Banking

Através do office banking ou mobile, beneficiários devidamente

Registro através do CNAB 240 – versão 10.3

Registro através de chamadas XML

Nesta modalidade cliente beneficiário deverá desenvolver uma solução

Além do registro, beneficiário também poderá contar com a emissão de

A utilização do registro online via XML será apresentada nos próximos

2.1. Certificado digital

Este certificado digital deve ser emitido por uma Autoridade de

Poderá ser aceito qualquer um dos três tipos de certificados abaixo

I. Validação de domínio (site);

II. Emitido para e-CNPJ (tipo A1);

III. Emitido para e-CPF (tipo A1).

I. O Common Name do certificado deverá ser igual ao DNS (Domain

II. Deve utilizar chaves criptográficas RSA, no mínimo, de 2048 bits e

III. O certificado deve conter o Uso Avançado de Chave “Autenticação de

Exemplo de certificado emitido por uma AC Internacional para validação de domínio.

I. O Common Name do certificado deverá ser composto do nome

II. O certificado deve conter o Uso Avançado de Chave “Autenticação de

Exemplo de certificado emitido por uma AC da ICP-Brasil

I. O Common Name do certificado deverá ser composto do nome da

II. O certificado deve conter o Uso Avançado de Chave “Autenticação de

Exemplo de certificado e-CPF emitido por uma AC da ICP-Brasil

2.1.4.1. Certificado Banrisul

Todos os certificados digitais para os domínios do Banco do Estado do

2.1.4.2. Certificado Cliente

Para que o Banrisul possa verificar e validar a autenticidade do

Atenção: O Banrisul não solicita o envio de chave privada. Este tipo

Para esta habilitação, será necessário que o cliente tenha em mãos os

I. Domínio (URL) do site de onde serão feitas as chamadas ao serviço de

Caso o certificado utilizado seja de validação de domínio (site), o

Exemplo de certificado emitido por uma AC Internacional para validação de domínio

Caso o certificado utilizado seja do tipo e-CNPJ ou e-CPF, o CNPJ/CPF

Exemplo de certificados e-CNPJ e e-CPF emitidos por uma AC da ICP-Brasil

Para acessar o ambiente de homologação utilize a seguinte url:

A partir de uma solicitação retornada com sucesso, é necessário

Se o beneficiário não desejar desenvolver o seu leiaute próprio do

Se optar pela emissão de segunda via pela página do Banco, não é

É de responsabilidade do beneficiário o controle sobre os boletos

Para receber arquivos de retorno, o beneficiário deverá informar o

Mesmo no ambiente de produção, é possível validar o registro de um

Os serviços da Cobrança Online serão acessados através de chamada

Todos eles possuem o mesmo padrão de dados de entrada e de saída

Abaixo exemplo da especificação da chamada ao serviço para registrar

<?xml version="1.0" encoding="utf-8"?>

Todas as tags e atributos devem ser minúsculos. O validador do XML

As letras são sempre convertidas automaticamente para maiúsculo.

3.1.1. XML de entrada

<dados ... >

3.1.1.1. Tag <dados>

Atributo Formato Conteúdo Notas

3.1.1.3. Tag <beneficiario>

3.1.1.4. Tag <pagador>

3.1.1.5. Tag <instrucoes>

3.1.1.6. Tag <pag_parcial>