Endpoints

Ambiente Endpoint

Produção https://secure.api.itau/pix_recebimentos_conciliacoes/v2/

Homologação https://api.rdhi.com.br/pix_recebimentos_conciliacoes/v2/

Sandbox https://devportal.itau.com.br/sandboxapi/pix_recebimentos_conciliacoes_v2_ext/v2

Bolecode - Emissão / Simulação de BoleCode (POST)

[POST] ../pix_recebimentos_conciliacoes/v2/boletos_pix

API responsável por efetuar a emissão de um boleto + Pix.

Obs: Por regras internas não é permitido o uso de caracter especial, tais como os exemplos: *“ [ “ , “ : “ , “ < ” , “ > ” , “ & ” , “ ; ” , “ ' “ , “ " “ , “ ` “ , “ ( “ , “ ) “ , “ # “ , “
** “ , “ / “ , “ | “ , “ *] “ , “ ü ” , “ http “ , “ javascript “ , “ alert “

Parâmetros de entrada

Parâmetro Tipo Tipo do Presen Descrição Observação

do dado ça
parâm
etro

etapa_processo_boleto body string obrigat Simulação de Emissão - Quando

ório 'simulacao’ e Emissão - escolhida a
'efetivacao' opção
“simulação”
Parâmetro Tipo Tipo do Presen Descrição Observação
do dado ça
parâm
etro

, todas as
validações
serão
realizadas e
os dados de
saída serão
retornados,
porém não
ocorre a
geração
efetiva do
Boleto e do
Pix. Na
efetivação o
processo é
o mesmo e
a emissão é
efetivada.

beneficiario object - obrigat Dados do beneficiário da

ório cobrança (recebedor)

beneficiario.id_beneficiario body string obrigat Agência (4 dígitos) + Conta

ório (7 dígitos) + DAC (1 dígito).
Exemplo: 150000123450

dado_boleto object - obrigat Dados do Boleto associado

ório ao Pix

dado_boleto.tipo_boleto body string opcion Indica o tipo do boleto Deve ser

al indicado um
dos tipos do
boleto: 'a
vista'
Parâmetro Tipo Tipo do Presen Descrição Observação
do dado ça
parâm
etro

'proposta'

dado_boleto.codigo_carteira body string obrigat Deve ser informado algum

ório dos códigos de carteiras
disponíveis: 109, 110,111,
115, 118, 148, 153, 175,
180, 198

dado_boleto.valor_total_titulo body string obrigat Valor total a ser cobrado.

ório Sendo 15 dígitos inteiros e
2 casas decimais. Exemplo:
99999999999999900

dado_boleto.codigo_especie body string obrigat Espécie do título. Ver

ório "Tabela de Espécies"

dado_boleto.data_emissao body string obrigat Data de emissão do boleto.

ório Formato: AAAA-MM-DD

dado_boleto.valor_abatimento body string opcion Valor do abatimento da

al cobrança. Este valor não
pode superar o valor da
cobrança. Formato do
campo: 15 dígitos inteiros e
2 casas decimais.

dado_boleto.protesto object - opcion Configuração de protesto

al

dado_boleto.protesto.protesto body integer obrigat Códigos das instruções de

ório protesto. Ver "Tabela de
Instruções". ESTE CAMPO
ESTÁ EM AJUSTE. CASO
Parâmetro Tipo Tipo do Presen Descrição Observação
do dado ça
parâm
etro

DESEJE PROTESTAR O
TÍTULO, POR FAVOR,
INFORMAR NO CAMPO DE
INSTRUÇÃO

dado_boleto.protesto.quantidade_dias_protesto body integer opcion Quantidade de dias

al requisitado para instrução
de protesto

dado_boleto.instrucao_cobranca object - opcion Configuração de protesto

al

dado_boleto.instrucao_cobranca.codigo_instrucao_cobranca body string opcion Códigos das instruções de

al protesto. Ver "Tabela de
Instruções".

dado_boleto.instrucao_cobranca.quantidade_dias_apos_venciment body string opcion Quantidade de dias após

o al vencimento do boleto.

dado_boleto.instrucao_cobranca.dia_util body boolean opcion Caso a quantidade de dias

al após o vencimento tenha
que ser contabilizada em
dia útil, informar true. Caso
tenha que ser contabilizada
em dias corridos, informar
false.

dado_boleto.negativacao. object - opcion Configuração de

al negativação

dado_boleto.negativacao.negativacao body integer obrigat Códigos das instruções de

ório negativação. Ver "Tabela
Parâmetro Tipo Tipo do Presen Descrição Observação
do dado ça
parâm
etro

de Instruções

dado_boleto.negativacao.quantidade_dias_negativacao body integer opcion Quantidade de dias

al requisitado para instrução
de negativação

dado_boleto.pagador object - obrigat Dados do pagador

ório

dado_boleto.pagador.pessoa object - obrigat Dados do pagador

ório

