Versão 3 - Outubro/2023

MANUAL E LAYOUT
API DE PAGAMENTO DE BOLETOS

Versão 3 – outubro/2023

1
 Versão 3 - Outubro/2023

SUMÁRIO

1. OBJETIVO .......................................................................................................................................................3

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

3. PAGAMENTO DE BOLETO COBRANÇA ...................................................................................................3

4. FLUXO DE PAGAMENTO ........................................................................................................................... 4

4.1. VALIDAÇÃO DE DADOS DO TÍTULO ...................................................................................................... 4

4.2. VALIDAÇÃO DADOS DO PAGAMENTO.................................................................................................. 8

4.3. EFETIVAR PAGAMENTO ........................................................................................................................... 12

5. TABELA GERAL DE CÓDIGOS DE RETORNO .......................................................................................18

6. TABELA GERAL DE CÓDIGOS DE RETORNO - CANAL ...................................................................... 19

7. COMPROVANTE AO PAGADOR FINAL................................................................................................. 20

8. DÚVIDAS FREQUENTES .......................................................................................................................... 20

9. SUPORTE ..................................................................................................................................................... 22

2
 Versão 3 - Outubro/2023

1. OBJETIVO

Este manual apresentará o modelo de acesso às APIs - Interface de Programação de Aplicativos

da Organização Bradesco, demonstrando a regra de negócio e orientando o passo a passo para
automatizar o uso das APIs na integração da API de Pagamento de Boleto.
Nesse modelo, a autorização de acesso considerará os recursos acessados pertencentes à
aplicação servidora, e o token de acesso será emitido para a própria aplicação, e não para um usuário
final.
O padrão de autorização adotado será o JSON Web Token (JWT) Profile for Oauth 2.0 Client
Authentication and Authorization Grants.

2. PRÉ-REQUISITOS

Para a utilização do pagamento de Boleto via API, será necessário:

✓ Desenvolver a sistemática de conectividade descrita no Manual do Desenvolvedor e
neste manual, integrada ao seu sistema de pagamento de Boleto de Cobrança.

3. PAGAMENTO DE BOLETO COBRANÇA

Após o desenvolvimento, testes e validação concluída, o usuário estará apto para iniciar a
conectividade, para efetuar os pagamentos de boletos de cobrança de forma on-line, conforme
condições e tipos de recebimento registrados no boleto na base centralizada.

A API está preparada para receber as condições de pagamentos de boletos de cobrança abaixo:

✓ Com valor divergente;

✓ Boleto de cartão de crédito;
✓ Juros/Multa;
✓ Desconto/Abatimento;
✓ A vencer/Vencido;
✓ Pagamento parcial (utilizando o mesmo boleto);
✓ Moeda indexada;
✓ Agendamento.

3
 Versão 3 - Outubro/2023

Horário para Pagamentos:

✓ Boletos Bradesco: das 0h às 23h59.

✓ Boletos de outros Bancos: das 0h às 23h.

Notas:

1. Somente será aceito o pagamento de boleto se: estiver devidamente registrado pela Instituição
destinatária e na base Núclea, anteriormente conhecida como Câmara Interbancária de Pagamentos
S.A (CIP), com todas as condições necessárias e especiais; caso contrário, o pagamento será
rejeitado com código e mensagem de erro.
2. Para boleto a vencer, pago em dia não útil, será agendado automaticamente para ser efetivado no
próximo dia útil, devendo o usuário consultar a efetivação por meio do ID transaction ou protocolo
no próximo dia útil.

4. FLUXO DE PAGAMENTO

Para realizar o pagamento, será necessário seguir os passos abaixo:

4.1. VALIDAÇÃO DE DADOS DO TÍTULO

Para boletos Bradesco, o usuário informa o número de código de barras, e o sistema faz as
validações/atualizações junto à base de Boletos de Cobrança Bradesco.
Caso seja boleto de outro Banco, o sistema realizará validações/atualizações do boleto na base
da Núclea (CIP), gerando o número de controle do participante vinculado ao boleto. Esse campo será
utilizado nas etapas “Pré-Confirmação” e “Confirmação”.

Endpoint
Realizar requisição conforme abaixo:

• URL de Homologação:
https://proxy.api.prebanco.com.br/oapi/v1/pagamentos/boleto/validarDadosTitulo

• URL de Produção:
https://openapi.bradesco.com.br/oapi/v1/pagamentos/boleto/validarDadosTitulo

4
 Versão 3 - Outubro/2023

LAYOUT DE ENTRADA - VALIDAÇÃO DE DADOS DO TÍTULO

VALIDAÇÃO DE DADOS DO TÍTULO

Obrigatório Tipo
S = sim A=
Limite
Nome N = não Descrição alfanumérico Explicação/Exemplo
Caracteres

C = condicional N = numérico
CÓDIGO DA AGÊNCIA DE
agencia S N 5 -
DÉBITO
tipoEntrada S TIPO ENTRADA N 1 Formato fixo: 1

dadosEntrada S DADOS ENTARDA A 44 Código de barras contém 44 caracteres

Exemplo de Validação de Dados do Título (JSON):

{
"agencia": 1234,
"tipoEntrada": 1,
"dadosEntrada": "23700.00000 00000.112340 00002.222333 4 555500000100"
}

LAYOUT DE RETORNO - VALIDAÇÃO DE DADOS DO TÍTULO

RETORNO DE VALIDAÇÃO DE DADOS DO TÍTULO

Tipo
Limite
Nome Descrição A = alfanumérico Explicação/Exemplo
Caracteres
N = numérico

Códigos de Retorno indicados

CÓDIGO DE RETORNO DE
codigoRetorno N 7 na TABELA GERAL DE CÓDIGOS
SUCESSO
DE RETORNO

Códigos de Retorno indicados

código CÓDIGO DE RETORNO DE ERRO N 7 na TABELA GERAL DE CÓDIGOS
DE RETORNO

Códigos de Retorno indicados

mensagem MENSAGEM DO MOTIVO DO ERRO A - na TABELA GERAL DE CÓDIGOS
DE RETORNO

Formato: AAAAMMDD (Ex.:

dataVencimento DATA DE VENCIMENTO N 8
20231231)

Dias corridos até a data de

