Manual API Pagtos Contas Tributos Via Cód. Barras

MANUAL E LAYOUT
API DE PAGAMENTO DE CONTAS DE CONSUMO

E TRIBUTOS VIA CÓDIGO DE BARRAS
Versão 13 - setembro/23
Manual de API - Pagamento de Contas de Consumo e Tributos via Código de Barras - Versão 13 - Set/2023
SUMÁRIO
1. OBJETIVO...................................................................................................................................................... 4
2. PRÉ-REQUISITOS......................................................................................................................................... 5
3. CONDIÇÕES DE PAGAMENTOS................................................................................................................. 6
4. IDENTIFICANDO UMA GUIA DE ARRECADAÇÃO..................................................................................... 7
5. FLUXO DE PAGAMENTOS DE ARRECADAÇÃO....................................................................................... 8
6. LAYOUTS DE COMUNICAÇÃO PARA INCLUSÃO DE PAGAMENTO..................................................... 9
6.1. Entrada do Pagamento...................................................................................................................... 9
6.2. Saída do Pagamento........................................................................................................................... 10
6.3. Códigos de Retorno da Transação de Negócio.............................................................................. 17
7. CONSULTAR PAGAMENTO EFETUADO................................................................................................... 19
7.1. Entrada da Consulta........................................................................................................................... 19
7.2. Saída da Consulta................................................................................................................................ 20
7.3. Códigos de Retorno da Transação de Negócio.............................................................................. 27
8. CÓDIGOS DE RETORNO DO SERVIDOR HTTP.......................................................................................... 28
9. SUMARIZAÇÃO DE DÉBITOS...................................................................................................................... 29
10. COMPROVANTES DE PAGAMENTO.......................................................................................................... 30
10.1. DARF Preto Europa 5-0064.............................................................................................................. 30
10.2. DARF Preto Europa 5-0153............................................................................................................... 32
10.3. Simples Nacional............................................................................................................................... 33
10.4. DARF Numerado................................................................................................................................. 34
10.5. E-Social............................................................................................................................................... 35
10.6. FGTS/GRF sem Tomador.................................................................................................................. 36
10.7. FGTS/GRF com Tomador................................................................................................................. 38
10.8. SEFAZ/SP GARE IPVA PPD................................................................................................................ 40
10.9. SEFAZ/SP GARE IPVA 036................................................................................................................. 42
10.10. SEFAZ/SP GARE IPVA AIIM............................................................................................................. 44
10.11. SEFAZ/SP GARE IPVA Dívida Ativa................................................................................................ 46
10.12. SEFAZ/SP GARE PPD....................................................................................................................... 48
10.13. SEFAZ/SP GNRE............................................................................................................................... 50
10.14. SEFAZ/SP DARE............................................................................................................................... 52
10.15. SEFAZ/SP GARE ICMS PEP............................................................................................................. 54
10.16. SEFAZ/SP GARE ICMS GERAL........................................................................................................ 56
10.17. SEFAZ/PR.......................................................................................................................................... 58
10.18. Comprovante Genérico Demais Tributos................................................................................... 59
10.19. Comprovante Concessionárias.................................................................................................... 61

11. FAQ................................................................................................................................................................. 62
12. SUPORTE....................................................................................................................................................... 64
13. TABELA DE VERSÕES.................................................................................................................................. 65
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 Pagamentos de tributos e contas de consumo de
arrecadação.
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.
4
2. PRÉ-REQUISITOS
Para a utilização do pagamento de guias de arrecadação via API, será necessário:
✓ Público-alvo: Clientes Pessoa Jurídica;
✓ Firmar Contrato de Correspondente Bancário Eletrônico;
✓ Gerar/obter o ID da aplicação;
✓ Gerar o par de chaves - privada e pública;
✓ Gerar o JWT assertion para requisição do Access-Token1;
✓ Obter o Access Token JWT (auth/server/v1.1/token)1;
✓ Gerar a assinatura do request de serviço1;
✓ Chamar o serviço de exemplo (/v1.1/jwt-service) 1.
1
Conforme especificações do manual de conectividade.
5
3. CONDIÇÕES DE PAGAMENTOS
Após o desenvolvimento, testes e validação concluída, o cliente estará apto para iniciar a
conectividade e efetuar os pagamentos de guias de arrecadação de forma on-line, conforme condições
e tipos de recebimento de cada concessionária ou Órgão público.
A API está preparada para receber diversas condições de pagamentos de guias, como:
✓ Inclusão de agendamento;
✓ Com valor divergente;
✓ Juros/multa após o vencimento;
✓ Desconto/abatimento para pagamento antecipado;
✓ A vencer/vencido;
✓ Pagamentos duplicados ou não, conforme regras do emissor do documento;
✓ Moeda indexada.
Não disponível:
✓ Cancelamento de pagamento.
6
4. IDENTIFICANDO UMA GUIA DE ARRECADAÇÃO
(Tributos e Contas de Consumo: Água, Luz, Telefone e Gás)
Identificação do Produto: constante “8” para identificar um documento de arrecadação.
Identificação do Segmento:
1. Prefeituras;
2. Saneamento;
3. Energia Elétrica e Gás;
4. Telecomunicações;
5. Órgãos Governamentais Estaduais e Federais;
6. Empresas de Segmentos Diversos;
7. Multas de Trânsito;
9. Uso do Banco.
Identificação da Empresa: está nas posições 16 a 19 do código de barras. Para o Segmento 6, a

identificação da empresa está nas posições 16 a 23 do código de barras, que correspondem ao CNPJ
base do emissor do documento de arrecadação.
7
5. FLUXO DE PAGAMENTOS DE ARRECADAÇÃO
Para realizar o pagamento de guias de arrecadação, poderão ser seguidos os 2 (dois) passos
abaixo:
✓ Consulta (campo tipoRegistro = 0)

Esse recurso faz a validação dos dados informados pelo cliente para certificar que os mesmos
serão aceitos para realização do pagamento.
✓ Efetivação (campo tipoRegistro = 1)
Esse recurso possui duas funcionalidades: realiza a etapa anterior de consulta e concretiza o
pagamento, eliminando, dessa forma, a necessidade de enviar o tipoRegistro=0, conforme a
necessidade do cliente.
8
6. LAYOUTS DE COMUNICAÇÃO PARA INCLUSÃO DE PAGAMENTO

URL de Homologação:
https://proxy.api.prebanco.com.br/oapi/v1/pagamentos/pagamentoContaConsumo
URL de Produção:
https://openapi.bradesco.com.br/oapi/v1/pagamentos/pagamentoContaConsumo
6.1 Entrada do Pagamento

Relação dos campos para inclusão de pagamento:
Swagger - API Arrecadações v1.0.14
Nome Tipo/Tamanho Obrigatório Exemplo Descrição
agencia Numérico (int32;4) Sim “agencia”: 3975 Código da Agência
Agência onde está instalado

agenciaTerminal Numérico (int32) Não “agenciaTerminal”: 3975
o Terminal
"codigoBarras":
Código de Barras a ser
codigoBarras String (44 dígitos) Sim "826000000005262009714
pago/consultado
87208527468121514520072"
conta Numérico (int64;7) Sim "conta": 15478 Número da Conta
Data do Débito (formato:

dataDebito String Sim "dataDebito": "2021-02-01"
yyyy-mm-dd)
String (máximo 32 "descricaoCliente": "Teste Descrição do Pagamento

descricaoCliente Não
caracteres) Manual" pelo Cliente
"digitoAgencia": 0
digitoAgencia Numérico (int32;1) Sim Dígito da Agência
digitoConta String (1) Sim "digitoConta": "4" Dígito da Conta

Identificação única da
transação para a API
String (máximo 9
Arrecadações. Essa
idTransacao caracteres) Não "idTransacao": "4x99",
informação pode ser
[a-zA-Z0-9]{1,9}
utilizada para consultas
posteriores.
1 - Conta-Corrente
2 - Poupança
tipoConta Numérico (int32;1) Não "tipoConta": 1
5 - Conta-Corrente /
Poupança
0 - Consulta
tipoRegistro Numérico (int32;1) Sim "tipoRegistro": 1
1 - Inclusão
Valor de Débito Digitado

valorPrincipal Numérico (double) Sim "valorPrincipal": 52.62
(formato: 000000000.00)
9
Body exemplo:
{
"agencia": 3963,
"codigoBarras": "82600000000526200971487208527468121514520072",
"conta": 404,
"dataDebito": "2021-03-11",
"digitoAgencia": 0,
"digitoConta": "4",
"idTransacao": "502R",
"tipoConta": 1,
"tipoRegistro": 1,
"valorPrincipal": 52.62
}
6.2 Saída do Pagamento