dado_boleto.pagador.pessoa.nome_pessoa body string obrigat Nome/Razão social do

ório pagador. Máximo
caracteres: 50

dado_boleto.pagador.pessoa.nome_fantasia body string opcion Nome Fantasia do pagador

al - Obrigatório

dado_boleto.pagador.pessoa.tipo_pessoa object - obrigat Dados tipo pessoa do

ório pagador

dado_boleto.pagador.pessoa.tipo_pessoa.codigo_tipo_pessoa body string obrigat Tipo de pessoa do pagador

ório Pessoa Física - 'F' Pessoa
Jurídica - 'J'

dado_boleto.pagador.pessoa.tipo_pessoa.numero_cadastro_pessoa body string opcion CPF do pagador -

_fisica al Obrigatório caso
tipo_pessoa = F Exemplo:
12345678910
Parâmetro Tipo Tipo do Presen Descrição Observação
do dado ça
parâm
etro

dado_boleto.pagador.pessoa.tipo_pessoa.numero_cadastro_nacion body string opcion CNPJ do pagador -

al_pessoa_juridica al Obrigatório caso
tipo_pessoa = J Exemplo:
12312312000110

dado_boleto.pagador.endereco object - obrigat Dados do endereço do

ório pagador

dado_boleto.pagador.endereco.nome_logradouro body string obrigat Nome do logradouro,

ório número, complemento.
Máximo caracteres: 45.

dado_boleto.pagador.endereco.nome_bairro body string obrigat Nome do bairro. Máximo

ório caracteres: 15.

dado_boleto.pagador.endereco.nome_cidade body string obrigat Nome da cidade. Máximo

ório caracteres: 20.

dado_boleto.pagador.endereco.sigla_UF body string obrigat Sigla da UF. Máximo

ório caracteres: 2.

dado_boleto.pagador.endereco.numero_CEP body string obrigat CEP. Máximo caracteres: 8.

ório

dado_boleto.sacador_avalista object - opcion Dados do sacador avalista

al

dado_boleto.sacador_avalista.pessoa object - obrigat Dados do sacador avalista

ório

dado_boleto.sacador_avalista.pessoa.nome_pessoa body string obrigat Nome/Razão social do

Parâmetro Tipo Tipo do Presen Descrição Observação
do dado ça
parâm
etro

ório sacador avalista

dado_boleto.sacador_avalista.pessoa.tipo_pessoa object - obrigat Dados do tipo pessoa

ório sacador avalista

dado_boleto.sacador_avalista.pessoa.tipo_pessoa.codigo_tipo_pess body string obrigat Tipo de pessoa do sacador

oa ório avalista. Pessoa Física - 'F'
Pessoa Jurídica - 'J'

dado_boleto.sacador_avalista.pessoa.tipo_pessoa.numero_cadastr body string opcion CPF do sacador avalista -

o_pessoa_fisica al Obrigatório caso
tipo_pessoa = F Exemplo:
12345678910

dado_boleto.sacador_avalista.pessoa.tipo_pessoa.numero_cadastr body string opcion CNPJ do sacador avalista -

o_nacional_pessoa_juridica al Obrigatório caso
tipo_pessoa = J Exemplo:
12312312000110

dado_boleto.sacador_avalista.endereco.nome_logradouro body string Obrigat Logradouro do endereço -

ório do sacador avalista.
Máximo caracteres: 45.

dado_boleto.sacador_avalista.endereco.nome_bairro body string Obrigat Nome do bairro. Máximo -

ório caracteres: 15.

dado_boleto.sacador_avalista.endereco.nome_cidade body string Obrigat Nome da cidade. Máximo -

ório caracteres: 20.

dado_boleto.sacador_avalista.endereco.sigla_UF body string Obrigat Sigla da UF do endereço. -

ório Máximo caracteres: 2.
Parâmetro Tipo Tipo do Presen Descrição Observação
do dado ça
parâm
etro

dado_boleto.dados_individuais_boleto object - obrigat Dados principais do

ório BoleCode para emissão

dado_boleto.dados_individuais_boleto.numero_nosso_numero body string obrigat Número de identificação De livre

ório da cobrança. utilização
do usuário
seguindo as
regras da
carteira do
produto
contratado.
Não pode
ser repetido
se nosso
número
ainda
estiver ativo
ou tiver
menos de
45 dias de
sua
baixa/liquid
ação.
Formato do
campo: 8
digitos
inteiros.

dado_boleto.dados_individuais_boleto.data_vencimento body string obrigat Data máxima para

ório pagamento sem que haja
acréscimo de juros e multa.
Formato: AAAA-MM-DD

dado_boleto.dados_individuais_boleto.valor_titulo body string obrigat Valor a ser cobrado.

ório Formato do campo: 15
Parâmetro Tipo Tipo do Presen Descrição Observação
do dado ça
parâm
etro

dígitos inteiros e 2 casas

decimais

dado_boleto.dados_individuais_boleto.data_limite_pagamento body string opcion Data limite para