vencimento. Calculado a partir
fatorVencimento FATOR DE VENCIMENTO N 4
da data-base à data de
vencimento do título.

Nome do pagador que será

nomePagador NOME DO PAGADOR A 40
registrado no boleto.

5
 Versão 3 - Outubro/2023

CPF/CNPJ do pagador que será

cpfCnpjPagador CPF/CNPJ DO PAGADOR N 15
registrado no boleto.

bancoTitulo CÓDIGO DO BANCO DO BOLETO N 3 Ex.: 237 (Bradesco)

nomeBanco NOME DO BANCO DO BOLETO A 40 Ex.: Bradesco

Nome do cliente beneficiário

NOME DO BENEFICIÁRIO DO
nomeCedente A 50 que está registrando/emitindo
BOLETO
o boleto

CPF/CNPJ do beneficiário que

CPF/CNPJ DO BENEFICIÁRIO
cnpjBeneficiario N 15 está registrando/emitindo o
REGISTRADO NO BOLETO
boleto

Indica se o boleto é cadastrado

tituloDDA TÍTULO DDA A 1 no DDA. Formato fixo: S (sim)
ou N (Não)

Indica se o boleto pode ser

permitePagarBoletoComC PERMITE PAGAR O BOLETO COM pago com cartão de crédito.
A 1
artaoCredito CARTÃO DE CRÉDITO Formato fixo: S (sim) ou N
(Não)

Valor necessário para

valorTitulo VALOR DO TÍTULO N 15
pagamento do título

Informa se o boleto foi

consultado na base da CIP.
consultaCIP CONSULTA CIP A 1
Formato fixo: S (sim) ou N
(Não)
Número de controle que é
enviado à CIP para obter os
numeroControleParticipan NÚMERO CONTROLE
A 20 dados do boleto e que
te PARTICIPANTE
identifica a requisição quando
da resposta da CIP
Informa qual o tipo de
recebimento está registrado no
boleto para pagamento.
aceitaPagarComValorDifer ACEITA PAGAR COM VALOR Formato fixo: 1 (permite
A 1
enteCalculado DIFERENTE DO CALCULADO qualquer valor); 2 (entre o
mínimo e o máximo); 3 (não
aceita valor diferente) e 4
(considera apenas o mínimo)

obrigatorioInformarCpfCn OBRIGATÓRIO INFORMAR Formato fixo: S (Sim) ou N

A 1
jpSacado CPF/CNPJ DO SACADO (Não)

PERMISSÃO PARA REALIZAR O

indPermissaoPagamentoP Formato fixo: S (Sim) ou N
PAGAMENTO DO BOLETO EM A 1
arcial (Não)
PARCELAS

valorDesconto VALOR DO DESCONTO N 15 -

valorAbatimento VALOR DO ABATIMENTO N 15 -

valorBonificacao VALOR DA BONIFICAÇÃO N 15 -

valorMulta VALOR DA MULTA N 15 -

valorJuros VALOR DOS JUROS N 15 -

valorCobrado VALOR COBRADO N 15 -

valorMinimo VALOR MÍNIMO N 15 -

valorMaximo VALOR MÁXIMO N 15 -

nomeFantasiaBeneficiario NOME FANTASIA BENEFICIÁRIO A 40 -

6
 Versão 3 - Outubro/2023

Nome do responsável pela

nomePagadorBoleto NOME DO PAGADOR DO BOLETO A 40 efetivação do pagamento do
boleto.

Exemplo de Retorno com Sucesso (JSON):

Boleto Bradesco:

{
"consultaFatorDataVencimentoResponse": {
"codigoRetorno": 2100,
"dataVencimento": 20231231,
"fatorVencimento": 30,
"bancoTitulo": 237,
"nomeBanco": "BANCO BRADESCO S.A",
"nomeCedente": "FORNECEDOR FICTÍCIO LTDA",
"tituloDDA": "S",
"permitePagarBoletoComCartaoCredito": "S",
"valorTitulo": 100.00,
"consultaCIP": "S",
"aceitaPagarComValorDiferenteCalculado": "3",
"indPermissaoPagamentoParcial": "S",
"cnpjBeneficiario": 123 456 789 10,
"nomePagador": "EMPRESA FICTÍCIA S.A",
"cpfCnpjPagador": 987 654 321 01

},
"consultaDadosTituloCIPResponse": {}
}

Boleto de Outros Bancos:

{
"consultaFatorDataVencimentoResponse": {
"codigoRetorno": 2100,
"dataVencimento": 20231231,
"fatorVencimento": 30,
"bancoTitulo": 237,
"nomeBanco": "BANCO BRADESCO S.A",
"tituloDDA": "S",
"permitePagarBoletoComCartaoCredito": "S",
"valorTitulo": 100.00,
"consultaCIP": "S",
"numeroControleParticipante": “0237CP01232540298556”,
"aceitaPagarComValorDiferenteCalculado": "3",
"indPermissaoPagamentoParcial": "S",
"cnpjBeneficiario": 123 456 789 10,
"cpfCnpjPagador": 987 654 321 01
},
"consultaDadosTituloCIPResponse": {
"codigoRetorno": 2100,
"dataVencimento": 20231231,
"obrigatorioInformarCpfCnpjSacado": "S",
"cpfCnpjCedente": 123 456 789 10,

7
 Versão 3 - Outubro/2023

"nomeCedente": "FORNECEDOR FICTÍCIO LTDA",

"cpfCnpjSacado": 987 654 321 01,
"nomeSacado": "EMPRESA FICTÍCIA S.A",
"valorTitulo": 100.00,
"valorDesconto": 0.00,
"valorAbatimento": 0.00,
"valorBonificacao": 0.00,
"valorMulta": 0.00,
"valorJuros": 0.00,
"valorCobrado": 100.00,
"valorMinimo": 100.00,
"valorMaximo": 100.00,
"aceitaPagamentoComValorDiferenteCalculado": "3",
"indicadorPagamentoParcial": "S",
"nomeFantasiaBeneficiario": ”FORNECEDOR FICTÍCIO LTDA",
"nomePagadorBoleto": "EMPRESA FICTÍCIA S.A"
}
}
Caso os dados recepcionados pela Plataforma Bradesco estejam incorretos ou com má
formatação, o processo será interrompido com retorno de mensagem de erro, conforme exemplo de
layout abaixo:

Exemplo de Retorno com Erro (JSON):

{
"codigo": "2101",
"mensagem": "CODIGO DE BARRAS INVALIDO"
}

4.2. VALIDAÇÃO DADOS DO PAGAMENTO

LAYOUT DE ENTRADA - VALIDAÇÃO DE DADOS DO TÍTULO

LAYOUT DE ENTRADA - VALIDAÇÃO DE DADOS DO PAGAMENTO DO TÍTULO

Obrigatório Tipo

S = sim Limite
Nome Descrição A = alfanumérico Explicação/Exemplo
Caracteres
N = não
C = condicional N = numérico
CÓDIGO DA
agencia S AGÊNCIA DE N 5 -
DÉBITO
IDENTIFICADOR
indicadorFormaCaptura S N 1 Formato fixo: 1
DE CAPTURA
CÓDIGO DE
identificacaoTituloCobranca S N 44 -
BARRAS
DATA DO Formato: AAAAMMDD
dataVencimento S N 8
VENCIMENTO (Ex.: 20231231)
VALOR DO Valor necessário para
valorTitulo S N 15
TÍTULO pagamento do título
DATA DO Formato: AAAAMMDD
dataPagamento S N 8
PAGAMENTO (Ex.: 20231231)
Formato: HHMMSS
HORA DA (Ex.: 235959) Horário
horaTransacao S N 6
TRANSAÇÃO de efetivação da
transação.
IDENTIFICAÇÃO
identificacaoChequeCartao S DO CHEQUE OU N 20 Formato fixo: 0
CARTÃO

8
 Versão 3 - Outubro/2023

INDICADOR DE
indicadorValidacaoGravacao S VALIDAÇÃO E A 1 Formato fixo: N
GRAVAÇÃO
NOME DO
nomeCliente N CLIENTE A 40 -
PAGADOR
VALOR MÍNIMO
valorMinimoIdentificacao N DE N 1 Formato fixo: 0
IDENTIFICAÇÃO
CÓDIGO DO
BANCO DA Formato fixo: 237
bancoContaDebitada S N 3
CONTA (Bradesco)
DEBITADA
CÓDIGO DA
AGÊNCIA DA
agenciaContaDebitada S N 5 -
CONTA
DEBITADA
DÍGITO DA
digitoAgenciaDebitada S AGÊNCIA N 1 -
DEBITADA
CÓDIGO DA
contaDebitada S CONTA N 13 -
DEBITADA
DÍGITO DA
digitoContaDebitada S CONTA N 1 -
DEBITADA
HISTÓRICO
COMPLEMENTAR
dadosSegundaLinhaExtrato N A 32 -
/ 2ª LINHA DE
EXTRATO
Data da intenção de
DATA DO pagamento. Formato:
dataMovimento S N 8
MOVIMENTO AAAAMMDD (Ex.:
20231231)
Deve ser enviado para
pagamento de título
de outros Bancos.
Número de controle
que é enviado à Núclea
(CIP) para obter os
dados do boleto e que
NÚMERO DE identifica a requisição
numeroControleParticipante S CONTROLE DO A 2 quando da resposta da
PARTICIPANTE Núclea (CIP). Nesse
caso, enviar o
conteúdo retornado
no campo de mesmo
nome de saída do
passo 1. Para
pagamento de títulos
Bradesco, enviar "0"
CÓDIGO DO
CPF/CNPJ DE CPF/CNPJ do
cpfCnpjRemetente N N 9
QUEM EMITIU O Remetente do Boleto
BOLETO
CÓDIGO DO
CPF/CNPJ DO CPF/CNPJ do Portador
cpfCnpjPortador N N 9
PAGADOR DO do Boleto
BOLETO
CÓDIGO DO
CPF/CNPJ DA
cpfCnpjDestinatario N PESSOA A QUEM N 9 -
O BOLETO SE
DESTINA

9
 Versão 3 - Outubro/2023

Exemplo de Entrada de Validação de Pagamento do Título (JSON):

{
"agencia": 1234,
"pagamentoComumRequest":{
"contaDadosComum": {
"agenciaContaDebitada": 1234,
"bancoContaDebitada": 237,
"contaDebitada": 5,
"digitoAgenciaDebitada": 8,
"digitoContaDebitada": "2"
},
"dadosSegundaLinhaExtrato": "Sprint",
"dataMovimento": 20231231,
"dataPagamento": 20231231,
"dataVencimento": 20230101,
"horaTransacao": 121505,
"identificacaoTituloCobranca": "0",
"indicadorFormaCaptura": 1,
"valorTitulo": 100.00
},
"destinatarioDadosComum": {
"cpfCnpjDestinatario": 987 654 321 01
},
"identificacaoChequeCartao": 0,
"indicadorValidacaoGravacao": "N",
"nomeCliente": EMPRESA FICTÍCIA S.A
"numeroControleParticipante": "0237CP01232540298556",
"portadorDadosComum": {
"cpfCnpjPortador": 987 654 321 01
},
"remetenteDadosComum": {
"cpfCnpjRemetente": 123 456 789 10
},
"valorMinimoIdentificacao": 0
}

LAYOUT DE RETORNO - VALIDAÇÃO DE PAGAMENTO DO TÍTULO

RETORNO DA VALIDAÇÃO DE PAGAMENTO DO TÍTULO

Tipo
A= Limite
Nome Descrição Explicação/Exemplo
alfanumérico Caracteres
N = numérico
Códigos de Retorno
indicados na TABELA
codigoRetorno CÓDIGO DE RETORNO N 7
GERAL DE CÓDIGOS
DE RETORNO
nomeCedente NOME DO BENEFICIÁRIO A 40 -
valorTitulo VALOR DO BOLETO N 15 -
valorDesconto VALOR DO DESCONTO N 15 -
valorAbatimento VALOR DO ABATIMENTO N 15 -
valorBonificacao VALOR DA BONIFICAÇÃO N 15 -
valorMulta VALOR DA MULTA N 15 -

10
 Versão 3 - Outubro/2023

valorJuros VALOR DOS JUROS N 15 -