Os campos abaixo serão devolvidos após o envio do pagamento, e o preenchimento
ou não dos mesmos será variável, conforme o tipo de conta de consumo ou tributo pago.
Em caso de não efetivação, será devolvido um código de erro.
Nome Tipo Tamanho Descrição
Código de Retorno da execução (ver item 6.3
Código de Retorno Numérico 03 “Códigos de Retorno da Transação de Negócio”
abaixo)
Código de erro retornado pelo gerenciador de
SQL CODE Numérico 03
banco de dados DB2
Banco Numérico 03 Número do Banco (Fixo: 237)
Agência Numérico 05 Código da Agência
Conta Numérico 13 Número da Conta
Tipo da Conta Numérico 02 01 - Conta-Corrente
Conta de Débito Numérico 13
Nome do Cliente String 32
Tipo de Operação String 01 Validação de Saldo
Número do Periférico Numérico 08
Número Sequência / Transação Numérico 04
Autenticação Bancária Numérico 09 Número utilizado para os comprovantes
Data de Débito Numérico 08 Data de Débito no Formato AAAAMMDD
Data de Vencimento Numérico 08 Data do Vencimento no Formato AAAAMMDD
Valor Original do Código de Barras
Valor do Tributo Numérico 13
(99999999999DD)
Valor Pago Numérico 13 Valor do Débito (99999999999DD)
Valor da Multa Numérico 13 Valor da Multa (99999999999DD)
Valor Juros de Mora Numérico 13 Valor dos Juros / Mora (99999999999DD)
Valor Desconto Numérico 13 Valor do Desconto (99999999999DD)
Exercício Numérico 04 Ano do Exercício. Se vier 0000, não existe exercício.
Número da Parcela Numérico 02 Número da Parcela
Código do Tributo Numérico 02 Código do Tributo
Número do NR Numérico 02 Número do NR
Identificação do Pagamento String 40 Descrição do Tributo
10
Nome do Campo-Chave
Identificação do Campo-Chave String 23 Campo-Chave do Documento (Utilizando apenas
para o DARF 50385)
Campo-Chave do Documento
Nome do Campo-Chave (Utilizando apenas para o

Campo-Chave Identificação do DARF 50385)
String 15
Documento
Número do Documento GARE ICMS Geral (Convênio
5-0489), composto pelas posições 31 a 44 do
código de barras
Nome Fantasia String 20
Tipo de Serviço da Empresa (vide descrição da

Tipo de Serviço Numérico 02
transação pcon2360)
Título Débito Automático String 25 Tipo de Débito Automático

Formato do Documento String 30 Forma do Documento
Forma de Digitação String 25 Forma de Digitação Documento
Status do Débito Automático
Status Débito Automático Numérico 01 0 - Empresa cadastrada no Débito Automático
1 - Empresa NÃO cadastrada no Débito Automático
Título PCON String 40 Título PCON
Linha Detalhe 1 String 40
Competência Numérico 06 Competência (MMAAAA)
Data de Validade Numérico 08 Data de Validade (AAAAMMDD)
CNPJ ou CEI ou Identificador Numérico 14 CNPJ ou CEI ou Identificador
Identifica o tipo de comprovante que deve ser
impresso:
01 - IPTU - PMSP
02 - Demais Tributos
03 - Concessionárias
04 - FGTS - imprimir campo (lacre de conectividade)
digitado
05 - FGTS - imprimir campo (Identificador) -
digitado
06 - FGTS - imprimir os dois campos digitados
07 - IPTU - On-Line
08 - ISS - On-Line
09 - FGTS - imprimir sem os campos digitados
Tipo de Comprovante Numérico 02
10 - GARE-ICMS
11 - Taxa de Incêndio
12 - GNRE - DI / DSI
13 - GNRE - AIIM / Referência
14 - DARF na Cor Preta - Europa (Convênios: 5-
0064 e 5-0153)
15 - DARF Simples (Convênio: 5-0154)
16 - Licenciamento Paraná
17 - DARF Numerado (Convênio: 5-0385)
18 - DARE 50185 (substituído pelo comprovante 27)
19 - Cartões Outros Bancos - Concessionária
20 - Cartões Outros Bancos - Tributos
11
21 - RENAINF
22 - GARE IPVA SP (substituído pelos comprovantes
31 e 32)
23 - GNRE - DI / DSI / AIIM / Referência
24 - GARE ICMS Geral (substituído pelos

comprovantes 28 e 29)
25 - DAS - Simples Nacional (Convênio: 5-0328)

26 - E-Social (Convênio: 5-0432)
27 - DARE-SP / GNRE - SEFAZ-SP (Convênio: 5-
0185)
28 - GARE ICMS GERAL - SEFAZ-SP (Convênio: 5-
0489)
29 - GARE ICMS - PEP - SEFAZ-SP (Convênio: 5-
0428)
30 - GARE PPD - SEFAZ-SP (Convênio: 5-0052)
31 - GARE IPVA PPD - SEFAZ-SP (Convênio: 5-0025)
32 - GARE IPVA - SEFAZ-SP (Convênio: 5-0025)
Campo GARE-ICMS - Empresas 5-0051 / 5-0099 / 5-
0165
Campo HHMMSS - Empresa 5-0232
Código de Receita
Código da Receita - Empresa 5-0025
Hora Pagamento Transação Numérico 06
Código de Receita
Código da Receita GARE ICMS Geral (convênio 5-
0489), composto pelas posições 28 a 30 da barra +
dígito verificador calculado
UF String 02 Campo GARE-ICMS

DI / DSI - AIIM Numérico 09 Campo GARE-ICMS
Município Numérico 03 Campo Taxa de Incêndio
S - É obrigatório digitar o valor do débito
Obriga Digitar Valor de Débito String 01
N - Não é permitido digitar o valor do débito
Código Empresa Débito Automático Numérico 05 Código da Empresa do Débito Automático
Nome Fantasia Débito Automático String 20 Nome Fantasia do Débito Automático
Descrição Cliente String 32 Descrição do Pagamento pelo Cliente
Percentual do CET Período Numérico 05 Percentual do CET Período
Percentual do CET Mensal Numérico 05 Percentual do CET Mensal
Valor do CET Anual Numérico 17 Valor do CET Anual
Valor de Encargo Numérico 05 Valor de Encargo
Valor da Tarifa Numérico 05 Valor da Tarifa
Valor do IOF Numérico 05 Valor do IOF
Valor total de encargos a serem cobrados Numérico 07 Valor total de encargos a serem cobrados
Quantidade de pontos acumulados pelo
Numérico 11 Quantidade de pontos acumulados pelo cartão
cartão
Número do Cartão String 16 Número do Cartão de Crédito
Limite do Cartão Numérico 17 Limite Disponível do Cartão de Crédito
Vencimento da Fatura do Cartão de Crédito
Vencimento da Fatura do Cartão Numérico 08
(DDMMAAAA)
Expiração do Cartão Numérico 06 Expiração do Cartão de Crédito (MMAAAA)
Senha String 16 Senha do Cartão de Crédito
Nome do Portador do Cartão String 35 Nome do Portador do Cartão de Crédito
Número Cartão Outros Bancos String 19 Número do Cartão Outros Bancos
Código de Autorização Outros Bancos Numérico 06 Código de Autorização Outros Bancos
CPF / CNPJ - Principal Numérico 09 Número Principal do CPF / CNPJ
CPF / CNPJ - Filial Numérico 05 Número Filial do CPF / CNPJ
12
CPF / CNPJ - DVs Numérico 02 Dígito do CPF / CNPJ

DDD - Telefone Numérico 04 DDD do Telefone
Telefone Numérico 11 Número do Telefone
Percentual Tarifa Numérico 05 Percentual da Tarifa
Percentual IOF Numérico 05 Percentual do IOF
Percentual Encargos Numérico 05 Percentual dos Encargos
Total da Transação Numérico 17 Valor Total da Transação
Taxa de Juros Numérico 05 Percentual da Taxa de Juros
Tipo de Dispositivo Numérico 03 Tipo de Dispositivo
Placa String 07 Número da Placa
Código do Município Numérico 04 Número do Código do Município (NNND)
Código Mensagem HSBC-NET Numérico 07 Código da Mensagem no HSBC-NET
1 - CNPJ
2 - CPF
3 - Identificador
Identifica número do DS / DSI ou AIIM:
Identifica Número DS / DSI - AIIM Numérico 02 1 - DS / DSI
2 - AIIM
Descrição DS / DSI - AIIM Numérico 10 Número do DS / DSI ou AIIM
Data do momento do pagamento realizado no Canal

Data do Pagamento Numérico 08 (AAAAMMDD)
(Tipos de Comprovantes: 14, 15, 17, 25 e 26)
Período de Apuração (AAAAMMDD)

Período de Apuração Numérico 08
(Tipos de Comprovantes: 14 e 15)
CNPJ ou CPF Principal

CNPJ - Principal Numérico 09
Filial do CNPJ ou zeros quando CPF

CNPJ - Filial Numérico 04
(Tipo de Comprovante: 14)
DVs do CNPJ ou CPF

CNPJ - DVs Numérico 02
Código da Receita do Pagamento (NNND)

Código da Receita Numérico 04
(Tipo de Comprovante: 14, 15 e 28)
Valor da Receita Bruta Acumulada (999999999DD)

Valor da Receita Bruta Acumulada Numérico 11
Percentual Aplicado (99DD)

Percentual Numérico 04
Data de Vencimento (AAAAMMDD)

Data de Vencimento Numérico 08
Número do Documento
Número do Documento Numérico 17
(Tipos de Comprovantes: 17, 25 e 26)
Nome da Empresa String 40 Nome da Empresa Conveniada

