MANUAL E LAYOUT

API DE BAIXA DE TÍTULO

DE COBRANÇA BRADESCO
Versão 1.4 - Outubro/2023

Atualizado: 31/08/2022
Versão: 1.3
Atualizado: Out/2023
Versão: 1.4
0
SUMÁRIO

1. ATUALIZAÇÕES ..................................................................................................... 2

2. PRÉ-REQUISITOS .................................................................................................. 2

3. BAIXA DE TÍTULO VIA API .................................................................................... 2

4. LAYOUT DE COMUNICAÇÃO - ENTRADA ............................................................ 3

5. LAYOUT DE COMUNICAÇÃO - RETORNO ........................................................... 4

6. CÓDIGO DA BAIXA ................................................................................................ 4

7. STATUS E MENSAGENS DE RETORNO ................................................................ 5

8. CÓDIGO MENSAGENS DE RETORNO TÉCNICO................................................... 5

9. PERGUNTAS E RESPOSTAS .................................................................................. 6

10. SUPORTE E ATENDIMENTO .............................................................................. 6

Atualizado: Out/2023
Versão: 1.4
1
1. ATUALIZAÇÕES
Versão 1.4, de 25/07/2023.

2. PRÉ-REQUISITOS

Para promover a integração sistêmica para baixa de boletos de Cobrança

Bradesco, o cliente deve:

• Desenvolver a sistemática de conectividade descrita neste Manual,

integrada ao seu sistema.

3. BAIXA DE TÍTULO VIA API

A API de Baixa de Títulos permite realizar o comando de baixar um título específico,
desde que esteja na base da cobrança.

Para utilizar, basta desenvolver a interface em sua plataforma de acordo com o

layout de desenvolvimento disponibilizado (página 3), sendo possível a
conectividade de transmissão de dados e a utilização do serviço.

Após concluir a conectividade, basta enviar a requisição com os dados do título a

ser baixado. A plataforma Bradesco consistirá as informações recepcionadas e,
estando com os dados preenchidos de acordo com a formatação válida, o título
receberá o comando de baixa. Essa baixa é processada em dia útil no período
noturno, assim, caso necessário, será possível durante o dia realizar o estorno da
baixa/dia, também disponível via API.

Realizar requisição, conforme abaixo:

• URL de Homologação:
POST https://proxy.api.prebanco.com.br/v1/boleto/titulo-baixar

• URL de Produção:
POST https://openapi.bradesco.com.br/v1/ boleto/titulo-baixar

CLIENTE BANCO
1. Envia dados do
título para baixar e 2. Processa os dados
recebe a confirmação e registra o comando
do comando de baixa na base da BASE COBRANÇA
cobrança

3. Processa a baixa no período

noturno

Atualizado: Out/2023
Versão: 1.4
2
 4. LAYOUT DE COMUNICAÇÃO - ENTRADA

Qtde. Campo
Nome do Campo Tipo Descrição
CHAR Obrigatório

Raiz CPF/CNPJ
cpfCnpj Numérico 9 Sim
Beneficiário

Filial CPF/CNPJ do
filial Numérico Beneficiário 4 Sim
Se CPF, filial = 0
Dígito de Controle do
controle Numérico 2 Sim
CPF/CNPJ Beneficiário
Código da Carteira/
Modalidade de
produto Numérico Cobrança. Ex.: 09 2 Sim
(Cobrança Escritural), 05
(Cobrança de Seguros)
Número da Negociação a
ser utilizada. Formato:
Agência: 4 posições (sem
negociacao Numérico
dígito)
11 Sim
Conta: 7 posições (sem
dígito)
Identificação do título
para o Banco, pode ser
informado pelo cliente ou
gerado pelo Banco. Esse
nossoNumero Numérico número deve ser único, 11 Sim
de acordo com a carteira
e negociação utilizadas.
Formato: (Nosso Número
sem o dígito)

Número de sequência
sequencia Numérico 1 Sim
Fixo “0”

Código da Baixa
codigoBaixa Numérico TABELA 1 - Baixa 02 Sim
(Cód. Baixa) Pág. 4

Exemplo JSON - Entrada

{
"cpfCnpj": {
"cpfCnpj": 114383908,
"filial": 0,
"controle": 7
},
"produto": 9,
"negociacao": 28560230114,
"nossoNumero": 399912875,
"sequencia": 0,
"codigoBaixa": 57
}

Atualizado: Out/2023
Versão: 1.4
3
 5. LAYOUT DE COMUNICAÇÃO - RETORNO

Qtde.
Nome do Campo Tipo Campo de Saída - Descrição
CHAR
Código do Status HTTP
status Numérico 3
TABELA 2 - Status (Cód. Status) Pág. 5
Código da Transação executada
transacao Alfanumérico 8
Padrão: “CBTTIAGQ”
Mensagem de Retorno:
Quando o campo status for 400, 412 ou 500, serão
demonstrados código e mensagem de erro técnica,
mensagem Alfanumérico 100 gerada no mainframe/API.
Quando o campo status for 200, serão demonstrados
código e mensagem de sucesso.
TABELA 3 - Mensagem Pág. 5
dados Objeto Trata-se de um array
Data e Hora da solicitação no formato
dataHoraSolicitacao Alfanumérico 26
“AAAA-MM-DD-HH.MM.SS.MMMMMM”
Status Numérico 02 Status do Título
statusAnterior Numérico 02 Status Anterior do Título