al pagamento. Após esta
data, o título não poderá
ser pago. Formato: AAAA-
MM-DD

dado_boleto.dados_individuais_boleto.texto_uso_beneficiario body string opcion Campo de 25 caractéres,

al utilizado na API legado
como
"identificador_titulo_empr
esa".

dado_boleto.dados_individuais_boleto.texto_seu_numero body string opcion Seu número é a

al identificação do boleto que
poderá ter letras e
números e facilitará a
consulta e
acompanhamento do
status do boleto. Este
campo é para controle do
cliente. CAMPO
OBRIGATÓRIO CASO A
COBRANÇA SEJA
PROTESTADA

dado_boleto.juros object - opcion Dados de juros

al

dado_boleto.juros.data_juros body string opcion Data de início de cobrança

al de juros. Caso o campo
esteja vazio, será
Parâmetro Tipo Tipo do Presen Descrição Observação
do dado ça
parâm
etro

automaticamente
assumido que a cobrança
de juros se inicia logo após
o vencimento. Formato:
AAAA-MM-DD

dado_boleto.juros.codigo_tipo_juros body string obrigat Tipo da cobrança dos juros

ório no cálculo do valor à pagar.
'90' - Percentual mensal
(utilizando parâmetros do
cadastro de beneficiário
para dias úteis ou corridos)
'93' - Valor diário
(utilizando parâmetros do
cadastro de beneficiário
para dias úteis ou corridos)

dado_boleto.juros.valor_juros body string opcion Valor dos juros a ser

al cobrado. Obrigatório para
codigo_tipo_juros ‘93’.
Formato do campo: 15
dígitos inteiros e 2 casas
decimais. Exemplo:
99999999999999900

dado_boleto.juros.percentual_juros body string opcion Percentual dos juros a ser

al cobrado. Obrigatório para
tipo_juros ‘90’, ‘91’ e ‘92’.
Formato do campo: 7
dígitos inteiros e 5 casas
decimais. Exemplo:
999999900000

dado_boleto.multa object - opcion Dados de Multa

Parâmetro Tipo Tipo do Presen Descrição Observação
do dado ça
parâm
etro

al

dado_boleto.multa.codigo_tipo_multa body string obrigat Código da multa '01' -

ório Quando se deseja cobrar
um valor fixo de multa
após o vencimento. '02' -
Quando se deseja cobrar
um percentual do valor do
título de multa após o
vencimento. '03' - Quando
não se deseja cobrar multa
caso o pagamento seja
feito após o vencimento
(isento)

dado_boleto.multa.valor_multa body string opcion Valor da multa cobrada.

al Obrigatório para
codigo_tipo_multa 01.
Formato do campo: 15
dígitos inteiros e 2 casas
decimais.

dado_boleto.multa.percentual_multa body string opcion Percentual da multa

al cobrada. Obrigatório para
tipo_multa 02. Formato do
campo: 7 dígitos inteiros e
5 casas decimais.

dado_boleto.multa.data_multa body string opcion Data de início de cobrança

al de multa. Caso o campo
esteja vazio, será
automaticamente
assumido que a cobrança
de multa se inicia logo após
Parâmetro Tipo Tipo do Presen Descrição Observação
do dado ça
parâm
etro

o vencimento. Formato:
AAAA-MM-DD

dado_boleto.desconto object - opcion Dados de desconto

al

dado_boleto.desconto.codigo_tipo_desconto body string obrigat Código do desconto. Caso

ório exista mais de um
desconto, todos os
“tipo_desconto” deverão
ter o mesmo código.
'00' - Quando não houver
condição de desconto –
sem desconto
'01' - Quando o desconto
for um valor fixo se o título
for pago até a data
informada (data_desconto)
'02' - Quando o desconto
for um percentual do valor
do título e for pago até a
data informada
(data_desconto)
'90' - Percentual por
antecipação(utilizando
parâmetros do cadastro de
beneficiário para dias úteis
ou corridos)"
'91' -Valor por antecipação
(utilizando parâmetros do
cadastro de beneficiário
para dias úteis ou
corridos)"
Parâmetro Tipo Tipo do Presen Descrição Observação
do dado ça
parâm
etro

dado_boleto.desconto.data_desconto body string opcion Data limite de cobrança de

al desconto. Caso o campo
esteja vazio, será
automaticamente
assumido que a cobrança
de desconto é até a data
de vencimento. Formato:
AAAA-MM-DD

dado_boleto.desconto.valor_desconto body string opcion Valor do desconto a ser

al cobrado. Obrigatório para
codigo_tipo_desconto 1 ou
91. Formato do campo: 15
dígitos inteiros e 2 casas
decimais

dado_boleto.desconto.percentual_desconto body string opcion Percentual do desconto

al concedido. Obrigatório
para codigo_tipo_desconto
2 ou 90. Formato do
campo: 7 dígitos inteiros e
5 casas decimais.