Código de Barras 48 Numérico 48 Código de Barras (com os dígitos verificadores)
Número de Controle DARE Numérico 15 Número de Controle do DARE
Número do Documento SEFAZ Numérico 14 Número do Documento
Número da Guia Numérico 11 Número da Guia
13
Número da Etiqueta Numérico 13 Número da Etiqueta

Informa o tipo de parcelamento do IPVA:
0 - Não existe parcelamento
1 - 1ª Parcela
2 - 2ª Parcela
3 - 3ª Parcela
Cota Numérico 1 4 - 4ª Parcela
5 - 5ª Parcela
6 - 6ª Parcela
7 - 7ª Parcela
8 - 8ª Parcela
9 - Cota Única
Hora do Pagamento Numérico 06 Hora em que foi realizado o pagamento (HHMMSS)
Identifica o tipo de veículo para o qual está sendo

pago o IPVA:
Tipo de Veículo Numérico 01 0 - Pagamento não possui identificação do veículo

1 - Aeronave
2 - Embarcação
3 - Veículo Terrestre
Se o “Tipo de Veículo” for “3 - Veículo Terrestre”

Esse campo conterá a placa (AAANNNN ou
AAAAAANN)
Se o “Tipo de Veículo” for “1 - Aeronave” ou “2 -

Embarcação”
Esse campo conterá o número de inscrição
Identificação do Veículo String 14 (NNNNNNNNNN0000)
Em ambos os casos, a identificação do veículo será

alinhada à
esquerda, com brancos à direita. Se o pagamento
não possuir a
identificação do veículo, esse campo será
preenchido com brancos.
14
Exemplo de saída de pagamento realizado com sucesso:
{
"retorno": 0,
"sqlCode": 0,
"banco": 237,
"agencia": 3963,
"conta": 404,
"tipoConta": 1,
"contaDebito": 404,
"nomeCliente": "UBIRAJA RICSSONEY DA SILVA",
"tipoRegistro": "1",
"numeroPeriferico": 0,
"numeroSequencia": 0,
"autenticacaoBancaria": 45154760,
"dataDebito": "2021-03-11",
"dataVencimento": null,
"valorTributo": 52.62,
"valorPago": 52.62,
"valorMulta": 0.0,
"valorJurosMora": 0.0,
"valorDesconto": 0.0,
"exercicio": 0,
"numeroParcela": 0,
"codigoTributo": 0,
"numeroNr": 0,
"identificacaoPagamento": "AGUA",
"identificacaoCampoChave": "RGI",
"campoChaveIdentificacaoDocumento": "08527468",
"nomeFantasia": "SABESP/SP",
"tipoServico": 2,
"tituloDebitoAutomatico": "N. DO CLIENTE",
"formatoDocumento": "TESTES ARNALDO DBT04190",
"formaDigitacao": "111111111111",
"statusDebitoAutomatico": 0,
"tituloPCON": null,
"linhaDetalhe": null,
"competencia": null,
"dataValidade": null,
"cnpjCEI": "00000000000000",
"tipoComprovante": 3,
"codigoReceita": 0,
"uf": null,
"diDSI": 0,
"municipio": 0,
"obrigaDigitarValorDebito": "N",
"codigoEmpresaDebitoAutomatico": 16,
"nomeFantasiaDebitoAutomatico": "Sabesp",
"descricaoCliente": "Teste",
"percentualCETPeriodo": 0.0,
"percentualCETMensal": 0.0,
"valorCETAnual": 0.0,
"valorEncargo": 0.0,
"valorTarifa": 0.0,
15
"valorIOF": 0.0,
"valorTotalEncargosASeremCobrados": 0.0,
"quantidadePontosAcumuladosCartao": 0,
"numeroCartao": null,
"limiteCartao": 0.0,
"vencimentoFaturaCartao": null,
"expiracaoCartao": null,
"senha": null,
"nomePortadorCartao": null,
"numeroCartaoOutrosBancos": null,
"codigoAutorizacaoOutrosBancos": null,
"cpfCnpj": null,
"dddTelefone": null,
"telefone": "00000000000",
"percentualTarifa": 0.0,
"percentualIOF": 0.0,
"percentualEncargo": 0.0,
"totalTransacao": 0.0,
"taxaJuros": 0.0,
"tipoDispositivo": 0,
"placa": null,
"codigoMunicipio": 0,
"codigoMensagemHsbcNet": 600001,
"tipoIdentificacao": 0,
"identificaNroDsDsiAiim": 0,
"descricaoDsDsiAiim": 0,
"dataPagamento": null,
"periodoApuracao": null,
"cnpjDarf": null,
"codigoReceitaDarf": 0,
"valorReceitaBruta": 0.0,
"prcentualAplicado": 0.0,
"dataVencimentoDarf": null,
"numeroDocumento": 0,
"nomeEmpresaConveniada": "SABESP",
"codigoBarras": null,
"numeroControleDare": 0,
"numeroDocumentoSefaz": 0,
"numeroGuia": 0,
"numeroEtiqueta": 0,
"cota": 0,
"horaPagamento": "131254",
"tipoVeiculo": 0,
"identificacaoVeiculo": null
}
Exemplo de saída com mensagem de erro:

{
"codigo": "15",
"mensagem": "Insufficient Balance"
}
16
6.3 Códigos de Retorno da Transação de Negócio

000 - Ok
001 - Empresa não disponível para pagamento
002 - Empresa não disponível para pagamento
003 - Dígito do código de barras inválido
004 - Opção de processamento inválida
005 - Conta já cadastrada para Débito Automático
006 - Conta já programada para débito
007 - Valor do débito excede valor-limite para pagamento
008 - Data de débito excede data-limite para pagamento
009 - Data de débito inválida
010 - Agência / conta não cadastrada
011 - Código de barras inválido
012 - Data de débito excede data-limite para pagamento
013 - Data de débito inválida
014 - Agência / conta inválida
015 - Saldo insuficiente
016 - Conta / competência bloqueada
017 - Tributo não autorizado para pagamento
018 - Valor inconsistente
019 - Conta não autorizada para pagamento
020 - Data do débito deve ser igual ao dia corrente
021 - Cartão com senha vencida
022 - Documento não autorizado para pagamento
023 - Data de vencimento inválida (não existe cadastramento para data do vencimento)
024 - Problema no cálculo do valor (valor em moeda difere de real e não existe parametrização para a conversão)
025 - Exercício não autorizado para pagamento
17
026 - Campo versão inválido

027 - Anulação inválida (válido somente para os Canais Bradesco Expresso e Guichê de Caixa)
028 - Lacre de conectividade digitado inválido (Tributo FGTS)
029 - Identificador digitado inválido (Tributo FGTS)
030 - Valor de débito digitado inválido
031 - Conta com bloqueio judicial
033 - Limite de pagamento excedido
034 - Data para efetivação do débito inválida (GPS)
035 - Código do pagamento inválido (GPS)
036 - Data de competência inválida (GPS)
037 - Código do identificador do contribuinte inválido (GPS)
038 - Valor do INSS inválido GPS
039 - Valor outras entidades inválido (GPS)
040 - Valor total inválido (GPS)
041 - Código da receita inválido (DARF)
042 - Data da arrecadação inválida (DARF)
043 - Período de apuração inválido (DARF)
044 - Data de vencimento inválida (DARF)
045 - Percentual inválido (DARF)
046 - CPF / CNPJ inválido (DARF)
047 - Referência inválida (DARF)
048 - Valor total inválido (DARF)
049 - Valor da receita bruta acumulada inválido (DARF)
050 - Valor do principal inválido (DARF)
051 - Código de barras inconsistente - Tribunal de Justiça
052 - Pagamento via código de barras não autorizado (GPS)
053 - Competência 13 tem que ser paga dentro do próprio exercício (GPS)
054 - Canal desabilitado para pagamento
055 - Data do pagamento excede data máxima permitida (GPS)
056 - Pagamento com cartão de crédito não autorizado
057 - Pagamento duplicado (válido somente para o Canal Net Empresa)
058 - Para transação recusada com manutenção da sessão
059 - Para transação recusada com encerramento da sessão
100 - Horário excedido para pagamento de contas
200 - Permitido pagar somente IPTU desse exercício
18
7. CONSULTAR PAGAMENTO EFETUADO

Após a efetivação do pagamento, é possível realizar a consulta dos pagamentos efetuados,
basta informar ID transaction2, agência, conta, data inicial e data final.
A consulta está disponível em até 5 (cinco) anos, e serão demonstrados todos os dados do
documento pago, inclusive o valor e a data em que foi pago.
Nota: não é permitida a consulta do pagamento em rajadas, apenas consulta um a um.
Horários para Pagamentos: das 0h às 23h59.
URL de Homologação:
https://proxy.api.prebanco.com.br/v1/pagamentos/{agencia}/{conta}/{tipoConta}?tipoConsul
ta=3&segmentoConsulta=99&dataInicial=AAAA-MM-DD&dataFinal=AAAA-MM-
DD&idTransacao=XXXXXXXXX
URL de Produção:
https://bradesco.com.br/v1/pagamentos/{agencia}/{conta}/{tipoConta}}?tipoConsulta=3&se
gmentoConsulta=99&dataInicial=AAAA-MM-DD&dataFinal=AAAA-MM-
DD&idTransacao=XXXXXXXXX
7.1. Entrada da Consulta

