{
"openapi": "3.1.1",
"info": {
"title": "Cobranças API",
"description": "API para gerenciar os serviços de cobranças de cliente do Banco do Brasil S.A.",
"contact": {
"name": "Banco do Brasil S.A. - BB for Developers",
"url": "https://developers.bb.com.br"
},
"version": "3.2.2"
},
"externalDocs": {
"url": "https://apoio.developers.bb.com.br/apis/5?versaoApi=2&topico=17458866"
},
"servers": [
{
"url": "https://api.sandbox.bb.com.br/cobrancas/v2",
"description": "Servidor de Testes"
},
{
"url": "https://api.hm.bb.com.br/cobrancas/v2",
"description": "Servidor de Homologação"
},
{
"url": "https://api.bb.com.br/cobrancas/v2",
"description": "Servidor de Produção"
}
],
"security": [
{
"OAuth2": [
"cobrancas.boletos-info",
"cobrancas.boletos-requisicao",
"cobrancas.convenio-requisicao"
],
"OAuth2-Sandbox": [
"cobrancas.boletos-info",
"cobrancas.boletos-requisicao",
"cobrancas.convenio-requisicao"
],
"OAuth2-Homologacao": [
"cobrancas.boletos-info",
"cobrancas.boletos-requisicao",
"cobrancas.convenio-requisicao"
],
"ApiKey": [],
"mutualTLS": []
}
],
"paths": {
"/boletos": {
"parameters": [
{
"$ref": "#/components/parameters/AppKey"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"get": {
"summary": "Listar Boletos",
"description": "Listar títulos de cobrança - Em Ser, Baixados, Liquidados e Com Protesto por Beneficiário.
Se você deseja receber informações quando seu boleto foi pago ou cancelado imediatamente, conheça nosso **serviço de notificação automática (Webhook)**, documentado abaixo.",
"externalDocs": {
"url": "https://publicador.developers.bb.com.br/bucket/Situacoes_de_boletos_e6bb98da89.png",
"description": "Para mais informações de associação entre os campos 'indicadorSituacao' e 'codigoEstadoTituloCobranca', veja a imagem na URL abaixo."
},
"parameters": [
{
"name": "indicadorSituacao",
"in": "query",
"description": "Situação do boleto. Campo obrigatoriamente MAIÚSCULO.\nDomínios:\nA - Em ser\nB - Baixados/Protestados/Liquidados",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contaCaucao",
"in": "query",
"description": "Número da conta caução.\n\nDomínio:\n1 - Compõe Garantia;\n2 - Não Compõe Garantia;\n4 - Não Compõe Garantia (vencimento superior a 180 dias);\n5 - Não Compõe Garantia (Vedado);\n6 - Em análise;\n7 - Em análise;\n8 - Não Compõe Garantia.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "agenciaBeneficiario",
"in": "query",
"description": "Número da agência do beneficiário, sem o dígito verificador. Ex: 452. CAMPO OBRIGATÓRIO.",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "contaBeneficiario",
"in": "query",
"description": "Número da conta do beneficiário, sem o dígito verificador. Ex: 123873. CAMPO OBRIGATÓRIO.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "carteiraConvenio",
"in": "query",
"description": "Número da carteira do convênio de cobrança. Ex: 17",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "variacaoCarteiraConvenio",
"in": "query",
"description": "Número da variação da carteira do convênio de cobrança. Ex: 35",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "modalidadeCobranca",
"in": "query",
"description": "Código para identificar a característica dos boletos dentro das modalidades de cobrança existentes no BB.\nDomínio:\n1 - SIMPLES COM REGISTRO\n2 - SIMPLES SEM REGISTRO\n4 - VINCULADA\n6 - DESCONTADA\n8 - FINANCIADA VENDOR",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "cnpjPagador",
"in": "query",
"description": "CNPJ do pagador, sem o dígito verificador (últimos 2 dígitos). Se for enviado, é obrigatório preencher o campo `digitoCNPJPagador`",
"schema": {
"type": "string"
},
"examples": {
"exemplo 1": {
"value": "867613930001"
},
"exemplo 2": {
"value": "000000000001"
},
"exemplo 3": {
"value": "BBFUNDORENFX"
},
"exemplo 4": {
"value": "JY1EPYEG0001"
},
"exemplo 5": {
"value": "84.6JB.9EM/S1BL"
}
}
},
{
"name": "digitoCNPJPagador",
"in": "query",
"description": "Dígito verificador do CNPJ do pagador. Caso o campo `cnpjPagador` seja informado, o campo `digitoCNPJPagador` deve ser preenchido.",
"schema": {
"type": "string"
},
"examples": {
"exemplo 1": {
"value": "71"
},
"exemplo 2": {
"value": "91"
},
"exemplo 3": {
"value": "50"
},
"exemplo 4": {
"value": "14"
},
"exemplo 5": {
"value": "99"
}
}
},
{
"name": "cpfPagador",
"in": "query",
"description": "CPF do pagador sem o dígito. Ex: 711285901",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "digitoCPFPagador",
"in": "query",
"description": "Dígito verificador do CPF do pagador. Ex: 82",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "dataInicioVencimento",
"in": "query",
"description": "Data inicial de vencimento do boleto que delimita o período da consulta. Campo não obrigatório. Se informado Data Início, deixando em branco a Data Fim, o sistema deve assumir a data atual como Data Fim. Ex: 22.04.2020",
"schema": {
"type": "string"
}
},
{
"name": "dataFimVencimento",
"in": "query",
"description": "Data final de vencimento do boleto que delimita o período da consulta - deverá ser maior que a data de início. Campo não obrigatório. Se informado, deverá ser preenchido dataInicioVencimento. Ex: 28.04.2020",
"schema": {
"type": "string"
}
},
{
"name": "dataInicioRegistro",
"in": "query",
"description": "Data inicial do registro do boleto que delimita o período da consulta. Ex: 22.04.2020",
"schema": {
"type": "string"
}
},
{
"name": "dataFimRegistro",
"in": "query",
"description": "Data final do registro do boleto que delimita o período da consulta - deverá ser maior que a data de início. Campo não obrigatório. Se informado, deverá ser preenchido dataInicioRegistro. Ex: 28.04.2020",
"schema": {
"type": "string"
}
},
{
"name": "dataInicioMovimento",
"in": "query",
"description": "Delimita o período da consulta de boletos liquidados, baixados ou protestados, caso seja informado, no campo codigoEstadoTituloCobranca os códigos 05, 06, 07 ou 09. Ex: 22.04.2020",
"schema": {
"type": "string"
}
},
{
"name": "dataFimMovimento",
"in": "query",
"description": "Data final do movimento que delimita o período da consulta de boletos liquidados, baixados ou protestados, caso seja informado, no campo codigoEstadoTituloCobranca os códigos 05, 06, 07 ou 09. Data fim deverá ser maior que a data de início. Campo não obrigatório. Se informado, deverá ser preenchido dataInicioMovimento. Ex: 28.04.2020",
"schema": {
"type": "string"
}
},
{
"name": "codigoEstadoTituloCobranca",
"in": "query",
"description": "Código da situação atual do boleto. \n\nDomínios:\n\n01 - NORMAL\n02 - MOVIMENTO CARTORIO\n03 - EM CARTORIO\n04 - TITULO COM OCORRENCIA DE CARTORIO\n05 - PROTESTADO ELETRONICO\n06 - LIQUIDADO\n07 - BAIXADO\n09 - TITULO PROTESTADO MANUAL\n10 - TITULO BAIXADO/PAGO EM CARTORIO\n11 - TITULO LIQUIDADO/PROTESTADO\n12 - TITULO LIQUIDADO/PAGO CARTORIO\n13 - TITULO PROTESTADO AGUARDANDO BAIXA\n18 - PAGO PARCIALMENTE",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "boletoVencido",
"in": "query",
"description": "Indica se o Boleto está vencido ou não. Campo obrigatoriamente MAIÚSCULO.\nDomínio:\nS para boletos vencidos\nN para boletos não vencidos",
"schema": {
"type": "string"
}
},
{
"name": "indice",
"in": "query",
"description": "Somente deve ser utilizado em caso de pesquisas que retornem mais de 300 boletos. Caso o campo RPST \"Indicador Continuidade\" retorne com o valor \"S\", o usuário deve informar o conteúdo do campo RPST \"Numero Ultimo Registro\" a partir do qual será iniciada nova consulta.\n",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "SUCESSO. A requisição foi atendida e resultou em resposta.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RespostaListaBoletos"
}
}
}
}
},
"400": {
"description": "REQUISIÇÃO INVÁLIDA. O servidor não pôde processar a requisição devido a uma sintaxe de requisição malformada, estrutura da mensagem da requisição inválida, ou valores inválidos.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v2"
}
}
}
},
"401": {
"description": "NÃO AUTORIZADO. A requisição requer autenticação do usuário.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErroOAuthNaoAutorizado"
}
}
}
},
"404": {
"description": "NÃO ENCONTRADO. O servidor não conseguiu encontrar o recurso solicitado.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"500": {
"description": "ERRO INTERNO. O servidor encontrou uma condição inesperada que o impediu de atender a requisição.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v2"
}
}
}
},
"503": {
"description": "SERVIÇO INDISPONÍVEL. No momento o servidor não pode atender a solicitação devido a uma sobrecarga temporária ou manutenção do servidor.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v2"
}
}
}
}
},
"security": [
{
"OAuth2": [
"cobrancas.boletos-info"
],
"OAuth2-Sandbox": [
"cobrancas.boletos-info"
],
"OAuth2-Homologacao": [
"cobrancas.boletos-info"
],
"ApiKey": []
}
],
"operationId": "listaBoletosId",
"tags": [
"boletos"
]
},
"post": {
"summary": "Registra Boleto de Cobrança",
"description": "Permite incluir um novo boleto de cobrança ",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequisicaoRegistroBoletos"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "CRIADO. A solicitação foi atendida e resultou em um novo recurso sendo criado.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RespostaRegistroBoletos"
}
}
}
},
"400": {
"description": "REQUISIÇÃO INVÁLIDA. O servidor não pôde processar a requisição devido a uma sintaxe de requisição malformada, estrutura da mensagem da requisição inválida, ou valores inválidos.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v4"
}
}
}
},
"401": {
"description": "NÃO AUTORIZADO. A requisição requer autenticação do usuário.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErroOAuthNaoAutorizado"
}
}
}
},
"500": {
"description": "ERRO INTERNO. O servidor encontrou uma condição inesperada que o impediu de atender a requisição.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v4"
}
},
"application/xml": {
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"503": {
"description": "SERVIÇO INDISPONÍVEL. O servidor está impossibilitado de lidar com a requisição no momento. Tente mais tarde.\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v4"
},
"examples": {
"example-1": {
"value": {}
}
}
}
}
}
},
"security": [
{
"OAuth2": [
"cobrancas.boletos-requisicao"
],
"OAuth2-Sandbox": [
"cobrancas.boletos-requisicao"
],
"OAuth2-Homologacao": [
"cobrancas.boletos-requisicao"
],
"ApiKey": []
}
],
"operationId": "incluiBoletoBancarioId",
"tags": [
"boletos"
]
}
},
"/boletos/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/AppKey"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"get": {
"summary": "Detalha um boleto bancário",
"description": "Consulta detalhes de um boleto bancário.
Se você deseja receber informações quando seu boleto foi pago ou cancelado imediatamente, conheça nosso **serviço de notificação automática (Webhook)**, documentado abaixo.
Observação: Ao consultar o mesmo boleto mais de uma vez em um intervalo de até 30 segundos, a resposta fornecida será com as mesmas informações da consulta anterior. Isso garante mais velocidade e estabilidade para todos os clientes.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Número do título de cobrança.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "numeroConvenio",
"in": "query",
"description": "Número do convênio.",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "SUCESSO. A requisição foi atendida e resultou em resposta.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RespostaDetalhamentoBoleto"
}
}
}
},
"400": {
"description": "REQUISIÇÃO INVÁLIDA. O servidor não pôde processar a requisição devido a uma sintaxe de requisição malformada, estrutura da mensagem da requisição inválida, ou valores inválidos.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro"
}
}
}
},
"401": {
"description": "NÃO AUTORIZADO. A requisição requer autenticação do usuário.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErroOAuthNaoAutorizado"
}
}
}
},
"404": {
"description": "NÃO ENCONTRADO. O servidor não conseguiu encontrar o recurso solicitado.",
"content": {}
},
"500": {
"description": "ERRO INTERNO. O servidor encontrou uma condição inesperada que o impediu de atender a requisição.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro"
}
}
}
}
},
"security": [
{
"OAuth2": [
"cobrancas.boletos-info"
],
"OAuth2-Sandbox": [
"cobrancas.boletos-info"
],
"OAuth2-Homologacao": [
"cobrancas.boletos-info"
],
"ApiKey": []
}
],
"operationId": "detalhaBoletoBancarioId",
"tags": [
"boletos"
]
},
"patch": {
"summary": "Altera um boleto bancário",
"description": "Realiza alterações nos valores dos campos presentes em um boleto bancário já criado.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Número do título de cobrança.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Representação dos campos de requisição de uma solicitação de alteração dos dados de boletos bancários.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequisicaoAlterarBoleto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "SUCESSO. A requisição foi atendida e resultou em resposta.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RespostaAlterarBoleto"
}
}
}
},
"400": {
"description": "REQUISIÇÃO INVÁLIDA. O servidor não pôde processar a requisição devido a uma sintaxe de requisição malformada, estrutura da mensagem da requisição inválida, ou valores inválidos.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro"
}
}
}
},
"401": {
"description": "NÃO AUTORIZADO. A requisição requer autenticação do usuário.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErroOAuthNaoAutorizado"
}
}
}
},
"403": {
"description": "PROIBIDO. A requisição foi válida, mas o servidor está recusando a ação. O usuário pode não ter as permissões necessárias para um recurso ou pode precisar de uma conta de algum tipo.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro"
}
}
}
},
"404": {
"description": "NÃO ENCONTRADO. O servidor não conseguiu encontrar o recurso solicitado.",
"content": {}
},
"500": {
"description": "ERRO INTERNO. O servidor encontrou uma condição inesperada que o impediu de atender a requisição.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro"
}
}
}
}
},
"security": [
{
"OAuth2": [
"cobrancas.boletos-requisicao"
],
"OAuth2-Sandbox": [
"cobrancas.boletos-requisicao"
],
"OAuth2-Homologacao": [
"cobrancas.boletos-requisicao"
],
"ApiKey": []
}
],
"operationId": "alteraBoletoBancarioId",
"tags": [
"boletos"
]
}
},
"/boletos/{id}/baixar": {
"parameters": [
{
"$ref": "#/components/parameters/AppKey"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"post": {
"summary": "Permitir a baixa/cancelamento de um título de cobrança.",
"description": "Permite a baixa/cancelamento de um título de cobrança.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Número do boleto bancário (único e exclusivo) que identifica o título e é usado para pagá-lo.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequisicaoBaixaBoleto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "SUCESSO. A requisição foi atendida e resultou em resposta.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RespostaBaixaBoleto"
}
}
}
},
"400": {
"description": "SOLICITAÇÃO INCORRETA. O servidor não pode ou não processará a solicitação devido a algo que parece ser um erro do lado cliente (por exemplo, sintaxe malformada, quadro de mensagem inválida ou roteamento de solicitação fraudulenta).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro"
}
}
}
},
"401": {
"description": "NÃO AUTORIZADO. A requisição requer autenticação do usuário. Repita a requisição com um campo do header de autorização.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErroOAuthNaoAutorizado"
}
}
}
},
"403": {
"description": "PROIBIDO. A requisição foi válida, mas o servidor está recusando a ação. O usuário pode não ter as permissões necessárias para um recurso ou pode precisar de uma conta de algum tipo.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro"
}
}
}
},
"500": {
"description": "ERRO INTERNO. O servidor encontrou uma condição inesperada que impediu o cumprimento da solicitação.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro"
}
}
}
}
},
"security": [
{
"OAuth2": [
"cobrancas.boletos-requisicao"
],
"OAuth2-Sandbox": [
"cobrancas.boletos-requisicao"
],
"OAuth2-Homologacao": [
"cobrancas.boletos-requisicao"
],
"ApiKey": []
}
],
"operationId": "permitirBaixaCancelamentoId",
"tags": [
"boletos"
]
}
},
"/boletos/{id}/cancelar-pix": {
"parameters": [
{
"schema": {
"type": "string"
},
"name": "id",
"in": "path",
"required": true,
"description": "Número de identificação do boleto (correspondente ao NOSSO NÚMERO, numeroTituloCliente), no formato STRING, com 20 dígitos, que deverá ser formatado da seguinte forma: “000” + (número do convênio com 7 dígitos) + (10 algarismos - se necessário, completar com zeros à esquerda). Campo Obrigatório."
},
{
"$ref": "#/components/parameters/AppKey"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"post": {
"summary": "Cancelar Pix de Boleto",
"operationId": "cancelarPixBoletoId",
"responses": {
"200": {
"description": "SUCESSO. A requisição foi atendida e resultou em resposta.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"pix": {
"type": "object",
"properties": {
"chave": {
"type": "string",
"description": "Código chave do pagador do Pix."
}
}
},
"qrCode": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "URL do payload do QR Code Pix."
},
"txId": {
"type": "string",
"description": "Código que identifica a transação Pix - transactionID."
},
"emv": {
"type": "string",
"description": "BR Code no padrão EMV. Sequência de caracteres correspondente ao payload do QR Code Pix."
}
}
}
}
}
}
}
},
"400": {
"description": "REQUISIÇÃO INVÁLIDA. O servidor não pôde processar a requisição devido a uma sintaxe de requisição malformada, estrutura da mensagem da requisição inválida, ou valores inválidos.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v4"
}
}
}
},
"401": {
"description": "NÃO AUTORIZADO. A requisição requer autenticação do usuário.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErroOAuthNaoAutorizado"
}
}
}
},
"403": {
"description": "PROIBIDO. A requisição foi válida, mas o servidor está recusando a ação. O usuário pode não ter as permissões necessárias para um recurso ou pode precisar de uma conta de algum tipo.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v4"
}
}
}
},
"404": {
"description": "NÃO ENCONTRADO. O servidor não conseguiu encontrar o recurso solicitado."
},
"500": {
"description": "ERRO INTERNO. O servidor encontrou uma condição inesperada que o impediu de atender a requisição.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v4"
}
}
}
}
},
"tags": [
"boletos"
],
"description": "Cancelar Pix vinculado a um boleto de cobrança existente.",
"security": [
{
"OAuth2": [
"cobrancas.boletos-requisicao"
],
"OAuth2-Sandbox": [
"cobrancas.boletos-requisicao"
],
"OAuth2-Homologacao": [
"cobrancas.boletos-requisicao"
],
"ApiKey": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"numeroConvenio": {
"type": "integer",
"format": "int32",
"description": "Número do convênio de Cobrança do Cliente."
}
},
"required": [
"numeroConvenio"
]
}
}
}
}
}
},
"/boletos/{id}/gerar-pix": {
"parameters": [
{
"schema": {
"type": "string"
},
"name": "id",
"in": "path",
"required": true,
"description": "Número de identificação do boleto (correspondente ao NOSSO NÚMERO, numeroTituloCliente), no formato STRING, com 20 dígitos, que deverá ser formatado da seguinte forma: “000” + (número do convênio com 7 dígitos) + (10 algarismos - se necessário, completar com zeros à esquerda). Campo Obrigatório."
},
{
"$ref": "#/components/parameters/AppKey"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"post": {
"summary": "Gerar Pix de Boleto",
"operationId": "gerarPixBoletoId",
"responses": {
"200": {
"description": "SUCESSO. A requisição foi atendida e resultou em resposta.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"pix": {
"type": "object",
"properties": {
"chave": {
"type": "string",
"description": "Código chave do pagador do Pix."
}
}
},
"qrCode": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "URL do payload do QR Code Pix."
},
"txId": {
"type": "string",
"description": "Código que identifica a transação Pix - transactionID."
},
"emv": {
"type": "string",
"description": "BR Code no padrão EMV. Sequência de caracteres correspondente ao payload do QR Code Pix."
}
}
}
}
}
}
}
},
"400": {
"description": "REQUISIÇÃO INVÁLIDA. O servidor não pôde processar a requisição devido a uma sintaxe de requisição malformada, estrutura da mensagem da requisição inválida, ou valores inválidos.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v4"
}
}
}
},
"401": {
"description": "NÃO AUTORIZADO. A requisição requer autenticação do usuário.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErroOAuthNaoAutorizado"
}
}
}
},
"403": {
"description": "PROIBIDO. A requisição foi válida, mas o servidor está recusando a ação. O usuário pode não ter as permissões necessárias para um recurso ou pode precisar de uma conta de algum tipo.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v4"
}
}
}
},
"404": {
"description": "NÃO ENCONTRADO. O servidor não conseguiu encontrar o recurso solicitado."
},
"500": {
"description": "ERRO INTERNO. O servidor encontrou uma condição inesperada que o impediu de atender a requisição.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v4"
}
}
}
}
},
"tags": [
"boletos"
],
"description": "Gerar Pix vinculado a um boleto de cobrança através de um QRCode Dinâmico ou Estático.",
"security": [
{
"OAuth2": [
"cobrancas.boletos-requisicao"
],
"OAuth2-Sandbox": [
"cobrancas.boletos-requisicao"
],
"OAuth2-Homologacao": [
"cobrancas.boletos-requisicao"
],
"ApiKey": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"numeroConvenio": {
"type": "integer",
"format": "int32",
"description": "Número do convênio de Cobrança do Cliente."
}
},
"required": [
"numeroConvenio"
]
}
}
}
}
}
},
"/boletos/{id}/pix": {
"parameters": [
{
"$ref": "#/components/parameters/AppKey"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"get": {
"summary": "Consultar Pix de Boleto",
"description": "Consultar os dados de um Pix vinculado a um boleto de cobrança.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Número de identificação do boleto (correspondente ao NOSSO NÚMERO, numeroTituloCliente), no formato STRING, com 20 dígitos, que deverá ser formatado da seguinte forma: “000” + (número do convênio com 7 dígitos) + (10 algarismos - se necessário, completar com zeros à esquerda). Campo Obrigatório.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "numeroConvenio",
"in": "query",
"description": "Número do convênio de Cobrança do Cliente",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "SUCESSO. A requisição foi atendida e resultou em resposta.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RespostaConsultaPixBoleto"
}
}
}
},
"400": {
"description": "REQUISIÇÃO INVÁLIDA. O servidor não pôde processar a requisição devido a uma sintaxe de requisição malformada, estrutura da mensagem da requisição inválida, ou valores inválidos.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v4"
}
}
}
},
"401": {
"description": "NÃO AUTORIZADO. A requisição requer autenticação do usuário.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErroOAuthNaoAutorizado"
}
}
}
},
"404": {
"description": "NÃO ENCONTRADO. O servidor não conseguiu encontrar o recurso solicitado.",
"content": {}
},
"500": {
"description": "ERRO INTERNO. O servidor encontrou uma condição inesperada que o impediu de atender a requisição.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v4"
}
}
}
}
},
"security": [
{
"OAuth2": [
"cobrancas.boletos-info"
],
"OAuth2-Sandbox": [
"cobrancas.boletos-info"
],
"OAuth2-Homologacao": [
"cobrancas.boletos-info"
],
"ApiKey": []
}
],
"operationId": "consultarPixBoletoId",
"tags": [
"boletos"
]
}
},
"/convenios/{id}/listar-retorno-movimento": {
"parameters": [
{
"schema": {
"type": "string",
"example": "1234567"
},
"name": "id",
"in": "path",
"required": true,
"description": "Número identificador do convênio de intercambio de dados em meio eletrônico, pelo qual serão fornecidos os dados dos títulos de um ou mais serviços de cobrança contratados."
},
{
"$ref": "#/components/parameters/AppKey"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"post": {
"summary": "Listar Dados do Retorno do Convênio",
"operationId": "post-convenios-id-listar-retorno-movimento",
"responses": {
"200": {
"description": "SUCESSO. A requisição foi atendida e resultou em resposta.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"indicadorContinuidade": {
"type": "string",
"enum": [
"S",
"N"
],
"example": "S",
"description": "Indicador de continuidade para informar que a pesquisa possui mais registros a apresentar\nS-Sim, N-Não"
},
"numeroUltimoRegistro": {
"type": "integer",
"example": 8900,
"format": "int64",
"description": "Numero do ultimo registro da consulta"
},
"listaRegistro": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dataMovimentoRetorno": {
"type": "string",
"description": "Data do processamento do movimento de retorno de cobrança de Boleto.",
"example": "24.03.2022"
},
"numeroConvenio": {
"type": "integer",
"description": "Número do convênio de Cobrança do Cliente",
"format": "int64",
"example": 1234567
},
"numeroTituloCobranca": {
"type": "string",
"description": "Nosso Número",
"example": "00012345670000000001"
},
"codigoComandoAcao": {
"type": "integer",
"description": "Tipo de ação ou comando que o boleto sofre.\n\"COMANDO\n02 - Confirmação de Entrada de Boleto\n03 - Comando recusado (Motivo indicado na posição 087/088)\n05 - Liquidado sem registro (carteira 17-tipo4)\n06 - Liquidação Normal\n07 - Liquidação por Conta/Parcial\n08 - Liquidação por Saldo\n09 - Baixa de Titulo\n10 - Baixa Solicitada\n11 - Boletos em Ser (constara somente do arquivo de existência de cobrança, fornecido mediante solicitação do cliente)\n12 - Abatimento Concedido\n13 - Abatimento Cancelado\n14 - Alteração de Vencimento do boleto\n15 - Liquidação em Cartório\n16 - Confirmação de alteração de juros de mora\n19 - Confirmação de recebimento de instruções para protesto\n20 - Débito em Conta\n21 - Alteração do Nome do Sacado\n22 - Alteração do Endereço do Sacado\n23 - Indicação de encaminhamento a cartório\n24 - Sustar Protesto\n25 - Dispensar Juros de mora\n26 - Alteração do número do boleto dado pelo Cedente (Seu número) – 10 e 15 posições\n28 - Manutenção de titulo vencido\n31 - Conceder desconto\n32 - Não conceder desconto\n33 - Retificar desconto\n34 - Alterar data para desconto\n35 - Cobrar Multa\n36 - Dispensar Multa\n37 - Dispensar Indexador\n38 - Dispensar prazo limite para recebimento\n39 - Alterar prazo limite para recebimento\n41 - Alteração do número do controle do participante (25 posições)\n42 - Alteração do número do documento do sacado (CNPJ/CPF)\n44 - Boleto pago com cheque devolvido\n46 - Boleto pago com cheque, aguardando compensação\n61-Registrado QR Code Pix\n72- Alteração de tipo de cobrança (específico para boletos das carteiras 11 e 17)\n73 - Confirmação de Instrução de Parâmetro de Pagamento Parcial\n85 - Inclusão de Negativação\n86 - Exclusão de Negativação\n93 - Baixa Operacional\n96 - Despesas de Protesto\n97 - Despesas de Sustação de Protesto\n98 - Débito de Custas Antecipadas\n\nObservação:\nQuando as posições 109-110 apresentarem “06”-Liquidação Normal e as posições 87-88 apresentarem “03”-Liquidação por Saldo ou “11” – Liquidação por Saldo com Cheque a Compensar, significa que o valor residual foi liquidado totalmente.\"",
"example": 2,
"format": "int32",
"enum": [
2,
3,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14
]
},
"codigoPrefixoAgencia": {
"type": "integer",
"description": "Agência do Beneficiário",
"example": 1,
"format": "int32"
},
"numeroContaCorrente": {
"type": "integer",
"description": "Conta Corrente do Beneficiário",
"example": 123456789,
"format": "int64"
},
"numeroCarteiraCobranca": {
"type": "integer",
"description": "Número da carteira do convênio de cobrança",
"example": 17,
"format": "int32"
},
"numeroVariacaoCarteiraCobranca": {
"type": "integer",
"description": "Número da variação da carteira do convênio de cobrança",
"example": 35,
"format": "int32"
},
"tipoCobranca": {
"type": "integer",
"description": "Código para identificar a característica dos boletos dentro das modalidades de cobrança existentes no banco\n1 –Simples, 2-Vinculada, 4-Descontada, 7-Cobrança Simples Carteira 17, 8-Vendor",
"example": 1,
"format": "int32",
"enum": [
1,
2,
4,
7,
8
]
},
"codigoControleParticipante": {
"type": "string",
"description": "\"Número de controle interno definido pelo Beneficiário.\nNúmero adotado e controlado pelo Cliente, para identificar o título de cobrança. Para uso do Banco. Seu Número\"",
"example": "A123456"
},
"codigoEspecieBoleto": {
"type": "integer",
"description": "Código para identificar o tipo de boleto de cobrança (espécie)\n\"ESPÉCIE DO BOLETO: Esse campo será preenchido somente nas modalidades de Cobrança com Registro (Carteiras 11, 12, 17, 31 e 51) 00 – informado nos registros com comando 97-Despesas de Sustação de Protesto nas posições 109/110 desde que o titulo não conste mais da existência\n 01 – duplicata mercantil\n 02 – nota promissória\n 03 – nota de seguro\n 05 – recibo\n 08 – letra de câmbio\n 09 – warrant\n 10 – cheque\n 12 – duplicata de serviço\n 13 – nota de débito\n 15 – apólice de seguro\n 25 – dívida ativa da União\n 26 – dívida ativa de Estado\n 27 – dívida ativa de Município\n 31 – Boleto de Cartão de Crédito\n 32 – Boleto de Proposta\n\nPara carteiras 16 e 18: Preenchido com zeros\"",
"example": 12,
"format": "int32",
"enum": [
0,
1,
2,
3,
5,
8,
9,
10,
12,
13,
15,
25,
26,
27,
31,
32
]
},
"dataVencimentoBoleto": {
"type": "string",
"description": "Data de vencimento do boleto.",
"example": "31.12.2022"
},
"valorBoleto": {
"type": "number",
"description": "Valor do boleto no registro",
"example": 100,
"format": "double"
},
"codigoBancoRecebedor": {
"type": "integer",
"description": "Código ISPB da Instituição Financeira na qual o boleto foi pago.",
"example": 237,
"format": "int32"
},
"codigoPrefixoAgenciaRecebedora": {
"type": "integer",
"description": "Código do prefixo identificador de uma dependência da instituição financeira onde o boleto foi pago.",
"example": 2,
"format": "int32"
},
"dataCreditoPagamentoBoleto": {
"type": "string",
"description": "Data do crédito do pagamento do Boleto",
"example": "03.02.2023"
},
"valorTarifa": {
"type": "number",
"description": "Valor que o Cliente é debitado da tarifa por realizar um determinado ação",
"format": "double",
"example": 9
},
"valorOutrasDespesasCalculadas": {
"type": "number",
"description": "Despesas calculadas conforme o comando determinado pelo Cliente.",
"format": "double",
"example": 0
},
"valorJurosDesconto": {
"type": "number",
"description": "Valor de juros calculados apenas para boletos da modalidade do tipo de cobrança desconto.",
"example": 1,
"format": "double"
},
"valorIofDesconto": {
"type": "number",
"description": "Valor do IOF incidente sobre o valor do desconto.",
"format": "double",
"example": 0.5
},
"valorAbatimento": {
"type": "number",
"description": "Valor do abatimento concedido sobre o valor do título.",
"format": "double",
"example": 10
},
"valorDesconto": {
"type": "number",
"description": "Valor do desconto concedido sobre o valor do título.",
"format": "double",
"example": 1
},
"valorRecebido": {
"type": "number",
"description": "Valor do recebido pelo título de cobrança do boleto.",
"format": "double",
"example": 100
},
"valorJurosMora": {
"type": "number",
"description": "Valor dos juros de mora cobrados pelo atraso no pagamento do título.",
"format": "double",
"example": 5
},
"valorOutrosValoresRecebidos": {
"type": "number",
"description": "Outros valores recebidos no momento do pagamento do Boleto (título).",
"format": "double",
"example": 2
},
"valorAbatimentoNaoUtilizado": {
"type": "number",
"description": "Valor de abatimento ao qual o clente tem direito mas que não foi utilizado por ele (para comando 311 - liquidação).",
"format": "double",
"example": 1
},
"valorLancamento": {
"type": "number",
"description": "Valor de lançamento calculado com base no valor pago, descontos e abatimentos.",
"format": "double",
"example": 30
},
"codigoFormaPagamento": {
"type": "integer",
"description": "Indica a forma de pagamento do Boleto (título) de cobrança.\n0-sem lançamento, 1-débito, 2-crédito",
"format": "int32",
"example": 1,
"enum": [
0,
1,
2
]
},
"codigoValorAjuste": {
"type": "integer",
"description": "Indica se ocorreu um ajuste a débito ou a crédito do Boleto.\n0-sem ajuste, 1-ajuste de valor a débito, 2-ajuste de valor a crédito",
"format": "int32",
"example": 2,
"enum": [
0,
1,
2
]
},
"valorAjuste": {
"type": "number",
"description": "Para tipo de cobrança descontada, nos comandos de liquidação ou baixa de boleto, quando o Indicador de Valor é igual a 1 e houver valor a débito ou Indicador de valor igual a 2 é preenchido com o valor do ajuste.",
"format": "double",
"example": 0.51
},
"codigoAutorizacaoPagamentoParcial": {
"type": "integer",
"description": "Indica se o boleto pode ser pago parcialmente ou não.\n1 - Não aceita receber pagamento parcial de boletos, 2-Aceita receber pagamento parcial de boletos",
"format": "int32",
"example": 1,
"enum": [
1,
2
]
},
"codigoCanalPagamento": {
"type": "integer",
"description": "Número do canal de pagamento do Boleto que identifica qual o meio utilizado para realizar o pagamento.\n\"CANAL UTILIZADO PARA PAGAMENTO/MEIOS DE APRESENTAÇÃO DO BOLETO AO SACADO:\nComando 02 nas posições 109/110 (Confirmação de entrada de boleto – Nota 07)\n00 – Não é Sacado Eletrônico no DDA\n50 – Sacado eletrônico no DDA\n\nComando 06, 07, 08, 15 ou 46 nas posições 109/110 (Liquidação de boleto – Nota 07)\n01 – terminal de auto-atendimento\n02 – internet\n03 – central de atendimento (URA)\n04 – gerenciador financeiro\n05 – central de atendimento\n06 – outro canal de auto-atendimento\n07 – correspondente bancário\n08 – guichê de caixa\n09 – arquivo-eletrônico\n10 – compensação\n11 – outro canal eletrônico\n61 - Pix\n\nComando 93 nas posições 109/110 (Baixa Operacional – Nota 07)\n01 - Liquidação Caixa\n02 - Liquidação TAA\n03 - Liquidação Internet\n05 - Liquidação Correspondente Bancário\n06 - Liquidação Central de Atendimento\n07 - Liquidação Arquivo\n08 - Liquidação Internet\"",
"format": "int32",
"example": 11
},
"URL": {
"type": "string",
"description": "Link do QRCode gerado na iniciação de um pagamento de título de cobrança vinculado ao sistema de pagamento instantâneo, que conterá as demais informações constantes no QRCODE para que os dados sejam apresentados para o pagador.",
"example": "qrcode.sed.desenv.bb.com.br/pix/v2/cobv/ce8a678e-0a0c-414e-938a-88dc072708a0"
},
"textoIdentificadorQRCode": {
"type": "string",
"description": "Código que identifica a transação que vincula o QRCode disponibilizado para pagamento do título de cobrança vinculado ao sistema de pagamento instantâneo.",
"example": "BOLETO19221240800005487DATA17012022 "
},
"quantidadeDiasCalculo": {
"type": "integer",
"description": "Quantidade de dias para calculo do boleto de cobrança.\na) Carteiras 11, 12, 15, 16, 7, 18 e 31: quando o boleto for liquidado, é preenchido com o número de dias decorridos desde o vencimento até a liquidação. b) Carteira 51: igual ao número de dias sobre os quais foram calculados o desconto e o IOF.",
"format": "int32",
"example": 12
},
"valorTaxaDesconto": {
"type": "number",
"description": "Valor da taxa de desconto aplicada ao boleto de cobrança.",
"format": "double",
"example": 0.33
},
"valorTaxaIOF": {
"type": "number",
"description": "Valor da taxa de IOF calculado ao boleto de cobrança.",
"format": "double",
"example": 1.2323
},
"naturezaRecebimento": {
"type": "integer",
"description": "A natureza do Recebimento é o número de validação do ciclo de vida do boleto, que vai variar de acordo com o comando.\n\"NATUREZA DO RECEBIMENTO\na) comando 05, 06, 07, 08 ou 15 ou 46 nas posições 109/110\n01-liquidação normal\n02-liquidação parcial\n03-liquidação por saldo\n04-liquidação com cheque a compensar\n05-liquidação de boleto sem registro (carteira 7 tipo 4)\n07-liquidação na apresentação\n09-liquidação em cartório\n10-Liquidação Parcial com Cheque a Compensar\n11-Liquidação por Saldo com Cheque a Compensar\n61-Liquidação via Pix\n\nb) comando 02 nas posições 109/110 (ENTRADA):\n00-por meio magnético\n11-por via convencional\n16-por alteração do código do cedente\n17-por alteração da variação\n18-por alteração da carteira\nc) comandos 09, 10 ou 20 nas posições 109/110 (BAIXA):\n00-solicitada pelo cliente\n15-protestado\n18-por alteração da carteira\n19-débito automático\n31-liquidado anteriormente\n32-habilitado em processo\n33-incobrável por nosso intermédio\n34-transferido para créditos em liquidação\n46-por alteração da variação\n47-por alteração da variação\n51-acerto\n61-Registrado com QR Code Pix\n62-Registrado sem QR Code Pix\n90-baixa automática\n\nd) comando 03 nas posições 109/110 (RECUSA):\n01-identificação inválida\n02-variação da carteira inválida\n03-valor dos juros por um dia inválido\n04-valor do desconto inválido\n05-espécie de boleto inválida para carteira/variação\n06-espécie de valor invariável inválido\n07-prefixo da agência usuária inválido\n08-valor do boleto/apólice inválido\n09-data de vencimento inválida\n10-fora do prazo/só admissível na carteira \n11-inexistência de margem para desconto\n12-o banco não tem agência na praça do sacado\n13-razões cadastrais\n14-sacado interligado com o sacador (só admissível em cobrança simples- cart. 11 e 17)\n15-Titulo sacado contra órgão do Poder Público (só admissível na carteira 11 e sem ordem de protesto)\n16-Titulo preenchido de forma irregular \n17-Titulo rasurado\n18-Endereço do sacado não localizado ou incompleto \n19-Código do cedente inválido \n20-Nome/endereço do cliente não informado (ECT)\n21-Carteira inválida\n22-Quantidade de valor variável inválida\n23-Faixa nosso-numero excedida\n24-Valor do abatimento inválido\n25-Novo número do boleto dado pelo cedente inválido (Seu número)\n26-Valor do IOF de seguro inválido\n27-Nome do sacado/cedente inválido\n28-Data do novo vencimento inválida\n29-Endereço não informado\n30-Registro de boleto já liquidado (carteira 17-tipo 4)\n31-Numero do borderô inválido\n32-Nome da pessoa autorizada inválido\n33-Nosso número já existente\n34-Numero da prestação do contrato inválido\n35-percentual de desconto inválido\n36-Dias para fichamento de protesto inválido\n37-Data de emissão do boleto inválida\n38-Data do vencimento anterior à data da emissão do boleto\n39-Comando de alteração indevido para a carteira\n40-Tipo de moeda inválido\n41-Abatimento não permitido\n42-CEP/UF inválido/não compatíveis (ECT)\n43-Código de unidade variável incompatível com a data de emissão do boleto\n44-Dados para débito ao sacado inválidos\n45-Carteira/variação encerrada\n46-Convenio encerrado\n47-Titulo tem valor diverso do informado\n48-Motivo de baixa invalido para a carteira\n49-Abatimento a cancelar não consta do boleto\n50-Comando incompatível com a carteira\n51-Código do convenente invalido\n52-Abatimento igual ou maior que o valor do titulo\n53-Titulo já se encontra na situação pretendida\n54-Titulo fora do prazo admitido para a conta 1\n55-Novo vencimento fora dos limites da carteira\n56-Titulo não pertence ao convenente\n57-Variação incompatível com a carteira\n58-Impossível a variação única para a carteira indicada \n59-Titulo vencido em transferência para a carteira 51\n60-Titulo com prazo superior a 179 dias em variação única para carteira 51\n61-Titulo já foi fichado para protesto\n62-Alteração da situação de débito inválida para o código de responsabilidade\n63-DV do nosso número inválido\n64-Titulo não passível de débito/baixa – situação anormal\n65-Titulo com ordem de não protestar – não pode ser encaminhado a cartório\n66-Número do documento do sacado (CNPJ/CPF) inválido\n67-Titulo/carne rejeitado\n69-Valor/Percentual de Juros Inválido\n70-Boleto já se encontra isento de juros\n71-Código de Juros Inválido\n72 - Prefixo da Ag. cobradora inválido\n73 – Numero do controle do participante inválido\n74 – Cliente não cadastrado no CIOPE (Desconto/Vendor)\n75 – Qtde. de dias do prazo limite p/ recebimento de boleto vencido inválido\n76 – Titulo excluído automaticamente por decurso de prazo CIOPE (Desconto/Vendor)\n77 – Titulo vencido transferido para a conta 1 – Carteira vinculada\n84 – Boleto não localizado na existência/Baixado por protesto\n80-Nosso numero inválido\n81-Data para concessão do desconto inválida. Gerada nos seguintes casos:\n11\t - erro na data do desconto;\n12\t - data do desconto anterior à data de emissão\n82-CEP do sacado inválido\n83-Carteira/variação não localizada no cedente\n84-Titulo não localizado na existência\n85-Recusa do Comando “41” – Parâmetro de Liquidação Parcial.\n99-Outros motivos\n\nComando 72 nas posições 109/110 (Alteração de Tipo de Cobrança):\n00-transferência de boleto de cobrança simples para descontada ou vice-versa\n52-reembolso de boleto vendor ou descontado, quando ocorrerem reembolsos de boletos por falta de liquidação. Não há migração de carteira descontada para simples.\n\nComando 85 nas posições 109/110:\n01 - Negativação aceita no BB \n02 - Negativação aceita no agente negativador \n03 - Inclusão cancelada \n04 - Negativação recusada - pagador menor de idade \n05 - Negativação recusada - espécie do boleto não permitida \n06 - Negativação recusada - beneficiário não é PJ \n07 - Negativação recusada - moeda do boleto não é Real \n08 - Negativação recusada - endereço do pagador inválido \n09 - Negativação recusada pelo agente negativador\n10 - Negativação recusada - situação do boleto não permite NGTV \n11 - Negativação recusada - cadastro do benef. desatualizado \n12 - Negativação recusada - boleto inexistente \n13 - Negativação recusada - pagador não identificado \n14 - Recusa de tarifação de negativação\n15 - Negativação recusada - motivos diversos \nComando 86 nas posições 109/110:\n01 - Exclusão cancelada \n02 - Negativação excluída no agente negativador \n03 - Negativação excluída - devolução pelos correios \n04 - Negativação excluída - data de ocorrência decursada \n05 - Negativação excluída - determinação judicial \n06 - Negativação excluída - contestação do interessado \n07 - Negativação excluída - carta não retornou do correio \n08 - Exclusão negativação recusada - registro inexistente\n09 - Exclusão de negativação aceita no BB\n15 - Exclusão negativação recusada - motivos diversos \n\nComando 93 nas posições 109/110:\n01 - Baixa Operacional BB \n02 - Baixa Operacional Outros Bancos\n10 - Cancelamento de Baixa Operacional\"",
"format": "int32",
"example": 7
},
"codigoTipoCobrancaComando": {
"type": "integer",
"description": "Código do tipo de cobrança original. O objetivo é preservar o tipo de cobrança original.\n0-Caso não haja alteração de tipo de cobrança, 1-Simples, 2-Vinculada, 4-Descontada, 7-Cobrança Simples Carteira 17, 8-Vendor",
"format": "int32",
"example": 0,
"enum": [
0,
1,
2,
4,
7,
8
]
},
"dataLiquidacaoBoleto": {
"type": "string",
"description": "Data de liquidação do boleto.",
"example": "dd.mm.aaaa"
}
}
}
}
}
},
"examples": {
"example-1": {
"value": {
"indicadorContinuidade": "S",
"numeroUltimoRegistro": 8900,
"listaRegistro": [
{
"dataMovimentoRetorno": "24.03.2022",
"numeroConvenio": 1234567,
"numeroTituloCobranca": "00012345670000000001",
"codigoComandoAcao": 2,
"codigoPrefixoAgencia": 1,
"numeroContaCorrente": 123456789,
"numeroCarteiraCobranca": 17,
"numeroVariacaoCarteiraCobranca": 35,
"tipoCobranca": 1,
"codigoControleParticipante": "A123456",
"codigoEspecieBoleto": 0,
"dataVencimentoBoleto": "31.12.2022",
"valorBoleto": 100,
"codigoBancoRecebedor": 237,
"codigoPrefixoAgenciaRecebedora": 2,
"dataCreditoPagamentoBoleto": "03.02.2023",
"valorTarifa": 9,
"valorOutrasDespesasCalculadas": 0,
"valorJurosDesconto": 1,
"valorIofDesconto": 0.5,
"valorAbatimento": 10,
"valorDesconto": 1,
"valorRecebido": 100,
"valorJurosMora": 5,
"valorOutrosValoresRecebidos": 2,
"valorAbatimentoNaoUtilizado": 1,
"valorLancamento": 30,
"codigoFormaPagamento": 0,
"codigoValorAjuste": 0,
"valorAjuste": 0.51,
"codigoAutorizacaoPagamentoParcial": 1,
"codigoCanalPagamento": 11,
"URL": "qrcode.sed.desenv.bb.com.br/pix/v2/cobv/ce8a678e-0a0c-414e-938a-88dc072708a0",
"textoIdentificadorQRCode": "BOLETO19221240800005487DATA17012022 ",
"quantidadeDiasCalculo": 12,
"valorTaxaDesconto": 0.33,
"valorTaxaIOF": 1.2323,
"naturezaRecebimento": 7,
"codigoTipoCobrancaComando": 0,
"dataLiquidacaoBoleto": "dd.mm.aaaa"
}
]
}
}
}
}
}
},
"400": {
"description": "REQUISIÇÃO INVÁLIDA. O servidor não pôde processar a requisição devido a uma sintaxe de requisição malformada, estrutura da mensagem da requisição inválida, ou valores inválidos.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v4"
}
}
}
},
"401": {
"description": "NÃO AUTORIZADO. A requisição requer autenticação do usuário.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErroOAuthNaoAutorizado"
}
}
}
},
"403": {
"description": "PROIBIDO. A requisição foi válida, mas o servidor está recusando a ação. O usuário pode não ter as permissões necessárias para um recurso ou pode precisar de uma conta de algum tipo.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v4"
}
}
}
},
"404": {
"description": "NÃO ENCONTRADO. O servidor não conseguiu encontrar o recurso solicitado."
},
"500": {
"description": "ERRO INTERNO. O servidor encontrou uma condição inesperada que o impediu de atender a requisição.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v4"
}
}
}
}
},
"description": "Lista os dados do retorno de movimento do convênio de Cobranças.
ATENÇÃO: Para utilização do serviço, entre em contato com seu Gerente de Cash ou Gerente de Relacionamento.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"dataMovimentoRetornoInicial": {
"type": "string",
"description": "Data inicial do processamento do movimento de retorno de cobrança de Boleto.",
"example": "01.03.2022"
},
"dataMovimentoRetornoFinal": {
"type": "string",
"description": "Data final do processamento do movimento de retorno de cobrança de Boleto.",
"example": "20.03.2022"
},
"codigoPrefixoAgencia": {
"type": "integer",
"description": "Código do prefixo identificador de uma dependência do Banco.",
"example": 1,
"format": "int64"
},
"numeroContaCorrente": {
"type": "integer",
"description": "Número identificador de uma Conta Corrente contratada pelo cliente junto ao Banco do Brasil.",
"example": 12345678,
"format": "int64"
},
"numeroCarteiraCobranca": {
"type": "integer",
"description": "Número identificador da carteira de Cobrança. Indica o tipo de serviço de cobrança, para o qual são aplicadas regras específicas.",
"example": 17,
"format": "int32"
},
"numeroVariacaoCarteiraCobranca": {
"type": "integer",
"description": "Número identificador da variação da Carteira de Cobrança. Identifica cada grupo de condições específicas (variação) para um mesmo tipo de serviço de cobrança contratado pelo cliente (carteira), visando separar os títulos de cobrança de acordo com os interesses do próprio cliente e previamente negociados com o Banco.",
"example": 35,
"format": "int32"
},
"numeroRegistroPretendido": {
"type": "integer",
"description": "Número do registro ou da página que deseja buscar na consulta. Quando primeira chamada, informar \"001\"",
"example": 1,
"format": "int64"
},
"quantidadeRegistroPretendido": {
"type": "integer",
"description": "Quantidade de registros ou páginas que desejar buscar na consulta. Quantidade máxima de 10000 boletos por chamada",
"format": "int64",
"example": 10000
}
},
"required": [
"dataMovimentoRetornoInicial",
"dataMovimentoRetornoFinal"
]
},
"examples": {
"example-1": {
"value": {
"dataMovimentoRetornoInicial": "01.03.2022",
"dataMovimentoRetornoFinal": "20.03.2022",
"codigoPrefixoAgencia": 1,
"numeroContaCorrente": 12345678,
"numeroCarteiraCobranca": 17,
"numeroVariacaoCarteiraCobranca": 35,
"numeroRegistroPretendido": 1,
"quantidadeRegistroPretendido": 10000
}
}
}
}
}
},
"tags": [
"movimento"
],
"security": [
{
"OAuth2": [
"cobrancas.boletos-info"
],
"OAuth2-Sandbox": [
"cobrancas.boletos-info"
],
"OAuth2-Homologacao": [
"cobrancas.boletos-info"
],
"ApiKey": []
}
]
}
},
"/boletos-baixa-operacional": {
"parameters": [
{
"$ref": "#/components/parameters/AppKey"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"get": {
"summary": "Informações de Baixa Operacional de Boletos",
"description": "Lista boletos pagos em outras instituições financeiras (baixa operacional) dentro do período informado de pesquisa. A consulta à baixa operacional pode ser realizada em até 5 dias após a efetivação do pagamento.
Para receber informações de pagamento e baixa operacional dos seus boletos em tempo real, utilize o **serviço de notificação automática (Webhook da Cobrança Bancária)**,que envia notificações automáticas sempre que ocorrerem alterações relevantes e está documentado abaixo.
_Observação_: A utilização do recurso depende da habilitação através do PATCH /convenios/{id}/ativar-consulta-baixa-operacional.
Para desativar o o recurso, utilize o PATCH /convenios/{id}/desativar-consulta-baixa-operacional.",
"parameters": [
{
"name": "agencia",
"in": "query",
"description": "Número da agência do beneficiário, sem o dígito verificador.",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 9999
}
},
{
"name": "conta",
"in": "query",
"description": "Número da conta do beneficiário, sem o dígito verificador.",
"required": true,
"schema": {
"type": "integer",
"format": "int64",
"minimum": 1,
"maximum": 99999999999
}
},
{
"name": "carteira",
"in": "query",
"description": "Número da carteira do convênio de cobrança.",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 999999999
},
"required": true
},
{
"name": "variacao",
"in": "query",
"description": "Número da variação da carteira do convênio de cobrança.",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 9999
},
"required": true
},
{
"name": "estadoBaixaOperacional",
"in": "query",
"description": "Código para identificar o estado da baixa operacional. Domínio:1 - BAIXA OPERACIONAL BB; 2 - BAIXA OPERACIONAL OUTROS BANCOS; 10- CANCELAMENTO DE BAIXA OPERACIONAL",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 10
}
},
{
"name": "modalidadeTitulo",
"in": "query",
"description": "Código para identificar a característica dos boletos dentro das modalidades de cobrança existentes no banco.\n\nDomínio:\n1 - SIMPLES\n4 - VINCULADA",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 4
}
},
{
"name": "dataInicioVencimentoTitulo",
"in": "query",
"description": "Data de vencimento inicial para delimitar período da consulta.",
"schema": {
"type": "string",
"minLength": 10,
"maxLength": 10,
"example": "01/05/2021"
}
},
{
"name": "dataFimVencimentoTitulo",
"in": "query",
"description": "Data de vencimento final para delimitar período da consulta.",
"schema": {
"type": "string",
"minLength": 10,
"maxLength": 10,
"example": "31/05/2021"
}
},
{
"name": "dataInicioRegistroTitulo",
"in": "query",
"description": "Data de registro inicial para delimitar período da consulta.",
"schema": {
"type": "string",
"minLength": 10,
"maxLength": 10,
"example": "01/05/2021"
}
},
{
"name": "dataFimRegistroTitulo",
"in": "query",
"description": "Data de registro final para delimitar período da consulta.",
"schema": {
"type": "string",
"minLength": 10,
"maxLength": 10,
"example": "31/05/2021"
}
},
{
"name": "dataInicioAgendamentoTitulo",
"in": "query",
"description": "Data de agendamento inicial para delimitar período da consulta.",
"schema": {
"type": "string",
"minLength": 10,
"maxLength": 10,
"example": "01/05/2021"
},
"required": true
},
{
"name": "dataFimAgendamentoTitulo",
"in": "query",
"description": "Data de agendamento final para delimitar período da consulta.",
"schema": {
"type": "string",
"minLength": 10,
"maxLength": 10,
"example": "01/05/2021"
},
"required": true
},
{
"name": "horarioInicioAgendamentoTitulo",
"in": "query",
"description": "Hora de agendamento inicial para delimitar período da consulta.",
"schema": {
"type": "string",
"minLength": 8,
"maxLength": 8,
"example": "07:00:00"
}
},
{
"name": "horarioFimAgendamentoTitulo",
"in": "query",
"description": "Hora de agendamento final para delimitar período da consulta.",
"schema": {
"type": "string",
"minLength": 8,
"maxLength": 8,
"example": "17:00:00"
}
},
{
"name": "idProximoTitulo",
"in": "query",
"description": "Identificador do próximo título da próxima paginação a ser consultado. Somente deve ser utilizado em caso de pesquisas que retornem mais de 650 boletos.\nSe na resposta da primeira consulta, ou consulta anterior, o campo \"possuiMaisTitulos\" retorne o valor \"S\", então na próxima chamada, o usuário deve informar o valor do campo \"proximoTitulo\" que veio na resposta, a partir do qual será iniciada nova consulta.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "SUCESSO. A requisição foi atendida e resultou em resposta.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RespostaBoletosBaixaOperacional"
}
}
}
},
"400": {
"description": "REQUISIÇÃO INVÁLIDA. O servidor não pôde processar a requisição devido a uma sintaxe de requisição malformada, estrutura da mensagem da requisição inválida, ou valores inválidos.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v4"
}
}
}
},
"401": {
"description": "NÃO AUTORIZADO. A requisição requer autenticação do usuário.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErroOAuthNaoAutorizado"
}
}
}
},
"500": {
"description": "ERRO INTERNO. O servidor encontrou uma condição inesperada que o impediu de atender a requisição.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v4"
}
}
}
}
},
"security": [
{
"OAuth2": [
"cobrancas.boletos-info"
],
"OAuth2-Sandbox": [
"cobrancas.boletos-info"
],
"OAuth2-Homologacao": [
"cobrancas.boletos-info"
],
"ApiKey": []
}
],
"operationId": "boletosBaixaOperacional",
"tags": [
"boletos"
]
}
},
"/convenios/{id}/ativar-consulta-baixa-operacional": {
"parameters": [
{
"schema": {
"type": "string"
},
"in": "path",
"required": true,
"description": "Número do convênio de Cobrança do Cliente",
"name": "id"
},
{
"$ref": "#/components/parameters/AppKey"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"patch": {
"summary": "Habilitar Consulta de Baixa Operacional",
"operationId": "AtivarConsultaBaixaOperacional",
"responses": {
"200": {
"description": "SUCESSO. A requisição foi atendida e resultou em resposta.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"estadoPersonalizacao": {
"type": "string",
"description": "Retorno da solicitação.",
"maxLength": 30
},
"dataHoraEstado": {
"type": "string",
"description": "Data e hora do registro da inclusão do serviço.",
"maxLength": 26
}
}
}
}
}
},
"400": {
"description": "REQUISIÇÃO INVÁLIDA. O servidor não pôde processar a requisição devido a uma sintaxe de requisição malformada, estrutura da mensagem da requisição inválida, ou valores inválidos.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v4"
}
}
}
},
"401": {
"description": "NÃO AUTORIZADO. A requisição requer autenticação do usuário.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErroOAuthNaoAutorizado"
}
}
}
},
"403": {
"description": "PROIBIDO. A requisição foi válida, mas o servidor está recusando a ação. O usuário pode não ter as permissões necessárias para um recurso ou pode precisar de uma conta de algum tipo.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v4"
}
}
}
},
"404": {
"description": "NÃO ENCONTRADO. O servidor não conseguiu encontrar o recurso solicitado."
},
"500": {
"description": "ERRO INTERNO. O servidor encontrou uma condição inesperada que o impediu de atender a requisição.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v4"
}
}
}
}
},
"description": "Habilita a personalização de convênio, permitindo realizar consulta das informações de baixa operacional de boletos da carteira de cobranças do cliente no mesmo dia.\n",
"security": [
{
"OAuth2": [
"cobrancas.convenio-requisicao"
],
"OAuth2-Sandbox": [
"cobrancas.convenio-requisicao"
],
"OAuth2-Homologacao": [
"cobrancas.convenio-requisicao"
],
"ApiKey": []
}
],
"tags": [
"convênio"
]
}
},
"/convenios/{id}/desativar-consulta-baixa-operacional": {
"parameters": [
{
"schema": {
"type": "string"
},
"in": "path",
"required": true,
"description": "Número do convênio de Cobrança do Cliente",
"name": "id"
},
{
"$ref": "#/components/parameters/AppKey"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"patch": {
"summary": "Desativar Consulta Baixa Operacional",
"operationId": "DesativaConsultaBaixaOperacional",
"responses": {
"200": {
"description": "SUCESSO. A requisição foi atendida e resultou em resposta.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"estadoPersonalizacao": {
"type": "string",
"description": "Retorno da solicitação.",
"maxLength": 30
},
"dataHoraEstado": {
"type": "string",
"description": "Data e hora do registro da inclusão do serviço.",
"maxLength": 26
}
}
}
}
}
},
"400": {
"description": "REQUISIÇÃO INVÁLIDA. O servidor não pôde processar a requisição devido a uma sintaxe de requisição malformada, estrutura da mensagem da requisição inválida, ou valores inválidos.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v4"
}
}
}
},
"401": {
"description": "NÃO AUTORIZADO. A requisição requer autenticação do usuário.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErroOAuthNaoAutorizado"
}
}
}
},
"403": {
"description": "PROIBIDO. A requisição foi válida, mas o servidor está recusando a ação. O usuário pode não ter as permissões necessárias para um recurso ou pode precisar de uma conta de algum tipo.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v4"
}
}
}
},
"404": {
"description": "NÃO ENCONTRADO. O servidor não conseguiu encontrar o recurso solicitado."
},
"500": {
"description": "ERRO INTERNO. O servidor encontrou uma condição inesperada que o impediu de atender a requisição.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro-v4"
}
}
}
}
},
"description": "Desativa a personalização de convênio, não permitindo realizar consulta das informações de baixa operacional de boletos da carteira de cobranças do cliente no mesmo dia.",
"security": [
{
"OAuth2": [
"cobrancas.convenio-requisicao"
],
"OAuth2-Sandbox": [
"cobrancas.convenio-requisicao"
],
"OAuth2-Homologacao": [
"cobrancas.convenio-requisicao"
],
"ApiKey": []
}
],
"tags": [
"convênio"
]
}
}
},
"webhooks": {
"baixa-operacional": {
"post": {
"summary": "Notificação de liquidação/baixa de boleto bancário",
"description": "O Webhook da API Cobrança notifica o emissor do boleto bancário sobre o recebimento pelo Banco do Brasil de uma Baixa Operacional de um boleto, seja a liquidação (pagamento) ou solicitação de baixa.
Baixa Operacional é o meio pelo qual a Instituição Recebedora (onde o boleto foi pago) informa à Base Centralizada de Cobrança (PCR) que o boleto está sendo pago e esta, por sua vez, é responsável por repassar essa informação ao Banco emissor do boleto.",
"externalDocs": {
"url": "https://apoio.developers.bb.com.br/guias-e-tutoriais/webhook/visao-geral",
"description": "Para obter mais informações sobre o que é o serviço de Webhook e seu funcionamento, acesse nossa documentação negocial completa."
},
"operationId": "webhookApiCobranca",
"tags": [
"boletos"
],
"security": [
{
"mutualTLS": []
}
],
"responses": {
"200": {
"description": "SUCESSO. A notificação foi enviada com sucesso ao cliente.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookBaixaBoleto"
}
}
}
},
"401": {
"description": "NÃO AUTORIZADO. O certificado de mTLS não foi reconhecido pelo BB e por isso a notificação no pode ser entregue."
}
}
}
}
},
"components": {
"schemas": {
"RequisicaoAlterarBoleto": {
"title": "RequisicaoAlterarBoleto",
"required": [
"indicadorAlterarAbatimento",
"indicadorAlterarDataDesconto",
"indicadorAlterarDesconto",
"indicadorAlterarEnderecoPagador",
"indicadorAlterarPrazoBoletoVencido",
"indicadorAlterarSeuNumero",
"indicadorAtribuirDesconto",
"indicadorCancelarProtesto",
"indicadorCobrarJuros",
"indicadorCobrarMulta",
"indicadorDispensarJuros",
"indicadorDispensarMulta",
"indicadorIncluirAbatimento",
"indicadorNegativar",
"indicadorNovaDataVencimento",
"indicadorProtestar",
"indicadorSustacaoProtesto",
"indicadorNovoValorNominal"
],
"type": "object",
"properties": {
"numeroConvenio": {
"type": "integer",
"description": "Identificador determinado pelo sistema de boleto bancário para fornecer a emissão e liquidação do boleto e, portanto, usado para creditar o Beneficiário.",
"format": "int32"
},
"indicadorNovaDataVencimento": {
"type": "string",
"description": "Indica a intenção de atribuir nova data de vencimento ao boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"
},
"alteracaoData": {
"$ref": "#/components/schemas/alteracaoData"
},
"indicadorNovoValorNominal": {
"type": "string",
"description": "Indica a intenção de alterar valor nominal do boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"
},
"alteracaoValor": {
"$ref": "#/components/schemas/AlterarValorNominal"
},
"indicadorAtribuirDesconto": {
"type": "string",
"description": "Indica a intenção de atribuir desconto ao boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"
},
"desconto": {
"$ref": "#/components/schemas/desconto"
},
"indicadorAlterarDesconto": {
"type": "string",
"description": "Indica a intenção de alterar desconto do boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"
},
"alteracaoDesconto": {
"$ref": "#/components/schemas/alteracaoDesconto"
},
"indicadorAlterarDataDesconto": {
"type": "string",
"description": "Indica a intenção de alterar a data do desconto do boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"
},
"alteracaoDataDesconto": {
"$ref": "#/components/schemas/alteracaoDataDesconto"
},
"indicadorProtestar": {
"type": "string",
"description": "Indica a intenção de protestar o boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"
},
"protesto": {
"$ref": "#/components/schemas/protesto"
},
"indicadorSustacaoProtesto": {
"type": "string",
"description": "Indica a intenção de sustar/cancelar um comando de protesto do boleto que já tenha sido processado pelo Banco. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar."
},
"indicadorCancelarProtesto": {
"type": "string",
"description": "Deve ser utilizada para cancelar uma instrução de protesto enviada ao Banco na mesma data ou que ainda não tenha sido processada pelo Banco. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"
},
"indicadorIncluirAbatimento": {
"type": "string",
"description": "Indica a intenção de incluir abatimento no boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"
},
"abatimento": {
"$ref": "#/components/schemas/abatimento"
},
"indicadorAlterarAbatimento": {
"type": "string",
"description": "Indica a intenção de alterar o valor do abatimento no boleto. Domínio:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"
},
"alteracaoAbatimento": {
"$ref": "#/components/schemas/alteracaoAbatimento"
},
"indicadorCobrarJuros": {
"type": "string",
"description": "Indica a intenção de cobrar juros no boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"
},
"juros": {
"$ref": "#/components/schemas/juros"
},
"indicadorDispensarJuros": {
"type": "string",
"description": "Indica a intenção de dispensar juros no boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"
},
"indicadorCobrarMulta": {
"type": "string",
"description": "Indica a intenção de cobrar multa no boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"
},
"multa": {
"$ref": "#/components/schemas/multa"
},
"indicadorDispensarMulta": {
"type": "string",
"description": "Indica a intenção de dispensar cobrança de multa no boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"
},
"indicadorNegativar": {
"type": "string",
"description": "Indica a intenção de negativar ou cancelar negativação boleto. (Inclusão ou Cancelamento) Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"
},
"negativacao": {
"$ref": "#/components/schemas/negativacao"
},
"indicadorAlterarSeuNumero": {
"type": "string",
"description": "Indica a intenção de alterar Seu Numero no boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"
},
"alteracaoSeuNumero": {
"$ref": "#/components/schemas/alteracaoSeuNumero"
},
"indicadorAlterarEnderecoPagador": {
"type": "string",
"description": "Indica a intenção de alterar endereço do Pagador no boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"
},
"alteracaoEndereco": {
"$ref": "#/components/schemas/alteracaoEndereco"
},
"indicadorAlterarPrazoBoletoVencido": {
"type": "string",
"description": "Indica a intenção de prazo de aceite de boleto vencido. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"
},
"alteracaoPrazo": {
"$ref": "#/components/schemas/alteracaoPrazo"
}
},
"description": "Representação dos campos de requisição de uma solicitação de alteração dos dados de boletos bancários."
},
"RequisicaoBaixaBoleto": {
"required": [
"numeroConvenio"
],
"type": "object",
"properties": {
"numeroConvenio": {
"type": "number",
"description": "Identificador determinado pelo sistema de boleto bancário usado para emissão e liquidação do boleto e, portanto, usado para creditar o Beneficiário."
}
},
"description": "Objeto de requisição da baixa de boletos."
},
"RequisicaoRegistroBoletos": {
"type": "object",
"description": "Representação dos campos de requisição de uma solicitação de criação de boletos bancários.",
"title": "",
"properties": {
"numeroConvenio": {
"type": "integer",
"description": "Número do convênio de Cobrança do Cliente. Identificador determinado pelo sistema Cobrança para controlar a emissão de boletos, liquidação, crédito de valores ao Beneficiário e intercâmbio de dados com o cliente.",
"format": "int64"
},
"numeroCarteira": {
"type": "integer",
"description": "Características do serviço de boleto bancário e como ele deve ser tratado pelo banco.",
"format": "int32"
},
"numeroVariacaoCarteira": {
"type": "integer",
"description": "Número da variação da carteira do convênio de cobrança.",
"format": "int32"
},
"codigoModalidade": {
"type": "integer",
"description": "Identifica a característica dos boletos dentro das modalidades de cobrança existentes no banco.\n\nDomínio:\n01 - SIMPLES;\n04 - VINCULADA",
"format": "int32"
},
"dataEmissao": {
"type": "string",
"description": "Data de emissão do boleto (formato \"dd.mm.aaaaa\"). "
},
"dataVencimento": {
"type": "string",
"description": "Data de vencimento do boleto (formato \"dd.mm.aaaaa\")."
},
"valorOriginal": {
"type": "number",
"description": "Valor de cobrança > 0.00, emitido em Real (formato decimal separado por \".\"). Valor do boleto no registro. Deve ser maior que a soma dos campos “VALOR DO DESCONTO DO TÍTULO” e “VALOR DO ABATIMENTO DO TÍTULO”, se informados. Informação não passível de alteração após a criação. No caso de emissão com valor equivocado, sugerimos cancelar e emitir novo boleto.",
"format": "float"
},
"valorAbatimento": {
"type": "number",
"description": "Valor de dedução do boleto >= 0.00 (formato decimal separado por \".\").",
"format": "float"
},
"quantidadeDiasProtesto": {
"type": "number",
"description": "Quantos dias após a data de vencimento do boleto para iniciar o processo de cobrança através de protesto. (valor inteiro >= 0).",
"format": "int32"
},
"quantidadeDiasNegativacao": {
"type": "integer",
"description": "Quantos dias após a data de vencimento do boleto para iniciar o processo de negativação através da opção escolhida no campo orgaoNegativador. (valor inteiro >= 0).",
"format": "int32"
},
"orgaoNegativador": {
"type": "integer",
"description": "Código do Órgão Negativador.\n\nDomínio:\n10 - SERASA",
"format": "int32"
},
"indicadorAceiteTituloVencido": {
"type": "string",
"description": "Indicador de que o boleto pode ou não ser recebido após o vencimento. Campo não obrigatório\n\nSe não informado, será assumido a informação de limite de recebimento que está definida no convênio.\n\nQuando informado \"S\" em conjunto com o campo \"numeroDiasLimiteRecebimento\", será definido a quantidade de dias (corridos) que este boleto ficará disponível para pagamento após seu vencimento.\nObs.: Se definido \"S\" e o campo \"numeroDiasLimiteRecebimento\" ficar com valor zero também será assumido a informação de limite de recebimento que está definida no convênio.\n\nQuando informado \"N\", fica definindo que o boleto NÃO permite pagamento em atraso, portanto só aceitará pagamento até a data do vencimento ou o próximo dia útil, quando o vencimento ocorrer em dia não útil.\n\nQuando informado qualquer valor diferente de \"S\" ou \"N\" será assumido a informação de limite de recebimento que está definida no convênio."
},
"numeroDiasLimiteRecebimento": {
"type": "integer",
"description": "Número de dias limite para recebimento. Informar valor inteiro > 0.",
"format": "int32"
},
"codigoAceite": {
"type": "string",
"description": "Código para identificar se o boleto de cobrança foi aceito (reconhecimento da dívida pelo Pagador).\n\nDomínios:\nA - ACEITE\nN - NAO ACEITE"
},
"codigoTipoTitulo": {
"type": "integer",
"description": "Código para identificar o tipo de boleto de cobrança.\n\nDomínios:\n1- CHEQUE\n2- DUPLICATA MERCANTIL\n3- DUPLICATA MTIL POR INDICACAO\n4- DUPLICATA DE SERVICO\n5- DUPLICATA DE SRVC P/INDICACAO\n6- DUPLICATA RURAL\n7- LETRA DE CAMBIO\n8- NOTA DE CREDITO COMERCIAL\n9- NOTA DE CREDITO A EXPORTACAO\n10- NOTA DE CREDITO INDULTRIAL\n11- NOTA DE CREDITO RURAL\n12- NOTA PROMISSORIA\n13- NOTA PROMISSORIA RURAL\n14- TRIPLICATA MERCANTIL\n15- TRIPLICATA DE SERVICO\n16- NOTA DE SEGURO\n17- RECIBO\n18- FATURA\n19- NOTA DE DEBITO\n20- APOLICE DE SEGURO\n21- MENSALIDADE ESCOLAR\n22- PARCELA DE CONSORCIO\n23- DIVIDA ATIVA DA UNIAO\n24- DIVIDA ATIVA DE ESTADO\n25- DIVIDA ATIVA DE MUNICIPIO\n31- CARTAO DE CREDITO\n32- BOLETO PROPOSTA\n33- BOLETO APORTE\n99- OUTROS.",
"format": "int32"
},
"descricaoTipoTitulo": {
"type": "string",
"description": "Descrição do tipo de boleto."
},
"indicadorPermissaoRecebimentoParcial": {
"type": "string",
"description": "Código para identificação da autorização de pagamento parcial do boleto.\n\nDomínios:\nS - SIM\nN - NÃO\n"
},
"numeroTituloBeneficiario": {
"type": "string",
"description": "São aceitos como caracteres válidos:\n\n • caracteres alfanuméricos: A a Z, 0 a 9;\n\n • caracteres especiais de conjunção: hifen (-),apostrofo (');\n\n exemplos: D'EL-REI, D'ALCORTIVO, SANT'ANA\n\n • separador de palavras: branco ( );\n\n Obs: Quaisquer caracteres diferentes dos mencionados acima, serão considerados inválidos."
},
"campoUtilizacaoBeneficiario": {
"type": "string",
"description": "Informações adicionais sobre o beneficiário."
},
"numeroTituloCliente": {
"type": "string",
"description": "Número de identificação do boleto (correspondente ao NOSSO NÚMERO), no formato STRING, com 20 dígitos, que deverá ser formatado da seguinte forma: “000” + (número do convênio com 7 dígitos) + (10 algarismos - se necessário, completar com zeros à esquerda)."
},
"mensagemBloquetoOcorrencia": {
"type": "string",
"description": "Mensagem definida pelo beneficiário para ser impressa no boleto.
O limite é de 165 caracteres, sendo que a cada 55 caracteres, a linha é quebrada.
O limite é de 3 linhas de mensagem (cada uma com 55 caracteres).
Caracteres de quebra de linha e de escape (como \n, \r, \\, \\lf, \\l e \\f) não são permitidos."
},
"desconto": {
"type": "object",
"description": "Define a ausência ou a forma como será concedido o desconto para o Título de Cobrança.",
"properties": {
"tipo": {
"type": "integer",
"description": "Como o desconto será concedido, inteiro >= 0. Domínios: \n0 - SEM DESCONTO;\n1 - VLR FIXO ATE A DATA INFORMADA;\n2 - PERCENTUAL ATE A DATA INFORMADA; \n3 - DESCONTO POR DIA DE ANTECIPACAO.",
"format": "int32"
},
"dataExpiracao": {
"type": "string",
"description": "Se tipo > 0, Definir uma data de expiração do desconto, no formato \"dd.mm.aaaa\"."
},
"porcentagem": {
"type": "number",
"description": "Se tipo = 2, definir uma porcentagem de desconto >= 0.00 (formato decimal separado por \".\").",
"format": "float"
},
"valor": {
"type": "number",
"description": "Se tipo = 1, definir um valor de desconto >= 0.00 (formato decimal separado por \".\").",
"format": "float"
}
}
},
"segundoDesconto": {
"type": "object",
"properties": {
"dataExpiracao": {
"type": "string",
"description": "Se tipo > 0, Definir uma data de expiração do desconto, no formato \"dd.mm.aaaa\" ."
},
"porcentagem": {
"type": "number",
"description": "Se tipo = 2, definir uma porcentagem de desconto >= 0.00 (formato decimal separado por \".\").",
"format": "float"
},
"valor": {
"type": "number",
"description": "Se tipo = 1, definir um valor de desconto >= 0.00 (formato decimal separado por \".\").",
"format": "float"
}
}
},
"terceiroDesconto": {
"type": "object",
"properties": {
"dataExpiracao": {
"type": "string",
"description": "Se tipo > 0, Definir uma data de expiração do desconto, no formato \"dd.mm.aaaa\"."
},
"porcentagem": {
"type": "number",
"description": "Se tipo = 2, definir uma porcentagem de desconto >= 0.00 (formato decimal separado por \".\").",
"format": "float"
},
"valor": {
"type": "number",
"description": "Se tipo = 1, definir um valor de desconto >= 0.00 (formato decimal separado por \".\").",
"format": "float"
}
}
},
"jurosMora": {
"type": "object",
"description": "Código utilizado pela FEBRABAN para identificar o tipo de taxa de juros, sendo:\n0 - DISPENSAR, 1 - VALOR DIA ATRASO, 2 - TAXA MENSAL, 3 - ISENTO. Se informado ‘0’ (zero) ou ‘3’ (três), os campos “PERCENTUAL DE JUROS DO TÍTULO” e “VALOR DO JUROS DO TÍTULO” não devem ser informados ou ser informados igual a ‘0’ (zero).\n\nO valor de juros e multa incidem sobre o valor atual do boleto (valor do boleto - valor de abatimento).",
"properties": {
"tipo": {
"type": "integer",
"description": "Código utilizado pela FEBRABAN para identificar o tipo de taxa de juros.\n\nDomínios:\n0 - DISPENSAR;\n1 - VALOR DIA ATRASO;\n2 - TAXA MENSAL;\n3 - ISENTO.",
"format": "int32"
},
"porcentagem": {
"type": "number",
"description": "Se tipo = 2, definir uma porcentagem de juros >= 0.00 (formato decimal separado por \".\").",
"format": "float"
},
"valor": {
"type": "number",
"description": "Se tipo = 1, definir um valor de juros >= 0.00 (formato decimal separado por \".\").",
"format": "float"
}
}
},
"multa": {
"type": "object",
"description": "Código para identificação do tipo de multa para o Título de Cobrança, inteiro >= 0, sendo: 0 - Sem multa, 1 - Valor da Multa, 2 - Percentual da Multa. Se informado ‘0’ (zero) os campos “DATA DE MULTA”, “PERCENTUAL DE MULTA” e “VALOR DA MULTA” não devem ser informados ou ser informados iguais a ‘0’ (zero).\n\nO valor de juros e multa incidem sobre o valor atual do boleto (valor do boleto - valor de abatimento).",
"properties": {
"tipo": {
"type": "integer",
"description": "Como a multa será concedida, inteiro >= 0.\n\nDomínios: \n0 - DISPENSAR; \n1 - VALOR DIA ATRASO; \n2 - TAXA MENSAL; \n3 - ISENTO.",
"format": "int32"
},
"data": {
"type": "string",
"description": "Se tipo > 0, Definir uma data de multa, no formato \"dd.mm.aaaa\" "
},
"porcentagem": {
"type": "number",
"description": "Se tipo = 2, definir porcentagem >= 0.00 (formato decimal separado por \".\").",
"format": "float"
},
"valor": {
"type": "number",
"description": "Se tipo = 1, definir valor do juros >= 0.00 (formato decimal separado por \".\").",
"format": "float"
}
}
},
"pagador": {
"type": "object",
"properties": {
"tipoInscricao": {
"type": "integer",
"description": "Código que identifica o tipo de inscrição do Pagador.\n\nDomínios:\n1 - CPF;\n2 - CNPJ",
"format": "int32"
},
"numeroInscricao": {
"type": "string",
"description": "Número de inscrição do pagador.\n\n - Quando tipoInscricao = 1 (CPF): informe o CPF, com ou sem máscara (ex.: \"12345678909\" ou \"123.456.789-09\").\n\n - Quando tipoInscricao = 2 (CNPJ): informe o CNPJ, com ou sem máscara. O CNPJ deve conter 12 caracteres numéricos ou alfanuméricos (0-9, A-Z) seguidos de 2 dígitos verificadores."
},
"nome": {
"type": "string",
"description": "Nome do pagador."
},
"endereco": {
"type": "string",
"description": "Endereço do pagador."
},
"cep": {
"type": "integer",
"description": "Código postal do pagador.",
"format": "int32"
},
"cidade": {
"type": "string",
"description": "Cidade do pagador."
},
"bairro": {
"type": "string",
"description": "Bairro do pagador."
},
"uf": {
"type": "string",
"description": "Sigla do unidade federativa em que o pagador vive."
},
"telefone": {
"type": "string",
"description": "Número de telefone do pagador."
},
"email": {
"type": "string",
"description": "Email do pagador."
}
},
"required": [
"tipoInscricao",
"numeroInscricao"
]
},
"beneficiarioFinal": {
"type": "object",
"properties": {
"tipoInscricao": {
"type": "integer",
"description": "Código que identifica o tipo de inscrição do beneficiário final.\n\nDomínios:\n1 - CPF;\n2 - CNPJ",
"format": "int32"
},
"numeroInscricao": {
"type": "string",
"description": "Número de inscrição do beneficiário final.\n\n - Quando tipoInscricao = 1 (CPF): informe o CPF, com ou sem máscara (ex.: \"12345678909\" ou \"123.456.789-09\").\n\n - Quando tipoInscricao = 2 (CNPJ): informe o CNPJ, com ou sem máscara. O CNPJ deve conter 12 caracteres numéricos ou alfanuméricos (0-9, A-Z) seguidos de 2 dígitos verificadores."
},
"nome": {
"type": "string",
"description": "Nome do beneficiário final"
}
}
},
"indicadorPix": {
"type": "string",
"description": "Código para informar se o boleto terá um QRCode Pix atrelado e qual o tipo de Pix utilizado.\n\nDomínios:\n\n - 'S' - Pix com QRCode Dinâmico (Boleto com Pix);\n\n - 'N' - Sem Pix\n\n - 'A' -Pix com QRCode Dinâmico + recorrência (Boleto com Pix Automático - BB numero)\n\n - 'B' - Pix com QRCode Dinâmico + recorrência (Boleto com Pix Automático - Cliente numera)\n\n - 'C' -Pix com QRCode Location + recorrência (Boleto com Pix Automático com Location)\n\n - OUTRO - Sem Pix\n\nCaso seja informado um caractere inválido, o sistema assumirá automaticamente N (Sem Pix)."
},
"idLocationPix": {
"type": "integer",
"description": "Número obtido no sistema Pix, que deve ser gerado com o tipoCob = cobv (Cobrança com vencimento). Este número será considerado quando o indicadorPix = S ou indicadorPix = 'C'.\n\nDomínios:\n\n - Maior que zero (> 0) → Pix com QRCode Location\n\n - Igual a zero (0) ou nulo → Pix sem Location"
},
"idLocationRecorrencia": {
"type": "integer",
"description": "Número obtido no sistema Pix, que deve ser gerado com o tipoCob = cobv (Cobrança com vencimento).\n\nEste campo só é considerado quando indicadorPix = 'C'.\n\nDomínios:\n\n - Maior que zero (> 0) → Pix com Location de recorrência\n\n - Igual a zero (0) → Sem Location de recorrência\n\n\nCasos de uso::\n\nCaso 1) Boleto sem Pix:\n\n - indicadorPix ≠ 'S', 'A', 'B', 'C'\n\n - idLocationPix: ignorado\n\n - id - LocationRecorrencia: ignorado\n\nCaso 2) Boleto com Pix dinâmico:\n\n - indicadorPix = 'S' \n\n - idLocationPix = 0 ou nulo\n\n - idLocationRecorrencia: não utilizado\n\nCaso 3) Boleto com Pix Location: \n\n- indicadorPix = 'S'\n\n- idLocationPix, número > 0\n\n - idLocationRecorrencia: não utilizado \n\nCaso 4) Boleto com Pix Automático + recorrência:\n\n- indicadorPix = 'A'\n\n- campoUtilizacaoBeneficiario - esse campo deve estar em branco\n\n- idLocationPix - número = 0\n\n- idLocationRecorrencia - número = 0\n\n Observação: O código da recorrência é gerado e controlado pelo Banco do Brasil.\n\nCaso 5) Boleto com Pix Automático + recorrência:\n\n- indicadorPix = 'B'\n\n- campoUtilizacaoBeneficiario - deve ser prenchido caracteres alfanumérico maiúsculo\n\n- idLocationPix - número = 0\n\n- idLocationRecorrencia - número = 0\n\n Observação: O conteúdo do campo campoUtilizacaoBeneficiario é o código da recorrência a ser utilizado em futuros boletos para o mesmo pagador\n\nCaso 6) Boleto com Pix Automático + Location com recorrência: \n\n- indicadorPix = 'C'\n\n- campoUtilizacaoBeneficiario - deve ser prenchido caracteres alfanumérico maiúsculo\n\n- idLocationPix - número > 0\n\n- idLocationRecorrencia - número > 0\n\n Observação: O conteúdo deste do campo campoUtilizacaoBeneficiario é o código da recorrência a ser utilizado em futuros boletos para o mesmo pagador"
}
},
"required": [
"numeroConvenio",
"dataVencimento",
"valorOriginal"
]
},
"RespostaAlterarBoleto": {
"title": "RespostaAlterarBoleto",
"type": "object",
"properties": {
"numeroContratoCobranca": {
"type": "integer",
"description": "Código adotado pelo Banco para identificar o Contrato entre este e a Empresa Cliente",
"format": "int32"
},
"dataAtualizacao": {
"type": "string",
"description": "Data do pedido de atualização do boleto bancário."
},
"horarioAtualizacao": {
"type": "string",
"description": "Horário do pedido de atualização do boleto bancário.HH:mm:ss"
}
},
"description": "Representação dos campos de resposta de uma solicitação de alteração dos dados de boletos bancários."
},
"RespostaBaixaBoleto": {
"required": [
"dataBaixa",
"horarioBaixa",
"numeroContratoCobranca"
],
"type": "object",
"properties": {
"numeroContratoCobranca": {
"type": "string",
"description": "Número do contrato de cobrança do boleto bancário."
},
"dataBaixa": {
"type": "string",
"description": "Data do pedido de baixa do boleto bancário."
},
"horarioBaixa": {
"type": "string",
"description": "Horário do pedido de baixa do boleto bancário.HH:mm:ss"
}
},
"description": "Objeto de resposta da baixa de boletos."
},
"RespostaConsultaPixBoleto": {
"type": "object",
"description": "Representação dos campos de resposta de uma solicitação de detalhamento de Pix vinculado a boleto bancário.",
"title": "",
"properties": {
"id": {
"type": "string",
"description": "Número de identificação do boleto (correspondente ao NOSSO NÚMERO, numeroTituloCliente), no formato STRING, com 20 dígitos, que deverá ser formatado da seguinte forma: “000” + (número do convênio com 7 dígitos) + (10 algarismos - se necessário, completar com zeros à esquerda). Campo Obrigatório.",
"minLength": 20,
"maxLength": 20
},
"dataRegistroTituloCobranca": {
"type": "string",
"description": "Data de registro do boleto no banco."
},
"agenciaBeneficiario": {
"type": "integer",
"description": "Número da agência do beneficiário, sem o dígito verificador."
},
"contaBeneficiario": {
"type": "integer",
"description": "Número da conta do beneficiário, sem o dígito verificador."
},
"valorOriginalTituloCobranca": {
"type": "number",
"description": "Valor original do boleto indicado quando do registro.",
"format": "float"
},
"validadeTituloCobranca": {
"type": "string",
"description": "Data de validade do boleto."
},
"pix": {
"type": "object",
"properties": {
"valorRecebido": {
"type": "number",
"description": "Valor recebido via Pix.",
"format": "float"
},
"timestamp": {
"type": "string",
"description": "Data e hora do recebimento via Pix."
},
"chave": {
"type": "string",
"description": "Código chave do pagador do Pix."
},
"textoRetorno": {
"type": "string",
"description": "Texto da mensagem de retorno do Pix."
},
"idInstituicaoPagador": {
"type": "string",
"description": "Código identificador da instituição do pagador do Pix."
},
"agenciaPagador": {
"type": "integer",
"description": "Prefixo da agência do pagador do Pix."
},
"contaPagador": {
"type": "integer",
"description": "Número da conta corrente do pagador do Pix."
},
"tipoPessoaPagador": {
"type": "integer",
"description": "Código do tipo de pessoa do pagador do Pix. Este valor pode ser 1 para Pessoa Física ou 2 para Pessoa Jurídica.",
"minimum": 1,
"maximum": 2
},
"idPagador": {
"type": "string",
"description": "Número do CPF ou CNPJ do pagador do Pix."
}
}
},
"qrCode": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "URL do payload do QR Code Pix "
},
"txId": {
"type": "string",
"description": "Codigo que identifica a transação Pix - transactionID"
},
"emv": {
"type": "string",
"description": "BR Code no padrão EMV. Sequência de caracteres correspondente ao payload do QR Code Pix."
},
"tipo": {
"type": "integer",
"description": "Código do tipo de QR Code do Pix. Este valor pode ser 1 para Estático ou 2 para Dinâmico.",
"minimum": 1,
"maximum": 2
}
}
}
}
},
"WebhookBaixaBoleto": {
"type": "object",
"description": "Representação dos campos enviados no Webhook de Baixa Operacional de um boleto bancário.",
"title": "Objeto de Webhook",
"properties": {
"id": {
"type": "string",
"description": "Nosso número - identificador do boleto, com 20 caracteres.",
"minLength": 20,
"maxLength": 20,
"pattern": "\\d",
"examples": [
"00031285570000104055"
]
},
"dataRegistro": {
"type": "string",
"title": "Data de registro original do boleto",
"description": "Data de registro original do boleto, com 10 caracteres e no formato 'dd.mm.aaaa'",
"minLength": 10,
"maxLength": 10,
"examples": [
"11.06.2025"
],
"pattern": "^([0-2][0-9]|(3)[0-1]).(0[1-9]|1[0-2]).\\d{4}$"
},
"dataVencimento": {
"type": "string",
"title": "Data de vencimento do boleto",
"description": "Data de vencimento do boleto, com 10 caracteres e no formato 'dd.mm.aaaa'",
"minLength": 10,
"maxLength": 10,
"examples": [
"11.06.2025"
],
"pattern": "^([0-2][0-9]|(3)[0-1]).(0[1-9]|1[0-2]).\\d{4}$"
},
"valorOriginal": {
"type": "number",
"format": "double",
"title": "Valor original do boleto",
"description": "Valor original do boleto registrado.
Utiliza o padrão americano para números (decimais separados por pontos), as casas dos milhares não são separadas por nenhum caracter e zeros à direita na casas decimais são ignorados.",
"examples": [
1000
]
},
"valorPagoSacado": {
"type": "number",
"format": "double",
"title": "Valor pago pelo boleto",
"description": "Valor pago pelo boleto (considerando evetuais acréscimos ou descontos).
Utiliza o padrão americano para números (decimais separados por pontos), as casas dos milhares não são separadas por nenhum caracter e zeros à direita na casas decimais são ignorados.",
"examples": [
1000
]
},
"numeroConvenio": {
"type": "integer",
"title": "Número do Convênio",
"description": "Número da carteira do convênio de cobrança firmado entre o beneficiário e o Banco do Brasil. Um beneficiário pode ter mais de um convênio.",
"format": "int32",
"examples": [
3128557
]
},
"numeroOperacao": {
"type": "integer",
"title": "Número da Operação",
"description": "Número da Operação de Cobrança",
"format": "int32",
"examples": [
10055680
]
},
"carteiraConvenio": {
"type": "integer",
"title": "Número da carteira de Cobrança.",
"description": "Determina as características do serviço de Cobrança e define como os boletos serão tratados pelo BB.",
"format": "int32",
"examples": [
17
]
},
"variacaoCarteiraConvenio": {
"type": "integer",
"title": "Código da variação do convênio",
"description": "Parâmetro de agrupamento de boletos dentro de uma mesma carteira.",
"format": "int32",
"examples": [
35
]
},
"codigoEstadoBaixaOperacional": {
"type": "integer",
"enum": [
1,
2,
10
],
"description": "Código para identificação da situação da Baixa Operacional.
Valores possíveis:
1 - Baixa Operacional emitida pelo BB
2 - Baixa Operacional emitida por outro Banco
10 - Cancelamento da Baixa Operacional",
"title": "Código de estado da Baixa Operacional",
"examples": [
1
],
"pattern": "\\d"
},
"dataLiquidacao": {
"type": "string",
"title": "Data e hora do movimento",
"description": "Data e hora do movimento (baixa operacional ou cancelamento), com 19 caracteres e no formato 'dd/mm/aaaa hh:mm:ss'",
"minLength": 19,
"maxLength": 19,
"examples": [
"12/06/2025 16:29:30"
],
"pattern": "^([0][1-9]|[1-2][0-9]|3[0-1])/(0[1-9]|1[0-2])/\\d{4} ([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$"
},
"instituicaoLiquidacao": {
"type": "integer",
"title": "Código da Instituição Recebedora",
"description": "Código Compe da Instituição Financeira, com três dígitos numéricos",
"format": "int32",
"examples": [
"001"
],
"pattern": "\\d{3}"
},
"canalLiquidacao": {
"type": "integer",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"description": "Código do canal onde a transação foi realizada.
Valores possíveis:
1 - Agências - Postos tradicionais
2 - Terminal de Auto-atendimento
3 - Internet (home/office banking)
4 - Pix
5 - Correspondente bancário
6 - Central de atendimento (Call Center)
7 - Arquivo eletrônico
8 - DDA
9 - Correspondente bancário digital",
"title": "Código do canal onde a transação foi realizada",
"examples": [
4
],
"pattern": "\\d{1}"
},
"codigoModalidadeBoleto": {
"type": "integer",
"enum": [
1,
4
],
"description": "É a categoria do serviço de cobrança que indica as particularidades, forma e modelo do serviço de cobrança contratado.
Valores possíveis:
1 - Simples
4 - Vinculada",
"title": "Código da modalidade do boleto",
"example": 1,
"pattern": "\\d"
},
"tipoPessoaPortador": {
"type": "integer",
"description": "Indica qual é o tipo de pessoa que efetuou o pagamento, com 1 dígito.
Valores possíveis:
1 - Pessoa Física
2 - Pessoa Jurídica",
"examples": [
2
],
"title": "Tipo de pessoa do portador",
"pattern": "^[12]$"
},
"identidadePortador": {
"type": "string",
"description": "Número do documento fiscal da pessoa que efetuou o pagamento. Retorna CPF para pessoas físicas e CNPJ para pessoas jurídicas. O campo \"tipoPessoaPortador\" indica qual o tipo de número do documento.",
"examples": [
"98959112000179"
],
"title": "Identificação do portador"
},
"nomePortador": {
"type": "string",
"description": "Nome da pessoa que efetuou o pagamento. Pode ser o nome de uma pessoa física ou jurídica.",
"examples": [
"CINE VENTURA DE PADUA"
],
"title": "Nome do portador"
},
"formaPagamento": {
"type": "integer",
"enum": [
1,
2,
3,
4
],
"description": "Forma de pagamento do título. Em conjunto com o campo 'canalLiquidacao', indica como o boleto foi liquidado.
Valores possíveis:
1 - Em espécie
2 - Débito em conta
3 - Cartão de Crédito
4 - Cheque",
"title": "Forma de pagamento",
"examples": [
2
],
"pattern": "\\d"
},
"dataCredito": {
"type": "string",
"title": "Data de crédito da liquidação",
"description": "Data para crédito da liquidação ao beneficiário, com 10 caracteres e no formato 'dd.mm.aaaa'.",
"minLength": 10,
"maxLength": 10,
"examples": [
"13.06.2025"
],
"pattern": "^([0-2][0-9]|(3)[0-1]).(0[1-9]|1[0-2]).\\d{4}$"
}
}
},
"RespostaDetalhamentoBoleto": {
"type": "object",
"description": "Representação dos campos de resposta de uma solicitação de detalhamento de boletos bancários.",
"title": "",
"properties": {
"codigoLinhaDigitavel": {
"type": "string",
"description": "Campo correpondente à linha digitável do boleto."
},
"textoEmailPagador": {
"type": "string",
"description": "E-mail do Pagador."
},
"textoMensagemBloquetoTitulo": {
"type": "string",
"description": "Mensagem para ser impressa no boleto."
},
"codigoTipoMulta": {
"type": "number",
"description": "Código para identificação do tipo de multa para o Título de Cobrança.
Domínios:
0 - Sem multa
1 - Valor da Multa
2 - Percentual da Multa.
"
},
"codigoCanalPagamento": {
"type": "number",
"description": "Código para identificação da forma de pagamento e do canal onde foi pago o boleto. Composto por 3 dígitos.
O primeiro dígito é:
1 Espécie
2 Débito em conta
3 Cartão de crédito
4 Cheque
Os dois últimos:
01 Agencias - Postos tradicionais
02 Terminal de Auto-atendimento
03 Internet (home / office banking)
05 Correspondente bancário
06 Central de atendimento(Call Center)
07 Arquivo Eletrônico
08 DDA
61 Pix"
},
"numeroContratoCobranca": {
"type": "number",
"description": "Código adotado pelo Banco para identificar o Contrato entre este e a Empresa Cliente."
},
"codigoTipoInscricaoSacado": {
"type": "number",
"description": "Código que identifica o tipo de documento do pagador registrado no boleto.
Domínios:
1 - CPF
2 - CNPJ"
},
"numeroInscricaoSacadoCobranca": {
"type": "string",
"description": "Número do CPF ou CNPJ do pagador registrado no boleto. O campo `codigoTipoInscricaoSacado` indica qual o tipo de número do documento."
},
"codigoEstadoTituloCobranca": {
"type": "number",
"description": "Código da situação atual do boleto.
Domínios:
1 - NORMAL
2 - MOVIMENTO CARTORIO
3 - EM CARTORIO
4 - TITULO COM OCORRENCIA DE CARTORIO
5 - PROTESTADO ELETRONICO
6 - LIQUIDADO
7 - BAIXADO
8 - TITULO COM PENDENCIA DE CARTORIO
9 - TITULO PROTESTADO MANUAL
10 - TITULO BAIXADO/PAGO EM CARTORIO
11 - TITULO LIQUIDADO/PROTESTADO
12 - TITULO LIQUID/PGCRTO
13 - TITULO PROTESTADO AGUARDANDO BAIXA
14 - TITULO EM LIQUIDACAO
15 - TITULO AGENDADO
16 - TITULO CREDITADO
17 - PAGO EM CHEQUE - AGUARD.LIQUIDACAO
18 - PAGO PARCIALMENTE
19 - PAGO PARCIALMENTE CREDITADO
21 - TITULO AGENDADO COMPE
80 - EM PROCESSAMENTO (ESTADO TRANSITÓRIO)"
},
"codigoTipoTituloCobranca": {
"type": "number",
"description": "Código para identificar o tipo de boleto de cobrança.
Domínios:
1\t- CHEQUE
2\t- DUPLICATA MERCANTIL
3\t- DUPLICATA MTIL POR INDICACAO
4\t- DUPLICATA DE SERVICO
5\t- DUPLICATA DE SRVC P/INDICACAO
6\t- DUPLICATA RURAL
7\t- LETRA DE CAMBIO
8\t- NOTA DE CREDITO COMERCIAL
9\t- NOTA DE CREDITO A EXPORTACAO
10\t- NOTA DE CREDITO INDULTRIAL
11\t- NOTA DE CREDITO RURAL
12\t- NOTA PROMISSORIA
13\t- NOTA PROMISSORIA RURAL
14\t- TRIPLICATA MERCANTIL
15\t- TRIPLICATA DE SERVICO
16\t- NOTA DE SEGURO
17\t- RECIBO
18\t- FATURA
19\t- NOTA DE DEBITO
20\t- APOLICE DE SEGURO
21\t- MENSALIDADE ESCOLAR
22\t- PARCELA DE CONSORCIO
23\t- DIVIDA ATIVA DA UNIAO
24\t- DIVIDA ATIVA DE ESTADO
25\t- DIVIDA ATIVA DE MUNICIPIO
31\t- CARTAO DE CREDITO
32 \t- BOLETO PROPOSTA
99\t- OUTROS"
},
"codigoModalidadeTitulo": {
"type": "number",
"description": "Código para identificar a característica dos boletos dentro das modalidades de cobrança existentes no BB.
Domínios:
1 - SIMPLES COM REGISTRO
2 - SIMPLES SEM REGISTRO
4 - VINCULADA
6 - DESCONTADA
8 - FINANCIADA VENDOR"
},
"codigoAceiteTituloCobranca": {
"type": "string",
"description": "Código para identificar se o boleto de cobrança foi aceito (reconhecimento da dívida pelo Pagador).
Domínios:
A - ACEITE
N - NAO ACEITE"
},
"codigoPrefixoDependenciaCobrador": {
"type": "number",
"description": "Código agência da praça do pagador (endereço)."
},
"codigoIndicadorEconomico": {
"type": "number",
"description": "Código para identificar a moeda referenciada no boleto.
Domínios:
0\t- NENHUM
1\t- FAJTR
2\t- DOLAR
3\t- EURO
4\t- IENE
5\t- MARCO ALEMAO
6\t- FTR
7\t- IDTR
8\t- UFIR
9\t- REAL
10\t- SELIC
11\t- IGP-M
12\t- INPC
13\t- TR (BESC)"
},
"numeroTituloCedenteCobranca": {
"type": "string",
"description": "Campo destinado para uso da Empresa Beneficiário para identificação do boleto. Equivalente ao SEU NÚMERO ou ao numeroTituloBeneficiario do request do registro"
},
"codigoTipoJuroMora": {
"type": "number",
"description": "Código utilizado pela FEBRABAN para identificar o tipo de taxa de juros.
Domínios:
0 - DISPENSAR
1 - VALOR DIA ATRASO
2 - TAXA MENSAL
3 - ISENTO"
},
"dataEmissaoTituloCobranca": {
"type": "string",
"description": "Data de emissão do boleto."
},
"dataRegistroTituloCobranca": {
"type": "string",
"description": "Data de registro do boleto."
},
"dataVencimentoTituloCobranca": {
"type": "string",
"description": "Data de vencimento do boleto."
},
"valorOriginalTituloCobranca": {
"type": "number",
"description": "Valor original do boleto indicado quando do registro.",
"format": "float"
},
"valorAtualTituloCobranca": {
"type": "number",
"description": "Valor atualizado do boleto, considerando possíveis abatimento e pagamento parcial, que incidem sob o valor original",
"format": "float"
},
"valorPagamentoParcialTitulo": {
"type": "number",
"description": "Valores já recebidos em pagamentos parciais.",
"format": "float"
},
"valorAbatimentoTituloCobranca": {
"type": "number",
"description": "Valor do abatimento (redução do valor do documento, devido a algum problema), expresso em moeda corrente.",
"format": "float"
},
"percentualImpostoSobreOprFinanceirasTituloCobranca": {
"type": "number",
"description": "Percentual do IOF - Imposto sobre Operações Financeiras - de um boleto prêmio de seguro na sua data de emissão, expresso de acordo com o tipo de moeda.",
"format": "float"
},
"valorImpostoSobreOprFinanceirasTituloCobranca": {
"type": "number",
"description": "Valor do IOF - Imposto sobre Operações Financeiras - de um boleto prêmio de seguro na sua data de emissão, expresso de acordo com o tipo de moeda.",
"format": "float"
},
"valorMoedaTituloCobranca": {
"type": "number",
"description": "Valor do boleto expresso em moeda variável.",
"format": "float"
},
"percentualJuroMoraTitulo": {
"type": "number",
"description": "Porcentagem sobre o valor do boleto a ser cobrada de juros de mora."
},
"valorJuroMoraTitulo": {
"type": "number",
"description": "Valor sobre o valor do boleto a ser cobrado de juros de mora.",
"format": "float"
},
"percentualMultaTitulo": {
"type": "number",
"description": "Porcentagem sobre o valor do boleto a ser cobrada de multa.",
"format": "float"
},
"valorMultaTituloCobranca": {
"type": "number",
"description": "Valor sobre o valor do boleto a ser cobrado de multa.",
"format": "float"
},
"quantidadeParcelaTituloCobranca": {
"type": "number",
"description": "Quantidade de parcela do boleto."
},
"dataBaixaAutomaticoTitulo": {
"type": "string",
"description": "Data da baixa automática do boleto, conforme cadastrado no convênio."
},
"textoCampoUtilizacaoCedente": {
"type": "string",
"description": "Texto de observações destinado ao envio de mensagens livres, a serem impressas no campo de instruções da ficha de compensação do Boleto de Pagamento."
},
"indicadorCobrancaPartilhadoTitulo": {
"type": "string",
"description": "Código para identificação de Rateio de Crédito (partilhamento).
Domínios:
S - SIM
N - NÃO"
},
"nomeSacadoCobranca": {
"type": "string",
"description": "Nome que identifica a pessoa, física ou jurídica, a qual se quer fazer referência."
},
"textoEnderecoSacadoCobranca": {
"type": "string",
"description": "Texto referente a localização da rua/avenida, número, complemento para entrega de correspondência."
},
"nomeBairroSacadoCobranca": {
"type": "string",
"description": "Texto referente ao bairro para entrega de correspondência."
},
"nomeMunicipioSacadoCobranca": {
"type": "string",
"description": "Texto referente ao nome do município componente do endereço utilizado para entrega de correspondência."
},
"siglaUnidadeFederacaoSacadoCobranca": {
"type": "string",
"description": "Código do estado, unidade da federação componente do endereço utilizado para entrega de correspondência."
},
"numeroCepSacadoCobranca": {
"type": "number",
"description": "Código adotado pelos Correios, para identificação de logradouros."
},
"valorMoedaAbatimentoTitulo": {
"type": "number",
"description": "Valor da moeda do abatimento.",
"format": "float"
},
"dataProtestoTituloCobranca": {
"type": "string",
"description": "Data para inicialização do processo de cobrança via protesto."
},
"codigoTipoInscricaoSacador": {
"type": "number",
"description": "Código que identifica o tipo de documento do Beneficiário original do boleto de cobrança.
Domínios:
1 - CPF
2 - CNPJ"
},
"numeroInscricaoSacadorAvalista": {
"type": "string",
"description": "Número do CPF ou CNPJ do Beneficiário final do boleto de cobrança."
},
"nomeSacadorAvalistaTitulo": {
"type": "string",
"description": "Nome que identifica a entidade, pessoa física ou jurídica, Beneficiário final do boleto de cobrança."
},
"percentualDescontoTitulo": {
"type": "number",
"description": "Percentual de desconto a ser concedido sobre o boleto de cobrança.",
"format": "float"
},
"dataDescontoTitulo": {
"type": "string",
"description": "Data limite do desconto do boleto de cobrança."
},
"valorDescontoTitulo": {
"type": "number",
"description": "Valor de desconto a ser concedido sobre o boleto de cobrança.",
"format": "float"
},
"codigoDescontoTitulo": {
"type": "number",
"description": "Código para identificação do tipo de desconto que deverá ser concedido.
Domínios:
0 - SEM DESCONTO
1 - VLR FIXO ATE A DATA INFORMADA
2 - PERCENTUAL ATE A DATA INFORMADA
3 - DESCONTO POR DIA DE ANTECIPACAO"
},
"percentualSegundoDescontoTitulo": {
"type": "number",
"description": "Percentual do segundo desconto a ser concedido sobre o boleto de cobrança.",
"format": "float"
},
"dataSegundoDescontoTitulo": {
"type": "string",
"description": "Data limite do segundo desconto do boleto de cobrança."
},
"valorSegundoDescontoTitulo": {
"type": "number",
"description": "Valor do segundo desconto a ser concedido sobre o boleto de cobrança.",
"format": "float"
},
"codigoSegundoDescontoTitulo": {
"type": "number",
"description": "Código para identificação do tipo do segundo desconto que deverá ser concedido.
Domínios:
0 - SEM DESCONTO
1 - VLR FIXO ATE A DATA INFORMADA
2 - PERCENTUAL ATE A DATA INFORMADA
3 - DESCONTO POR DIA DE ANTECIPACAO"
},
"percentualTerceiroDescontoTitulo": {
"type": "number",
"description": "Percentual do terceiro desconto a ser concedido sobre o boleto de cobrança.",
"format": "float"
},
"dataTerceiroDescontoTitulo": {
"type": "string",
"description": "Data limite do terceiro desconto do boleto de cobrança."
},
"valorTerceiroDescontoTitulo": {
"type": "number",
"description": "Valor do terceiro desconto a ser concedido sobre o boleto de cobrança.",
"format": "float"
},
"codigoTerceiroDescontoTitulo": {
"type": "number",
"description": "Código para identificação do tipo do terceiro desconto que deverá ser concedido.
Domínios:
0 - SEM DESCONTO
1 - VLR FIXO ATE A DATA INFORMADA
2 - PERCENTUAL ATE A DATA INFORMADA
3 - DESCONTO POR DIA DE ANTECIPACAO"
},
"dataMultaTitulo": {
"type": "string",
"description": "Data para início da cobrança da multa."
},
"numeroCarteiraCobranca": {
"type": "number",
"description": "Número da carteira do convênio de cobrança."
},
"numeroVariacaoCarteiraCobranca": {
"type": "number",
"description": "Número da variação da carteira do convênio de cobrança."
},
"quantidadeDiaProtesto": {
"type": "number",
"description": "Número de dias decorrentes após a data de vencimento para inicialização do processo de cobrança via protesto."
},
"quantidadeDiaPrazoLimiteRecebimento": {
"type": "number",
"description": "Número de dias corridos para recebimento do boleto após a data de vencimento."
},
"dataLimiteRecebimentoTitulo": {
"type": "string",
"description": "Data limite para recebimento do boleto após a data de vencimento."
},
"indicadorPermissaoRecebimentoParcial": {
"type": "string",
"description": "Código para identificação da autorização de pagamento parcial do boleto.
Domínios:
S - SIM
N - NAO"
},
"textoCodigoBarrasTituloCobranca": {
"type": "string",
"description": "Código de barras do boleto."
},
"codigoOcorrenciaCartorio": {
"type": "number",
"description": "Código para identificação das ocorrências de retorno do cartório.
Domínios:
0\t- TITULO PROTOCOLADO - ANTIGO \"TEC\"
1\t- TITULO PAGO EM CARTORIO
2\t- TITULO PROTESTADO - ANTIGO \"DDP\"
3\t- TITULO RETIRADO CARTORIO - ANT. DDS
4\t- TITULO SUSTADO JUDICIALMENTE
5\t- TITULO RECUSADO SEM CUSTAS
6\t- TITULO RECUSADO COM CUSTAS
7\t- TITULO PAGO LIQUIDACAO CONDICIONAL
8\t- TITULO ACEITO
9\t- CUSTAS DE EDITAL
20\t- LQ. CARTORIO AG. SEMI-AUTOM.
21\t- CHQ DEVOLV. TIT. ENC. PROT.
22\t- TITULO SUSTADO DEFINITIVO
23\t- RETIRADA APÓS SUSTAÇÃO JUDICIAL
59\t- PAGTO CONDICIONAL VIA SELTEC
60\t- TITULO PAGO EM CARTORIO-SELTEC"
},
"valorImpostoSobreOprFinanceirasRecebidoTitulo": {
"type": "number",
"description": "Valor do IOF recebido.",
"format": "float"
},
"valorAbatimentoTotal": {
"type": "number",
"description": "Valor do abatimento concedido.",
"format": "float"
},
"valorJuroMoraRecebido": {
"type": "number",
"description": "Valor dos juros recebidos.",
"format": "float"
},
"valorDescontoUtilizado": {
"type": "number",
"description": "Valor de desconto utilizado pelo pagador.",
"format": "float"
},
"valorPagoSacado": {
"type": "number",
"description": "Valor pago.",
"format": "float"
},
"valorCreditoCedente": {
"type": "number",
"description": "Valor líquido creditado ao beneficiário.",
"format": "float"
},
"codigoTipoLiquidacao": {
"type": "number",
"description": "Código para identificação do tipo de liquidação.
Domínios:
1\tCAIXA
2\tVIA COMPE
3\tEM CARTORIO
4\tPix
5\tTITULO EM LIQUIDACAO - ORIGEM AGE
6\tTITULO EM LIQUIDACAO - PGT
7\tBANCO POSTAL
8\tTITULO LIQUIDADO VIA COMPE/STR"
},
"dataCreditoLiquidacao": {
"type": "string",
"description": "Data a qual será creditado o valor inerente ao título (este campo só será preenchido após a liquidação, ou seja, após codigoEstadoTituloCobranca = 6)."
},
"dataRecebimentoTitulo": {
"type": "string",
"description": "Data para a qual foi agendado o recebimento/pagamento do título."
},
"codigoPrefixoDependenciaRecebedor": {
"type": "number",
"description": "Código agência da praça do recebimento do boleto."
},
"codigoNaturezaRecebimento": {
"type": "number",
"description": "Código para identificar as ocorrências (rejeições, tarifas, custas, liquidação e baixas) do boleto.\n\nDomínios:\n\n1 - NORMAL\n2 - POR CONTA\n3 - POR SALDO\n4 - CHEQUE A COMPENSAR\n7 - LIQUIDADO NA APRESENTACAO\n8 - POR CONTA EM CARTORIO\n9 - EM CARTORIO"
},
"numeroIdentidadeSacadoTituloCobranca": {
"type": "string",
"description": "Número de identidade do pagador do título."
},
"codigoResponsavelAtualizacao": {
"type": "string",
"description": "Código para identificação do sistema/usuário responsável pela atualização do boleto."
},
"codigoTipoBaixaTitulo": {
"type": "number",
"description": "Código para identificação do tipo de baixa do boleto.
Domínios:
1\t- BAIXADO POR SOLICITACAO
2\t- ENTREGA FRANCO PAGAMENTO
9\t- COMANDADA BANCO
10\t- COMANDADA CLIENTE - ARQUIVO
11\t- COMANDADA CLIENTE - ON-LINE
12\t- DECURSO PRAZO - CLIENTE
13\t- DECURSO PRAZO - BANCO
15\t- PROTESTADO
31\t- LIQUIDADO ANTERIORMENTE
32\t- HABILITADO EM PROCESSO
35\t- TRANSFERIDO PARA PERDAS
51\t- REGISTRADO INDEVIDAMENTE
90\t- BAIXA AUTOMATICA"
},
"valorMultaRecebido": {
"type": "number",
"description": "Valor de multa recebido.",
"format": "float"
},
"valorReajuste": {
"type": "number",
"description": "Valor do reajuste (índice econômico).",
"format": "float"
},
"valorOutroRecebido": {
"type": "number",
"description": "Outros valores recebidos.",
"format": "float"
},
"codigoIndicadorEconomicoUtilizadoInadimplencia": {
"type": "number",
"description": "Código do índice econômico utilizado para o cálculo de juros/multa.",
"format": "float"
}
}
},
"RespostaListaBoletos": {
"type": "object",
"description": "Objeto de Resposta do recurso GET Lista Boletos",
"properties": {
"indicadorContinuidade": {
"type": "string",
"description": "Indicador de que a consulta resultou em uma quantidade superior a 300 boletos (capacidade de resposta por requisição do serviço). Uma nova requisição, nos mesmos moldes, deve ser feita para consultar o restante dos boletos. Para tanto, deverá ser utilizado o valor informado no atributo \"Número Último Registro\" como valor inicial da próxima consulta.",
"example": "s"
},
"quantidadeRegistros": {
"type": "integer",
"description": "Quantidade de boletos que atendem os critérios da requisição. ",
"format": "int32",
"example": 300
},
"proximoIndice": {
"type": "integer",
"description": "Número do último registro apresentado pela lista, que poderá ser utilizado como parâmetro inicial de uma nova requisição para consultar os boletos restantes.",
"format": "int32",
"example": 300
},
"boletos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"numeroBoletoBB": {
"type": "string",
"description": "Número de identificação do boleto (correspondente ao NOSSO NÚMERO), no formato STRING, com 20 dígitos. Corresponde aos campos numeroTituloCliente (requisição do registro do boleto), numero (resposta do registro) e id (detalhamento do boleto).",
"example": "00024589070000000412"
},
"estadoTituloCobranca": {
"type": "string",
"description": "Texto da situação atual do boleto.\n\nPossíveis valores de retorno:\n- NORMAL \n- MOVIMENTO CARTORIO\n- EM CARTORIO\n- TITULO COM OCORRENCIA DE CARTORIO\n- PROTESTADO ELETRONICO \n- LIQUIDADO \n- BAIXADO \n- TITULO COM PENDENCIA DE CARTORIO \n- TITULO PROTESTADO MANUAL",
"example": "Mvto. Cartorio"
},
"dataRegistro": {
"type": "string",
"description": "Data de registro do boleto.\n",
"example": "01.05.2020"
},
"dataVencimento": {
"type": "string",
"description": "Data de vencimento do boleto\n",
"example": "01.05.2020"
},
"dataMovimento": {
"type": "string",
"description": "Data do evento que baixou, protestou ou liquidou o boleto.
No caso de títulos vigentes (campo `indicadorSituacao` = A), mesmo que o boleto esteja vencido, o campo fica vazio.",
"examples": [
"01.05.2020",
"30.12.2023"
]
},
"valorOriginal": {
"type": "number",
"description": "Valor do boleto no registro.\n",
"format": "float",
"example": 1000
},
"valorAtual": {
"type": "number",
"description": "Valor atualizado do boleto.\n",
"format": "float",
"example": 10000
},
"valorPago": {
"type": "number",
"description": "Valor pago pelo pagador/sacado.\n",
"format": "float",
"example": 9000
},
"contrato": {
"type": "integer",
"description": "Código do contrato entre o Banco do Brasil e a empresa cliente.",
"format": "int32",
"example": 0
},
"carteiraConvenio": {
"type": "integer",
"description": "Número da carteira do convênio de cobrança.\n",
"format": "int32",
"example": 17
},
"variacaoCarteiraConvenio": {
"type": "integer",
"description": "Número da variação da carteira do convênio de cobrança.",
"format": "int32",
"example": 27
},
"codigoEstadoTituloCobranca": {
"type": "integer",
"description": "Código da situação atual do boleto:\n\nDomínios:\n01 - NORMAL \n02 - MOVIMENTO CARTORIO\n03 - EM CARTORIO\n04 - TITULO COM OCORRENCIA DE CARTORIO\n05 - PROTESTADO ELETRONICO \n06 - LIQUIDADO \n07 - BAIXADO \n08 - TITULO COM PENDENCIA DE CARTORIO \n09 - TITULO PROTESTADO MANUAL",
"format": "int32",
"example": 1
},
"dataCredito": {
"type": "string",
"description": "Data do crédito dos valores ao beneficiário",
"example": "01.05.2020"
}
}
}
}
}
},
"RespostaRegistroBoletos": {
"type": "object",
"description": "Representação dos campos de resposta de uma solicitação de criação de boletos bancários.",
"properties": {
"numero": {
"type": "string",
"description": "Identificador exclusivo do boleto."
},
"numeroCarteira": {
"type": "number",
"description": "Número da carteira do convênio de cobrança"
},
"numeroVariacaoCarteira": {
"type": "number",
"description": "Número da variação da carteira do convênio de cobrança"
},
"codigoCliente": {
"type": "number",
"description": "Identificação do cliente."
},
"linhaDigitavel": {
"type": "string",
"description": "Linha digitável do boleto."
},
"codigoBarraNumerico": {
"type": "string",
"description": "Define o código de barras numérico do boleto."
},
"numeroContratoCobranca": {
"type": "number",
"description": "Define o número do contrato de cobrança do boleto."
},
"beneficiario": {
"type": "object",
"properties": {
"agencia": {
"type": "number",
"description": "Agência do beneficiário."
},
"contaCorrente": {
"type": "number",
"description": "Número da conta corrente do beneficiário."
},
"tipoEndereco": {
"type": "number",
"description": "Código do tipo de endereço do beneficiário."
},
"logradouro": {
"type": "string",
"description": "Nome do logradouro do beneficiário."
},
"bairro": {
"type": "string",
"description": "Bairro do Beneficiário."
},
"cidade": {
"type": "string",
"description": "Cidade do Beneficiário."
},
"codigoCidade": {
"type": "number",
"description": "Identificador da cidade do beneficiário."
},
"uf": {
"type": "string",
"description": "Sigla do Estado do beneficiário."
},
"cep": {
"type": "number",
"description": "Código Postal do Beneficiário."
},
"indicadorComprovacao": {
"type": "string",
"description": "Indicador de prova de vida do beneficiário."
}
}
},
"qrCode": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "URL do payload do QR Code Pix "
},
"txId": {
"type": "string",
"description": "Codigo que identifica a transação Pix - transactionID"
},
"emv": {
"type": "string",
"description": "BR Code no padrão EMV. Sequência de caracteres correspondente ao payload do QR Code Pix."
}
}
},
"urlImagemBoleto": {
"type": "string",
"description": "Link para emissão da segunda via do boleto."
},
"observacao": {
"type": "string",
"description": "O boleto foi registrado mas sem um ou mais dois itens abaixo.\n - Não envio por email.\n - Não vinculou o Pix.\n - Não vinculou a recorrência."
}
}
},
"RespostaBoletosBaixaOperacional": {
"required": [
"lista"
],
"type": "object",
"properties": {
"possuiMaisTitulos": {
"type": "string",
"enum": [
"S",
"N"
],
"example": "S",
"minLength": 1,
"maxLength": 1,
"description": "Indicador de que a consulta resultou em uma quantidade superior a 650 boletos (capacidade de resposta por requisição ao serviço).\n\nSe indicador igual a \"S\", uma nova requisição, nos mesmos moldes, poderá ser feita para consultar o restante dos boletos. Nesse caso, na próxima consulta, o valor do campo \"proximoTitulo\" deverá ser informado no campo \"idProximoTitulo\"."
},
"proximoTitulo": {
"type": "string",
"minLength": 20,
"maxLength": 20,
"description": "Número do último registro apresentado pela lista, que poderá ser utilizado como parâmetro inicial de uma nova requisição para consultar os boletos restantes.",
"example": "00012345670000000001"
},
"lista": {
"type": "array",
"description": "Lista de registros que atendam a consulta.",
"minItems": 0,
"maxItems": 650,
"items": {
"type": "object",
"description": "Objeto da lista com as informações de um título.",
"properties": {
"carteira": {
"description": "Número da carteira do convênio de cobrança.",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 9999,
"example": 17
},
"variacao": {
"description": "Número da variação da carteira do convênio de cobrança.",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 9999,
"example": 19
},
"convenio": {
"description": "Número do convênio de Cobrança do Cliente.",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 999999999
},
"titulo": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 20,
"maxLength": 20,
"description": "Número de identificação do boleto (correspondente ao NOSSO NÚMERO, numeroTituloCliente), cujo conteúdo é composto de: \"000\" + (número do convênio com 7 dígitos) + (10 algarismos - se necessário, completar com zeros à esquerda).",
"example": "00012345670000000001"
},
"estadoBaixaOperacional": {
"description": "Código para identificar o estado da baixa operacional.\n\nDomínio:\n1 - BAIXA OPERACIONAL BB\n2 - BAIXA OPERACIONAL OUTROS BANCOS\n10- CANCELAMENTO DE BAIXA OPERACIONAL",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 10
},
"modalidade": {
"description": "Código para identificar a característica dos boletos dentro das modalidades de cobrança existentes no banco.\n\nDomínio:\n1 - SIMPLES\n4 - VINCULADA",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 4
},
"dataRegistro": {
"description": "Data a qual foi efetuado o registro do boleto na CIP.",
"type": "string",
"minLength": 10,
"maxLength": 10,
"example": "2021-05-23"
},
"dataVencimento": {
"description": "Data de vencimento do boleto.",
"type": "string",
"minLength": 10,
"maxLength": 10,
"example": "2021-05-23"
},
"valorOriginal": {
"type": "number",
"description": "Valor original do boleto indicado quando do registro.",
"format": "double"
},
"agendamentoPagamento": {
"type": "object",
"description": "Informações referentes ao agendamento de pagamento do título.",
"properties": {
"momento": {
"description": "Data e hora no qual foi agendado o recebimento/pagamento do título. Atenção! Trata-se apenas de uma promessa de pagamento que poderá ser cancelada ou não efetivada.",
"type": "string",
"minLength": 26,
"maxLength": 26,
"example": "2021-05-14 09:00:40 "
},
"instituicaoFinanceira": {
"description": "Código de compensação bancária do SFN. Domínio: https://www.bcb.gov.br/Fis/CODCOMPE/Tabela.pdf",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 9999,
"example": 1
},
"canal": {
"type": "integer",
"description": "Código para identificação da forma de pagamento e do canal onde foi pago o boleto.\n\nDomínio:\n1 - Agencias - Postos tradicionais\n2 - Terminal de Auto-atendimento\n3 - Internet (home / office banking)\n4 - Pix\n5 - Correspondente bancário\n6 - Central de atendimento(Call Center)\n7 - Arquivo Eletrônico\n8 - DDA\n9 - Correspondente bancário digital",
"format": "int32",
"minimum": 1,
"maximum": 9
},
"valorCIP": {
"type": "number",
"description": "Valor do pagamento agendado na Câmara Interbancária de Pagamentos - CIP, conforme informado na baixa operacional.",
"format": "double"
}
}
}
}
}
}
}
}
}
},
"abatimento": {
"title": "abatimento",
"type": "object",
"properties": {
"valorAbatimento": {
"type": "number",
"description": "Valor do abatimento (reduz valor do boleto) expresso em moeda corrente.",
"format": "double"
}
},
"description": "Inclusão de Abatimento em Boleto Bancário"
},
"alteracaoAbatimento": {
"title": "alteracaoAbatimento",
"type": "object",
"properties": {
"novoValorAbatimento": {
"type": "number",
"description": "Novo valor do abatimento (reduz valor do boleto) expresso em moeda corrente.",
"format": "double"
}
},
"description": "Alterar valor do abatimento concedido em um Boleto Bancário"
},
"alteracaoData": {
"title": "alteracaoData",
"type": "object",
"properties": {
"novaDataVencimento": {
"type": "string",
"description": "Nova data de vencimento do boleto."
}
},
"description": "Alteração de data de vencimento do boleto."
},
"AlterarValorNominal": {
"title": "AlterarValorNominal",
"type": "object",
"properties": {
"novoValorNominal": {
"type": "number",
"description": "Novo valor nominal do boleto.",
"format": "double"
}
},
"description": "Alteração do valor nominal do boleto."
},
"alteracaoDataDesconto": {
"title": "alteracaoDataDesconto",
"type": "object",
"properties": {
"novaDataLimitePrimeiroDesconto": {
"type": "string",
"description": "Nova data limite do Primeiro Desconto"
},
"novaDataLimiteSegundoDesconto": {
"type": "string",
"description": "Nova data limite do Segundo Desconto\n"
},
"novaDataLimiteTerceiroDesconto": {
"type": "string",
"description": "Nova data limite do Terceiro Desconto"
}
},
"description": "Alteração das datas limites para concessão de desconto no Boleto Bancário"
},
"alteracaoDesconto": {
"title": "alteracaoDesconto",
"type": "object",
"properties": {
"tipoPrimeiroDesconto": {
"type": "integer",
"description": "Código para identificação do tipo de desconto que deverá ser concedido como Primeiro Desconto. Valores a informar:\n0 - Sem desconto\n1 - Valor fixo até a data\n2 - Percentual até a data informada\n3 - Desconto por dia de antecipação",
"format": "int32"
},
"novoValorPrimeiroDesconto": {
"type": "number",
"description": "Novo valor do Primeiro Desconto",
"format": "double"
},
"novoPercentualPrimeiroDesconto": {
"type": "number",
"description": "Novo percentual de desconto sobre o valor do boleto no Primeiro Desconto",
"format": "double"
},
"novaDataLimitePrimeiroDesconto": {
"type": "string",
"description": "Nova data limite do Primeiro Desconto"
},
"tipoSegundoDesconto": {
"type": "integer",
"description": "Código para identificação do tipo de desconto que deverá ser concedido como Segundo Desconto. Valores a informar:\n0 - Sem desconto\n1 - Valor fixo até a data\n2 - Percentual até a data informada\n3 - Desconto por dia de antecipação",
"format": "int32"
},
"novoValorSegundoDesconto": {
"type": "number",
"description": "Novo valor do Segundo Desconto\n",
"format": "double"
},
"novoPercentualSegundoDesconto": {
"type": "number",
"description": "Novo percentual de desconto sobre o valor do boleto no Segundo Desconto",
"format": "double"
},
"novaDataLimiteSegundoDesconto": {
"type": "string",
"description": "Nova data limite do Segundo Desconto"
},
"tipoTerceiroDesconto": {
"type": "integer",
"description": "Código para identificação do tipo de desconto que deverá ser concedido como Terceiro Desconto. Valores a informar:\n0 - Sem desconto\n1 - Valor fixo até a data\n2 - Percentual até a data informada\n3 - Desconto por dia de antecipação",
"format": "int32"
},
"novoValorTerceiroDesconto": {
"type": "number",
"description": "Novo valor do Terceiro Desconto",
"format": "double"
},
"novoPercentualTerceiroDesconto": {
"type": "number",
"description": "Novo percentual de desconto sobre o valor do boleto no Terceiro Desconto",
"format": "double"
},
"novaDataLimiteTerceiroDesconto": {
"type": "string",
"description": "Nova data limite do Terceiro Desconto"
}
},
"description": "Alteração de desconto em Boletos Bancários"
},
"alteracaoEndereco": {
"title": "alteracaoEndereco",
"type": "object",
"properties": {
"enderecoPagador": {
"type": "string",
"description": "Endereço do Pagador"
},
"bairroPagador": {
"type": "string",
"description": "Bairro do Pagador"
},
"cidadePagador": {
"type": "string",
"description": "Cidade do Pagador"
},
"UFPagador": {
"type": "string",
"description": "UF do Pagador"
},
"CEPPagador": {
"type": "integer",
"description": "CEP do Pagador",
"format": "int32"
}
},
"description": "Alteração de dados do Endereço do Pagador em Boleto bancário"
},
"alteracaoSeuNumero": {
"title": "alteracaoSeuNumero",
"type": "object",
"properties": {
"codigoSeuNumero": {
"type": "string",
"description": "Número adotado e controlado pelo Cliente, para identificar o título de cobrança."
}
},
"description": "Alteração de Seu Número em Boleto Bancário"
},
"alteracaoPrazo": {
"title": "alteracaoPrazo",
"type": "object",
"properties": {
"quantidadeDiasAceite": {
"type": "integer",
"description": "Quantidade máxima de dias corridos para recebimento do boleto após a data de vencimento",
"format": "int32"
}
},
"description": "Alteração de prazo limite de aceite após vencimento de Boleto Bancário"
},
"desconto": {
"title": "desconto",
"type": "object",
"properties": {
"tipoPrimeiroDesconto": {
"type": "integer",
"description": "Código para identificação do tipo de desconto que deverá ser concedido como Primeiro Desconto. Valores a informar:\n0 - Sem desconto\n1 - Valor fixo até a data\n2 - Percentual até a data informada\n3 - Desconto por dia de antecipação",
"format": "int32"
},
"valorPrimeiroDesconto": {
"type": "number",
"description": "Valor do Primeiro Desconto\n",
"format": "double"
},
"percentualPrimeiroDesconto": {
"type": "number",
"description": "Percentual de desconto sobre o valor do boleto no Primeiro Desconto\n",
"format": "double"
},
"dataPrimeiroDesconto": {
"type": "string",
"description": "Data limite do Primeiro Desconto\n"
},
"tipoSegundoDesconto": {
"type": "integer",
"description": "Código para identificação do tipo de desconto que deverá ser concedido como Segundo Desconto. Valores a informar:\n0 - Sem desconto\n1 - Valor fixo até a data\n2 - Percentual até a data informada\n3 - Desconto por dia de antecipação",
"format": "int32"
},
"valorSegundoDesconto": {
"type": "number",
"description": "Valor do Segundo Desconto\n",
"format": "double"
},
"percentualSegundoDesconto": {
"type": "number",
"description": "Percentual de desconto sobre o valor do boleto no Segundo Desconto\n",
"format": "double"
},
"dataSegundoDesconto": {
"type": "string",
"description": "Data limite do Segundo Desconto\n"
},
"tipoTerceiroDesconto": {
"type": "integer",
"description": "Código para identificação do tipo de desconto que deverá ser concedido como Terceiro Desconto. Valores a informar:\n0 - Sem desconto\n1 - Valor fixo até a data\n2 - Percentual até a data informada\n3 - Desconto por dia de antecipação",
"format": "int32"
},
"valorTerceiroDesconto": {
"type": "number",
"description": "Valor do Terceiro Desconto\n",
"format": "double"
},
"percentualTerceiroDesconto": {
"type": "number",
"description": "Percentual de desconto sobre o valor do boleto no Terceiro Desconto\n",
"format": "double"
},
"dataTerceiroDesconto": {
"type": "string",
"description": "Data limite do Terceiro Desconto\n"
}
},
"description": "Inclusão de desconto em Boleto Bancário"
},
"protesto": {
"title": "protesto",
"type": "object",
"properties": {
"quantidadeDiasProtesto": {
"type": "number",
"description": "Quantos dias após a data de vencimento do boleto para iniciar o processo de cobrança através de protesto. (valor inteiro >= 0).",
"format": "int32"
}
},
"description": "Inclusão de Protesto em Boleto Bancário"
},
"juros": {
"title": "juros",
"type": "object",
"properties": {
"tipoJuros": {
"type": "integer",
"description": "Valor do Juros de Mora a ser aplicado sobre o valor do Boleto",
"format": "int32"
},
"valorJuros": {
"type": "number",
"description": "Taxa do Juros de Mora a ser aplicado sobre o valor do Boleto",
"format": "double"
},
"taxaJuros": {
"type": "number",
"description": "Código para identificação do tipo de Juros de Mora que deverá ser aplicado ao Boleto. Valores a informar:\n0 - Dispensar\n1 - Valor por dia de atraso\n2 - Taxa Mensal\n3 - Isento",
"format": "double"
}
},
"description": "Inclusão de Juros de Mora em Boleto Bancário"
},
"multa": {
"title": "multa",
"type": "object",
"properties": {
"tipoMulta": {
"type": "integer",
"description": "Porcentagem sobre o valor do boleto a ser cobrada de multa",
"format": "int32"
},
"valorMulta": {
"type": "number",
"description": "Data para início da cobrança da multa",
"format": "float"
},
"dataInicioMulta": {
"type": "string",
"description": "Código para identificação do tipo de multa"
},
"taxaMulta": {
"type": "number",
"description": "Valor sobre o valor do boleto a ser cobrado de multa",
"format": "float"
}
},
"description": "Inclusão de multa em Boleto Bancário"
},
"negativacao": {
"title": "negativacao",
"type": "object",
"properties": {
"quantidadeDiasNegativacao": {
"type": "integer",
"description": "Quantidade de dias, após o vencimento do Boleto, que o Boleto será Negativado",
"format": "int32"
},
"tipoNegativacao": {
"type": "integer",
"description": "Código para identificação do tipo de Negativação que deverá ser aplicado ao Boleto. Valores a informar:\n1 - Incluir Negativação\n2 - Alterar Negativação\n3 - Cancelar Negativação\n4 - Excluir Negativação",
"format": "int32"
},
"orgaoNegativador": {
"type": "integer",
"description": "Código do Órgão Negativador.\n\nDomínio:\n10 - SERASA \n11 - QUOD.",
"format": "int32"
}
},
"description": "Inclui condições de Negativação de Boleto Bancário"
},
"Erro": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Código e versão do erro.",
"example": "4874915.1"
},
"message": {
"type": "string",
"description": "Mensagem de erro em português, indicando qual foi a falha. Respostas HTTP do tipo 4XX são falhas de requisição de quem está acionando o recurso. Respostas HTTP do tipo 5XX são erros internos no BB.",
"example": "Nosso Número já incluído anteriormente."
},
"action": {
"type": "string",
"description": "Aqui você verá o que você deve fazer para que o erro seja corrigido.",
"example": "Informar outro Nosso Número."
}
}
}
}
},
"description": "Representação de um objeto de erro."
},
"ErroOAuthNaoAutorizado": {
"type": "object",
"properties": {
"statusCode": {
"type": "number",
"description": "Código do estado do erro."
},
"error": {
"type": "string",
"description": "Tipo do erro."
},
"message": {
"type": "string",
"description": "Mensagem do erro."
},
"attributes": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Mensagem do erro."
}
},
"description": "Atributos do erro."
}
},
"description": "Representação de um objeto de erro do OAuth 2.0."
},
"Erro-v2": {
"title": "Erro-v2",
"type": "object",
"properties": {
"erros": {
"type": "array",
"items": {
"type": "object",
"properties": {
"codigoMensagem": {
"type": "string",
"description": "Código interno da mensagem de erro, com 7 dígitos.",
"example": "4874915"
},
"versaoMensagem": {
"type": "string",
"description": "Versão da mensagem. Informação interna, para auxiliar na resolução de falhas.",
"example": 1,
"default": 1
},
"textoMensagem": {
"type": "string",
"description": "Mensagem de erro em português, indicando qual foi a falha. Respostas HTTP do tipo 4XX são falhas de requisição de quem está acionando o recurso. Respostas HTTP do tipo 5XX são erros internos no BB.",
"example": "Nosso Número já incluído anteriormente."
},
"textoProvidencia": {
"type": "string",
"description": "Aqui você verá o que você deve fazer para que o erro seja corrigido.",
"example": "Informar outro Nosso Número."
},
"codigoRetorno": {
"type": "string",
"description": "Código de erro disparado pelo programa, que nos ajuda a encontrar a origem da falha reportada.",
"example": "1053"
}
}
}
}
},
"description": "Representação de um objeto de erro v2."
},
"Erro-v4": {
"type": "object",
"description": "Representa os campos de erro de uma requisição a um recurso.",
"properties": {
"erros": {
"type": "array",
"description": "Lista que contém os objetos de erro.",
"items": {
"type": "object",
"description": "Objeto de erro.",
"properties": {
"codigo": {
"type": "string",
"description": "Código da mensagem de erro.",
"example": "4874915"
},
"versao": {
"type": "string",
"description": "Versão da mensagem de erro.",
"example": "1"
},
"mensagem": {
"type": "string",
"description": "Mensagem de erro.",
"example": "Nosso Número já incluído anteriormente."
},
"providencia": {
"type": "string",
"description": "Aqui você verá o que você deve fazer para que o erro seja corrigido.",
"example": "Informar outro Nosso Número."
},
"ocorrencia": {
"type": "string",
"description": "Código da ocorrência do erro. Não se trata de código HTTP.",
"example": "2AzBShK/zFE=C0700051620C"
}
}
}
}
},
"title": "Representação de um objeto de erro v4."
}
},
"parameters": {
"Authorization": {
"name": "Authorization",
"in": "header",
"description": "É um \"token\" de acesso fornecido pelo OAuth 2.0.",
"required": true,
"schema": {
"type": "string",
"format": "jwt",
"pattern": "^Bearer [A-Za-z0-9-_=]+\\.[A-Za-z0-9-_=]+\\.[A-Za-z0-9-_.+/=]*$"
},
"example": "Bearer IId7jeRGJVeMTpFq0MhictygJfXqiiidLKrKf2Y8WkUBxuu0qVu8mWMCNVFuucbw.5ElT5KtoE3I08hmJ2dg1XNwZa89Hxq40-sZS2FQ5asAOfRUS3rBuIbsO0A11pLB6RytX6I78n4VY1ylZXaOS58RTAj8AiWwY8lFnSxsAzCwBlpE7sPNKcEkmiSTRe95AoH6VWjSrmNckS.JJfIoALx4n-asn7WaqP8T2yXP6pAHl-jNG0k-81edQAU9iQx-eTb8etwGw"
},
"AppKey": {
"name": "gw-dev-app-key",
"in": "query",
"description": "Chave da aplicação. É a developer_application_key que pode ser encontrada acessando o item Credenciais dentro da sua aplicação no Portal Developers BB.",
"required": true,
"schema": {
"type": "string",
"pattern": "^[0-9A-Fa-f]+$",
"maxLength": 31,
"minLength": 31
},
"example": "0021239456d80136bebf00505689bed"
}
},
"securitySchemes": {
"OAuth2-Sandbox": {
"type": "oauth2",
"description": "pt-BR: Com a proteção de credenciais de usuários, o OAuth 2.0 permite a recuperação segura de recursos seguros. AMBIENTE DE TESTES",
"flows": {
"clientCredentials": {
"tokenUrl": "https://oauth.sandbox.bb.com.br/oauth/token",
"scopes": {
"cobrancas.boletos-requisicao": "Permite registrar e baixar boletos de cobrança.",
"cobrancas.boletos-info": "Permite consultar detalhes de boletos de cobrança.",
"cobrancas.convenio-requisicao": "Permite habilitar e desabilitar a personalização dos convênios"
},
"refreshUrl": "https://oauth.sandbox.bb.com.br/oauth/token"
}
}
},
"OAuth2-Homologacao": {
"type": "oauth2",
"description": "pt-BR: Com a proteção de credenciais de usuários, o OAuth 2.0 permite a recuperação segura de recursos seguros. AMBIENTE DE HOMOLOGAÇÃO.",
"flows": {
"clientCredentials": {
"tokenUrl": "https://oauth.hm.bb.com.br/oauth/token",
"scopes": {
"cobrancas.boletos-requisicao": "Permite registrar e baixar boletos de cobrança.",
"cobrancas.boletos-info": "Permite consultar detalhes de boletos de cobrança.",
"cobrancas.convenio-requisicao": "Permite habilitar e desabilitar a personalização dos convênios"
},
"refreshUrl": "https://oauth.hm.bb.com.br/oauth/token"
}
}
},
"OAuth2": {
"type": "oauth2",
"description": "pt-BR: Com a proteção de credenciais de usuários, o OAuth 2.0 permite a recuperação segura de recursos seguros. AMBIENTE DE PRODUÇÃO.",
"flows": {
"clientCredentials": {
"tokenUrl": "https://oauth.bb.com.br/oauth/token",
"scopes": {
"cobrancas.boletos-requisicao": "Permite registrar e baixar boletos de cobrança.",
"cobrancas.boletos-info": "Permite consultar detalhes de boletos de cobrança.",
"cobrancas.convenio-requisicao": "Permite habilitar e desabilitar a personalização dos convênios"
},
"refreshUrl": "https://oauth.bb.com.br/oauth/token"
}
}
},
"ApiKey": {
"type": "apiKey",
"name": "gw-dev-app-key",
"in": "query",
"description": "Chave da aplicação. É a developer_application_key que pode ser encontrada acessando o item Credenciais dentro da sua aplicação no Portal Developers BB."
},
"mutualTLS": {
"type": "mutualTLS"
}
}
},
"tags": [
{
"name": "boletos",
"description": "Recursos relacionados a boletos."
},
{
"name": "movimento",
"description": "Recursos relacionados a movimentação."
},
{
"name": "convênio",
"description": "Recursos relacionados ao convênio de cobrança."
}
]
}