dado_boleto.lista_mensagem_cobranca object array opcion Lista de

al mensagens

dado_boleto.lista_mensagem_cobranca.mensagem body string opcion Texto da

al Mensagem

dado_boleto.recebimento_divergente object - Opcion Configuração para indicar

al se será aceito recebimento
divergente do valor
calculado
Parâmetro Tipo Tipo do Presen Descrição Observação
do dado ça
parâm
etro

dado_boleto.recebimento_divergente.codigo_tipo_autorizacao body string obrigat Tipo de autorização de 1 - Quando

ório recebimento divergente da o título
cobrança. aceita
qualquer
valor
divergente
ao da
cobrança
2 - Quando
o título
contém
uma faixa
de valores
aceitos para
recebiment
os
divergentes
3 - Quando
o título não
deve aceitar
pagamentos
de valores
divergentes
ao da
cobrança
4 - Quando
o título
aceitar
pagamentos
de valores
superiores
ao mínimo
definido

dado_boleto.recebimento_divergente.codigo_tipo_recebimento body string opcion Tipo de autorização de V-

al recebimento divergente da Recebiment
Parâmetro Tipo Tipo do Presen Descrição Observação
do dado ça
parâm
etro

cobrança. Obrigatório para o

codigo_tipo_autorizacao divergente
diferente de 01 e 03. for
informado
por valores
P-
Recebiment
o
divergente
for
informado
por
percentuais

dado_boleto.recebimento_divergente.valor_minimo body string opcion Valor mínimo permitido

al para pagamento.
Obrigatório para
codigo_aceite_pagamento
_divergente 2 ou 4.
Formato do campo: 15
dígitos inteiros e 2 casas
decimais.

dado_boleto.recebimento_divergente.percentual_minimo body string opcion Percentual mínimo

al permitido para pagamento.
Obrigatório para
codigo_tipo_autorizacao 2
ou 4. Formato do campo: 7
dígitos inteiros e 5 casas
decimais.

dado_boleto.recebimento_divergente.valor_maximo body string opcion Valor máximo permitido

al para pagamento.
Obrigatório para
codigo_tipo_autorizacao 2.
Parâmetro Tipo Tipo do Presen Descrição Observação
do dado ça
parâm
etro

Formato do campo: 15
dígitos inteiros e 2 casas
decimais.

dado_boleto.recebimento_divergente.percentual_maximo body string opcion Percentual máximo

al permitido. Obrigatório
para
codigo_tipo_autorizacao 2.
Formato do campo: 7
dígitos inteiros e 5 casas
decimais.

dados_qrcode object - opcion Dados do qrcode que

al vinculado ao boleto

dados_qrcode.chave body string opcion Chave DICT do recebedor

al (CNPJ, email, chave
aleatória ou telefone)

dados_qrcode.id_location body integer($i opcion Identificador da URL que Esse campo

nt64) al contém a localização dos deve ser
dados da cobrança utilizado
atrelada ao QR Code quando a
imagem do
QR Code foi
gerado pela
API de
Location
(para
reutilização
da imagem
do QR Code
ou para
emissão off-
Parâmetro Tipo Tipo do Presen Descrição Observação
do dado ça
parâm
etro

line) Caso
não seja
enviado a
location
será gerada
automatica
mente

dados_qrcode.tipo_cobranca body string opcion Identificador do tipo de Valores

al cobranca do PIX. aceitos: cob
= cobrança
pix imediata
Tabela de Instruções

Código Instrução

1 Protestar

2 Negativar

4 Não protestar

5 Não negativar

7 Não receber após o vencimento

8 Baixar após vencimento. OBS: Não aceita o valor 0.

Tabela de Espécies

Código Sigla Descrição da espécie

01 DM Duplicata de Venda Mercantil

02 NP Nota Promissória

03 NS Nota de Seguro

04 ME Mensalidade Escolar

05 RC Recibo

06 CT Contrato
Código Sigla Descrição da espécie

08 DS Duplicata de Prestação de Serviços Original

09 LC Letra de Câmbio

15 DD Documento de Dívida

16 EC Encargos CondominaisEncargos Condominais

17 FS Fatura de Serviço

18 BDP Boleto Proposta

88 CBI Cédula de Crédito Bancário por Indicação

89 CC Contrato de Câmbio

90 CCB Cédula de Crédito Bancário

91 CD Confissão de Dívida

92 CH Cheque

93 CM Contrato de Mútuo

94 CPS Conta de Prestação de Serviços

95 DMI Duplicata de Venda Mercantil por Indicação

96 DSI Duplicata de Prestação de Serviços - Original Por Indicação

 Código Sigla Descrição da espécie

97 RA Recibo de Aluguel (PJ)

98 TA Termo de acordo

99 DV Diversos

Exemplo de entrada