valorCobrado VALOR DEVIDO CALCULADO N 15 -
Formato:
dataVencimento DATA DE VENCIMENTO N 8 AAAAMMDD (Ex.:
20231231)
Formato:
dataQuitacao DATA EM QUE O PAGAMENTO SERÁ EFETIVADO N 8 AAAAMMDD (Ex.:
20231231)
Linha código que
contém dados de
linhaDigitavelPrimeiraParte LINHA DIGITÁVEL A 40
boleto, como data de
vencimento e valor
Linha código que
contém dados de
boleto, como data de
linhaDigitavelSegundaParte LINHA DIGITÁVEL N 14 vencimento e valor.
Complemento da
primeira parte da
linha digitável
CodigoCIP CÓDIGO DA CIP N 3
CÓDIGO DO BANCO CENTRALIZADOR DE
bancoProtesto N 3 -
PROTESTO
CÓDIGO DA AGÊNCIA CENTRALIZADORA DE
agenciaProtesto N 5 -
PROTESTO
Formato: AAAAMMDD
DataInstrucaoProtesto DATA DE INSTRUÇÃO DE PROTESTO N 8
(Ex.: 20231231)
Formato: AAAAMMDD
dataEnvioCartorio DATA DE ENVIO AO CARTÓRIO N 8
(Ex.: 20231231)
cpfCnpjPagador CNPJ/CPF DO PAGADOR N 15 -
nomeSacadoDebitado NOME DO PAGADOR A 40 -
valorMinimoPagamento VALOR MÍNIMO PARA PAGAMENTO N 15 -
valorMaximoPagamento VALOR MÁXIMO PARA PAGAMENTO N 15 -
nomeFantasiaBeneficiario NOME FANTASIA DO BENEFICIÁRIO A 40 -
cpfCnpjBeneficiario CNPJ/CPF DO BENEFICIÁRIO DO TÍTULO N 15 -
Deverá ser
informado, caso o
nomeSacadorAvalista NOME DO SACADOR AVALISTA A 40
boleto contenha
beneficiário final

Deverá ser
informado, caso o
cpfCnpjSacadorAvalista CPF/CNPJ DO SACADOR AVALISTA N 15
boleto contenha
beneficiário final
nomePagador NOME DO PAGADOR DO BOLETO A 40 -
NOME DO BANCO BENEFICIÁRIO DO BOLETO DE
nomeBancoBeneficiario A 30 -
COBRANÇA
NOME DO BANCO EM QUE SE ORIGINA O BOLETO
nomeBancoRecebedor A 30 -
DE COBRANÇA
CÓDIGO DO BANCO DE RECEBIMENTO DO
bancoRecebedor N 3 -
PAGAMENTO
CNPJ/CPF DO CLIENTE QUE ESTÁ EFETUANDO O
cpfCnpjContaPagamento N 15 -
PAGAMENTO

tituloAgendado TÍTULO AGENDADO A 1 Informa se o boleto

está agendado ou
não

Exemplo de Retorno de Validação de Pagamento do Título (JSON):

{
"pagamentoComumResponse": {
"codigoRetorno": 2100,
"nomeCedente": ”FORNECEDOR FICTÍCIO LTDA",
"valorTitulo": 100.00,
"valorDesconto": 0.00,
"valorAbatimento": 0.00,
"valorBonificacao": 0.00,
"valorMulta": 0.00,
"valorJuros": 0.00,

11
 Versão 3 - Outubro/2023

"valorCobrado": 100.00,
"dataVencimento": 20231231,
"dataQuitacao": 20231231,
"linhaDigitavelPrimeiraParte": 0,
"linhaDigitavelSegundaParte": 0,
"codigoCIP": "S"
"bancoProtesto": 237,
"agenciaProtesto": 1234,
"dataInstrucaoProtesto": 0,
"dataEnvioCartorio": 0,
"cpfCnpjPagador": 987 654 321 01,
"nomeSacadoDebitado": "EMPRESA FICTÍCIA S.A",
"valorMinimoPagamento": 100.00,
"valorMaximoPagamento": 100.00,
"nomeFantasiaBeneficiario": "FORNECEDOR DA SILVA",
"cpfCnpjBeneficiario": 123 456 789 10,
"cpfCnpjSacadorAvalista": 0,
"nomePagador": "EMPRESA FICTÍCIA S.A",
"nomeBancoBeneficiario": "BANCO BRADESCO S.A",
"nomeBancoRecebedor": "BANCO BRADESCO S.A",
"bancoRecebedor": 0,
"cpfCnpjContaPagamento": 0,
"tituloAgendado": "S"
}
}

Exemplo de Retorno com ERRO da Validação de Pagamento do Título (JSON):

{
"codigo": "2267",
"mensagem": "TRANSACTION ID JÁ EXISTENTE"
}

4.3. EFETIVAR PAGAMENTO

Efetiva o pagamento nas bases do Banco e envia a baixa para a CIP.

Endpoint

Realizar requisição, conforme abaixo:

• URL de Homologação:
https://proxy.api.prebanco.com.br/oapi/v1/pagamentos/boleto/efetivarPagamento

• URL de Produção:
https://openapi.bradesco.com.br/oapi/v1/pagamentos/boleto/efetivarPagamento

12
 Versão 3 - Outubro/2023

LAYOUT DE ENTRADA - EFETIVAÇÃO DE PAGAMENTO DO TÍTULO

EFETIVAÇÃO DO PAGAMENTO DO TÍTULO

Obrigatório Tipo

S = sim A = alfanumérico Limite

Nome Descrição
Caracteres
N = não N = numérico
C = condicional

CÓDIGO DA AGÊNCIA DE
agencia S N 5
DÉBITO

S INDICADOR FORMA DE
indicadorFormaCaptura N 1
CAPTURA
FIXO “1”

identificacaoTituloCobranca S CÓDIGO DE BARRAS N 44

INDICA A FUNÇÃO QUE

S A TRANSAÇÃO
indicadorFuncao REALIZARÁ N 1
1 - PAGAMENTO /
FIXO “1”
AGENDAMENTO

DATA DE VENCIMENTO
dataVencimento S NO FORMATO N 8
AAAAMMDD