Por meio do Campo idTransacao informado na inclusão do pagamento, é possível
consultar posteriormente o seu status pelo preenchimento dos campos abaixo:
Nome Tipo/Tamanho Obrigatório Exemplo Descrição
tipoConsulta Numérico (1) Sim 3 (FIXO) 3 - Consulta Débitos Efetuados
segmentoConsulta Numérico (2) Sim 99 (FIXO) 99 - Serão enviados todos os
registros cadastrados na conta do
cliente, não separando por
Segmento
dataInicial String Sim 2021-03-11 Data inicial da pesquisa do
pagamento
dataFinal String Sim 2021-03-11 Data final da pesquisa do
pagamento
idTransacao String (máximo 9 Sim 502R Identificação única da transação
caracteres) para a API Arrecadações
[a-zA-Z0-9]{1,9}
2
ID transaction é uma forma de controle do usuário, no qual inclui, na entrada do pagamento, o identificador
alfanumérico de até 9 caracteres ao consumir a API de Pagamento de tributos e contas de consumo.
19
Exemplo de Entrada:
Get:
https://99.999.99.99:9999/v1/pagamentos/3963/404/1?tipoConsulta=3&segmentoConsulta=9
9&dataInicial=2021-03-11&dataFinal=2021-03-11&idTransacao=502r
7.2. Saída da Consulta

Nome Tipo Tamanho Descrição
Código de Retorno da Execução (ver item 7.3 “Códigos de
Código de Retorno N 03
Retorno da Transação de Negócio” abaixo)
Código de erro retornado pelo gerenciador de banco de
SQL CODE N 03
dados DB2
Banco N 03 Número do Banco (Fixo: 237)
Agência N 05 Código da Agência
Conta A 13 Número da Conta
Conta Linkada N 13
Número do Periférico N 08
Número Sequência / Transação N 04
0 - Não existem mais dados
Controle de Paginação N 01
1 - Existem mais dados para serem enviados
Número de consultas já efetuadas. Primeiro envio deve ser
Quantidade de Consultas N 04
zeros
01 - Conta-Corrente
02 - Poupança
03 - INSS
Tipo da Conta N 01 04 - Cartão Salário (Não Implantado)
05 - Conta-Corrente / Poupança
06 - Cartão de Crédito
07 - Cartões outros Bancos
Conta Debitada:
Conta Debitada N 01 1 - Conta Débito Enviada
2 - Conta Débito Linkada
Código do Convênio N 05 Código da Empresa FEBRABAN (Segmento + Empresa)
Número do Documento A 25
Data do Débito N 08 Data do Débito (AAAAMMDD)
Data de Vencimento N 08 Data de Vencimento (AAAAMMDD)
Valor do Tributo N 13 Valor Original do Código de Barras (99999999999DD)
Valor Pago N 13 Valor do Débito (99999999999DD)
20
Valor da Multa N 13 Valor da Multa (99999999999DD)

Valor Juros de Mora N 13 Valor dos Juros / Mora (99999999999DD)
Valor Desconto N 13 Valor do Desconto (99999999999DD)
Exercício N 04 Ano do Exercício. Se vier 0000, não existe exercício.
Número da Parcela N 02 Número da Parcela
Identificação do Pagamento A 40 Descrição do Tributo
Nome do Campo-Chave
Identificação do Documento
A 23 Campo-Chave do Documento (Utilizando apenas para o
Campo-Chave
DARF 50385)
Campo-Chave do Documento
Nome do Campo-Chave (Utilizando apenas para o DARF
50385)
Identificação do Documento
A 15
Campo-Chave Número do Documento GARE ICMS Geral (convênio 5-0489),
composto
pelas posições 31 a 44 do código de barras

Número do NR N 02 Número do NR
Autenticação Bancária N 09 Número utilizado para os comprovantes
01 - A debitar: indica que a operação está agendada.
02 - A debitar: indica que a operação está agendada.
04 - Debitado: indica que a operação está debitada.
05 - Insuficiência de Saldo (não debitado): pagamento não
realizado por insuficiência de saldo na conta indicada para
pagamento.
06 - Debitado: indica que a operação está debitada.
Situação do Pagamento N 02
07 - Débito em Processamento: débito em processamento
(referente ao item “1”).
08 - Débito em Processamento: débito em processamento
(referente ao item “2”).
09 - Debitado (no ato da inclusão): indica que a operação
está debitada.
00 - Conta Encerrada (não debitado): pagamento não
realizado devido à conta indicada para pagamento estar
encerrada.
Notas sobre Situação do Pagamento:
Os códigos 01 e 02 estão seguramente agendados (A diferença entre eles refere-se às regras de processamento interno no
Banco).
Os códigos 04, 06 e 09 estão seguramente debitados (A diferença entre eles refere-se às regras de processamento interno no
Banco).
Os códigos 07 e 08 ainda não estão definitivamente debitados (em processamento).
Descrição da Mídia A 25
Código de Barras 44 N 44 Código de Barras (sem os dígitos verificadores)
Código do Tributo N 02
Nome do Contribuinte A 40 Nome do contribuinte enviado pela Prefeitura de São Paulo
Número do Contribuinte N 11 Número de Identificação do Contribuinte
01 - Parcela Única
Tipo de Parcelamento N 02 02 - Pagamento Parcelado
03 - Vencimento Integral
Código do Processamento N 06
Mês / Dia / Hora da Transação A 10 Mês / Dia / Hora da Transação (MMDDHHMMSS)
NSU PRODAM N 09 NSU da Prefeitura
NSU Banco N 06 Número de Sequência Único no Bradesco
Mês Incidência N 02 Mês de Incidência (MM)
Ano Incidência N 04 Ano de Incidência (AAAA)
Percentual Multa N 02 Percentual de Multa Aplicado
21
1 - Código de Barras
Forma de Acolhimento N 02
2 - On-Line
Valor Correção Monetária N 12 Valor Correção Monetária (9999999999DD)
0 - Não Imprime
Controle de Mensagem N 01
1 - Imprime
Mensagem de Retorno A 40 Mensagem de Retorno do CICS
Quantidade de Parcelas N 02 Quantidade de Parcelas
Código do Serviço / Estabelecimento / Identificador do Código do Estabelecimento do Órgão /
N 05
Anúncio Empresa
Data Vencimento do Órgão N 08 Data de Vencimento enviado pelo Órgão (AAAAMMDD)
Competência N 06 Competência (MMAAAA)
Data de Validade N 08 Data de Validade (AAAAMMDD)
CNPJ ou CEI ou Identificador N 14 CNPJ ou CEI ou Identificador
Campo Digitado 1 N 15 Lacre de Conectividade
Campo Digitado 2 A 20 Identificador
Identifica o tipo de comprovante que deve ser impresso:
01 - IPTU - PMSP
02 - Demais Tributos
03 - Concessionárias
04 - FGTS - imprimir campo (lacre de conectividade)
digitado
05 - FGTS - imprimir campo (Identificador) - digitado
06 - FGTS - imprimir os dois campos digitados
07 - IPTU - On-Line
08 - ISS - On-Line
09 - FGTS - imprimir sem os campos digitados
10 - GARE-ICMS
11 - Taxa de Incêndio
12 - GNRE - DI / DSI
13 - GNRE - AIIM / Referência
14 - DARF na Cor Preta - Europa (Convênios: 5-0064 e 5-
0153)
15 - DARF Simples (Convênio: 5-0154)
Tipo de Comprovante N 02
16 - Licenciamento Paraná
17 - DARF Numerado (Convênio: 5-0385)
18 - DARE 50185 (substituído pelo comprovante 27)
19 - Cartões Outros Bancos - Concessionária
20 - Cartões Outros Bancos - Tributos
21 - RENAINF
22 - GARE IPVA SP (substituído pelos comprovantes 31 e 32)
23 - GNRE - DI / DSI / AIIM / Referência
24 - GARE ICMS Geral (substituído pelos comprovantes 28 e
29)
25 - DAS - Simples Nacional (Convênio: 5-0328)
26 - E-Social (Convênio: 5-0432)
27 - DARE-SP / GNRE - SEFAZ-SP (Convênio: 5-0185)
28 - GARE ICMS GERAL - SEFAZ-SP (Convênio: 5-0489)
29 - GARE ICMS - PEP - SEFAZ-SP (Convênio: 5-0428)
30 - GARE PPD - SEFAZ-SP (Convênio: 5-0052)
31 - GARE IPVA PPD - SEFAZ-SP (Convênio: 5-0025)
22
32 - GARE IPVA - SEFAZ-SP (Convênio: 5-0025)

