Manual API

BoleCode powered by pix

Manual emissão via API

Bolecode - Emissão / Simulação de BoleCode (POST)
O “BoleCode” permite a disponibilização no mesmo instrumento de pagamento o código de barras e
o QR Code, dessa maneira, possibilita que o pagador decida a forma mais conveniente de realizar
seus pagamentos.

Essa solução oferece as vantagens das duas modalidades, como a instantaneidade do Pix e encargos,
descontos, protesto e negativação do boleto, podendo contribuir para maior eficiência do seu
negócio.

Os produtos “Pix” e “Boleto” mantém suas características preservadas e passam a ter uma
associação, evitando duplicidade no pagamento e permitindo a baixa da forma de pagamento não
escolhida.

Essa API simula ou emite o Boleto e Pix associados.

POST /pix_recebimentos/v2/boletos_pix

Parâmetros de entrada

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

parâmetro do Observação
dado

etapa_processo Body (String Obrigatório Simulação de Emissão - Quando escolhida

_boleto ) 'simulacao’ Emissão - a opção
'efetivacao' “simulação”, 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ório Dados do beneficiário da
cobrança (recebedor)

beneficiário. Body (String Obrigatório Agência (4 dígitos) +

id_beneficiario ) Conta (7 dígitos) + DAC
(1 dígito). Exemplo:
150000123450
dado_boleto object - Obrigatório Dados do Boleto
associado ao Pix

dado_boleto. Body (String obrigatório Indica o tipo do boleto Deve ser indicado
tipo_boleto ) um dos tipos do
boleto: 'a vista'
'proposta'