VALOR DO BOLETO,
CORRESPONDE AO
valorTitulo S VALOR PELO QUAL O N 15
CLIENTE QUITARÁ O
BOLETO
DATA DO MOVIMENTO
dataMovimento S NO FORMATO N 8
AAAAMMDD
DATA DO PAGAMENTO
dataPagamento S NO FORMATO N 8
AAAAMMDD
HORA DA TRANSAÇÃO
horaTransacao S N 6
NO FORMATO HHMMSS
CÓDIGO DO BANCO DA
bancoContaDebitada S N 3
CONTA DEBITADA
CÓDIGO DA AGÊNCIA
agenciaContaDebitada S N 5
DA CONTA DEBITADA
DÍGITO DA AGÊNCIA
digitoAgenciaDebitada S N 1
DEBITADA
CÓDIGO DA CONTA
contaDebitada S N 13
DEBITADA
DÍGITO DA CONTA
digitoContaDebitada S A 2
DEBITADA
HISTÓRICO
dadosSegundaLinhaExtrato S COMPLEMENTAR / 2ª A 32
LINHA DE EXTRATO
DEVE SER ENVIADO
PARA PAGAMENTO DE
TÍTULO DE OUTROS
BANCOS. NESSE CASO,
numeroControleParticipante S ENVIAR O CONTEÚDO A 20
RETORNADO NO
CAMPO DE MESMO
NOME DA SAÍDA DO
PASSO 1.

13
 Versão 3 - Outubro/2023

PARA PAGAMENTO DE
TÍTULOS BRADESCO
ENVIAR “0”
TRANSACTION ID
transactionId S ENVIADO PELO N 9
USUÁRIO

N VALOR MÍNIMO DE
valorMinimoIdentificacao N 1
IDENTIFICAÇÃO
FIXO “0”
CÓDIGO DO CPF/CNPJ
cpfCnpjRemetente S DO REMETENTE DO N 9
BOLETO
CÓDIGO DO CPF/CNPJ
DO PORTADOR DO
cpfCnpjPortador S N 9
TÍTULO ATIVO NA
RECEITA FEDERAL
nomeCliente S NOME DO CLIENTE N 40
CÓDIGO DO CPF/CNPJ
cpfCnpjDestinatario N DO DESTINATÁRIO DO N 9
BOLETO

Exemplo de Efetivação do Pagamento do Título (JSON):

{
"agencia": 1234,
"pagamentoComumRequest":{
"contaDadosComum": {
"agenciaContaDebitada": 1234,
"bancoContaDebitada": 237,
"contaDebitada": 5,
"digitoAgenciaDebitada": 8,
"digitoContaDebitada": "2"
},
"dadosSegundaLinhaExtrato": "Sprint",
"dataMovimento": 20231231,
"dataPagamento": 20231231,
"dataVencimento": 20230101,
"horaTransacao": 121505,
"identificacaoTituloCobranca": "0",
"indicadorFormaCaptura": 1,
"valorTitulo": 100.00
},
"destinatarioDadosComum": {
"cpfCnpjDestinatario": 987 654 321 01
},
"identificacaoChequeCartao": 0,
"indicadorValidacaoGravacao": "N",
"nomeCliente": EMPRESA FICTÍCIA S.A
"numeroControleParticipante": "0237CP01232540298556",
"portadorDadosComum": {
"cpfCnpjPortador": 987 654 321 01
},
"remetenteDadosComum": {
"cpfCnpjRemetente": 123 456 789 10
},
"valorMinimoIdentificacao": 0
}

14
 Versão 3 - Outubro/2023

LAYOUT DE RETORNO - EFETIVAÇÃO DE PAGAMENTO DO TÍTULO

RETORNO DE EFETIVAÇÃO DE PAGAMENTO DO TÍTULO

Tipo
Nome A = alfanumérico Limite Caracteres OBSERVAÇÕES
N = numérico

codigoRetorno N 7 CÓDIGO DE RETORNO

nomeCedente A 40 NOME DO BENEFICIÁRIO

numeroProtocoloCBCA N 15 NÚMERO DO PROTOCOLO GERADO PELO BANCO

valorTitulo N 15 VALOR DO TÍTULO

valorDesconto N 15 VALOR DO DESCONTO

valorAbatimento N 15 VALOR DO ABATIMENTO

valorBonificacao N 15 VALOR DA BONIFICAÇÃO

valorMulta N 15 VALOR DA MULTA

valorJuros N 15 VALOR DOS JUROS

valorCobrado N 15 VALOR DEVIDO CALCULADO

dataVencimento N 8 DATA DE VENCIMENTO NO FORMATO AAAAMMDD

DATA DE QUITAÇÃO

dataQuitacao N 8
FORMATO AAAAMMDD, CORRESPONDE À DATA EM
QUE O PAGAMENTO SERÁ EFETIVADO

linhaDigitavelPrimeiraParte A 40 LINHA DIGITÁVEL - IMPRESSÃO DO COMPROVANTE

LINHA DIGITÁVEL, CORRESPONDE AO FATOR +

linhaDigitavelSegundaParte N 14
VALOR DO TÍTULO

CÓDIGO DA CIP (CARTELA DE INSTRUÇÃO

codigoCIP N 3
PERMANENTE)

CÓDIGO DO BANCO CENTRALIZADOR DE

bancoProtesto N 3
PROTESTO

15
 Versão 3 - Outubro/2023

CÓDIGO DA AGÊNCIA CENTRALIZADORA DE

agenciaProtesto N 5
PROTESTO

DATA DE INSTRUÇÃO DE PROTESTO NO FORMATO

dataInstrucaoProtesto N 8
AAAAMMDD

DATA DE ENVIO AO CARTÓRIO NO FORMATO

dataEnvioCartorio N 8
AAAAMMDD

cpfCnpjPagador N 15 CNPJ/CPF DO PAGADOR

nomeSacadoDebitado A 40 NOME DO PAGADOR

valorMinimoPagamento N 15 VALOR MÍNIMO PARA PAGAMENTO

valorMaximoPagamento N 15 VALOR MÁXIMO PARA PAGAMENTO

nomeFantasiaBeneficiario A 40 NOME FANTASIA DO BENEFICIÁRIO

cpfCnpjBeneficiario N 15 CNPJ/CPF DO BENEFICIÁRIO DO BOLETO

RAZÃO SOCIAL DO BENEFICIÁRIO FINAL,

nomeSacadorAvalista A 40 INFORMADO CASO O BOLETO TENHA
BENEFICIÁRIO FINAL