Body:
{
"etapa_processo_boleto": "efetivacao",
"beneficiario": {
"id_beneficiario": "150000052061"
},
"dado_boleto": {
"tipo_boleto": "a vista",
"codigo_carteira": "110",
"valor_total_titulo": "90000000000030000",
"codigo_especie": "01",
"data_emissao": "2022-03-25",
"valor_abatimento": "00000000000000010",

"negativacao": {
"negativacao": 2,
"quantidade_dias_negativacao": 5
},
"pagador": {
"pessoa": {
"nome_pessoa": "Joao Silva",
"nome_fantasia": "Joao Silva Fantasia",
"tipo_pessoa": {
"codigo_tipo_pessoa": "F",
"numero_cadastro_pessoa_fisica": "26556923221"
}
},
"endereco": {
 "nome_logradouro": "Av do Estado, 5533",
"nome_bairro": "Mooca",
"nome_cidade": "Sao Paulo",
"sigla_UF": "SP",
"numero_CEP": "04135010"
}
},
"sacador_avalista": {
"pessoa": {
"nome_pessoa": "Sacador Teste",
"tipo_pessoa": {
"codigo_tipo_pessoa": "F",
"numero_cadastro_pessoa_fisica": "38365972841"
}
},
"endereco": {
"nome_logradouro": "Av do Estado, 5533",
"nome_bairro": "Mooca",
"nome_cidade": "Sao Paulo",
"sigla_UF": "SP",
"numero_CEP": "04135010"
}
},
"dados_individuais_boleto": [
{
"numero_nosso_numero": "12345678",
"data_vencimento": "2022-07-30",
"texto_seu_numero": "000001",
"texto_uso_beneficiario": "2",
"valor_titulo": "00000000000010001",
"data_limite_pagamento": "2022-10-30"
}
],
"juros": {
"data_juros": "2022-09-30",
"codigo_tipo_juros": "93",
"valor_juros": "00000000000000010"
},
"multa": {
"codigo_tipo_multa": "02",
"percentual_multa": "000000100001",
"data_multa": "2022-10-30"
},
"lista_mensagem_cobranca": [
 {
"mensagem": "mensagem 1"
}
],
"desconto": {
"codigo_tipo_desconto": "02",
"descontos": [
{
"data_desconto": "2022-06-30",
"valor_desconto": "00000000000010000",
"percentual_desconto": "000000001010"
}
]
},
"instrucao_cobranca": [
{
"codigo_instrucao_cobranca": "1",
"quantidade_dias_apos_vencimento": 2,
"dia_util": false
}
]
},
"dados_qrcode": {
"chave": "pjoperador@gmail.com",
"id_location": 789
}
}

Parâmetros de saída

Parâmetro Tipo do Tipo do dado Presenç Descrição Observação

parâme a
tro

codigo_canal_operacao body string obrigat Código canal da API

ório operação

codigo_operador body string obrigat Agência (4 dígitos)

ório + Conta (5 dígitos)

etapa_processo_boleto body string obrigat Etapa de negócio ["simulacao", "efetivacao"]

Parâmetro Tipo do Tipo do dado Presenç Descrição Observação
parâme a
tro

ório executada

beneficiario object - obrigat Dados do

ório beneficiário

beneficiario.id_beneficiario body string obrigat Agência + Conta +

ório DAC do
beneficiário

beneficiario.nome_cobranca body string obrigat Nome do

ório beneficiário para
uso na cobrança

beneficiario.tipo_pessoa object - obrigat Informações

ório pessoais do
beneficiário da
cobrança

beneficiario.tipo_pessoa.codigo_tipo_pessoa body string obrigat Tipo do pessoa ["F", "J"]

ório

beneficiario.tipo_pessoa.numero_cadastro_pessoa_fisica body string opciona CPF - Obrigatório

l caso tipo_pessoa =
F

beneficiario.tipo_pessoa.numero_cadastro_nacional_pessoa_ju body string opciona CNPJ - Obrigatório

ridica l caso tipo_pessoa =
J

beneficiario.endereco object - obrigat Dados do

ório endereço do
beneficiário
Parâmetro Tipo do Tipo do dado Presenç Descrição Observação
parâme a
tro

beneficiario.endereco.nome_logradouro body string obrigat Nome do

ório logradouro

beneficiario.endereco.nome_bairro body string obrigat Nome do bairro

ório

beneficiario.endereco.nome_cidade body string obrigat Nome da cidade

ório

beneficiario.endereco.sigla_UF body string obrigat Sigla da UF

ório

beneficiario.endereco.numero_CEP body string obrigat CEP

ório

beneficiario.endereco.numero body string obrigat Número do logradouro

ório

beneficiario.endereco.complemento body string obrigat Complemento do

ório Endereco

dado_boleto object - obrigat Dados do Boleto

ório associado ao Pix

dado_boleto.tipo_boleto body string Opcion Identifica o tipo do tipos do boleto: 'a vista' e 'proposta'
al boleto.

dado_boleto.codigo_carteira body string obrigat Código da carteira.

ório