dado_boleto.co Body (String obrigatório Deve ser informado

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

dado_boleto. Body (String obrigatório Valor total a ser cobrado.

valor_total_titu ) Sendo 15 dígitos inteiros
lo e 2 casas decimais.
Exemplo:
99999999999999900

dado_boleto. Body (String obrigatório Espécie do título. Ver

codigo_especie ) "Tabela de Espécies"

dado_boleto. Body (String opcional Valor do abatimento da

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

dado_boleto.da Body (String opcional Data de emissão do

ta_emissao ) boleto. Formato: AAAA-
MM-DD

dado_boleto.pa object - Obrigatório Dados do pagador

gador

dado_boleto.pa object - Obrigatório Dados do pagador

gador. pessoa

dado_boleto.pa Body (String obrigatório Nome/Razão social do

gador. pessoa. ) pagador. Máximo
nome_pessoa caracteres: 50

dado_boleto.pa Body (String opcional Nome Fantasia do

gador. pessoa. ) pagador - Obrigatório
nome_fantasia caso tipo_pessoa = J
Exemplo: Empresa A

dado_boleto.pa object - Obrigatório Dados tipo pessoa do

gador. pessoa. pagador
tipo_pessoa
dado_boleto.pa Body (String obrigatório Tipo de pessoa do
gador. pessoa. ) pagador Pessoa Física -
tipo_pessoa. 'F' Pessoa Jurídica - 'J'
codigo_tipo_pe
ssoa

dado_boleto.pa Body (String opcional CPF do pagador -

gador. pessoa. ) Obrigatório caso
tipo_pessoa. tipo_pessoa = F Exemplo:
numero_cadast 12345678910
ro_pessoa_fisic
a

dado_boleto.pa Body (String opcional CNPJ do pagador -

[Link] ) Obrigatório caso
po_pessoa. tipo_pessoa = J Exemplo:
numero_cadast 12312312000110
ro_nacional_pe
ssoa_juridica

dado_boleto. object - Obrigatório Dados do endereço do

[Link] pagador
co

dado_boleto. Body (String obrigatório Nome do logradouro,

[Link] ) número, complemento.
co.nome_logra Máximo caracteres: 45
douro

dado_boleto. Body (String obrigatório Nome do bairro

[Link] )
co.
nome_bairro

dado_boleto. Body (String obrigatório Nome da cidade

pagador. )
endereço.
nome_cidade

dado_boleto. Body (String obrigatório Sigla da UF

[Link] )
co. sigla_UF

dado_boleto. Body (String obrigatório CEP

[Link] )
co.numero_CEP

dado_boleto.sac object - Obrigatório Dados do sacador

ador_avalista avalista
dado_boleto.sac object - Obrigatório Dados do sacador
ador_avalista.pe avalista
ssoa

dado_boleto.sac Body (String obrigatório Nome/Razão social do

ador_avalista.pe ) sacador avalista
ssoa.
nome_pessoa

dado_boleto.sac object - Obrigatório Dados do tipo pessoa

ador_avalista.pe sacador avalista
ssoa.
tipo_pessoa

dado_boleto.sac Body (String obrigatório Tipo de pessoa do

ador_avalista.pe ) sacador avalista. Pessoa
ssoa. Física - 'F' Pessoa Jurídica
tipo_pessoa. - 'J'
codigo_tipo_pe
ssoa

dado_boleto.sac Body (String opcional CPF do sacador avalista -

ador_avalista.pe ) Obrigatório caso
ssoa. tipo_pessoa = F Exemplo:
tipo_pessoa. 12345678910
numero_cadast
ro_pessoa_fisic
a

dado_boleto.sac Body (String opcional CNPJ do sacador avalista

ador_avalista.pe ) - Obrigatório caso
ssoa. tipo_pessoa = J Exemplo:
tipo_pessoa. 12312312000110
numero_cadast
ro_nacional_pe
ssoa_juridica

dado_boleto.da object - Obrigatório Dados principais do

dos_individuais_ BoleCode para emissão
boleto

dado_boleto.da Body (String obrigatório Número de identificação De livre utilização

dos_individuais_ ) da cobrança. do usuário
boleto.numero_ seguindo as regras
nosso_numero 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/liquidação.

dado_boleto.da Body (String obrigatório Data máxima para

dos_individuais_ ) pagamento sem que haja
boleto. acréscimo de juros e
data_vencimen multa. Formato: AAAA-
to MM-DD

dado_boleto.da Body (String obrigatório Valor a ser cobrado.

dos_individuais_ ) Formato do campo: 15
boleto. dígitos inteiros e 2 casas
valor_titulo decimais

dado_boleto.da Body (String opcional Data limite para

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

dado_boleto.da Body (String opcional Campo de 25 caractéres,

dos_individuais_ ) utilizado na API legado
boleto. como
texto_uso_ben "identificador_titulo_empr
eficiario esa".

dado_boleto.te Body (String opcional Este campo é para

xto_seu_numer ) controle do cliente. Pode
o ter letras e números e
facilitar a consulta e
acompanhamento do
status do boleto.

dado_boleto. object - opcional Dados de juros

Juros

dado_boleto.jur Body (String obrigatório Tipo da cobrança dos

os.codigo_tipo_ ) juros no cálculo do valor
juros à 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.jur Body (String opcional Valor dos juros a ser

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

dado_boleto.jur Body (String opcional Percentual dos juros a ser

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

dado_boleto.jur Body (String opcional Data de início de

os.data_juros ) cobrança de juros. Caso o
campo esteja vazio, será
automaticamente
assumido que a cobrança
de juros se inicia logo
após o vencimento.
Formato: AAAA-MM-DD

dado_boleto. object - opcional Dados de Multa

multa

dado_boleto.mu Body (String obrigatório Código da multa '01' -

lta.codigo_tipo ) Quando se deseja cobrar
_multa 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.mu Body (String opcional Valor da multa cobrada.

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

dado_boleto.mu Body (String opcional Percentual da multa

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

dado_boleto.mu Body (String opcional Data de início de

lta. data_multa ) cobrança de multa. Caso
o campo esteja vazio,
será automaticamente
assumido que a cobrança
de multa se inicia logo
após o vencimento.
Formato: AAAA-MM-DD

dado_boleto. object - opcional Dados de desconto

desconto

dado_boleto.de Body (String obrigatório Código do desconto.

sconto.codigo_t ) Caso exista mais de um
ipo_desconto 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)"

dado_boleto.de Body (string opcional Data limite de cobrança

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

dado_boleto.de Body (String opcional Valor do desconto a ser

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

dado_boleto.de Body (String opcional Percentual do desconto

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

dado_boleto. object - obrigatório Configuração para indicar

recebimento_di se será aceito
vergente recebimento divergente
do valor calculado

dado_boleto.rec Body (String obrigatório Tipo de autorização de "01" - Quando o

ebimento_diver ) recebimento divergente título aceita
gente. da cobrança. qualquer valor
codigo_tipo_au divergente ao da
torizacao cobrança.

"02" - Quando o
título contém uma
faixa de valores
aceitos para
recebimentos
divergentes.

"03" - Quando o
título não deve
aceitar
pagamentos de
valores divergentes
ao da cobrança.

"04" - Quando o
título aceitar
pagamentos de
valores superiores
ao mínimo
definido"
dado_boleto.rec Body (String Opcional Tipo de autorização de V - Recebimento
ebimento_diver ) recebimento divergente divergente for
gente.codigo_ti da cobrança. Obrigatório informado por
po_recebiment para valores
o codigo_tipo_autorizacao
diferente de 01 e 03 P - Recebimento
divergente for
informado por
percentuais

dado_boleto.rec Body (String opcional Valor mínimo permitido

ebimento_diver ) para pagamento.
gente. Obrigatório para
valor_minimo codigo_aceite_pagament
o_divergente 2 ou 4.
Formato do campo: 15
dígitos inteiros e 2 casas
decimais

dado_boleto.rec Body (String opcional Percentual mínimo

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

dado_boleto.rec Body (String opcional Valor máximo permitido

ebimento_diver ) para pagamento.
gente.valor_ma Obrigatório para
ximo codigo_tipo_autorizacao
2. Formato do campo: 15
dígitos inteiros e 2 casas
decimais

dado_boleto.rec Body (String opcional Percentual máximo

ebimento_diver ) permitido. Obrigatório
gente. para
percentual_ma codigo_tipo_autorizacao
ximo 2. Formato do campo: 7
dígitos inteiros e 5 casas
decimais

dado_boleto. object - opcional Configuração de protesto

protesto

dado_boleto.pr Body (Integ obrigatorio Códigos das instruções

otesto. er) de protesto. Ver "Tabela
protesto de Instruções"
dado_boleto.pr Body (Integ opcional Quantidade de dias
otesto. er) requisitado para
quantidade_dia instrução de protesto
s_protesto

dado_boleto. object - obrigatorio Configuração de

negativacao negativação

dado_boleto.ne Body (Integ obrigatorio Códigos das instruções

[Link] er) de negativação. Ver
ivação "Tabela de Instruções"

dado_boleto.ne Body (Integ opcional Quantidade de dias

gativacao. er) requisitado para
quantidade_dia instrução de negativação
s_negativacao

dado_boleto.list object array opcional Lista de

a_mensagem_co mensagens
branca

dado_boleto.list Body String opcional Texto da

a_mensagem_co Mensagem
[Link]
em

dados_qrcode object - opcional Dados do qrcode que

vinculado ao boleto

dados_qrcode.c body (String opcional Chave DICT do recebedor

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

dados_qrcode.l object - opcional

oc

dados_qrcode.l body obrigatório Identificador da URL que Esse campo deve

[Link] intege contém a localização dos ser utilizado
r($int6 dados da cobrança quando a imagem
4) atrelada ao QR Code do QR Code foi
gerado pela API de
Location (para
reutilização da
imagem do QR
Code ou para
emissão off-line)

Caso não seja

enviado a location
será gerada
automaticamente
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

Tabela de Espécies

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

1 DM Duplicata de Venda Mercantil

2 NP Nota Promissória

3 NS Nota de Seguro

4 ME Mensalidade Escolar

5 RC Recibo

6 CT Contrato

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

9 LC Letra de Câmbio

15 DD Documento de Dívida

16 EC Encargos 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
 Código Sigla Descrição da espécie

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

Duplicata de Prestação de Serviços - Original Por

96 DSI
Indicação

97 RA Recibo de Aluguel (PJ)

98 TA Termo de acordo

99 DV Diversos

Exemplo de entrada

Body:

{
"etapa_processo_boleto":"simulacao",
"beneficiario":{
"id_beneficiario":"150000015605"
},
"dado_boleto":{
"tipo_boleto":"a vista",
"pagador":{
"pessoa":{
"nome_pessoa":"Nubibat",
"tipo_pessoa":{
"codigo_tipo_pessoa":"F",
"numero_cadastro_pessoa_fisica":"05201005225"
}
},
"endereco":{
"nome_logradouro":"Av Hilario Pereira de Souza, 492",
"nome_bairro":" ",
"nome_cidade":"Osasco",
"sigla_UF":"SP",
"numero_CEP":"04131020"
}
},
"sacador_avalista":{
"pessoa":{
"nome_pessoa":"Sacador Teste",
"tipo_pessoa":{
"codigo_tipo_pessoa":"F",
"numero_cadastro_pessoa_fisica":"38365972840"
}
},
},
 "codigo_tipo_vencimento":3,
"valor_total_titulo":"00000000000200001",
"dados_individuais_boleto":[{
"data_vencimento":"2020-08-22",
"valor_titulo":"00000000000010001"
"texto_uso_beneficiario":"1234567890123456789012345"
}],
"codigo_especie":"01",
"multa":{
"codigo_tipo_multa":"02",
"percentual_multa":"000000100001"
},
"lista_mensagem_cobranca":[
{
"mensagem":"jaime3 desconto fixo percentual"
},
{
"mensagem":"teste2"
}
],
}
"dado_qrcode":{
"chave": "pjoperador@[Link]"
"loc": {
"id": 789
}
}
}

Parâmetros de saída
Parâmetro Tipo do Tipo do dado Presença Descrição Observação
parâmetro
codigo_canal_o body string obrigatório Código canal API
peracao da operação
codigo_operad body string obrigatório Agência (4
or dígitos) +
Conta (5
dígitos)
etapa_processo body string obrigatório etapa de ["simulacao",
_boleto negócio "efetivacao"]
executada
beneficiario object - obrigatório Dados do
beneficiário
beneficiario. body string obrigatório Agência +
id_beneficiari Conta + DAC
o do beneficiário
beneficiario. body string obrigatório Nome do
nome_cobran beneficiário
ca para uso na
cobrança
beneficiario. object - obrigatório Informações
tipo_pessoa pessoais do
beneficiário
da cobrança
[Link] body string obrigatório Tipo do pessoa ["F", "J"]
o_pessoa.
codigo_tipo_p
essoa
[Link] Body string opcional CPF -
o_pessoa. Obrigatório
numero_cada caso
stro_pessoa_f tipo_pessoa = F
isica
[Link] Body string opcional CNPJ -
o_pessoa. Obrigatório
numero_cada caso
stro_nacional tipo_pessoa = J
_pessoa_jurid
ica
beneficiario. object - obrigatório Dados do
endereco endereço do
beneficiário
[Link] Body string obrigatório Nome do
dereco.nome_ logradouro
logradouro
[Link] Body string obrigatório Nome do
dereco.nome_ bairro
bairro
[Link] Body string obrigatório Nome da
dereco.nome_ cidade
cidade
[Link] body string obrigatório Sigla da UF
dereco.
sigla_UF
[Link] body string obrigatório CEP
dereco.
numero_CEP
[Link] body string obrigatório Número do
dereco. logradouro
numero
[Link] body string obrigatório Complemento
dereco. do Endereço
complement
o
dado_boleto object - obrigatório Dados do
Boleto
associado ao
Pix
dado_boleto. body string Obrigatório Tipo de "boleto_pix"
descricao_ins Instrumento de
trumento_co Cobrança
branca
dado_boleto. body string Obrigatório Identifica o tipo tipos do
tipo_boleto do boleto. boleto: 'a vista'
'proposta'

dado_boleto.p object - Obrigatório Dados do

agador pagador
dado_boleto.p object - Obrigatório Dados do
[Link] pagador
a
dado_boleto.pa body string Obrigatório Nome do
[Link]. pagador
nome_pessoa
dado_boleto.pa Object - Obrigatório Tipo da
[Link]. pessoa
tipo_pessoa pagadora
dado_boleto.pa body string Obrigatório Indicador do
[Link]. tipo da pessoa
tipo_pessoa.c pagadora (F -
odigo_tipo_pe Física / J -
ssoa Jurídica)
dado_boleto.pa body string Opcional Número do
[Link].t CPF quando o
ipo_pessoa. tipo da pessoa
numero_cada pagadora for
stro_pessoa_f "F"
isica
dado_boleto.pa body string Opcional Número do
[Link].t CPF quando o
ipo_pessoa. tipo da pessoa
numero_cada pagadora for
stro_pessoa_j "J"
uridica
dado_boleto.p object string opcional Dados do
[Link] endereço do
eco pagador
dado_boleto.pa body string opcional Logradouro do
[Link] endereço do
o. pagador
nome_lograd
ouro
dado_boleto.pa body string opcional Nome do
[Link] bairro
o.
nome_bairro
dado_boleto.pa body string opcional Nome da
[Link] cidade
o.
nome_cidade
dado_boleto.pa body string opcional Sigla da UF do
[Link] endereço
o.sigla_UF
dado_boleto.pa body string opcional CEP
[Link]
o.
numero_CEP
dado_boleto.pa body boolean opcional Indicador se é
gador. pagador
pagador_elet eletrônico
ronico_DDA (DDA)
dado_boleto.pa body boolean opcional Indicador CEP
gador. do pagador
praca_protest possui praça
o para protesto
dado_boleto. body string obrigatório Código da
codigo_cartei carteira.
ra

dado_boleto. body string obrigatório Tipos de 1 - Vencimento

codigo_tipo_v vencimento do boleto à
encimento vista (data de
vencimento é a
data do dia da
emissão)
3 - Data de
vencimento
determinada
(data
informada pelo
cliente)
dado_boleto. body string obrigatório Valor total a ser
valor_total_ti cobrado.
tulo

dado_boleto. object array obrigatório Dados

dados_indivi principais da
duais_boleto cobrança
dado_boleto.da body string obrigatório UUID que
dos_individuai identifica o
s_boleto. boleto
id_boleto_ind
ividual
dado_boleto.da body string obrigatório Número de
dos_individuai identificação
s_boleto. do título. De
numero_noss livre utilização
o_numero 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/liquidaçã
o.
dado_boleto.da body string obrigatório Dígito
dos_individuai verificador do
s_boleto. nosso número
dac_titulo
dado_boleto.da body string obrigatório Último dia para Formato:
dos_individuai pagamento YYYY-MM-DD
s_boleto. sem acréscimo
data_vencime de multa, juros
nto e outros. Tipo
de vencimento
à vista não é
preenchido
dado_boleto.da body string obrigatório Valor a ser Formato:
dos_individuai cobrado. Inserir 999999999999
s_boleto. em formato 99900
valor_titulo 999999999999
99900, sendo 9
os dígitos
inteiros e 0 as
casas decimais.
dado_boleto.da body string obrigatório Este campo é
dos_individuai para controle
s_boleto. do cliente.
texto_seu_nu Pode ter letras
mero e números e
facilitar a
consulta e
acompanhame
nto do status
do boleto.
dado_boleto.da body string obrigatório Número do Formato:
dos_individuai código de 341012345678
s_boleto. barras (barra 901234567890
codigo_barra lida). Para 123456789012
s carteiras com 34567890
nosso número
adicional,
sempre
preencher o
código de
barras.
dado_boleto.da body string obrigatório Número da Formato:
dos_individuai linha digitável 341012345678
s_boleto.num (barra 901234567890
ero_linha_dig digitável). 123456789012
itavel Número 34567890123
exibido para
pagamento do
boleto.
dado_boleto.da body string obrigatório Data limite Formato:
dos_individuai para YYYY-MM-DD
s_boleto.data_ pagamento.
limite_pagam Cobrança não
ento poderá ser
paga após essa
data. Esta data
é posterior a
data de
vencimento.
dado_boleto.da body string[] obrigatório Lista de
dos_individuai mensagens
s_boleto.lista_
mensagens_c
obranca
dado_boleto.co body string obrigatório Código de Preenchido
digo_especie espécie do conforme os
título domínios da
tabela de
espécies

dado_boleto.d body string obrigatório Data em que a

ata_emissao cobrança foi
emitida.
Formato: YYYY-
MM-DD
dado_boleto.p body boolean obrigatório Indicador se Será sempre
agamento_pa aceita false para
rcial pagamento bolecode
parcial.
dado_boleto.q body string obrigatório Quantidade Para bolecode
uantidade_m permitida de sempre igual a
aximo_parcia pagamentos zeros
l parciais do
boleto.
dado_boleto.r object string obrigatório
ecebimento_di
vergente
dado_boleto.re body string obrigatório Tipo de 1 - Quando o
cebimento_div autorização de título aceita
[Link] recebimento qualquer valor
o_tipo_autori divergente da divergente ao
zacao cobrança. da cobrança
2 - Quando o
título contém
uma faixa de
valores aceitos
para
recebimentos
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.re body string obrigatório Tipo de V-
cebimento_div autorização de Recebimento
[Link] recebimento divergente for
o_tipo_recebi divergente da informado por
mento cobrança. valores
Obrigatório P-
para Recebimento
codigo_tipo_au divergente for
torizacao informado por
diferente de 01 percentuais
e 03.
dado_boleto.re body string obrigatório Percentual
cebimento_div mínimo
[Link] permitido para
ntual_minim pagamento.
o Obrigatório
para
 codigo_tipo_au
torizacao 02 ou
04 e
codigo_tipo_re
cebimento P.
dado_boleto.re body string obrigatório Percentual
cebimento_div máximo
[Link] permitido.
ntual_maxim Obrigatório
o para
codigo_tipo_au
torizacao 02 e
codigo_tipo_re
cebimento P.
dado_boleto.d body boolean obrigatório Indicador se o False para
esconto_expr cliente tem o bolecode
esso produto
Desconto
Expresso.
dados_qrcode body string obrigatório
dados_qrcode. body string obrigatório Chave do
chave Beneficiário na
DICT
dados_qrcode. body string obrigatório Pix Copia e cola
emv (Texto usado
para
pagamento do
QR Code)
dados_qrcode. body string obrigatório Imagem em
base64 base64 do
QRCODE PIX.
dados_qrcode. obrigatório Identificador Inicia c/ “BL”
txid do Pix, gerado Na sequência ,
automaticamen Agência (4
te no bolecode posições),
Conta (7
posições),
carteira (3
posições) e
Nosso Número
(15 posições)
Exemplo:
“BL9999000000
010912345678
9012345”

dados_qrcode. object - Obrigatório

loc
 dados_qrcode. body integer($int6 obrigatório Identificador da Esse campo
[Link] 4) URL que posse ser
contem a informado ou
localização dos gerado
dados da automaticamen
cobrança te na emissão.
dados_qrcode.l body string($uri)/( URL com a Essa URL só
[Link] maxLength = localização do pode ser aberta
77) payload que por
contém os participantes,
dados da não sendo
cobrança possível a
visualização
dos dados do
QR Code em
qualquer
browser.
(apenas nos
aplicativos para
pagamento)

Códigos de Resposta
Código de Descrição
Status

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": "Teste Batch atualiza",
"tipo_pessoa": {
"codigo_tipo_pessoa": "J",
"numero_cadastro_nacional_pessoa_juridica": "60701190000104"
},
"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": {
"descricao_instrumento_cobranca": "boleto_pix",
"tipo_boleto": "a vista",
"pagador": {
"pessoa": {
"nome_pessoa": "Joao Silva",
"tipo_pessoa": {
"codigo_tipo_pessoa": "F",
"numero_cadastro_pessoa_fisica": "26556923222"
}
},
"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": "03c9e46c-d8d1-4088-814a-7fd18694b10b",
"numero_nosso_numero": "00127623",
"dac_titulo": "4",
"data_vencimento": "2022-07-30",
"valor_titulo": "00000000000030000",
"texto_seu_numero": "000001",
"codigo_barras": "34197906200000300001570012762341500052061000",
"numero_linha_digitavel": "3419157007127623415060052061000779062000003
0000",
"data_limite_pagamento": "2032-07-30",
"lista_mensagens_cobranca": []
}
],
"codigo_especie": "01",
"data_emissao": "2021-12-27",
"pagamento_parcial": false,
"quantidade_maximo_parcial": "0",
"recebimento_divergente": {
"codigo_tipo_autorizacao": "03",
"codigo_tipo_recebimento": "P",
"percentual_minimo": "00000000000000000",
"percentual_maximo": "00000000000000000"
},
"desconto_expresso": false
},
"dados_qrcode": {
"chave": "pjoperador@[Link]",
"txid": "BL150000052061109000000000127623",
 "loc": {
"id": 789,
"location": "[Link]/pix/qr/v2/04f90e1d-afe4-4aa9-9246-579551f48727520
4000053039865802BR5920CARVALHEIRA
},
"emv": "[Link]/pix/qr/v2/04f9
0e1d-afe4-4aa9-9246-579551f487275204000053039865802BR5920CARVALHEIRA GERALDES6009SAO PAU
LO62070503***6304AF50",
"base64": "iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAACy0lEQVR4Xu2XS3LlIBA
E4SJw/1v4KHARmMzG9vssHLOw2hthj54l0hHl7qpGU/bP66O8P3lbN3DWDZx1A2f9HzBKqXuu0lfrq/tZ+oyHecD
ke7S6Ope5WuncVh9mAt6OosDG5uZ21cOkAqNPRBYeRqFa/wMAgX2wU6obUbpcgG/80tzctm37Gc/TAP0539e7q9/
3fxlwmRWqhVuiaxjnrCwAnyCpa1Z+3ESngLSAsgCMijrkrU/n6p5piPKAPZqqkNqH/7rt6+th2gRAkTu2SqNI1Wr
BvP4VVwPqWZEXumWJgLfpyQOWLql2B7HLXvlbx7hZAFmhTJwoXpA3h8l5alYCQEmwKY0C6GeKxgGTCRxd7Di7JCn
c9DYRiKHFWcKlWSBEvoY3AdAy7GAagOIBZ2piqKQBhpUC2SuwUyxWKhDBjSvmVXCdNsr9NMBbSzMdI+00jXEaGc4
CLEsNrzLDzE/8gtc8gPkZM2uq9mt6OFYSAdyqS7RKjRTHeJdOBNS2fdn1UPHlfyvyKbzXA7xsntPUo5W8EN64/Ra
ZAKArXDJ0jbYxyi8D5HrA7kxPlUqz6FO4GNk1EbA1PF8O8DhdXWA9EVgIcmYso4PkuKo8E6gGltERh/vQOPulWQk
AfUKkJSruBNWNbyJgTM1MlIp++R9Df+iJQAgrehWNbvHxOc3SAEQxMjRsCOwRoh6ezQN4GrMLt9Kv1U50n9J9PUB
V4lAzPaWa4vh6NCsDwKHGBWlRJmkqVh/JSgCKscEpFoz0tDBOexJ5PYBAm7Q92hkjpkbBT+G9HnAZXvoT5eqENyZ
ZIhCKhlZxjtO4Fu+969u0CYAWoUq4hGcRmKHIlgrYJRJLrZCrVeprs5IA4mta6RAV21G8h2mzAM+TM8y27iE67uc
BwfBuE2cKep1hztVEwM4wR1FIv2Jw0LtupvOAn9YNnHUDZ93AWb8A/AN4HAw5z2fBbAAAAABJRU5ErkJggg=="
}
}
}