MANUAL E LAYOUT

API DE ESTORNO DA BAIXA DE TÍTULO

DE COBRANÇA BRADESCO
Versão 1.3 - Setembro/2023

Atualizado: 18.09.2023
Versão: 1.3
0
 Atualizado: 21/07/2022
Versão: 1.2

SUMÁRIO

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

2. ESTORNO DA BAIXA DE TÍTULO VIA API .......................................................... 2

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

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

5. CÓDIGO DA BAIXA ............................................................................................... 5

6. STATUS E MENSAGENS DE RETORNO .............................................................. 5

7. CÓDIGO E MENSAGENS DE RETORNO TÉCNICO (CAMPO CAUSA) .............. 5

8. PERGUNTAS E RESPOSTAS ................................................................................ 6

9. SUPORTE E ATENDIMENTO ................................................................................ 6

Atualizado: 18.09.2023
Versão: 1.3
1
1. PRÉ-REQUISITOS

Para promover a integração sistêmica do estorno da baixa on-line de boletos

de Cobrança Bradesco, o cliente deve:
• Desenvolver a sistemática de conectividade descrita neste Manual e no
Manual do Desenvolvedor, integrada ao seu sistema.

2. ESTORNO DA BAIXA DE TÍTULO VIA API

Para melhorar a experiência no produto Cobrança, disponibilizamos a API de

Estorno de Baixa de Títulos.

Lembrando que é possível fazer o estorno somente no próprio dia em que

comandou a baixa, e caso seja enviado no dia seguinte, será recusado com retorno
de erro.

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

layout de comunicação disponibilizado (página 3) e manual do desenvolvedor,
sendo possível a conectividade de transmissão de dados do Sistema Bradesco 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 estornado. 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 será
estornado.

Realizar requisição, conforme abaixo:

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

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

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

Atualizado: 18.09.2023
Versão: 1.3
2
 3. LAYOUT DE COMUNICAÇÃO - ENTRADA

Qtde. Campo
Nome do Campo Tipo Descrição
CHAR Obrigatório
cpfCnpj Objeto Trata-se de um array

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
ID Produto (Código da
Carteira/Modalidade de
produto Numérico Cobrança. Ex.: 9 2 Sim
Cobrança Escritural, 5
Cobrança de Seguros)

Número da Negociação
Formato:
Agência: 4 posições
negociacao Numérico 11 Sim
(sem dígito)
Conta: 7 posições (sem
dígito)

Número do Título
(Nosso Número sem o
dígito)
Identificação do título
nossoNumero Numérico para o Banco. Esse 11 Sim
número deve ser único,
de acordo com a
carteira e negociação
utilizadas

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

horaSolicitacao
Data e Hora da
solicitação no formato
“AAAA-MM-DD-
HH.MM.SS.MMMMMM”
Alfanumérico 26 Sim
Essa informação deve
ser a mesma retornada
no momento da Baixa
do Título
Status do Título
TABELA 1 - Status

status Numérico Essa informação deve 02 Sim

ser a mesma retornada
no momento da Baixa
do Título
Status Anterior do
Título

statusAnterior Numérico Essa informação deve 02 Sim

ser a mesma retornada
no momento da Baixa
do Título

Atualizado: 18.09.2023
Versão: 1.3
3
 Exemplo de Entrada (JSON)
{
"cpfCnpj": {
"cpfCnpj": 114383908,
"filial": 0,
"controle": 7
},
"produto": 9,
"negociacao": 28560230114,
"nossoNumero": 399912875,
"sequencia": 0,
"horaSolicitacao" : "2023-07-26-11.24.21.752018",
"status" : 57,
"statusAnterior" : 1
}

4. 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
transação Alfanumérico 8
Padrão: “CBTTIAGR”
Mensagem de Retorno
mensagem Alfanumérico 100
Sucesso ou Insucesso
Quando o campo status for 400, 412 ou 500,
serão demonstrados código e mensagem de erro
causa Alfanumérico 200
técnica, gerada no mainframe/API
TABELA 3 - Causa Pág. 5

Exemplo de Resposta com Sucesso (JSON)

{
"status": 200,
"transacao": "CBTTIAGR",
"mensagem": "CBTT0710 - SOLICITACAO DE ESTORNO EFETUADA COM SUCESSO"
}

Exemplo de Resposta com ERRO (JSON)

{
"status": 412,
"transacao": "CBTTIAGR",
"mensagem": "Parâmetros informados inválidos.",
"causa": "CBTT0107 - CPF/CNPJ INVÁLIDO"
}

Atualizado: 18.09.2023
Versão: 1.3
4
 5. CÓDIGO DA BAIXA

TABELA 1 - Baixa

Status Tipo
Descrição
57 CONFORME SEU PEDIDO Para cenário que o beneficiário deseja cancelar o boleto.

6. 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

7. CÓDIGO E MENSAGENS DE RETORNO TÉCNICO

(CAMPO CAUSA)

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

TABELA 3 - Causa
Código Descrição da Mensagem
CBTT0107 CPF/CNPJ INVÁLIDO
CBTT0411 IDENTIFICADOR DO PRODUTO INVÁLIDO
CBTT0412 CONTA PRODUTO INVÁLIDA
CBTT0108 NOSSO NÚMERO INVÁLIDO
TIPO DE CARTEIRA DE COBRANÇA NÃO PERMITIDA PARA ESSE
CBTT0928 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
ESTORNO DE SOLICITAÇÃO NÃO IDENTIFICADA NA BASE DE
CBTT0575 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

Atualizado: 18.09.2023
Versão: 1.3
5
8. 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-estornar

4. Quando é possível realizar o estorno?

É possível realizar o estorno apenas no próprio dia em que é comandada a
baixa do título. Caso seja realizado em dias posteriores, será retornada a
mensagem de erro.

9. 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: 18.09.2023
Versão: 1.3
6