Campo GARE-ICMS - Empresas 5-0051 / 5-0099 / 5-0165
Campo HHMMSS - Empresa 5-0232
Código de Receita
Hora Pagamento Transação N 06 Código da Receita - Empresa 5-0025
Código de Receita Código da Receita GARE ICMS Geral (convênio 5-0489),
composto pelas posições 28 a 30 da barra + dígito
verificador calculado
UF A 02 Campo GARE-ICMS
DI / DSI - AIIM N 09 Campo GARE-ICMS
Município N 03 Campo Taxa de Incêndio
S - O valor foi informado pelo cliente
Identificador Valor Informado A 01
N - O valor foi informado pelo cliente
Descrição do Cliente A 32 Descrição do Pagamento pelo Cliente
Percentual do CET Período N 05 Percentual do CET Período
Percentual do CET Mensal N 05 Percentual do CET Mensal
Valor do CET Anual N 17 Valor do CET Anual
Valor de Encargo N 05 Valor de Encargo
Valor da Tarifa N 05 Valor da Tarifa
Valor do IOF N 05 Valor do IOF
Valor total de encargos a serem cobrados N 07 Valor total de encargos a serem cobrados
Quantidade de pontos acumulados pelo
N 11 Quantidade de pontos acumulados pelo cartão
cartão
Número do Cartão A 16 Número do Cartão de Crédito
Expiração do Cartão N 08 Expiração do Cartão de Crédito (MMAAAA)
Nome do Portador do Cartão A 35 Nome do Portador do Cartão de Crédito
Número do Cartão Outros Bancos A 19 Número do Cartão Outros Bancos
Código de Autorização Outros Bancos N 06 Código de Autorização outros Bancos
CPF / CNPJ - Principal N 09 Número Principal do CPF / CNPJ
CPF / CNPJ - Filial N 05 Número Filial do CPF / CNPJ
CPF / CNPJ - DVs N 02 Dígito do CPF / CNPJ
DDD - Telefone N 04 DDD do Telefone
Telefone N 11 Número do Telefone
Placa A 07 Número da Placa
Código do Município N 04 Número do Código do Município (NNND)
Tipo de Identificação:
1 - CNPJ
Tipo de Identificação N 02
2 - CPF
3 - Identificador
Identifica Número do DS / DSI ou AIIM:
Identifica Número DS / DSI - AIIM N 02 1 - DS / DSI
2 - AIIM
Descrição DS / DSI - AIIM N 10 Número do DS / DSI ou AIIM
Data do momento do pagamento realizado no Canal
Data do Pagamento N 08 (AAAAMMDD)
(Tipos de Comprovantes: 14, 15, 17, 25 e 26)
Período de Apuração (AAAAMMDD)
Período de Apuração N 08
CNPJ ou CPF Principal
CNPJ - Principal N 09
23
Filial do CNPJ, ou zeros quando CPF

CNPJ - Filial N 04
DVs do CNPJ ou CPF
CNPJ - DVs N 02
Código da Receita do Pagamento (NNND)
Código da Receita N 04
(Tipo de Comprovante: 14, 15 e 28)
Valor da Receita Bruta Acumulada (999999999DD)
Valor da Receita Bruta Acumulada N 11
Percentual Aplicado (99DD)
Percentual N 04
Data de Vencimento (AAAAMMDD)
Data de Vencimento N 08
Número do Documento
Número do Documento N 17
(Tipos de Comprovantes: 17, 25 e 26)
Nome da Empresa A 40 Nome da Empresa Conveniada
Código de Barras 48 N 48 Código de Barras (com os dígitos verificadores)
Número de Controle N 15 Número de Controle do DARE
Número do Documento N 14 Número do Documento
Número da Guia N 11 Número da Guia
Número da Etiqueta N 13 Número da Etiqueta
Informa o tipo de parcelamento do IPVA:
0 - Não existe parcelamento
1 - 1ª Parcela
2 - 2ª Parcela
3 - 3ª Parcela
Cota N 1 4 - 4ª Parcela
5 - 5ª Parcela
6 - 6ª Parcela
7 - 7ª Parcela
8 - 8ª Parcela
9 - Cota Única
Hora do Pagamento N 06 Hora em que foi realizado o pagamento (HHMMSS)
Identifica o tipo de veículo para o qual está sendo pago o

IPVA:
Tipo de Veículo N 01 0 - Pagamento não possui identificação do veículo

1 - Aeronave
2 - Embarcação
3 - Veículo Terrestre
24
Exemplo de Saída:
{
"retorno": "000",
"sqlCode": "000",
"banco": 237,
"agencia": 3963,
"conta": 404,
"contaLinkada": 404,
"numeroPeriferico": 0,
"numeroSequencia": 0,
"restart": 0,
"contr": 1,
"regSaida": [
{
"contaTipo": 1,
"contaDebito": 1,
"codigoEmpresaConveniada": 16,
"documento": "08527468",
"dataDebito": "2021-03-11",
"valorCodigoBarras": "0000000005262",
"valorDebito": 52.62,
"multa": 0.0,
"juros": 0.0,
"descontos": 0.0,
"exercicio": 0,
"parcela": 0,
"identificacaoPagamento": "AGUA",
"numeroIdentidade": "RGI",
"identidadeDocumento": "8527468",
"numNr": 0,
"autenticacaoBancaria": 45154760,
"situacaoConta": 6,
"midia": "API SERVER TO SERVER",
"codigoBarras": "82600000000526200971487208527468121514520072",
"tributo": "00",
"numeroContribuinte": 0,
"tipoParcela": 0,
"codigoProcessamento": 0,
"nsuProdam": 0,
"nsuBanco": 0,
"mesIncidencia": 0,
"anoIncidencia": 0,
"percentualMulta": 0.0,
"formaAcolhimento": 1,
"correcaoMonetaria": 0.0,
"controleMensagem": "0",
"quantidadeParcelas": 0,
"codigoEstabelecimento": 0,
"dataVencimentoOrgao": "2021-03-11",
"competencia": "000000",
"cnpjCEI": "00000000000000",
"campoDigitado1": "000000000000000",
"tipoComprovante": "03",
25
"codigoReceita": "000000",
"diDSI": "000000000",
"municipio": "000",
"valorInformadoCliente": "N",
"descricaoCliente": "TESTE",
"percentualCETPeriodo": 0.0,
"percentualCETMensal": 0.0,
"valorCETAnual": 0.0,
"valorEncargo": 0.0,
"valorTarifa": 0.0,
"valorIOF": 0.0,
"valorEncargoCartao": 0.0,
"quantidadePontos": "00000000000",
"numeroCartao": "0000000000000000",
"expiracaoCartao": "01000000",
"codigoAutorizacaoOutroBanco": "0",
"cpfCnpjPrincipalOutroBanco": "000000000",
"cnpjFilialOutroBanco": "00000",
"cpfCnpjFilialOutroBanco": "00",
"dddOutroBanco": "0000",
"telefoneOutroBanco": "00000000000",
"codigoMunicipio": "0000",
"tipoIdentificacao": 0,
"identificaNroDsDsiAiim": 0,
"descricaoDsDsiAiim": 0,
"dataPagamento": "2021-03-11",
"codigoReceitaDarf": 0,
"valorReceitaBruta": 0.0,
"prcentualAplicado": 0.0,
"numeroDocumento": 0,
"nomeEmpresaConveniada": "SABESP",
"numeroControleDare": 0,
"numeroDocumentoSefaz": 0,
"numeroGuia": 0,
"numeroEtiqueta": 0,
"cota": 0,
"horaPagamento": "131254",
"tipoVeiculo": 0
}
]
}
26
7.3 Códigos de Retorno da Transação de Negócio
000 - OK
001 - Não existe débito agendado / programado
002 - Tipo de transação diferente de: consulta, alteração ou exclusão
010 - Conta encerrada
011 - Período informado inválido
012 - Período solicitado é inválido (mais de um ano)
016 - Conta / competência bloqueada
021 - Cartão com senha vencida
Códigos de Erros Genéricos
Acima de 900 - Problemas de comunicação, banco de dados, indisponibilidades etc.
27
8. CÓDIGOS DE RETORNO DO SERVIDOR HTTP

Trata-se da request enviada por meio das APIs de Pagamentos ou de Consultas de Pagamentos
Efetuados cujos retornos podem ou não estar associados aos códigos devolvidos pela transação de
negócio.
Para essa situação, serão devolvidos os códigos abaixo, referentes a operação atendida com
sucesso, erro de parâmetros ou indisponibilidade dos servidores do Banco para atendimento da
operação solicitada.
Código Descrição Retorno HTTP Retorno devolvido também pela transação de negócio
200 Operação realizada com sucesso Sim
400 Falha ao atender a requisição Não
412 Parâmetros informados inválidos Não
500 Erro inesperado na solicitação Não
28
9. SUMARIZAÇÃO DE DÉBITOS
Agrupamento em D+1 dos lançamentos a débito dos pagamentos de tributos e contas de
consumo na conta do cliente pagador, otimizando o extrato e facilitando a sua conciliação.
MODELO DE EXTRATO:
data historico n.docto valor
12/04/2022 00907 PGTO ELET TRIB 0000002 21,00-
API CORP.-CDBARRA PREFEITURAS
DESCRIÇÃO DOS CAMPOS:
Em azul: data do débito.
Em laranja: códigos de lançamento e descrição.

✓ 978 - conta de gás;
✓ 982 - conta de telefone;
✓ 983 - conta de luz;
✓ 984 - conta de água/esgoto;
✓ 907 - Pagamento Eletrônico de Tributos.
Em verde: quantidade de documentos pagos.
Em vermelho: valor total dos documentos pagos.
Em vermelho escuro: Canal de Pagamento.
Em preto: pagamento por código de barras.
Em cinza: segmento das contas de consumo ou tributos pagos.