CNPJ/CPF DO BENEFICIÁRIO FINAL, INFORMADO

cpfCnpjSacadoAvalista N 15
CASO O BOLETO TENHA BENEFICIÁRIO FINAL

NOME DO PAGADOR CONTRA QUEM FOI EMITIDO O

nomePagador A 40
BOLETO

NOME DO BANCO BENEFICIÁRIO DO BOLETO DE

nomeBancoBeneficiario A 30
COBRANÇA

NOME DO BANCO RECEBEDOR DO BOLETO DE

nomeBancoRecebedor A 30
COBRANÇA

CÓDIGO DO BANCO DE RECEBIMENTO DO

bancoRecebedor N 3
PAGAMENTO

16
 Versão 3 - Outubro/2023

CNPJ/CPF DO CLIENTE QUE ESTÁ EFETUANDO O

cpfCnpjContaPagamento N 15
PAGAMENTO

Exemplo de Efetivação de Pagamento do Título (JSON):

{
"numeroProtocoloCBCA": 0,
"pagamentoComumResponse": {
"codigoRetorno": 0,
"nomeCedente": ”EMPRESA FICTÍCIA S.A”,
"valorTitulo": 100.00,
"valorDesconto": 0.00,
"valorAbatimento": 0.00,
"valorBonificacao": 0.00,
"valorMulta": 0.00,
"valorJuros": 0.00,
"valorCobrado": 100.00,
"dataVencimento": 20231231,
"dataQuitacao": 20231231,
"linhaDigitavelPrimeiraParte": "0",
"linhaDigitavelSegundaParte": 0,
"codigoCIP": 0,
"bancoProtesto": 237,
"agenciaProtesto": 1234,
"dataInstrucaoProtesto": 20231231,
"dataEnvioCartorio": 20231231,
"cpfCnpjPagador": 123 456 789 10,
"nomeSacadoDebitado": ”EMPRESA FICTÍCIA S.A”,
"valorMinimoPagamento": 100.00,
"valorMaximoPagamento": 100.00,
"nomeFantasiaBeneficiario": ”EMPRESA FICTÍCIA S.A”,
"cpfCnpjBeneficiario": 123 456 789 10,
"nomeSacadorAvalista": ”EMPRESA FICTÍCIA S.A”,
"cpfCnpjSacadorAvalista": 123 456 789 10,
"nomePagador": ”EMPRESA FICTÍCIA S.A”,
"nomeBancoBeneficiario": "BANCO BRADESCO S.A",
"nomeBancoRecebedor": "BANCO BRADESCO S.A",
"bancoRecebedor": 237,
"cpfCnpjContaPagamento": 123 456 789 10
}
}
Exemplo de ERRO da Efetivação de Pagamento do Título (JSON):
{
"codigo": "2267",
"mensagem": "TRANSACTION ID JÁ EXISTENTE"
}

17
 Versão 3 - Outubro/2023

Caso os dados recepcionados pela Plataforma Bradesco estejam incorretos, com má formatação
ou dados divergentes com os dados do boleto, o processo será interrompido com retorno de
mensagem de erro, conforme TABELA DE CÓDIGOS DE RETORNO abaixo:

5. TABELA GERAL DE CÓDIGOS DE RETORNO

TABELA GERAL DE CÓDIGOS DE RETORNO

CÓDIGO DE
TIPO DE
RETORNO DESCRIÇÃO
RETORNO
(MAINFRAME)
2100 PAGAMENTO EFETUADO SUCESSO
2101 CÓDIGO DE BARRAS INVÁLIDO ERRO
2102 CÓDIGO DE BARRAS NÃO IDENTIFICADO COMO TÍTULO DE COBRANÇA ERRO
2103 DATA DE VENCIMENTO NÃO INFORMADA / INCONSISTENTE ERRO
2104 VALOR DO TÍTULO NÃO INFORMADO / INCONSISTENTE ERRO
2105 CÓDIGO DO BANCO NÃO ENCONTRADO ERRO
2106 BANCO DESTINATÁRIO INOPERANTE ERRO
2107 TÍTULO DE OUTRO BANCO VENCIDO PARA ESTA DATA ERRO
2108 TÍTULO DE OUTRO BANCO VENCIDO - MOVTO COMPENSAÇÃO ENCERRADO ERRO
2109 TÍTULO DE BANCO DA ORGANIZAÇÃO VENCIDO PARA ESTA DATA ERRO
2110 ERRO NA OBTENÇÃO DO NÚMERO DO PROTOCOLO ERRO
2111 SISTEMA INDISPONÍVEL ( EM ATUALIZAÇÃO ) ERRO
2112 VALOR CALCULADO DIVERGE DO VALOR INFORMADO ERRO
2113 TÍTULO NÃO REGISTRADO (VERIFICAR INSTRUÇÕES NA PAPELETA) ERRO
2114 TÍTULO COM INSTRUÇÃO DE PROTESTO, PROCURE O BENEFICIÁRIO ERRO
2115 TÍTULO COM INSTRUÇÃO DE PROTESTO, PROCURE O BENEFICIÁRIO ERRO
2116 TÍTULO EFETIVAMENTE PROTESTADO ERRO
2117 MOEDA DO TÍTULO DIFERENTE DA MOEDA CORRENTE ERRO
2118 VALOR INFORMADO MAIOR QUE O LIMITE PERMITIDO ERRO
2121 MÍDIA DE PAGAMENTO NÃO CADASTRADA ERRO
2122 SALDO INSUFICIENTE ERRO
2124 SISTEMA INDISPONÍVEL ERRO
2125 TÍTULO BAIXADO COMO PAGO ERRO
2126 DADOS INFORMADOS INCONSISTENTES ERRO
2134 VALOR INFORMADO MENOR QUE O LIMITE PERMITIDO ERRO
2135 TÍTULO COM PAGAMENTO DUPLICADO ERRO
2136 PAGTO EFETUADO APÓS HORÁRIO DE FECHAMENTO P/ OUTROS BANCOS SUCESSO
2137 CANAL NÃO ACEITA CANCELAMENTO ERRO
2138 PAGAMENTO NÃO ENCONTRADO ERRO
2239 PGTO DESTE TÍTULO NÃO É PERMITIDO, FAVOR PROCURAR BCO EMISSOR ERRO
2144 TÍTULO BRADESCO SEM REGISTRO VENCIDO ERRO
2143 CONSULTA EFETUADA SUCESSO
2145 VALOR ACIMA DO PERMITIDO PARA A MÍDIA ERRO
2146 DATA DE PAGAMENTO INVÁLIDA ERRO
2148 INDICADOR DE CONSULTA DEVE SER 1, 2 OU 3 ERRO
2149 TÍTULO NÃO ENCONTRADO NAS BASES DA COBRANÇA ERRO
2154 AGENDAMENTO EFETUADO SUCESSO
2156 HORÁRIO ENCERRADO PARA PAGAMENTO DE TÍTULOS DE OUTROS BANCOS ERRO