dado_boleto.codigo_tipo_vencimento body string obrigat Tipos de 1 - Vencimento do boleto à vista (data de

ório vencimento vencimento é a data do dia da emissão)
3 - Data de vencimento determinada (data
Parâmetro Tipo do Tipo do dado Presenç Descrição Observação
parâme a
tro

informada pelo cliente)

dado_boleto.valor_total_titulo body string obrigat Valor total a ser

ório cobrado.

dado_boleto.codigo_especie body string obrigat Código de espécie Preenchido conforme os domínios da

ório do título tabela de espécies

dado_boleto.data_emissao body string obrigat Data em que a

ório cobrança foi
emitida. Formato:
YYYY-MM-DD

dado_boleto.pagamento_parcial body boolean obrigat Indicador se aceita Será sempre false para bolecode
ório pagamento
parcial.

dado_boleto.quantidade_maximo_parcial body string obrigat Quantidade Para bolecode sempre igual a zeros
ório permitida de
pagamentos
parciais do boleto.

dado_boleto.desconto_expresso body boolean obrigat Indicador se o False para bolecode

ório cliente tem o
produto Desconto
Expresso.

dado_boleto.pagador object - obrigat Dados do pagador

ório

dado_boleto.pagador.pagador_eletronico_DDA body boolean opciona Indicador se é

l pagador eletrônico
(DDA)
Parâmetro Tipo do Tipo do dado Presenç Descrição Observação
parâme a
tro

dado_boleto.pagador.praca_protesto body boolean opciona Indicador CEP do

l pagador possui
praça para
protesto

dado_boleto.pagador.pessoa object - obrigat Dados do pagador

ório

dado_boleto.pagador.pessoa.nome_pessoa body string obrigat Nome do pagador

ório

dado_boleto.pagador.pessoa.tipo_pessoa object - obrigat Tipo da pessoa

ório pagadora

dado_boleto.pagador.pessoa.tipo_pessoa.codigo_tipo_pessoa body string obrigat Indicador do tipo

ório da pessoa
pagadora (F -
Física / J - Jurídica)

dado_boleto.pagador.pessoa.tipo_pessoa.numero_cadastro_p body string opciona Número do CPF

essoa_fisica l quando o tipo da
pessoa pagadora
for "F"

dado_boleto.pagador.pessoa.tipo_pessoa.numero_cadastro_n body string opciona Número do CPF

acional_pessoa_juridica l quando o tipo da
pessoa pagadora
for "J"

dado_boleto.pagador.endereco object string opciona Dados do

l endereço do
pagador
Parâmetro Tipo do Tipo do dado Presenç Descrição Observação
parâme a
tro

dado_boleto.pagador.endereco.nome_logradouro body string opciona Logradouro do

l endereço do
pagador

dado_boleto.pagador.endereco.nome_bairro body string opciona Nome do bairro

l

dado_boleto.pagador.endereco.nome_cidade body string opciona Nome da cidade

l

dado_boleto.pagador.endereco.sigla_UF body string opciona Sigla da UF do

l endereço

dado_boleto.pagador.endereco.numero_CEP body string opciona CEP

l

dado_boleto.dados_individuais_boleto object array obrigat Dados principais

ório da cobrança

dado_boleto.dados_individuais_boleto.id_boleto_individual body string obrigat UUID que

ório identifica o boleto

dado_boleto.dados_individuais_boleto.numero_nosso_numer body string obrigat Número de

o ório identificação do
título. De livre
utilização do
usuário seguindo
as regras da
carteira do
produto
contratado. Não
pode ser repetido
se nosso número
ainda estiver ativo
Parâmetro Tipo do Tipo do dado Presenç Descrição Observação
parâme a
tro

ou tiver menos de
45 dias de sua
baixa/liquidação.
Formato do
campo: 8 digitos
inteiros.

dado_boleto.dados_individuais_boleto.dac_titulo body string obrigat Dígito verificador

ório do nosso número

dado_boleto.dados_individuais_boleto.data_vencimento body string obrigat Último dia para Formato: YYYY-MM-DD

ório pagamento sem
acréscimo de
multa, juros e
outros. Tipo de
vencimento à vista
não é preenchido.

dado_boleto.dados_individuais_boleto.valor_titulo body string obrigat Valor a ser Formato: 99999999999999900

ório cobrado. Inserir
em formato
999999999999999
00, sendo 9 os
dígitos inteiros e 0
as casas decimais.

dado_boleto.dados_individuais_boleto.texto_seu_numero body string opciona Seu número é a

l identificação do
boleto que poderá
ter letras e
números e
facilitará a
consulta e
acompanhamento
do status do
Parâmetro Tipo do Tipo do dado Presenç Descrição Observação
parâme a
tro

boleto. Este
campo é para
controle do
cliente.

dado_boleto.dados_individuais_boleto.codigo_barras body string obrigat Número do código Formato:

ório de barras (barra 3410123456789012345678901234567890
lida). Para 1234567890
carteiras com
nosso numero
adicional, sempre
preencher o
código de barras.