Exemplo de Resposta (JSON)

{
"status": 200,
"transacao": "CBTTIAGQ",
"mensagem": "CBTT0532 - SOLICITACAO DE BAIXA EFETUADA",
"dados": {
"dataHoraSolicitacao": "2023-07-26-11.28.15.404226",
"status": 57,
"statusAnterior": 1
}
}

Importante: para efetuar o cancelamento da solicitação de baixa, é necessário

guardar os dados dos campos dataHoraSolicitacao, status e statusAnterior
retornados na resposta acima, pois serão solicitados na API de Estorno de Baixa/Dia.

6. CÓDIGO DA BAIXA

TABELA 1 - Baixa
Cód.
Tipo
Baixa Descrição
57 CONFORME SEU PEDIDO Para cenário que o beneficiário deseja cancelar o boleto.

Atualizado: Out/2023
Versão: 1.4
4
7. STATUS E MENSAGENS DE RETORNO

Descrição do Retorno HTTP

TABELA 2 - STATUS
Cód. Status Descrição (Mensagem)
200 Operação realizada com sucesso
400 Parâmetros informados inválidos
412 Falha ao atender a requisição
500 Erro inesperado na solicitação

8. CÓDIGO MENSAGENS DE RETORNO TÉCNICO

Quando o status for 400, 412 ou 500, serão formatados código e mensagem de
erro técnica, gerada no mainframe/API.
Quando o status for 200, serão formatados código e mensagem de sucesso
gerada no mainframe/API.

TABELA 3 - MENSAGEM
ERRO
Código Descrição (Mensagem)
CBTT0107 CPF/CNPJ INVÁLIDO
CBTT0411 IDENTIFICADOR DO PRODUTO INVÁLIDO
CBTT0412 CONTA PRODUTO INVÁLIDA
CBTT0108 NOSSO NÚMERO INVÁLIDO
CBTT0928 TIPO DE CARTEIRA DE COBRANÇA NÃO PERMITIDA PARA ESSE PRODUTO
CBTT0930 TIMESTAMP DA SOLICITAÇÃO INVÁLIDO
CBTT0931 STATUS DO TÍTULO INVÁLIDO
CBTT0932 STATUS ANTERIOR DO TÍTULO INVÁLIDO
CBTT0403 USUÁRIO NÃO AUTORIZADO
CBTT0575 ESTORNO DE SOLICITAÇÃO NÃO IDENTIFICADA NA BASE DE SOLICITAÇÕES
CBTT0573 ESTORNO DE SOLICITAÇÃO DIFERENTE DE BAIXA OU REATIVAÇÃO
CBTT0552 TÍTULO INEXISTENTE PARA O CONTRATO INFORMADO
CBTT0710 SOLICITAÇÃO DE ESTORNO EFETUADA COM SUCESSO
CBTT9100 ERRO DE ACESSO AO DB2

SUCESSO
Código Descrição (Mensagem)

CBTT0532 SOLICITAÇÃO DE BAIXA EFETUADA

Atualizado: Out/2023
Versão: 1.4
5
9. PERGUNTAS E RESPOSTAS
1. O serviço de Baixar Título utiliza SOAP ou REST?
Utiliza REST.

2. Como funciona o acesso às APIs Bradesco nos ambientes de homologação?

O acesso utiliza o protocolo TLS 1.2 com os algoritmos (cifras) abaixo:
✓ TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, e/ou
✓ TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384.

3. Qual é o endpoint URL de Homologação utilizado para utilizar a Baixa de

Títulos?
POST https://proxy.api.prebanco.com.br/v1/boleto/titulo-baixar

4. O título é baixado imediatamente da base da Cobrança?

Não. O título recebe o comando de baixa, sendo processada apenas no
período noturno. Assim, é possível desfazer esse comando apenas no
próprio dia, utilizando a API Estorno de Baixa/Dia.

10. SUPORTE E ATENDIMENTO

Regras técnicas da API: dúvidas técnicas relacionadas à conectividade e ao
consumo da API, entre em contato com a nossa Central de Suporte pelo e-
mail: suporte.api@bradesco.com.br.

Regras de Negócio: dúvidas técnicas relacionadas ao produto, entre em

contato com a nossa Central de Suporte pelo e-mail:
suportetransacoes.api@bradesco.com.br.

Disponível de segunda a sexta, das 8h às 17h.

É importante enviar as seguintes informações:

✓ O “request” e o “response” completos da chamada/requisição.
✓ O CNPJ e o Nome da Empresa que contratou o serviço com o Bradesco.

Atualizado: Out/2023
Versão: 1.4
6