18
 Versão 3 - Outubro/2023

2157 HORÁRIO ENCERRADO PARA PAGAMENTOS DE TÍTULOS DO BRADESCO ERRO

2158 DATA PARA PAGAMENTO EXCEDE O LIMITE PERMITIDO ERRO
2159 ERRO DE CONEXÃO COM O CICS ERRO
2160 ERRO DE CONEXÃO COM A AGÊNCIA ERRO
2161 PARÂMETROS INVÁLIDOS ERRO
2162 VALOR INFORMADO EXCEDE O LIMITE DIÁRIO ERRO
2163 BANCO NÃO OPERANTE - RECEB BLOQUEADO ERRO
2165 TÍTULO COM INSTRUÇÃO DE PROTESTO, SOLICITE AUTORIZAÇÃO ERRO
2167 TÍTULO COM INSTRUÇÃO PROTESTO, SOLICITE AUTORIZAÇÃO-NÃO VINC ERRO
2168 TÍTULO NÃO ENCONTRADO NAS BASES DA COBRANÇA ERRO
2170 TÍTULO COM INSTRUÇÃO DE PROTESTO - PROCURE CENTRALIZADORA ERRO
2171 TÍTULO COM INSTRUÇÃO DE PROTESTO, DIRIGIR AO CARTÓRIO ERRO
2172 TÍTULO EFETIVAMENTE PROTESTADO ERRO
2173 TÍTULO PROTESTADO ERRO
2174 VALOR DEVIDO MENOR DO QUE OS DESCONTOS ERRO
2177 RECEBIMENTO BLOQUEADO, O PAGADOR DEVE PROCURAR O BENEFICIÁRIO ERRO
2179 ERRO NO ACESSO ÀS BASES DE DADO ERRO
2184 INCONSISTÊNCIA NO CÓDIGO DE BARRA ERRO
2185 CLIENTE SÓ ACEITA PAGAMENTO EM DINHEIRO ERRO
2186 LINHA DIGITÁVEL INVÁLIDA ERRO
2187 CAPTURA DO CÓDIGO DE BARRAS INVÁLIDA ERRO
2188 CPF/CNPJ DO PAGADOR INVÁLIDO ERRO
2189 CPF/CNPJ BENEFICIÁRIO INVÁLIDO ERRO
2193 VALOR INFORMADO INVÁLIDO ERRO
2194 CONSULTA EFETUADA TÍTULO VENCIDO SUCESSO
2197 CNPJ/CPF DO PROPRIETÁRIO INVÁLIDO ERRO
2198 CNPJ/CPF DO PORTADOR INVÁLIDO ERRO
2199 CNPJ/CPF DO FAVORECIDO INVÁLIDO ERRO
2205 LIMITE FORNECIMENTO EXCEDIDO. FAVOR DIRIGIR-SE A SUA AGÊNCIA ERRO
2207 CONTA CADASTRADA COMO GARANTIA PAGAMENTO NÃO PERMITIDO ERRO
2210 CONTA-CORRENTE NÃO PERMITIDA ERRO
2232 NÃO ENCONTRADO-ENTRE EM CONTATO COM EMP BENEFICIÁRIA TÍTULO ERRO
2234 TÍTULO INDISPONÍVEL P/ VISUALIZAR, ENTRE EM CONTATO COM BENEFICIÁRIO ERRO
2235 TÍTULO PAGO VINCULADO ERRO
2236 TÍTULO PAGO NO DIA ERRO
2237 TÍTULO EM SITUAÇÃO DE PROTESTO ERRO
2238 BENEFICIÁRIO NÃO PERMITE PAGAMENTO DE TÍTULO VENCIDO ERRO
2239 PGTO DESTE TÍTULO NÃO É PERMITIDO, FAVOR PROCURAR BCO EMISSOR ERRO
2240 BENEFICIÁRIO NÃO PERMITE ALTERAÇÃO DE VALOR PARA PAGTO DO TÍTULO ERRO
2241 VALOR INFORMADO DIVERGE DO AUTORIZADO PELO BENEFICIÁRIO ERRO

6. TABELA GERAL DE CÓDIGOS DE RETORNO - CANAL

TABELA GERAL DE CÓDIGOS DE RETORNO - CANAL

CÓDIGO DE
TIPO DE
RETORNO DESCRIÇÃO
RETORNO
(CANAL)
200 SUCESSO NA TRANSAÇÃO SUCESSO
400 BAD RESQUEST - ERRO NA FORMATAÇÃO DOS CAMPOS ERRO
401 UNAUTHORIZED - FALHA NA AUTENTICAÇÃO ERRO
403 FOBBIDEN - FALHA NA AUTENTICAÇÃO ERRO
404 NOT FOUND - FALHA NA CONECTIVIDADE (ENDEREÇO INCORRETO) ERRO
422 ERRO NA TRANSAÇÃO - CONSULTAR CÓDIGO DE RETORNO MAINFRAME ERRO

19
 Versão 3 - Outubro/2023

500 INTERNAL SERVER ERROR - SISTEMA INDISPONÍVEL (SLA) ERRO