dado_boleto.dados_individuais_boleto.numero_linha_digitavel body string obrigat Número da linha Formato:

ório digitável (barra 3410123456789012345678901234567890
digitável). Número 1234567890123
exibido para
pagamento do
boleto.

dado_boleto.dados_individuais_boleto.data_limite_pagament body string obrigat Data limite para Formato: YYYY-MM-DD

o ório pagamento.
Cobrança não
poderá ser paga
após essa data.
Esta data é
posterior a data de
vencimento.

dado_boleto.dados_individuais_boleto.lista_mensagens_cobra body string[] obrigat Lista de

nca ório mensagens

dado_boleto.recebimento_divergente object string Opcion

Parâmetro Tipo do Tipo do dado Presenç Descrição Observação
parâme a
tro

al

dado_boleto.recebimento_divergente.codigo_tipo_autorizacao body string obrigat Tipo de 1 - Quando o título aceita qualquer valor
ório autorização de divergente ao da cobrança
recebimento 2 - Quando o título contém uma faixa de
divergente da valores aceitos para recebimentos
cobrança. divergentes
3 - Quando o título não deve aceitar
pagamentos de valores divergentes ao da
cobrança
4 - Quando o título aceitar pagamentos de
valores superiores ao mínimo definido

dado_boleto.recebimento_divergente.codigo_tipo_recebiment body string obrigat Tipo de V - Recebimento divergente for informado

o ório autorização de por valores
recebimento P - Recebimento divergente for informado
divergente da por percentuais
cobrança.
Obrigatório para
codigo_tipo_autor
izacao diferente
de 01 e 03.

dado_boleto.recebimento_divergente.percentual_minimo body string obrigat Percentual mínimo

ório permitido para
pagamento.
Obrigatório para
codigo_tipo_autor
izacao 02 ou 04 e
codigo_tipo_receb
imento P.

dado_boleto.recebimento_divergente.percentual_maximo body string obrigat Percentual

ório máximo
permitido.
Parâmetro Tipo do Tipo do dado Presenç Descrição Observação
parâme a
tro

Obrigatório para
codigo_tipo_autor
izacao 02 e
codigo_tipo_receb
imento P.

dados_qrcode object string obrigat

ório

dados_qrcode.chave body string obrigat Chave do

ório Beneficiário na
DICT

dados_qrcode.emv body string obrigat Pix Copia e cola

ório (Texto usado para
pagamento do QR
Code)

dados_qrcode.base64 body string obrigat Imagem em

ório base64 do
QRCODE PIX.

dados_qrcode.txid - - obrigat Identificador do Inicia c/ “BL” Na sequência , Agência (4

ório Pix, gerado posições), Conta (7 posições), carteira (3
automaticamente posições) e Nosso Número (15 posições)
no bolecode Exemplo:“BL999900000001091234567890
12345”

dados_qrcode.id_location body integer($int64) obrigat Identificador da Esse campo posse ser informado ou
ório URL que contem a gerado automaticamente na emissão.
localização dos
dados da cobrança

dados_qrcode.location body string($uri)/ - URL com a Essa URL só pode ser aberta por
Parâmetro Tipo do Tipo do dado Presenç Descrição Observação
parâme a
tro

(maxLength = 77) localização do participantes, não sendo possível a

payload que visualização dos dados do QR Code em
contém os dados qualquer browser. (apenas nos aplicativos
da cobrança para pagamento)

dados_qrcode.tipo_cobranca body string opciona Identificador do Valores aceitos: cob = cobrança pix
l tipo de cobranca imediata
do PIX.
Códigos de Resposta

Código de Status Descrição

200 BoleCode “simulado” ou “emitido e registrado com sucesso”

400 Parâmetros incorretos

401 Não autorizado