✓ Prefeituras (código de lançamento 907);
✓ Saneamento (código de lançamento 984);
✓ Energia e Gás (código de lançamento 978 ou 983);
✓ Telefonia (código de lançamento 984);
✓ Governamentais (código de lançamento 907);
✓ Empresas Diversas (código de lançamento 907);
✓ Multas (código de lançamento 907).
29
10. COMPROVANTES DE PAGAMENTO

Para toda transação de pagamento realizada, pode ser gerado um comprovante de pagamento,
contemplando as regras estabelecidas de emissão, conforme modelos a seguir.
Na descrição dos campos de cada comprovante consta entre aspas “” o seu retorno
correspondente no response da API.
10.1. 5-0064 DARF Preto Europa (Tipo de Comprovante 14)
BANCO BRADESCO S.A.
AGÊNCIA: 9999
COMPROVANTE DE PAGAMENTO DARF
AGENTE ARRECADADOR: 237 – BANCO BRADESCO S.A.

CÓDIGO DE BARRAS: 99999999999 99999999999 99999999999 99999999999
DATA DO PAGAMENTO: 99/99/9999
PERÍODO DE APURAÇÃO: 99/99/9999
NÚMERO DO CPF/CNPJ: 999.999.999-99 ou 99.999.999/9999-99
CÓDIGO DA RECEITA: 999-9
DATA DE VENCIMENTO: 99/99/9999
VALOR TOTAL: R$ 999.999.999,99
AUTENTICAÇÃO BANCÁRIA: xxxxxxxxxxxxxxxxxxxxxx
Modelo aprovado pela SRF - ADE Conjunto Corat/Cotec Nº 001 de 2006.
Transação realizada por meio do convênio entre (CLIENTE) e o Banco Bradesco S.A.
Agência: "agencia"
Agente Arrecadador: 237 - Banco Bradesco S/A.
Código de Barras : "codigoBarras" 44 posições, divididas em 4 blocos de 11.
Data do Pagamento: "dataDebito" formato DD/MM/AAAA.
Período de Apuração: "periodoApuracao" formato DD/MM/AAAA.
Número do CPF ou Número do CNPJ: para CPF, a informação é devolvida no campo

"campoChaveIdentificacaoDocumento" e o campo "cnpjDarf" retorna vazio.
30
Para CNPJ, a informação é devolvida no campo "cnpjDarf" com os dígitos verificadores do CNPJ já
calculados.
Código da Receita: "codigoReceitaDarf"
Data de Vencimento: "dataVencimento" formato DD/MM/AAAA.
Valor Total: "valorPago"
Autenticação Bancária: "autenticacaoBancaria"
31
10.2. 5-0153 DARF Preto Europa (Tipo de Comprovante 14)
BANCO BRADESCO S.A.
AGÊNCIA: 9999
COMPROVANTE DE PAGAMENTO DARF

CÓDIGO DE BARRAS: 99999999999 99999999999 99999999999 99999999999
PERÍODO DE APURAÇÃO: 99/99/9999
NÚMERO DO CNPJ: 99.999.999/9999-99
CÓDIGO DA RECEITA: 999-9
VALOR TOTAL: R$ 999.999.999,99
Modelo aprovado pela SRF - ADE Conjunto Corat/Cotec Nº 001 de 2006.
Agência: "agencia"
Código de Barras : "codigoBarras" 44 posições, divididas em 4 blocos de 11.
Período de Apuração: "periodoApuracao" formato DD/MM/AAAA.
Número do CPF ou Número do CNPJ: para CPF, a informação é devolvida no campo

"campoChaveIdentificacaoDocumento" e o campo "cnpjDarf" retorna vazio.
Para CNPJ, a informação é devolvida no campo "cnpjDarf" com os dígitos verificadores do CNPJ já
calculados.
Código da Receita: "codigoReceitaDarf"

32
10.3. 5-0328 Simples Nacional (Tipo de Comprovante 25)
BANCO BRADESCO S.A.
AGÊNCIA: 9999
COMPROVANTE DE PAGAMENTO - SIMPLES NACIONAL

CÓDIGO DE BARRAS: 99999999999 99999999999 99999999999 99999999999
NÚMERO DO DOCUMENTO: 99.99.99999.9999999-9
VALOR TOTAL: R$ 999.999.999,99
Agência: "agencia"
Código de Barras: codigoBarras" 44 posições, divididas em 4 blocos de 11.
Número do Documento: "numeroDocumento".
33
10.4. 5-0385 DARF Numerado (Tipo de Comprovante 17)
BANCO BRADESCO S.A.
AGÊNCIA: 9999
COMPROVANTE DE PAGAMENTO DARF NUMERADO

CÓDIGO DE BARRAS: 99999999999 99999999999 99999999999 99999999999
VALOR TOTAL: R$ 999.999.999,99
Modelo aprovado pelo Ato Declaratório Executivo Conjunto Codac/Cotec Nº 1,

de 31 de outubro de 2011.
Agência: "agencia"
34
10.5. 5-0432 E-Social (Tipo de Comprovante 26)
BANCO BRADESCO S.A.
AGÊNCIA: 9999
COMPROVANTE DE PAGAMENTO DO ESOCIAL

CÓDIGO DE BARRAS: 99999999999 99999999999 99999999999 99999999999
VALOR TOTAL: R$ 999.999.999,99
35
10.6. 5-0179 FGTS/GRF sem Tomador (Tipo de Comprovante 9)
BANCO BRADESCO S.A.
AGÊNCIA: 9999
COMPROVANTE DE PAGAMENTO
CÓDIGO DE BARRAS: 99999999999-9 99999999999-9 99999999999-9 99999999999-9

EMPRESA/ÓRGÃO: FGTS/GRF S/ TOMADOR
CNPJ/CEI: 99999999999999
IDENT. EMPRESA: 999999999999
AGENTE ARRECADADOR: 237-2 BRADESCO
COMPETÊNCIA: MM/AAAA
CÓDIGO CONVÊNIO: 0179
DATA DE VALIDADE: 99/99/9999
VALOR DO PAGAMENTO: R$ 999.999.999,99
DATA DE DÉBITO: 99/99/9999
Agência: "agencia"
Código de Barras: "codigoBarras" 48 posições.
Empresa/Órgão: "nomeFantasia"
CNPJ/CEI: "cnpjCEI"
Identif. Empresa: "campoChaveIdentificacaoDocumento"
Banco: 237-2 Bradesco.
Competência: "competencia" formato MM/AAAA:
Código Convênio: 0179 (posições 16 a 19 do código de barras).
Data de Validade: "dataValidade" no formato DD/MM/AAAA.
Valor do Pagamento: "valorPago"

36
Data de Débito: "dataDebito" formato DD/MM/AAAA.
37
10.7. 5-0180 FGTS/GRF com Tomador (Tipo de Comprovante 9)
BANCO BRADESCO S.A.
AGÊNCIA: 9999
CÓDIGO DE BARRAS: 99999999999-9 99999999999-9 99999999999-9 99999999999-9

EMPRESA/ÓRGÃO: FGTS/GRF C/ TOMADOR
CNPJ/CEI: 99999999999999
IDENT. EMPRESA: 999999999999
BANCO: 237-2 BRADESCO
COMPETÊNCIA: MM/AAAA
CÓDIGO CONVÊNIO: 0180
DATA DE VALIDADE: 99/99/9999
Agência: "agencia"
Código de Barras: "codigoBarras" 48 posições.
CNPJ/CEI: "cnpjCEI"
Identif. Empresa: "campoChaveIdentificacaoDocumento"
Banco: 237-2 Bradesco.
Competência: "competencia" formato MM/AAAA:
Código Convênio: 0179 (posições 16 a 19 do código de barras).
Data de Validade: "dataValidade" no formato DD/MM/AAAA.

38
Data de Débito: "dataDebito" formato DD/MM/AAAA.
39
10.8. 5-0025 SEFAZ/SP GARE IPVA PPD (Tipo de Comprovante 31)

PPD: posições 20 e 21 da barra = 42
BANCO BRADESCO S.A.
Nº BANCO/AGÊNCIA: 237/9999
CANAL DE PAGAMENTO: INTERNET BANKING
DATA DO PAGAMENTO: 99/99/9999 HORÁRIO: 99:99:99
GARE IPVA PPD – SEFAZ/SP
CÓDIGO DE RECEITA: 034-6

CÓDIGO DO MUNICÍPIO: 999-9
Nº DA GUIA: NNNNNNNNNN-D
VALOR: R$ 9.999.999.999,99
CÓDIGO DE BARRAS:
99999999999-9 99999999999-9 99999999999-9 99999999999-9
AUTENTICAÇÃO
xxxxxxxxxxxxxxxxxxxxxx
Comprovante de pagamento emitido de acordo com a Portaria CAT- 126, de 16/09/2011, e

autorizado pelo Processo nº SF-13836-561535/1999.
VIA DO CONTRIBUINTE
Nº Banco/Agência: "banco"/"agencia"
Canal de Pagamento: Internet Banking
Horário: "horaPagamento"
Código de Receita: "codigoReceita"

40
Código do Município: "codigoMunicipio"
Nº da Guia: "numeroGuia"
Código de Barras: "codigoBarras"
Autenticação: "autenticacaoBancaria"
41
10.9. 5-0025 SEFAZ/SP GARE IPVA 036 (Tipo de Comprovante 32)