2242 DATA INFORMADA EXCEDEU À DATA-LIMITE DE PAGAMENTO ERRO
2243 NÃO É PERMITIDO O PGTO DE BOLETO COM VALOR DESATUALIZADO ERRO
2245 HORÁRIO NÃO PERMITIDO P/ PGTO DE BOLETO OUTROS BCOS VENCIDO ERRO
2248 PAGTO DE TÍTULO VENCIDO NÃO AUTORIZADO PELO BENEFICIÁRIO ERRO
2249 TÍTULO VLR SUP NÃO DDA, PGTO DEVE SER FEITO NO BCO DESTINATÁRIO ERRO
2250 HORÁRIO NÃO PERMITIDO PARA PAGAMENTO DE TÍTULO SUPERIOR ERRO
2256 PAGTO NÃO PERMITIDO. POR FAVOR, PROCURE O BANCO DESTINATÁRIO ERRO
2257 BENEFICIÁRIO BLOQUEADO PARA RECEBIMENTO DE PAGAMENTO ERRO
2258 TÍTULO BLOQUEADO PARA PAGAMENTO ERRO
2259 TÍTULO NÃO DISPONÍVEL PARA PAGAMENTO, PROCURAR INSTITUIÇÃO ERRO
2260 TÍTULO NÃO DISPONÍVEL PARA PGTO NO MOMENTO. TENTE MAIS TARDE ERRO
2261 VALOR INFERIOR AO MÍNIMO PERMITIDO ERRO
2262 VALOR SUPERIOR AO MÁXIMO PERMITIDO ERRO
2268 O PORTADOR NÃO FOI LOCALIZADO NA RECEITA FEDERAL ERRO
2269 O PORTADOR NÃO PODE SER IGUAL À INSTITUIÇÃO FINANCEIRA ERRO
2264 TEMPO DE RESPOSTA EXCEDIDO. POR FAVOR, TENTE MAIS TARDE ERRO

7. COMPROVANTE AO PAGADOR FINAL

Para a emissão do comprovante ao pagador final, é obrigatório informar os dados mínimos exigidos
pela FEBRABAN, conforme abaixo:

COMPROVANTE AO PAGADOR FINAL

NOME DO CAMPO DE RECIBO DESCRIÇÃO DO CAMPO

Banco Recebedor Nome da Instituição recebedora do boleto.

Pagamento de Boleto Título da transação.
Linha Digitável do Código de Barras Representação numérica da barra do boleto.
Instituição Emissora Nome da Instituição que emitiu o boleto.
Beneficiário Título do grupo de dados referentes ao beneficiário.
Nome Fantasia Nome fantasia cadastrado, se Beneficiário PJ.
Razão Social Nome do cliente - PJ ou PF.
CNPJ/CPF N° do documento do beneficiário.
Sacador / Avalista Título do grupo de dados referentes ao sacador avalista.
Razão Social (Avalista) Nome do cliente - PJ ou PF.
CNPJ/CPF (Avalista) N° do documento do sacador avalista.
Pagador Título do grupo de dados referentes ao cliente pagador.
Nome Nome do cliente - PJ ou PF.
CNPJ/CPF N° do documento do pagador.
Título do grupo de dados referentes ao cliente pagador final, ou seja, aquele que
Pagador Final
efetivamente está liquidando o boleto.
CNPJ/CPF N° do documento do pagador final.
Data de Vencimento Data de vencimento do boleto de pagamento.
Valor Nominal Valor do boleto de pagamento antes de juros/multa, descontos ou abatimentos.
Valor calculado a título de juros e/ou multa (para casos de incidência de ambos, apresentar
Encargos
no campo valor somado).
Valor calculado a título de desconto e/ou abatimento (para casos de incidência de ambos,
Descontos
apresentar no campo valor somado).
Valor Pago Valor efetivamente pago pelo cliente pagador.
Data Data da transação.
Hora Hora da transação.
Autenticação N° da autenticação mecânica.

8. DÚVIDAS FREQUENTES

a) Qual o formato padrão para disponibilizar o comprovante ao pagador final?

20
 Versão 3 - Outubro/2023

O comprovante deve seguir o padrão com os dados mínimos estipulados pela FEBRABAN.

b) É possível realizar o pagamento de boletos de cobrança vencidos de outros Bancos?

Sim, desde que o boleto esteja registrado nessa condição. No entanto, somente é permitido o
pagamento em dias úteis.

c) É possível efetuar pagamento em duplicidade?

Sim, desde que o beneficiário registre o boleto nessa condição.

d) Qual o tamanho do Campo ID transaction?

Atualmente, o campo ID transaction aceita até 9 (nove) caracteres.

e) Como são realizados os testes de pagamento API?

O suporte disponibilizará massas de boletos de cobrança Bradesco e de outros Bancos em ambiente

de homologação contendo diversos cenários.

f) Para pagamento que possui desconto, abatimento, juros e multa, quem calcula o valor final
para o cliente?

O Banco fornecerá o valor já calculado, além de disponibilizar as informações do desconto, abatimento,

juros e multa que compõe o valor total final.

g) É possível efetuar pagamento com valor a menor?

Sim, desde que o beneficiário registre o boleto nessa condição.

h) O parceiro pode utilizar qualquer conta para pagamento?

O parceiro deve utilizar a Agência e conta própria do parceiro acordado em contrato.

i) O que deve ser informado no CPF/CNPJ do portador?

Deve ser informado um CPF/CNPJ válido e que esteja cadastrado na Receita Federal.

Obs.: quando o pagamento for realizado por um intermediador, o CPF/CNPJ informado deve ser
diferente do cadastrado na conta de débito.

j) Como montar um Código de Barras e Linha Digitável do Boleto de Cobrança?

Contém 44 (quarenta e quatro) posições, composto por:

Posição Tamanho Conteúdo

01 a 03 3 Identificação do Banco
04 a 04 1 Código da Moeda (Real = 9, Outras = 0)
05 a 05 1 Dígito Verificador do Código de Barras
06 a 09 4 Fator de Vencimento
10 a 19 10 Valor
20 a 44 25 Campo Livre

21
 Versão 3 - Outubro/2023

9. SUPORTE

Regras técnicas da API: dúvidas técnicas relacionadas à conectividade e ao consumo da

API, entrar em contato com a nossa Central de Suporte, pelo e-mail:
suporte.api@bradesco.com.br.

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

Regras de Negócio da API: em caso de dúvidas relacionadas ao negócio, entrar em

contato com a nossa Central de Atendimento (AOC), pelo e-mail: suportetransacoes
api@bradesco.com.br.

Horário de atendimento: 08h às 17h, de segunda a sexta-feira.

22