403 Acesso proibido (Requisição de participante autenticado que viola alguma regra de autorização

404 Recurso inexistente

405 Método não permitido

422 Dados informados estão fora do escopo definido para o campo (erro na validação de negócios)

428 Pré-requisito necessário

500 Erro Inesperado. Entre em contato com o suporte Itaú.

501 Não implementado

503 Serviço indisponível

504 Gateway Timeout. Entre em contato com o suporte Itaú.

Exemplo de saída (status = 200, application/json)
{
"data": {
"codigo_canal_operacao": "API",
"codigo_operador": "150015605",
"etapa_processo_boleto": "efetivacao",
"beneficiario": {
"id_beneficiario": "150000052061",
"nome_cobranca": "COMPUTADORES OCSIS S/A",
"tipo_pessoa": {
"codigo_tipo_pessoa": "J",
"numero_cadastro_nacional_pessoa_juridica": "00015602000112"
},
"endereco": {
"nome_logradouro": "R ODORICO MENDES, 22222, TESTE",
"nome_bairro": "MOOCA",
"nome_cidade": "SAO PAULO",
"sigla_UF": "SP",
"numero_CEP": "03106030",
"numero": "22222",
"complemento": "TESTE"
}
},
"dado_boleto": {
"tipo_boleto": "a vista",
"pagador": {
"pessoa": {
"nome_pessoa": "Joao Silva",
"tipo_pessoa": {
"codigo_tipo_pessoa": "F",
"numero_cadastro_pessoa_fisica": "26556923221"
}
},
"endereco": {
"nome_logradouro": "Av do Estado, 5533",
"nome_bairro": "Mooca",
"nome_cidade": "Sao Paulo",
"sigla_UF": "SP",
"numero_CEP": "04135010"
},
"pagador_eletronico_DDA": true,
"praca_protesto": true
},
 "codigo_carteira": "109",
"codigo_tipo_vencimento": 3,
"valor_total_titulo": "90000000000030000",
"dados_individuais_boleto": [
{
"id_boleto_individual": "0b0051fa-a02d-4a45-a11c-b8775a05b59f",
"numero_nosso_numero": "12345678",
"dac_titulo": "4",
"data_vencimento": "2022-07-30",
"valor_titulo": "00000000000030000",
"texto_seu_numero": "000001",
"texto_uso_beneficiario": "2",
"codigo_barras": "34194906200000300001570012763661500052061000",
"numero_linha_digitavel": "34191570071276366150600520610007490620000030000",
"data_limite_pagamento": "2032-07-30",
"lista_mensagens_cobranca": [
{
"mensagem": "mensagem 1"
}
]
}
],
"codigo_especie": "01",
"data_emissao": "2022-01-04",
"pagamento_parcial": false,
"quantidade_maximo_parcial": "0",
"recebimento_divergente": {
"codigo_tipo_autorizacao": "02",
"codigo_tipo_recebimento": "P",
"percentual_minimo": "00000000000000000",
"percentual_maximo": "00000000000000000"
},
"desconto_expresso": false
},
"dados_qrcode": {
"chave": "pjoperador@gmail.com",
"txid": "BL150000052061109000000000127623",
"id_location": 789,
"location": "api.itau/pix/qr/v2/04f90e1d-afe4-4aa9-9246-579551f487275204000053039865802BR5920CARVALHEIRA",
"emv": "00020101021226860014BR.GOV.BCB.PIX2564spi-h.itau.com.br/pix/qr/v2/e8772e8f-3e31-4766-831c-
c3ce8f453b635204000053039865802BR5920CARVALHEIRA GERALDES6009SAO PAULO62070503***63048DAC",
"base64": "iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAAC1klEQVR4Xu2XS47rIBBFYSNm/7vopcBG4J1TRG0ng9YbtKsnrkSKDSfSTX0uTlk/
x1f5XPmIB9jxADseYMf/Ab2UOusaax5ttll8DxcTgcF79CpZxzxKW9y5mAl014mGSpa9rZtJBUYnR4pckaij/QFAkhoMFfLGLCUDvFmcbrJx1OVnrKcB9uf4jM+u/tz/
ZcCYCCRXJKwNqkbj7MgCemQo6sMlI1wonD2cCKjMSjk10bm4CFJTgd62ToYHmS1umZ6zaRMAlJEct6pJimzBqDENYFR6gQipxRQBL4cpD7Bcs+3jBA+jVi6N+MgCwjqax5py27Jox3u
xbgc8xzxVD9dH2NewWJkAy9wyK3qXpwl1A7lW83bAVNVIThSset92rdIAvHPQr/TqcICGJgLIwZIH2J8+YGBj6NzJIg5VZgEIZNHkYOdMDmIt1KWa9wMjBqbooGhV3bR/r7/
idoBeYZXnXkgu1BjCz19xP2B6Op3SXRsv97CNEgHSNLZ796jacpDGuPyK+4HpWdL0kCPUwiryLFYCYNtao31h93b6p+qoeQBNq4kTtCqdgmTH2W9kAUxtt2d1U8zE+SXon0SANaZVA5
lyCNXRPO/zACpUHZ5ptnw5P1Tqu1gJAMOitBJOFpOMmzXxPMDjnP6IfXbsHr9yHd7bAded3kNh1IsHL2t3PdRuB+JER1ZRo1t8vNwsDRj7dG9LR53Uiz/
F79XMAFhdkSJONdA9upfhvR9YkSsyBFg0khavs1gJwHRumtZVI01LT8NVzmomADZKMU0y3TFC9XEReT+gZSCKRFGrEikLX/
sWmQAYeJcmXuNoVfH74X47oCL2lUW8PFVDTwRsET88WkmZeVOkGvMASoXQ4tD6XyhsXd3JgBliZlBGwlYk7yxWEsBC6z7eQHm4MDru5wG80ee04qNc6mGhOQ+IyrCL0ub0eCVswrKAn
+IBdjzAjgfY8QvAP6fWH62SBojlAAAAAElFTkSuQmCC",
"tipo_cobranca": "cob"
}
}
}