036: posições 20 e 21 da barra = 30
BANCO BRADESCO S.A.
GARE IPVA – SEFAZ/SP

PLACA: XXX9999 ou CCCCCC9
EXERCÍCIO: 9999
COTA:
VALOR: 999.999.999,99
CÓDIGO DE BARRAS:
99999999999-9 99999999999-9 99999999999-9 99999999999-9
AUTENTICAÇÃO

VIA DO CONTRIBUINTE
42
Placa: "placa"
Exercício: "exercicio"
Cota: "cota", sendo:
✓ 1 = 1ª Parcela;
✓ 6 = Cota Única.
43
10.10. 5-0025 SEFAZ/SP GARE IPVA AIIM (Tipo de Comprovante 32)

AIIM: posições 20 e 21 da barra = 18, 19, 28, 29, 38 ou 39
BANCO BRADESCO S.A.

Nº AIIM: 999999999
EXERCÍCIO: 9999
VALOR: 999.999.999,99
CÓDIGO DE BARRAS:
99999999999-9 99999999999-9 99999999999-9 99999999999-9
AUTENTICAÇÃO

VIA DO CONTRIBUINTE

44
Nº do AIIM: "descricaoDsDsiAiim"
45
10.11. 5-0025 SEFAZ/SP GARE IPVA Dívida Ativa (Tipo de Comprovante 32)
Dívida Ativa: posições 20 e 21 da barra = 11, 21 ou 31
BANCO BRADESCO S.A.

INSCRIÇÃO NA DÍVIDA ATIVA/Nº DA ETIQUETA: 9999999999999
EXERCÍCIO: 9999
VALOR: 999.999.999,99
CÓDIGO DE BARRAS:
99999999999-9 99999999999-9 99999999999-9 99999999999-9
AUTENTICAÇÃO

VIA DO CONTRIBUINTE

46
Inscrição na Dívida Ativa/Nº da Etiqueta: "numeroEtiqueta"
47
10.12. 5-0052 SEFAZ/SP GARE PPD (Tipo de Comprovante 30)
BANCO BRADESCO S.A.
GARE PPD – SEFAZ/SP

Nº DO DOCUMENTO: NNNNNNNNNN-D
VALOR: R$ 9.999.999.999,99
CÓDIGO DE BARRAS:
99999999999-9 99999999999-9 99999999999-9 99999999999-9
AUTENTICAÇÃO

VIA DO CONTRIBUINTE
Nº do Documento: "numeroDocumentoSefaz"

48
49
10.13. 5-0099 SEFAZ/SP GNRE (Tipo de Comprovante 23)
BANCO BRADESCO S.A.
CÓDIGO DE BARRAS: 99999999999-9 99999999999-9 99999999999-9 99999999999-9

EMPRESA/ÓRGÃO: SEFAZ-SP/GNRE
DESCRIÇÃO: GNRE
UF FAVORECIDA: SP
CPF/CNPJ: 999.999.999-99 ou 99.999.999/9999-99
DI/DSI: 999999999
AIIM: 999999999
REFERÊNCIA: AAAAMM
IDENTIFICADOR: 99999999999999
VALOR DO PAGAMENTO: R$ 9.999.999.999,99
AUTENTICAÇÃO
50
Descrição: "identificacaoPagamento"
UF Favorecida: "uf"

CPF/CNPJ: "cnpjCEI"
DI/DSI: "descricaoDsDsiAiim"
AIIM: "descricaoDsDsiAiim"
Referência: "competencia"
Identificador: "cnpjCEI"
Data de Débito: "dataDebito" formato DD/MM/AAAA
51
10.14. 5-0185 SEFAZ/SP DARE (Tipo de Comprovante 27)
BANCO BRADESCO S.A.
DARE-SP/GNRE – SEFAZ/SP
NÚMERO DE CONTROLE DO DARE: 999999999999999
VALOR: R$ 9.999.999.999,99
CÓDIGO DE BARRAS:
99999999999-9 99999999999-9 99999999999-9 99999999999-9
AUTENTICAÇÃO

VIA DO CONTRIBUINTE
Número de Controle do DARE: "numeroControleDare"
52
53
10.15. 5-0428 SEFAZ/SP GARE ICMS PEP (Tipo de Comprovante 29)
BANCO BRADESCO S.A.
GARE ICMS - PEP – SEFAZ/SP

Nº DO DOCUMENTO: NNNNNNNNNNNN-D
VALOR: R$ 9.999.999.999,99
CÓDIGO DE BARRAS:
99999999999-9 99999999999-9 99999999999-9 99999999999-9
AUTENTICAÇÃO

VIA DO CONTRIBUINTE
54
55
10.16. 5-0489 SEFAZ/SP GARE ICMS GERAL (Tipo de Comprovante 28)
BANCO BRADESCO S.A.
GARE ICMS GERAL – SEFAZ/SP
CÓDIGO DE RECEITA: 999

Nº DO DOCUMENTO: 99999999999999
VALOR: R$ 9.999.999.999,99
CÓDIGO DE BARRAS:
99999999999-9 99999999999-9 99999999999-9 99999999999-9
AUTENTICAÇÃO

VIA DO CONTRIBUINTE
56
57
10.17. 5-0232 SEFAZ/PR (Tipo de Comprovante 16)
BANCO BRADESCO S.A.
DD/MM/AAAA HH/MM/SS
CLIENTE:
AGÊNCIA: 9999 CONTA: 9999999
Convênio Governo Paraná SEFA GR PR
CÓDIGO DE BARRAS:
99999999999-9 99999999999-9 99999999999-9 99999999999-9
DATA DE PAGAMENTO: 99/99/9999

MEIO DE PAGAMENTO: INTERNET BANKING
VALOR TOTAL: R$ 999.999.999,99
EM CASO DE PAGAMENTO EM DIA NÃO ÚTIL, A LIQUIDAÇÃO OCORRERÁ NO DIA ÚTIL SEGUINTE
AUTENTICAÇÃO: xxxxxxxxxxxxxxxxxxxxxx
DD/MM/AAAA: substituir por "dataDebito"
HH/MM/SS: substituir por "horaPagamento"
Cliente: "nomeCliente"
Agência: "agencia"
Conta: "conta"
Data de Pagamento: "dataDebito" formato DD/MM/AAAA.
Meio de Pagamento: Internet Banking
58
10.18. COMPROVANTE GENÉRICO DEMAIS TRIBUTOS (Tipo de Comprovante 2)
BANCO BRADESCO S.A.
AGÊNCIA: 9999
BANCO ARRECADADOR: 237/BANCO BRADESCO S/A
CÓDIGO DE BARRAS: 999999999999 999999999999 999999999999 999999999999
EMPRESA/ÓRGÃO:
DESCRIÇÃO:
* TIPO DE DOCUMENTO:
DATA DO PAGAMENTO: DD/MM/AAAA
DATA DO VENCIMENTO: DD/MM/AAAA
VALOR PRINCIPAL: R$ 999.999.999,99
VALOR DE JUROS: R$ 999.999.999,99
VALOR DE MULTA: R$ 999.999.999,99
VALOR DE DESCONTOS: R$ 999.999.999,99
AUTENTICAÇÃO BANCÁRIA: 000.000.000
Agência: "agencia"
Descrição: "identificacaoPagamento"
Tipo de Documento: Label deve ser substituída pelo retorno do response no campo
"identificacaoCampoChave". Os dados a apresentar estão no campo
"campoChaveIdentificacaoDocumento"
59
Data do Vencimento: "dataVencimento" formato DD/MM/AAAA.
Valor Principal: "valorTributo"
Valor de Juros: "valorJurosMora"
Valor de Multa: "valorMulta"
Valor de Descontos: "valorDesconto"
60
10.19. COMPROVANTE CONCESSIONÁRIAS (Tipo de Comprovante 3)
BANCO BRADESCO S.A.
AGÊNCIA: 9999
CÓDIGO DE BARRAS: 999999999999 999999999999 999999999999 999999999999
* TIPO DE DOCUMENTO:
CONCESSIONÁRIA:
VALOR:
DATA DO PAGAMENTO:
AUTENTICAÇÃO BANCÁRIA: 000.000.000
Agência: "agencia"
Tipo de Documento: Label deve ser substituída pelo retorno do response no campo
"identificacaoCampoChave". Os dados a apresentar estão no campo
"campoChaveIdentificacaoDocumento"
Concessionária: "nomeFantasia"
Valor: "valorPago"
61
11. FAQ
1. Quais são as regras (premissas básicas) para o recebimento de documentos de
Arrecadações?
✓ O código de barras do documento deve ser válido para arrecadações, ou seja, deve conter 44
posições, iniciando sempre com o número “8”.
✓ O Bradesco precisa estar autorizado para o recebimento do pagamento a favor da empresa ou
Órgão público, ou seja, possuir convênio vigente e ativo; caso contrário, o documento será
rejeitado pelo motivo.
Nota: são definidas como concessionárias as empresas dos Segmentos de água, luz, telefone e
gás, que estão identificadas com os Segmentos 2 (empresas de saneamento), 3 (eletricidade e gás) e 4
(telefonia). Os tributos estão identificados com os segmentos 1 (prefeituras), 5 (Órgãos
governamentais), 6 (empresas de segmentos diversos que serão identificadas por meio do CNPJ base),
7 (multas de trânsito) e 9 (uso exclusivo do Banco).
✓ Deve ser considerado o limite operacional atribuído para o Canal e disponibilidade de saldo
disponível em conta-corrente.
2. Qual o horário permitido para pagamentos?
Todos os dias das 0h às 23h59. Para os pagamentos realizados em finais de semana, são
considerados efetivados junto às concessionárias e Órgãos no dia útil subsequente.
3. Como os pagamentos de arrecadações são demonstrados no extrato de conta-corrente?

São identificados individualmente, conforme segue:
✓ 978 - Conta de Gás;
✓ 982 - Conta de Água;
✓ 983 - Conta de Luz;
✓ 984 - Telefone;
✓ 907 - Tributos.
4. Existe possibilidade de estorno de um pagamento já realizado?

Não, após a ocorrência do débito em conta, não é permitido o estorno.
5. Quais são as etapas do processo de API de Arrecadações:

1ª Etapa: valida o código de barras, se temos convênio autorizado para arrecadação daquela
concessionária ou Órgão, e consulta de saldo e limites.
62
2ª Efetivação: realiza as consultas de saldo e limite operacional de pagamento e efetiva o

pagamento, sensibilizando de fato a conta do cliente.
6. Quais valores devem ser passados nos campos enviados no body na chamada a
/pagamentos/pagamentoContaConsumo?
Para a conta que será debitada, passar as informações para os Campos “Agência”, “Conta”,
“tipoConta”, “tipoRegistro”, “codigoBarras”, ”dataDebito”, “valorPrincipal” e “idTransacao”.
7. O Campo Valor Principal é obrigatório para ambas as chamadas (Consulta e Inclusão)? Esse
valor no caso seria igual ao extraído a partir do código de barras do boleto?
Sim, o valor é obrigatório nas duas chamadas. O valor principal está entre as posições 5 e 15 do código
de barras. Há situações em que o valor a ser pago é calculado automaticamente pelo sistema por meio
de índices, descontos, multas e/ou juros. Nesses casos, o valor total a ser pago será diferente daquele
constante dentro do código de barras.
8. Quais os motivos de existirem na API de Arrecadações duas chamadas? Uma só de consulta

e a outra de efetivação por meio da qual também realizamos as mesmas consultas?
A primeira chamada da transação faz com que o sistema, além de verificar todas as consistências
da barra, calcule os valores para situações especiais (como juros, multas e descontos sobre o valor
nominal da barra). Além do mais, a primeira chamada retorna algumas informações adicionais como
nome do convênio, datas etc., para que possam ser exibidas para o cliente confirmar se está fazendo
a operação correta.
9. Em caso de pagamento não efetivado por retorno de código de erro, o mesmo Id Transação
pode ser utilizado novamente?
O Id Transação é consumido apenas quando um pagamento é efetivado. Portanto, caso o
pagamento não seja concluído por erro, o mesmo Id pode ser utilizado novamente.
63
12. SUPORTE
Regras técnicas da API: em caso de dúvidas técnicas relacionadas à conectividade e ao
consumo da API, entrar em contato com a nossa Central de Suporte pelo e-mail:
[email protected]
Horário de atendimento: 08h à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 junto ao Bradesco.
Regras de Negócio da API pós-venda: em caso de dúvidas relacionadas ao negócio,

entrar em contato com a nossa Central de Atendimento (AOC) pelo e-mail:
[email protected]
Horário de atendimento: 08h às 17h.
64
13. TABELA DE VERSÕES

VERSÃO DATA RESPOSÁVEL DESCRIÇÃO
1 Junho/2020 Vivaldo Batista Vieira ✓ Perguntas e respostas do serviço de
pagamentos via API apenas para contas de
consumo.
2 Agosto/2020 Vivaldo Batista Vieira ✓ Liberação da API para pagamento de tributos;
✓ Inclusão de comprovantes.
3 Março/2021 Vivaldo Batista Vieira ✓ Inclusão do campo Id Transação;
✓ Inclusão dos campos de request e response da
API.
4 Setembro/2021 Vivaldo Batista Vieira ✓ Inclusão de notas explicativas sobre o status do
pagamento;
✓ Inclusão de fluxos de inclusão/consulta de
pagamento.
5 Abril/2022 Vivaldo Batista Vieira ✓ Atualização do número de parcelas do GARE
IPVA/SP para até 5 vezes.
6 Abril/2022 Vivaldo Batista Vieira ✓ Inclusão da funcionalidade de sumarização de
débitos.
7 Setembro/2022 Vivaldo Batista Vieira ✓ Atualização de perguntas e respostas.
8 Dezembro/2022 Vivaldo Batista Vieira ✓ Agrupamento dos manuais de conectividade e
operação da API.
9 Março/2023 Vivaldo Batista Vieira ✓ Separação dos manuais de conectividade e
operação da API;
✓ Revisão de texto a pedido da equipe de
implementação.
10 Junho/2023 Vivaldo Batista Vieira ✓ Exclusão do comprovante 5-181 FGTS GFIP;
✓ Inclusão dos campos do response da API em
cada modelo de comprovante;
✓ Inclusão dos códigos de retorno do Servidor
HTTP.
11 Julho/2023 Vivaldo Batista Vieira ✓ Atualização da URL da API de Consulta de
Pagamentos.
12 Agosto/2023 Vivaldo Batista Vieira ✓ Atualização da URL da API de Consulta de
Pagamentos.
13 Setembro/2023 Vivaldo Batista Vieira ✓ Atualização da URL da API de Consulta de
Pagamentos.
65

Manual API Pagtos Contas Tributos Via Cód. Barras

Enviado por

Direitos autorais:

Formatos disponíveis

Manual API Pagtos Contas Tributos Via Cód. Barras

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

Manual API Pagtos Contas Tributos Via Cód. Barras

Enviado por

Direitos autorais:

Formatos disponíveis

MANUAL E LAYOUT

API DE PAGAMENTO DE CONTAS DE CONSUMO

10.19. Comprovante Concessionárias.................................................................................................... 61

4. IDENTIFICANDO UMA GUIA DE ARRECADAÇÃO

(Tributos e Contas de Consumo: Água, Luz, Telefone e Gás)

Identificação do Produto: constante “8” para identificar um documento de arrecadação.

Identificação da Empresa: está nas posições 16 a 19 do código de barras. Para o Segmento 6, a

5. FLUXO DE PAGAMENTOS DE ARRECADAÇÃO

✓ Consulta (campo tipoRegistro = 0)

✓ Efetivação (campo tipoRegistro = 1)

6. LAYOUTS DE COMUNICAÇÃO PARA INCLUSÃO DE PAGAMENTO

6.1 Entrada do Pagamento

Swagger - API Arrecadações v1.0.14

Nome Tipo/Tamanho Obrigatório Exemplo Descrição

agencia Numérico (int32;4) Sim “agencia”: 3975 Código da Agência

Agência onde está instalado

conta Numérico (int64;7) Sim "conta": 15478 Número da Conta

Data do Débito (formato:

String (máximo 32 "descricaoCliente": "Teste Descrição do Pagamento

digitoConta String (1) Sim "digitoConta": "4" Dígito da Conta

Valor de Débito Digitado

6.2 Saída do Pagamento

Nome do Campo-Chave (Utilizando apenas para o

Tipo de Serviço da Empresa (vide descrição da

Título Débito Automático String 25 Tipo de Débito Automático

24 - GARE ICMS Geral (substituído pelos

25 - DAS - Simples Nacional (Convênio: 5-0328)

UF String 02 Campo GARE-ICMS

CPF / CNPJ - DVs Numérico 02 Dígito do CPF / CNPJ

Data do momento do pagamento realizado no Canal

Período de Apuração (AAAAMMDD)

CNPJ ou CPF Principal

Filial do CNPJ ou zeros quando CPF

DVs do CNPJ ou CPF

Código da Receita do Pagamento (NNND)

Valor da Receita Bruta Acumulada (999999999DD)

Percentual Aplicado (99DD)

Data de Vencimento (AAAAMMDD)

Nome da Empresa String 40 Nome da Empresa Conveniada

Número da Etiqueta Numérico 13 Número da Etiqueta

Cota Numérico 1 4 - 4ª Parcela

Hora do Pagamento Numérico 06 Hora em que foi realizado o pagamento (HHMMSS)

Identifica o tipo de veículo para o qual está sendo

Tipo de Veículo Numérico 01 0 - Pagamento não possui identificação do veículo

Se o “Tipo de Veículo” for “3 - Veículo Terrestre”

Se o “Tipo de Veículo” for “1 - Aeronave” ou “2 -

Em ambos os casos, a identificação do veículo será

Exemplo de saída de pagamento realizado com sucesso:

Exemplo de saída com mensagem de erro:

6.3 Códigos de Retorno da Transação de Negócio

026 - Campo versão inválido

7. CONSULTAR PAGAMENTO EFETUADO

7.1. Entrada da Consulta

7.2. Saída da Consulta

Valor da Multa N 13 Valor da Multa (99999999999DD)

pelas posições 31 a 44 do código de barras

32 - GARE IPVA - SEFAZ-SP (Convênio: 5-0025)

Filial do CNPJ, ou zeros quando CPF

0 - Não existe parcelamento