Skip to main content

Banco do Brasil

Manage your banking services with Banco do Brasil.

Banco do Brasil Logo

Authentication​

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use​

Using the Smart Chat​

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor​

from abstra.connectors import run_connection_action

result = run_connection_action(
  connection_name="your_connection_name",
  action_name="your_action_name",
  params={
    "param1": "value1",
    "param2": "value2"
  })

Available Actions​

This connector provides 234 actions:

ActionPurposeParameters
arrecadacao_integrada_ao_pix/post_arrecadacao_qrcodesGera um QR Code de pagamento instantâneo PIX para uma guia de arrecadação com ou sem código de barras.gw-app-key (string) required
Authorization (string) required
data: {
. numeroConvenio (integer)
. indicadorCodigoBarras (string)
. codigoGuiaRecebimento (string)
. emailDevedor (string)
. codigoPaisTelefoneDevedor (integer)
. dddTelefoneDevedor (integer)
. numeroTelefoneDevedor (string)
. codigoSolicitacaoBancoCentralBrasil (string)
. descricaoSolicitacaoPagamento (string)
. valorOriginalSolicitacao (number)
. cpfDevedor (string)
. cnpjDevedor (string)
. nomeDevedor (string)
. quantidadeSegundoExpiracao (integer)
. listaInformacaoAdicional (array)
} (object) required
arrecadacao_integrada_ao_pix/get_arrecadacao_qrcodesConsulta um QR Code de pagamentos instantâneos PIX por guia de recebimento com ou sem código de barras.Authorization (string) required
gw-app-key (string) required
numeroConvenio (integer) required
codigoGuiaRecebimento (string) required
arrecadacao_integrada_ao_pix/put_arrecadacao_qrcodes_by_idAltera um QR Code de pagamento instantâneo PIX de uma guia de arrecadação com ou sem código de barras.id (string)
gw-app-key (string) required
Authorization (string) required
data: {
. numeroConvenio (integer)
. indicadorCodigoBarras (string)
. codigoGuiaRecebimento (string)
. emailDevedor (string)
. codigoPaisTelefoneDevedor (integer)
. dddTelefoneDevedor (integer)
. numeroTelefoneDevedor (string)
. codigoSolicitacaoBancoCentralBrasil (string)
. descricaoSolicitacaoPagamento (string)
. valorOriginalSolicitacao (number)
. cpfDevedor (string)
. cnpjDevedor (string)
. nomeDevedor (string)
. quantidadeSegundoExpiracao (integer)
. listaInformacaoAdicional (array)
} (object) required
arrecadacao_integrada_ao_pix/get_arrecadacao_qrcodes_by_idConsulta um QR Code de pagamento instantâneo PIX de uma guia de arrecadação com ou sem código de barras.id (string)
Authorization (string) required
gw-app-key (string) required
numeroConvenio (integer) required
arrecadacao_integrada_ao_pix/post_arrecadacao_qrcodes_by_id_baixarDar baixa em um QR Code de pagamento instantâneo PIX de uma guia de arrecadação com ou sem código de barras.id (string)
gw-app-key (string) required
Authorization (string) required
data: {
. numeroConvenio (integer)
. codigoSolicitacaoBancoCentralBrasil (string)
. cpfDevedor (integer)
. cnpjDevedor (integer)
} (object) required
arrecadacao_integrada_ao_pix/get_arrecadacao_qrcodes_pagamentos_by_idA partir do código de pagamento, consulta dados do registro de Pagamento PIX QRCode de uma Guia de Arrecadaçãoid (string)
Authorization (string) required
gw-app-key (string) required
arrecadacao_integrada_ao_pix/get_pagamentos_codigo_barras_by_idRetorna uma lista de pagamentos Pix na arrecadação quando informado o código de barras.id (string)
Authorization (string) required
gw-app-key (string) required
numeroConvenio (integer) required
arrecadacao_integrada_ao_pix/get_pagamentos_transacao_by_idRetorna uma lista de pagamentos Pix na arrecadação quando informado o ID de transação.id (string)
Authorization (string) required
gw-app-key (string) required
numeroConvenio (integer) required
autorizacao_debito_automatico/post_direct_debit_authorizationsAutoriza débito automático recorrente em conta por parte de um terceiro.data: {
. codigoConvenio (integer)
. codigoIdentificador (string)
} (object) required
bb_pay_v1/post_solicitacao_pagamentoCria uma solicitação de pagamentos para clientesAuthorization (string) required
gw-dev-app-key (string) required
data: {
. numeroConvenio (integer)
. timestampLimiteSolicitacaoPagamento (string)
. indicadorPagamentoUnico (string)
. valorSolicitacaoPagamento (number)
. codigoConciliacaoSolicitacaoPagamento (string)
. descricaoSolicitacaoPagamento (string)
. tipoPessoaDevedor (integer)
. cpfCnpjDevedor (integer)
. cepDevedor (integer)
. enderecoDevedor (string)
. bairroDevedor (string)
. cidadeDevedor (string)
. ufDevedor (string)
. emailDevedor (string)
. dddTelefoneDevedor (integer)
. telefoneDevedor (integer)
. cpfCnpjRepresentanteEmpresa (integer)
. quantidadeTiposPagamentosLista (integer)
. listaPagamentos (array)
} (object) required
bb_pay_v1/get_solicitacao_pagamento_by_numero_solicitacao_pagamentoListar os pagamentos de um cliente em uma data ou por uma solicitação de pagamento especifica.numeroSolicitacaoPagamento (string)
gw-dev-app-key (string) required
Authorization (string) required
numeroConvenio (integer) required
dataPagamento (string)
numeroUltimoPagamentoConsultado (integer) required
bb_pay_v1/get_pagamentos_by_numero_pagamento_solicitacaoConsulta Informações relativas a um Pagamento específico de uma Solicitação de PagamentosnumeroPagamentoSolicitacao (string)
Authorization (string) required
gw-dev-app-key (string) required
numeroConvenio (integer) required
bb_pay_v1/post_pagamentos_by_numero_pagamento_solicitacao_devolverDevolve um pagamentonumeroPagamentoSolicitacao (string)
Authorization (string) required
gw-dev-app-key (string) required
data: {
. numeroConvenio (integer)
. valorDevolucao (number)
. motivoDevolucao (string)
. textoMotivoDevolucao (string)
} (object) required
bb_pay_v1/post_solicitacao_pagamentos_by_numero_solicitacao_pagamento_autorizacoesCria uma solicitação de autorização de pagamentonumeroSolicitacaoPagamento (string)
Authorization (string) required
gw-dev-app-key (string) required
data: {
. numeroMarcaParticipanteOpenbanking (integer)
. informacaoPagador (string)
. agenciaPagador (integer)
. tipoContaPagador (integer)
. contaCorrentePagador (integer)
. numeroConvenio (integer)
} (object) required
bb_pay_v1/get_by_id_marcas_ativasLista as marcas ativas participantes do Open Banking para utilização no processo de iniciação de pagamento.id (string)
Authorization (string) required
gw-dev-app-key (string) required
numeroConvenio (integer) required
bb_pay_v1/get_pagamentos_by_numero_pagamento_solicitacao_autorizacoesConsulta a autorização de pagamento consentimento de um pagamento em outra instituição financeiranumeroPagamentoSolicitacao (string)
Authorization (string) required
gw-dev-app-key (string) required
numeroConvenio (integer) required
bb_pay_v1/get_devolucoes_pagamentosLista as devoluções de uma solicitação de pagamento especifica ou as devoluções realizadas em uma data. Na requisição deve ser informada a data do pagamento ou a solicitação de pagamento.Authorization (string)
gw-dev-app-key (string)
numeroConvenio (integer) required
numeroSolicitacaoPagamento (integer)
dataPagamento (string)
numeroUltimaDevolucao (integer)
bb_pay_v2/get_solicitacoesListar solicitaçõesnumeroConvenio (integer) required
codigoConciliacaoSolicitacao (string)
dataSolicitacao (string)
codigoEstadoSolicitacao (array)
tokenPaginacao (string)
itensPorPagina (integer)
numeroParticipante (integer)
Authorization (undefined)
bb_pay_v2/post_solicitacoesCria uma solicitação de pagamentoAuthorization (undefined)
data: {
. geral
. devedor
. vencimento
. formasPagamento (array)
. repasse
} (object) required
bb_pay_v2/get_pagamentos_by_numero_pagamentoConsultar um pagamentonumeroPagamento (integer)
numeroConvenio (integer) required
Authorization (undefined)
bb_pay_v2/get_pagamentosListar pagamentosnumeroConvenio (integer) required
numeroSolicitacao (integer)
codigoConciliacaoSolicitacao (string)
codigoTipoPagamento (array)
codigoEstadoPagamento (array)
dataPagamento (string)
numeroDocumentoPagador (integer)
tokenPaginacao (string)
itensPorPagina (integer)
Authorization (undefined)
bb_pay_v2/get_devolucoes_by_numero_devolucaoConsultar uma devoluçãonumeroDevolucao (string)
numeroConvenio (integer) required
Authorization (undefined)
bb_pay_v2/get_devolucoesListar devoluçõesnumeroConvenio (integer) required
numeroPagamento (integer)
dataDevolucao (string)
tokenPaginacao (string)
itensPorPagina (integer)
bb_pay_v2/post_devolucoesDevolver um pagamentodata: {
. numeroPagamento (integer)
. numeroConvenio (integer)
. valorDevolucao (number)
. textoMotivoDevolucao (string)
} (object) required
bb_pay_v2/get_participantesListar participantesnumeroConvenio (integer) required
codigoEstadoParticipante (array)
itensPorPagina (integer)
tokenPaginacao (string)
numeroSolicitacao (integer)
Authorization (undefined)
bb_pay_v2/post_participantesCadastra um novo participante no splitAuthorization (undefined)
data: {
. numeroConvenio (integer)
. nomeParticipante (string)
. tipoDocumento (integer)
. numeroDocumento (integer)
. numeroConta (integer)
. tipoConta (integer)
. variacaoPoupanca (integer)
. codigoIspb (integer)
. numeroAgencia (integer)
} (object) required
bb_pay_v2/get_participantes_by_numero_participanteConsultar um participantenumeroParticipante (string)
Authorization (undefined)
bb_pay_v2/put_participantes_by_numero_participanteAltera nome e/ou dados bancários de um participantenumeroParticipante (string)
Authorization (undefined)
data: {
. nomeParticipante (string)
. numeroConta (integer)
. numeroAgencia (integer)
. codigoTipoConta (integer)
. numeroVariacaoPoupanca (integer)
. codigoIspb (integer)
} (object) required
bb_pay_v2/delete_participantes_by_numero_participanteRemover um participantenumeroParticipante (string)
Authorization (undefined)
bb_pay_v2/post_openfinance_autorizacoesEsse recurso inicia o fluxo de pagamento no Open Finance, após pagador escolher a instituição detentora da sua conta marca. Enquanto o pagador espera o redirecionamento, esse recurso deve ser chamado para dar ciência à instituição detentora da conta do pagador de sua intenção, para que ela crie uma autorização que será confirmada pelo pagador em ambiente de sua confiançaAuthorization (undefined)
data: {
. numeroSolicitacao (integer)
. numeroConvenio (integer)
. informacaoPagador (string)
. agenciaPagador (integer)
. tipoContaPagador (integer)
. contaCorrentePagador (integer)
. numeroMarcaParticipanteOpenfinance (integer)
} (object) required
bb_pay_v2/get_openfinance_autorizacoes_by_numero_pagamentoEsse recurso verifica se a autorização foi criada pela instituição escolhida pelo pagador e, em caso positivo, devolve a url para direcionamento do pagador ao ambiente da instituição escolhida, por ela fornecidanumeroPagamento (string)
numeroConvenio (number) required
Authorization (undefined)
bb_pay_v2/get_openfinance_marcas_ativasListar marcas ativasnumeroConvenio (number) required
tokenPaginacao (string)
Authorization (undefined)
bb_pay_v2/get_solicitacoes_by_numero_solicitacaoConsulta uma solicitaçãonumeroSolicitacao (string)
numeroConvenio (integer) required
Authorization (undefined)
bb_pay_v2/put_solicitacoes_by_numero_solicitacaoAltera data de vencimento, data limite para pagamento, valor e/ou descrição de uma solicitação de pagamento, bem como o QRCode Pix e o boleto associados à solicitação. Não é possível fazer alterações em solicitações com split de valor fixo.numeroSolicitacao (string)
numeroConvenio (integer) required
Authorization (undefined)
data: {
. valorSolicitacao (number)
. descricaoSolicitacao (string)
. dataVencimento (string)
. timestampLimiteSolicitacao (string)
} (object) required
bb_pay_v2/delete_solicitacoes_by_numero_solicitacaoDeleta uma solicitaçãonumeroSolicitacao (string)
numeroConvenio (integer) required
Authorization (undefined)
cobrancas/get_boletosListar títulos de cobrança - Em Ser, Baixados, Liquidados e Com Protesto por Beneficiário.br /br /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.indicadorSituacao (string) required
contaCaucao (integer)
agenciaBeneficiario (integer) required
contaBeneficiario (integer) required
carteiraConvenio (integer)
variacaoCarteiraConvenio (integer)
modalidadeCobranca (integer)
cnpjPagador (integer)
digitoCNPJPagador (integer)
cpfPagador (integer)
digitoCPFPagador (integer)
dataInicioVencimento (string)
dataFimVencimento (string)
dataInicioRegistro (string)
dataFimRegistro (string)
dataInicioMovimento (string)
dataFimMovimento (string)
codigoEstadoTituloCobranca (integer)
boletoVencido (string)
indice (integer)
cobrancas/post_boletosPermite incluir um novo boleto de cobrançadata: {
. numeroConvenio (integer)
. numeroCarteira (integer)
. numeroVariacaoCarteira (integer)
. codigoModalidade (integer)
. dataEmissao (string)
. dataVencimento (string)
. valorOriginal (number)
. valorAbatimento (number)
. quantidadeDiasProtesto (number)
. quantidadeDiasNegativacao (integer)
. orgaoNegativador (integer)
. indicadorAceiteTituloVencido (string)
. numeroDiasLimiteRecebimento (integer)
. codigoAceite (string)
. codigoTipoTitulo (integer)
. descricaoTipoTitulo (string)
. indicadorPermissaoRecebimentoParcial (string)
. numeroTituloBeneficiario (string)
. campoUtilizacaoBeneficiario (string)
. numeroTituloCliente (string)
. mensagemBloquetoOcorrencia (string)
. desconto (object)
. segundoDesconto (object)
. terceiroDesconto (object)
. jurosMora (object)
. multa (object)
. pagador (object)
. beneficiarioFinal (object)
. indicadorPix (string)
} (object) required
cobrancas/get_boletos_by_idConsulta detalhes de um boleto bancário.br /br /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.br /br /bObservação:/b 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.id (string)
numeroConvenio (number) required
cobrancas/patch_boletos_by_idRealiza alterações nos valores dos campos presentes em um boleto bancário já criado.id (string)
data: {
. numeroConvenio (integer)
. indicadorNovaDataVencimento (string)
. alteracaoData
. indicadorNovoValorNominal (string)
. alteracaoValor
. indicadorAtribuirDesconto (string)
. desconto
. indicadorAlterarDesconto (string)
. alteracaoDesconto
. indicadorAlterarDataDesconto (string)
. alteracaoDataDesconto
. indicadorProtestar (string)
. protesto
. indicadorSustacaoProtesto (string)
. indicadorCancelarProtesto (string)
. indicadorIncluirAbatimento (string)
. abatimento
. indicadorAlterarAbatimento (string)
. alteracaoAbatimento
. indicadorCobrarJuros (string)
. juros
. indicadorDispensarJuros (string)
. indicadorCobrarMulta (string)
. multa
. indicadorDispensarMulta (string)
. indicadorNegativar (string)
. negativacao
. indicadorAlterarSeuNumero (string)
. alteracaoSeuNumero
. indicadorAlterarEnderecoPagador (string)
. alteracaoEndereco
. indicadorAlterarPrazoBoletoVencido (string)
. alteracaoPrazo
} (object) required
cobrancas/post_boletos_by_id_baixarPermite a baixa/cancelamento de um título de cobrança.id (string)
data: {
. numeroConvenio (number)
} (object) required
cobrancas/post_boletos_by_id_cancelar_pixCancelar Pix vinculado a um boleto de cobrança existente.id (string)
data: {
. numeroConvenio (integer)
} (object) required
cobrancas/post_boletos_by_id_gerar_pixGerar Pix vinculado a um boleto de cobrança através de um QRCode Dinâmico ou Estático.id (string)
data: {
. numeroConvenio (integer)
} (object) required
cobrancas/get_boletos_by_id_pixConsultar os dados de um Pix vinculado a um boleto de cobrança.id (string)
numeroConvenio (number) required
cobrancas/post_convenios_by_id_listar_retorno_movimentoLista os dados do retorno de movimento do convênio de Cobranças.br /br /bATENÇÃO:/b Este recurso faz parte de um programa piloto. Para obter acesso, entre em contato com seu Gerente de Cash ou Gerente de Relacionamento.id (string)
data: {
. dataMovimentoRetornoInicial (string)
. dataMovimentoRetornoFinal (string)
. codigoPrefixoAgencia (integer)
. numeroContaCorrente (integer)
. numeroCarteiraCobranca (integer)
. numeroVariacaoCarteiraCobranca (integer)
. numeroRegistroPretendido (integer)
. quantidadeRegistroPretendido (integer)
} (object) required
cobrancas/get_boletos_baixa_operacionalLista as informações de baixa operacional de boletos de uma carteira de cobrança.br /br /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.br /br /Observação: A utilização do recurso depende da habilitação através do PATCH /convenios/id/ativar-consulta-baixa-operacional.br /Para desativar o o recurso, utilize o PATCH /convenios/id/desativar-consulta-baixa-operacional.agencia (integer) required
conta (integer) required
carteira (integer) required
variacao (integer) required
estadoBaixaOperacional (integer)
modalidadeTitulo (integer)
dataInicioVencimentoTitulo (string)
dataFimVencimentoTitulo (string)
dataInicioRegistroTitulo (string)
dataFimRegistroTitulo (string)
dataInicioAgendamentoTitulo (string) required
dataFimAgendamentoTitulo (string) required
horarioInicioAgendamentoTitulo (string)
horarioFimAgendamentoTitulo (string)
idProximoTitulo (string)
cobrancas/patch_convenios_by_id_ativar_consulta_baixa_operacionalHabilita 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.id (string)
cobrancas/patch_convenios_by_id_desativar_consulta_baixa_operacionalDesativa 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.id (string)
debitos_veiculantes/post_solicitacoesCadastra uma solicitação de consulta de dados de débitos veiculares. O retorno da consulta é assíncrono, com tempo estimado de processamento superior a 1000ms, sendo enviado automaticamente por meio de webhook previamente cadastrado quando a consulta estiver finalizada.data: {
. numeroRenavam (string)
. codigoCpf (string)
. codigoCnpj (string)
. codigoUf (string)
. codigoPlaca (string)
} (object) required
debitos_veiculantes/post_pagamentosPermite a liquidação de débitos veiculares por meio de identificadores únicos, obtidos em consulta de débitos prévia.data: {
. codigoSolicitacao (string)
. codigoServico (integer)
. numeroUnicoItemBanco (integer)
. numeroIdentificadorItem (integer)
} (object) required
debitos_veiculantes/get_solicitacoes_by_codigo_solicitacaoObtém informações de débitos veiculares de consulta previamente registrada por codigoSolicitacao.codigoSolicitacao (string)
extratos/get_conta_corrente_agencia_by_agencia_conta_by_contaDado um código de agência e um número de conta corrente, retorna a listagem de transações efetivadas e de lançamentos futuros, no padrão definido para API BB.agencia (string)
conta (string)
gw-dev-app-key (string) required
numeroPaginaSolicitacao (integer)
**** (integer)
dataInicioSolicitacao (integer)
dataFimSolicitacao (integer)
fundos_de_investimento/get_saldo_agencia_by_numero_agencia_conta_by_numero_contaLista os fundos de investimento do cliente com os valores de seus respectivos saldos bruto e líquido para resgate.numeroAgencia (integer)
numeroConta (integer)
fundos_de_investimento/post_aplicacaoSolicita a aplicação de um valor, proveniente de Conta Corrente, em um fundo de investimento.data: {
. numeroAgencia (integer)
. numeroConta (integer)
. codigoFundo (integer)
. dataAplicacao (string)
. valorAplicacao (number)
} (object) required
fundos_de_investimento/post_resgateSolicita o resgate de um valor, a ser crédito na Conta Corrente, em um fundo de investimento.data: {
. numeroAgencia (integer)
. numeroConta (integer)
. codigoFundo (integer)
. dataResgate (string)
. valorResgate (number)
} (object) required
fundos_de_investimento/post_resgate_totalSolicita resgate de todo saldo em um fundo de investimento, a ser crédito na Conta Corrente.data: {
. numeroAgencia (integer)
. numeroConta (integer)
. codigoFundo (integer)
. dataResgate (string)
} (object) required
login_bb/servers_oauth_jwksNo description availableNo parameters
login_bb/get_oauth_jwksEste endpoint retorna as chaves publicas usadas para verificar a assinatura dos IDs Tokens emitidos pelo OAUth 2.0.No parameters
login_bb/get_oauth_v2_userinfoEste endpoint é utilizado para recuperar o objeto JWT assinado pelo servidor de autorização OAuth BB, contendo a informação do usuário logado. Para mais informações sobre este endpoint, gentileza verificar a documentação do OpenID Connect OIDC disponível em https://openid.net/specs/openid-connect-core-1_0.html UserInfogw-app-key (string) required
pag_bb/post_lotes_pixPermite a inclusão de um lote contendo lançamentos do tipo PIX.gw-dev-app-key (string) required
data: {
. idLote (integer)
. numeroAgenciaDebito (string)
. numeroContaDebito (string)
. numeroContrato (integer)
. lancamentos (array)
} (object) required
pag_bb/get_lotes_by_id_lote_pix_lancamentosPermite detalhar as informações de um lote PIX.id-lote (string)
gw-dev-app-key (string) required
contrato (integer) required
pag_bb/get_lotes_by_id_lote_pix_lancamentos_by_id_lancamentoPermite detalhar os dados de um lançamento específico realizado dentro de um lote PIX.id-lote (string)
id-lancamento (string)
gw-dev-app-key (string) required
contrato (integer) required
pag_bb/put_lotes_by_id_lote_liberacoesAutoriza o pagamento dos lançamentos de um lote.id-lote (string)
gw-dev-app-key (string) required
contrato (integer) required
pag_bb/put_lotes_by_id_lote_cancelamentosCancela um lote e todos os seus lançamentos.id-lote (string)
gw-dev-app-key (string) required
contrato (integer) required
pagamentos_em_lote/post_liberar_pagamentosPermite que a empresa efetue a liberação dos lotes de pagamentos diretamente de seu sistema de gestão - ERP. Após o comando de liberação, o processamento do pagamento de todos os lançamentos do lote liberado dependerá da existência de saldo em conta até o horário limite para efetivação de cada um deles, da validação dos dados e demais regras pactuadas na contratação do serviço. A situação de cada lançamento deverá se consultada posteriormente. O mesmo lote poderá ser liberado mais de uma vez.gw-dev-app-key (string) required
Authorization (string) required
data: {
. numeroRequisicao (integer)
. indicadorFloat (string)
} (object) required
pagamentos_em_lote/get_lotes_transferenciasRealiza consulta a um Lote de Pagamentos realizados via Tranferência BancáriaAuthorization (string) required
gw-dev-app-key (string) required
numeroContratoPagamento (integer)
agenciaDebito (integer)
contaCorrenteDebito (integer)
digitoVerificadorContaCorrente (string) required
dataInicio (integer)
dataFim (integer)
tipoPagamento (integer)
estadoRequisicao (integer)
indice (integer)
pagamentos_em_lote/post_lotes_transferenciasEfetua o envio de um Lote de Pagamentos a serem realizados via Tranferência BancáriaAuthorization (string) required
gw-dev-app-key (string) required
data: {
. numeroRequisicao (integer)
. numeroContratoPagamento (integer)
. agenciaDebito (integer)
. contaCorrenteDebito (integer)
. digitoVerificadorContaCorrente (string)
. tipoPagamento (integer)
. listaTransferencias (array)
} (object) required
pagamentos_em_lote/post_lotes_transferencias_pixEfetua pagamentos em lote via tranferência PIX. Atualmente, a requisição pode ser enviada a qualquer horário, mas a liberação é permitida a partir das 7h30. Quando não se tratar de liberação automática, a liberação manual poderá ser feita por meio do recurso '/liberar-pagamentos'. Não haverá recurso para confirmação de titularidade da chave PIX.Authorization (string) required
gw-dev-app-key (string) required
data: {
. numeroRequisicao (integer)
. numeroContrato (integer)
. agenciaDebito (integer)
. contaCorrenteDebito (integer)
. digitoVerificadorContaCorrente (string)
. tipoPagamento (integer)
. listaTransferencias (array)
} (object) required
pagamentos_em_lote/post_cancelar_pagamentosEfetua o Cancelamento de um Lote de PagamentosAuthorization (string) required
gw-dev-app-key (string) required
data: {
. agenciaDebito (integer)
. contaCorrenteDebito (integer)
. digitoVerificadorContaCorrente (string)
. listaPagamentos (array)
. numeroContratoPagamento (integer)
} (object) required
pagamentos_em_lote/get_darf_preto_by_idA partir de um código identificador de pagamento de um DARF Preto, retorna os detalhes do pagamento desta, como estado do pagamento, data do pagamento, forma do pagamento, valor, descrição, código de devolução, entre outros.id (string)
agencia (number)
contaCorrente (number)
digitoVerificador (string)
gw-dev-app-key (string) required
Authorization (string) required
pagamentos_em_lote/get_guias_codigo_barras_by_idA partir de um código identificador de pagamento de uma Guia com Código de Barras, retorna os detalhes do pagamento desta, como estado do pagamento, data do pagamento, forma do pagamento, valor, descrição, código de devolução, entre outros.id (string)
Authorization (string) required
gw-dev-app-key (string) required
agencia (number)
contaCorrente (number)
digitoVerificador (string)
pagamentos_em_lote/get_lotes_guias_codigo_barras_by_id_solicitacaoPermite consultar a resposta de uma solicitação de pagamento em lote de guias de recolhimento com código de barras. Utilizada quando a empresa não recebeu a confirmação da solicitação de pagamento de guia com barras ou precisar recuperar a resposta original ou quer confirmar se o número da solicitação de pagamento já foi utilizada.id (string)
Authorization (string) required
gw-dev-app-key (string) required
agencia (number)
contaCorrente (number)
digitoVerificador (string)
pagamentos_em_lote/get_gru_by_idA partir de um código identificador de pagamento de uma Guia de Recolhimento da União, retorna os detalhes do pagamento desta, como estado do pagamento, data do pagamento, forma do pagamento, valor, descrição, código de devolução, entre outros.id (string)
gw-dev-app-key (string) required
Authorization (string) required
agencia (number)
digitoVerificador (string)
contaCorrente (number)
pagamentos_em_lote/get_gps_by_idA partir de um código identificador de pagamento de uma Guia da Previdência Social, retorna os detalhes do pagamento desta, como estado do pagamento, data do pagamento, forma do pagamento, valor, descrição, código de devolução, entre outros.id (string)
agencia (integer)
contaCorrente (integer)
digitoVerificador (string)
gw-dev-app-key (string) required
Authorization (string) required
pagamentos_em_lote/post_pagamentos_gruGera uma requisição de pagamento de guias com código de barras, do tipo GRU.gw-dev-app-key (string) required
Authorization (string) required
data: {
. numeroRequisicao (integer)
. codigoContrato (integer)
. agencia (integer)
. conta (integer)
. digitoConta (string)
. listaRequisicao (array)
} (object) required
pagamentos_em_lote/get_pagamentosConsulta os pagamentos e transferências devolvidos.Authorization (string) required
gw-dev-app-key (string) required
agenciaDebito (integer)
contaCorrenteDebito (integer)
digitoVerificadorContaCorrente (string)
numeroContratoPagamento (integer)
dataInicio (integer) required
dataFim (integer) required
estadoPagamento (string)
indice (integer) required
pagamentos_em_lote/get_transferencias_by_idConsulta sobre um Pagamento específico em um Lote de Transferênciasid (string)
agencia (integer)
contaCorrente (integer)
digitoVerificador (string)
Authorization (string) required
gw-dev-app-key (string) required
pagamentos_em_lote/get_by_idConsulta um lote de pagamentos.id (string)
Authorization (string) required
gw-dev-app-key (string) required
pagamentos_em_lote/get_by_id_solicitacaoConsulta sobre uma solicitação de requisição para efetuar um lote de pagamentos via transferência e os pagamentos deste lote.id (string)
Authorization (string) required
gw-dev-app-key (string) required
pagamentos_em_lote/get_lotes_gru_by_id_solicitacaoConsulta a resposta de uma solicitação de pagamentos de GRU em lote. Recurso utilizado quando do não recebimento da confirmação da Solicitação de Pagamento de Guia GRU em Lote, ou quando houver a necessidade de recuperar a resposta original de uma solicitação, ou quando for necessário confirmar se determinado número da solicitação de pagamento já fora utilizada.id (string)
gw-dev-app-key (string) required
Authorization (string) required
numeroAgenciaDebito (integer)
numeroContaCorrenteDebito (integer)
digitoVerificadorContaCorrenteDebito (string)
pagamentos_em_lote/get_lotes_gps_by_id_solicitacaoConsulta a resposta de uma solicitação de pagamentos de GPS em lote. Recurso utilizado quando do não recebimento da confirmação da Solicitação de Pagamento de Guia de Previdência Social - GPS em Lote, ou quando houver a necessidade de recuperar a resposta original de uma solicitação, ou quando for necessário confirmar se determinado número da solicitação de pagamento já fora utilizado.id (string)
gw-dev-app-key (string) required
Authorization (string) required
numeroAgenciaDebito (integer)
numeroContaCorrenteDebito (integer)
digitoVerificadorContaCorrenteDebito (string)
pagamentos_em_lote/get_lotes_darf_preto_normal_by_id_solicitacaoConsulta a resposta de uma solicitação de pagamentos de DARF Preto Normal em Lote.id (string)
gw-dev-app-key (string) required
Authorization (string) required
numeroAgenciaDebito (integer)
numeroContaCorrenteDebito (integer)
digitoVerificadorContaCorrenteDebito (string)
pagamentos_em_lote/post_lotes_darf_normal_pretoPermite efetuar solicitação de pagamentos em lote de Darf Normal e Darf Preto.Authorization (string) required
gw-dev-app-key (string) required
data: {
. id (integer)
. codigoContrato (integer)
. numeroAgenciaDebito (integer)
. numeroContaCorrenteDebito (integer)
. digitoVerificadorContaCorrenteDebito (string)
. lancamentos (array)
} (object) required
pagamentos_em_lote/post_lotes_gpsPermite efetuar solicitação de pagamentos em lote de Guia da Previdência Social - GPS.Authorization (string) required
gw-dev-app-key (string) required
data: {
. numeroRequisicao (integer)
. codigoContrato (integer)
. numeroAgenciaDebito (integer)
. numeroContaCorrenteDebito (integer)
. digitoVerificadorContaCorrenteDebito (string)
. lancamentos (array)
} (object) required
pagamentos_em_lote/get_pagamentos_codigo_barras_by_idConsulta todos os Pagamentos Efetuados e Vinculados a um Código de Barras Específico em um Lote de Pagamentosid (string)
agenciaDebito (integer)
contaCorrenteDebito (integer)
digitoVerificadorContaCorrente (string)
gw-dev-app-key (string) required
Authorization (string) required
pagamentos_em_lote/get_beneficiarios_by_id_transferenciasConsultar Tranferências Bancárias realizadas por Beneficiárioid (string)
Authorization (string) required
gw-dev-app-key (string) required
agenciaDebito (integer)
contaCorrenteDebito (integer)
digitoVerificadorContaCorrente (string)
tipoPagamento (integer)
numeroCOMPE (integer)
numeroISPB (integer)
agenciaCredito (integer)
contaCorrenteCredito (integer)
digitoVerificadorContaCorrenteCredito (string)
contaPagamentoCredito (string)
dataInicio (integer) required
dataFim (integer) required
indice (integer) required
tipoBeneficiario (integer) required
pagamentos_em_lote/get_boletos_by_idConsulta sobre um Pagamento específico em um Lote de Boletosid (string)
agencia (number)
contaCorrente (number)
digitoVerificador (string)
gw-dev-app-key (string) required
Authorization (string) required
pagamentos_em_lote/post_lotes_boletosPermite efetuar solicitação de pagamentos em lote de Boletos.Authorization (string) required
gw-dev-app-key (string) required
data: {
. numeroRequisicao (integer)
. codigoContrato (integer)
. numeroAgenciaDebito (integer)
. numeroContaCorrenteDebito (integer)
. digitoVerificadorContaCorrenteDebito (string)
. lancamentos (array)
} (object) required
pagamentos_em_lote/post_lotes_guias_codigo_barrasPermite efetuar solicitação de pagamento em lote de Guias de Recolhimento com código de barras.Authorization (string) required
gw-dev-app-key (string) required
data: {
. numeroRequisicao (integer)
. codigoContrato (integer)
. numeroAgenciaDebito (integer)
. numeroContaCorrenteDebito (integer)
. digitoVerificadorContaCorrenteDebito (string)
. lancamentos (array)
} (object) required
pagamentos_em_lote/get_lotes_transferencias_pix_by_id_solicitacaoPermite ao cliente recuperar a resposta da Solicitação de Transferência em lote para pagamentos realizados via PIX. Utilizada quando a empresa não recebeu a confirmação da Solicitação de Transferência em lote ou quando precisar recuperar a resposta original ou queira confirmar que o número da Solicitação de Pagamento já foi utilizado.id (string)
agencia (integer)
contaCorrente (integer)
digitoVerificador (string)
Authorization (string) required
gw-dev-app-key (string) required
pagamentos_em_lote/get_pix_by_idDetalha todos os dados de um pagamento efetuado na modalidade PIX.id (string)
agencia (integer)
contaCorrente (integer)
digitoVerificador (string)
Authorization (string) required
gw-dev-app-key (string) required
pagamentos_em_lote/get_lotes_boletos_by_id_solicitacaoPermite ao cliente recuperar a resposta da Solicitação de Transferência em lote para pagamentos realizados via boletos. Utilizada quando a empresa não recebeu a confirmação da Solicitação de Transferência em lote ou quando precisar recuperar a resposta original ou queira confirmar que o número da Solicitação de Pagamento já foi utilizado.id (string)
agencia (integer)
contaCorrente (integer)
digitoVerificador (string)
Authorization (string) required
gw-dev-app-key (string) required
pagamentos_em_lote/get_lancamentos_periodoEvento utilizado para requisicao e resposta da transacao negocial da operação 'Listar Lançamentos por Período de Pagamento'.Authorization (string) required
gw-dev-app-key (string) required
codigoClienteConveniado (integer)
numeroAgenciaDebito (integer) required
numeroContaCorrenteDebito (integer) required
digitoVerificadorContaCorrenteDebito (string) required
dataInicialdeEnviodaRequisicao (integer) required
dataFinaldeEnviodaRequisicao (integer)
codigodoEstadodoPagamento (integer)
codigoProduto (integer)
numeroDaPosicaoDePesquisa (integer)
pagamentos_em_lote/put_by_id_data_pagamentosEste recurso permite alterar a data original do pagamento.id (string)
Authorization (string) required
gw-dev-app-key (string) required
data: {
. numeroAgenciaDebito (integer)
. numeroContaCorrenteDebito (integer)
. digitoVerificadorContaCorrenteDebito (string)
. codigoProduto (integer)
. dataOriginalPagamento (integer)
. dataNovoPagamento (integer)
} (object) required
pix/get_webhookcobrEndpoint para recuperação de informações sobre o Webhook. brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrada.' 'correlationId': 'API-BB-3x3mpl01-3b3f-4997-8cNo parameters
pix/delete_webhookcobrEndpoint para cancelamento do webhook. Não é a única forma pela qual um webhook pode ser removido. brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrada.' 'corrNo parameters
pix/put_webhookcobrEndpoint para configuração do serviço de notificações acerca de cobranças recorrentes. Somente cobranças recorrentes associadas ao usuário recebedor serão notificadas. brbrResponsesbr br 400br 'type': 'https://api.bb.com.br/api/v2/error/WebhookOperacaoInvalida', 'title': 'Webhook inválido.', 'status': 400, 'detail': 'A presente requisição busca criar um webhook sem respeitar o schema ou, ainda, com sentido semanticamente inválido.' 403br 'type': 'https://api.bb.com.br/api/v2/data: {
. webhookUrl (string)
} (object) required
pix/get_pixEndpoint para consultar Pix recebidos brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrada.' 'correlationId': 'API-BB-3x3mpl01-3b3f-4997-8c8b-477c368a8bcinicio (string) required
fim (string) required
txid (string)
txIdPresente (boolean)
devolucaoPresente (boolean)
cpf (string)
cnpj (string)
paginacao.paginaAtual (integer)
paginacao.itensPorPagina (integer)
pix/delete_locrec_by_id_id_recEndpoint utilizado para desvincular uma recorrência de uma location. brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrada.' 'correlationId': 'API-BB-3x3mpl01-3id (string)
pix/patch_cob_by_txidEndpoint para revisar uma cobrança imediata. brbrResponsesbr br 400br 'type': 'https://api.bb.com.br/api/v2/error/CobOperacaoInvalida', 'title': 'Operação inválida.', 'status': 400, 'detail': 'A requisição que busca alterar ou criar uma cobrança para pagamento imediato não respeita o schema ou está semanticamente errada.' 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de partitxid (string)
data: {
. calendario (object)
. devedor (object)
. loc (object)
. status (string)
. valor (object)
. chave (string)
. solicitacaoPagador (string)
. infoAdicionais (array)
} (object) required
pix/get_cob_by_txidEndpoint para consultar uma cobrança através de um determinado txid. brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrada.' 'correlationId': 'API-BB-3x3mtxid (string)
pix/put_cob_by_txidEndpoint para criar uma cobrança imediata. brbrResponsesbr br 400br 'type': 'https://api.bb.com.br/api/v2/error/CobOperacaoInvalida', 'title': 'Cobrança inválida.', 'status': 400, 'detail': 'A requisição que busca alterar ou criar uma cobrança para pagamento imediato não respeita o schema ou está semanticamente errada.', 'violacoes': 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requtxid (string)
data: {
. calendario (object)
. devedor (object)
. loc (object)
. valor (object)
. chave (string)
. solicitacaoPagador (string)
. infoAdicionais (array)
} (object) required
pix/delete_loc_by_id_txidEndpoint utilizado para desvincular uma cobrança de uma location. Se executado com sucesso, a entidade loc não apresentará mais um txid, se apresentava anteriormente à chamada. Adicionalmente, a entidade cob ou cobv associada ao txid desvinculado também passará a não mais apresentar um location. Esta operação não altera o status da cob ou cobv em questão. brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403,id (string)
pix/patch_lotecobv_by_idEndpoint utilizado para revisar cobranças específicas dentro de um lote de cobranças com vencimento. brbrResponsesbr br 400br 'type': 'https://api.bb.com.br/api/v2/error/CobVOperacaoInvalida', 'title': 'Operação inválida.', 'status': 400, 'detail': 'Cobrança não encontra-se mais com o status ATIVA, somente cobranças ativas podem ser revisadas.' 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição did (string)
data: {
. descricao (string)
. cobsv (array)
} (object) required
pix/get_lotecobv_by_idEndpoint para consultar um lote de cobranças com vencimento. brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrada.' 'correlationId': 'API-BB-3x3mpl01-3b3f-4997id (string)
pix/put_lotecobv_by_idEndpoint utilizado para criar ou alterar um lote de cobranças com vencimento. brbrResponsesbr br 400br 'type': 'https://api.bb.com.br/api/v2/error/LoteCobVOperacaoInvalida', 'title': 'Lote de cobranças inválido.', 'status': 400, 'detail': 'A requisição que busca alterar ou criar um lote de cobranças com vencimento não respeita o schema ou está semanticamente errada.', 'violacoes': 'razao': 'O objeto loteCobV.cobsV não respeita o schema.', 'propriedade': 'loteCoid (string)
data: {
. descricao (string)
. cobsv (array)
} (object) required
pix/post_recEndpoint utilizado para criar recorrência. brbrResponsesbr br 400br 'type': 'https://api.bb.com.br/api/v2/error/RecOperacaoInvalida', 'title': 'Operação inválida.', 'status': 400, 'detail': 'A recorrência não respeita o schema.', 'violacoes': 'razao': 'O campo rec.calendario.dataInicial não respeita o schema.', 'propriedade': 'rec.calendario.dataInicial' 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'stadata: {
. vinculo (object)
. calendario (object)
. valor (object)
. politicaRetentativa (string)
. loc (integer)
. ativacao (object)
. recebedor (object)
} (object) required
pix/get_recEndpoint utilizado para consultar lista de recorrências. brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrada.' 'correlationId': 'API-BB-3x3mpl01-3b3f-4997-8c8inicio (string) required
fim (string) required
cpf (string)
cnpj (string)
locationPresente (boolean)
status (string)
convenio (string)
paginacao.paginaAtual (integer)
paginacao.itensPorPagina (integer)
pix/get_pix_by_e2eid_devolucao_by_idEndpoint para consultar uma devolução através de um End To End ID do Pix e do ID da devolução brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrada.' 'core2eid (string)
id (string)
pix/put_pix_by_e2eid_devolucao_by_idEndpoint para solicitar uma devolução através de um e2eid do Pix e do ID da devolução. O motivo que será atribuído à PACS.004 será 'Devolução solicitada pelo usuário recebedor do pagamento original' cuja sigla é 'MD06' de acordo com a aba RTReason da PACS.004 que consta no Catálogo de Mensagens do Pix. brbrResponsesbr br 400br 'type': 'https://api.bb.com.br/api/v2/error/PixDevolucaoInvalida', 'title': 'Devolução inválida.', 'status': 400, 'detail': 'A presente requisição de deve2eid (string)
id (string)
data: {
. valor (string)
} (object) required
pix/post_solicrecEndpoint utilizado para criar solicitação de confirmação de recorrência. brbrResponsesbr br 400br 'type': 'https://api.bb.com.br/api/v2/error/SolicRecOperacaoInvalida', 'title': 'Operação inválida.', 'status': 400, 'detail': 'A solicitação de confirmação de recorrência não respeita o schema.', 'violacoes': 'razao': 'O objeto solicrec.destinatario não respeita o schema.', 'propriedade': 'solicrec.destinatario' 403br 'type': 'https://api.bb.com.br/apidata: {
. idRec (string)
. calendario (object)
. destinatario (object)
} (object) required
pix/patch_cobv_by_txidEndpoint para revisar uma cobrança com vencimento. brbrResponsesbr br 400br 'type': 'https://api.bb.com.br/api/v2/error/CobVOperacaoInvalida', 'title': 'Operação inválida.', 'status': 400, 'detail': 'Cobrança não encontra-se mais com o status ATIVA, somente cobranças ativas podem ser revisadas.' 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que violatxid (string)
data: {
. calendario (object)
. devedor (object)
. loc (object)
. status (string)
. valor (object)
. chave (string)
. solicitacaoPagador (string)
. infoAdicionais (array)
} (object) required
pix/get_cobv_by_txidEndpoint para consultar uma cobrança com vencimento através de um determinado txid. brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrada.' 'correlationIdtxid (string)
revisao (integer)
pix/put_cobv_by_txidEndpoint para criar uma cobrança com vencimento. brbrResponsesbr br 400br 'type': 'https://api.bb.com.br/api/v2/error/CobVOperacaoInvalida', 'title': 'Cobrança inválida.', 'status': 400, 'detail': 'A requisição que busca alterar ou criar uma cobrança com vencimento não respeita o schema ou está semanticamente errada.', 'violacoes': 'razao': 'O objeto cobv.devedor não respeita o schema.', 'propriedade': 'cobv.devedor' 403txid (string)
data: {
. calendario (object)
. devedor (object)
. loc (object)
. valor (object)
. chave (string)
. solicitacaoPagador (string)
. infoAdicionais (array)
} (object) required
pix/get_webhookEndpoint para consultar Webhooks cadastrados brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrada.' 'correlationId': 'API-BB-3x3mpl01-3b3f-4997-8c8b-477cinicio (string) required
fim (string) required
paginacao.paginaAtual (integer)
paginacao.itensPorPagina (integer)
pix/post_locrecEndpoint para criar location do payload brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 503br 'type': 'https://api.bb.com.br/api/v2/error/ServicoIndisponivel', 'title': 'Serviço Indisponível', 'status': 503, 'detail': 'Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou forNo parameters
pix/get_locrecEndpoint para consultar locations cadastradas brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrada.' 'correlationId': 'API-BB-3x3mpl01-3b3f-4997-8c8b-477c368a8inicio (string) required
fim (string) required
idRecPresente (boolean)
convenio (string)
paginacao.paginaAtual (integer)
paginacao.itensPorPagina (integer)
pix/get_webhook_by_chaveEndpoint para recuperação de informações sobre o Webhook Pix brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrada.', 'correlationId': 'API-BB-3x3mpl01-3bchave (string)
pix/delete_webhook_by_chaveEndpoint para cancelamento do webhook. Não é a única forma pela qual um webhook pode ser removido. O PSP recebedor está livre para remover unilateralmente um webhook que esteja associado a uma chave que não pertence mais a este usuário recebedor. brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'tychave (string)
pix/put_webhook_by_chaveEndpoint para configuração do serviço de notificações acerca de Pix recebidos. Somente Pix associados a um txid serão notificados. brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail'chave (string)
data: {
. webhookUrl (string)
} (object) required
pix/patch_cobr_by_txidEndpoint para revisar uma cobrança recorrente. brbrResponsesbr br 400br 'type': 'https://api.bb.com.br/api/v2/error/CobROperacaoInvalida', 'title': 'Operação inválida.', 'status': 400, 'detail': 'Não é possível cancelar uma cobrança em uma data igual ou maior que a data prevista da primeira tentativa de liquidação.' 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado qutxid (string)
data: {
. status (string)
} (object) required
pix/get_cobr_by_txidEndpoint para consultar uma cobrança recorrente através de um determinado txid. brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrada.' 'correlationId': 'API-BB-txid (string)
pix/put_cobr_by_txidEndpoint para criar uma cobrança recorrente. brbrResponsesbr br 400br 'type': 'https://api.bb.com.br/api/v2/error/CobROperacaoInvalida', 'title': 'Operação inválida.', 'status': 400, 'detail': 'A cobrança não respeita o schema.', 'violacoes': 'razao': 'O objeto cobr.calendario não respeita o schema.', 'propriedade': 'cobr.calendario' 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detaitxid (string)
data: {
. idRec (string)
. infoAdicional (string)
. calendario (object)
. valor (object)
. ajusteDiaUtil (boolean)
. recebedor (object)
. devedor (object)
} (object) required
pix/patch_rec_by_id_recEndpoint utilizado para revisar recorrência. brbrResponsesbr br 400br 'type': 'https://api.bb.com.br/api/v2/error/RecOperacaoInvalida', 'title': 'Operação inválida.', 'status': 400, 'detail': 'A recorrência não respeita o schema.', 'violacoes': 'razao': 'O campo rec.calendario.dataInicial não respeita o schema.', 'propriedade': 'rec.calendario.dataInicial' 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'sidRec (string)
data: {
. status (string)
. vinculo (object)
. loc (integer)
. calendario (object)
. ativacao (object)
} (object) required
pix/get_rec_by_id_recEndpoint utilizado para consultar recorrência. brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrada.' 'correlationId': 'API-BB-3x3mpl01-3b3f-4997-8c8b-477c368aidRec (string)
txid (string)
pix/post_locEndpoint para criar location do payload brbrResponsesbr br 400br 'type': 'https://api.bb.com.br/api/v2/error/PayloadLocationOperacaoInvalida', 'title': 'PayloadLocation inválido.', 'status': 400, 'detail': 'A presente requisição busca criar uma location sem respeitar o schema estabelecido.' 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola aldata: {
. tipoCob (string)
} (object) required
pix/get_locEndpoint para consultar locations cadastradas brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrada.', 'correlationId': 'API-BB-3x3mpl01-3b3f-4997-8c8b-47inicio (string) required
fim (string) required
txIdPresente (boolean)
tipoCob (string)
paginacao.paginaAtual (integer)
paginacao.itensPorPagina (integer)
pix/get_loc_by_idRecupera a location do payload brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrada.' 'correlationId': 'API-BB-3x3mpl01-3b3f-4997-8c8b-477c368a8bc9',id (string)
pix/post_cobr_by_txid_retentativa_by_dataEndpoint para solicitar retentativa de uma cobrança recorrente. brbrResponsesbr br 400br 'type': 'https://pix.bcb.gov.br/api/v2/error/CobROperacaoInvalida', 'title': 'Cobrança não encontrada.', 'status': 400, 'detail': 'A política configurada na recorrência não permite retentativa de cobrança.' 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regratxid (string)
data (string)
pix/get_cobvEndpoint para consultar cobranças com vencimento através de parâmetros como início, fim, cpf, cnpj e status. brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontinicio (string) required
fim (string) required
cpf (string)
cnpj (string)
locationPresente (boolean)
status (string)
loteCobVId (integer)
paginacao.paginaAtual (integer)
paginacao.itensPorPagina (integer)
pix/get_pix_bb_devolucoesConsulta Pix recebidos com devolução. O parâmetro data início/fim da pesquisa considera a data da devolução. brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrada.'inicio (string) required
fim (string) required
estadoDevolucao (string)
paginacao.paginaAtual (integer)
paginacao.itensPorPagina (integer)
pix/post_cobrEndpoint para criar uma cobrança recorrente, neste caso, o txid deve ser definido pelo PSP. brbrResponsesbr br 400br 'type': 'https://api.bb.com.br/api/v2/error/CobROperacaoInvalida', 'title': 'Operação inválida.', 'status': 400, 'detail': 'A cobrança não respeita o schema.', 'violacoes': 'razao': 'O objeto cobr.calendario não respeita o schema.', 'propriedade': 'cobr.calendario' 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'titdata: {
. idRec (string)
. infoAdicional (string)
. calendario (object)
. valor (object)
. ajusteDiaUtil (boolean)
. recebedor (object)
. devedor (object)
} (object) required
pix/get_cobrEndpoint para consultar cobranças recorrentes através de parâmetros como início, fim, idRec, cpf, cnpj e status. brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrainicio (string) required
fim (string) required
idRec (string)
cpf (string)
cnpj (string)
status (string)
convenio (string)
paginacao.paginaAtual (integer)
paginacao.itensPorPagina (integer)
pix/get_lotecobvEndpoint para consultar lista de lotes de cobranças com vencimento. brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrada.' 'correlationId': 'API-BB-3x3mpl01-3b3inicio (string) required
fim (string) required
paginacao.paginaAtual (integer)
paginacao.itensPorPagina (integer)
pix/post_cobEndpoint para criar uma cobrança imediata, neste caso, o txid deve ser definido pelo PSP. brbrResponsesbr br 400br 'type': 'https://api.bb.com.br/api/v2/error/CobOperacaoInvalida', 'title': 'Cobrança inválida.', 'status': 400, 'detail': 'A requisição que busca alterar ou criar uma cobrança para pagamento imediato não respeita o schema ou está semanticamente errada.', 'violacoes': 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acessodata: {
. calendario (object)
. devedor (object)
. loc (object)
. valor (object)
. chave (string)
. solicitacaoPagador (string)
. infoAdicionais (array)
} (object) required
pix/get_cobEndpoint para consultar cobranças imediatas através de parâmetros como início, fim, cpf, cnpj e status. brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontradainicio (string) required
fim (string) required
cpf (string)
cnpj (string)
locationPresente (boolean)
status (string)
paginacao.paginaAtual (integer)
paginacao.itensPorPagina (integer)
pix/get_locrec_by_idEndpoint utilizado para recuperar location do payload. brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrada.' 'correlationId': 'API-BB-3x3mpl01-3b3f-4997-8c8b-id (string)
pix/get_pix_by_e2eidEndpoint para consultar um Pix através de um e2eid brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrada.' 'correlationId': 'API-BB-3x3mpl01-3b3f-4997-8c8e2eid (string)
pix/patch_solicrec_by_id_solic_recEndpoint utilizado para revisar solicitação de confirmação de recorrência. brbrResponsesbr br 400br 'type': 'https://pix.bcb.gov.br/api/v2/error/SolicRecOperacaoInvalida', 'title': 'Operação inválida.', 'status': 400, 'detail': 'Não é possível cancelar uma solicitação de recorrência com o status diferente de CRIADA ou RECEBIDA.' 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participanteidSolicRec (string)
data: {
. status (string)
} (object) required
pix/get_solicrec_by_id_solic_recEndpoint utilizado para consultar solicitação de confirmação de recorrência. brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrada.' 'correlationId': 'API-BB-3xidSolicRec (string)
pix/get_webhookrecEndpoint para recuperação de informações sobre o Webhook. brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrada.' 'correlationId': 'API-BB-3x3mpl01-3b3f-4997-8cNo parameters
pix/delete_webhookrecEndpoint para cancelamento do webhook. Não é a única forma pela qual um webhook pode ser removido. brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrada.' 'corrNo parameters
pix/put_webhookrecEndpoint para configuração do serviço de notificações acerca de recorrências. Somente recorrências associadas a chave e conta serão notificadas. brbrResponsesbr br 400br 'type': 'https://api.bb.com.br/api/v2/error/WebhookOperacaoInvalida', 'title': 'Webhook inválido.', 'status': 400, 'detail': 'A presente requisição busca criar um webhook sem respeitar o schema ou, ainda, com sentido semanticamente inválido.' 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado',data: {
. webhookUrl (string)
} (object) required
pix/get_pix_bbConsulta Pix recebidos, incluindo filtro por chave e filtro por existência de contestação. brbrResponsesbr br 403br 'type': 'https://api.bb.com.br/api/v2/error/AcessoNegado', 'title': 'Acesso Negado', 'status': 403, 'detail': 'Requisição de participante autenticado que viola alguma regra de autorização.' 404br 'type': 'https://api.bb.com.br/api/v2/error/NaoEncontrado', 'title': 'Não Encontrado', 'status': 404, 'detail': 'Entidade não encontrada.', 'correinicio (string)
fim (string)
txid (string)
txIdPresente (boolean)
devolucaoPresente (boolean)
contestacaoPresente (boolean)
cpf (string)
cnpj (string)
chave (string)
paginacao.paginaAtual (integer)
paginacao.itensPorPagina (integer)
seguro_credito_protegido/post_acessos_tokenRealiza a geração do token de acesso da BB corretora, para garantir o devido acesso aos serviços do portal do desenvolvedor.data: {
. codigoBalcaoVenda (number)
. codigoCanalVendaBalcao (number)
. codigoSecaoAtendimento (string)
. numeroTipoPessoa (number)
. textoCpfCadastroNacPessoasJuridicas (string)
} (object) required
seguro_credito_protegido/post_cotacoes_emissaobr/ bBRASIL_SEG - /emissao/cotacao/v1/b br/ br/ Para iniciar o fluxo de contratação da cotação é necessário informar obrigatóriamente o canal, meio canal, ponto de venda e o grupo de produto, e caso já possua os dados do proponente e ou número da oferta já pode informar nos repectivos campos, conforme exemplo. br/ br/ iCaso o número da oferta for informado nessa etapa, a etapa de selecionar a oferta não é necessária./i br/data: {
. canal (object)
. meioCanal (object)
. pontoVenda (object)
. nrGrupoProduto (string)
. nrOferta (number)
. proponente (object)
} (object) required
seguro_credito_protegido/post_cotacoes_ofertabr/ bBRASIL_SEG - /emissao/cotacao/v0/oferta/b br/ br/ Registra qual foi a oferta selecionada para a cotação. br/data: {
. localizadorCotacao (string)
. nmIdentificadorOferta (string)
} (object) required
seguro_credito_protegido/post_cotacoes_proponentebr/ bBRASIL_SEG - /emissao/cotacao/v0/proponente/b br/ br/ Grava o proponente na cotação. br/ br/ b Para testar a inclusão é necessário alterar os dados do proponente na requisição de exemplo./bdata: {
. localizadorCotacao (string)
. proponente (object)
} (object) required
seguro_credito_protegido/put_cotacoes_proponentebr/ bBRASIL_SEG - /emissao/cotacao/v0/proponente/b br/ br/ Atualiza o proponente na cotação. br /data: {
. localizadorCotacao (string)
. proponente (object)
} (object) required
seguro_credito_protegido/delete_cotacoes_proponentebr/ bBRASIL_SEG - /emissao/cotacao/v0/proponente/b br/ br/ Realiza a Exclusão do proponente da cotação.data: {
. localizadorCotacao (string)
. nmCpfCnpj (string)
} (object) required
seguro_credito_protegido/post_cotacoes_objeto_seguradobr/ bBRASIL_SEG - /emissao/cotacao/v0/objetosegurado/b br/ br/ Grava um objeto segurado de acordo com as resposta do questionário. br/ br/ iPara obter o questionário que deve ser respondido, é necessário buscar no response do último serviço executado, seguindo as etapas abaixo: br / i 1 - Localizar na lista de oferta a oferta selecionada. br / i 2 - A partir da estrutura json da oferta selecionada, é necessário localizar a lista de chassi e varrer cada item da lista br / i 3 - A partir da estrudata: {
. localizadorCotacao (string)
. nmIdentificadorChassi (string)
. objetoSegurado (object)
} (object) required
seguro_credito_protegido/put_cotacoes_objeto_seguradobr/ bBRASIL_SEG - /emissao/cotacao/v0/objetosegurado/b br/ br/ Altera um objeto segurado de acordo com as resposta do questionário. br/ br/ iPara obter o questionário que deve ser respondido, é necessário buscar no response do último serviço executado, seguindo as etapas abaixo: br / i 1 - Localizar na lista de oferta a oferta selecionada. br / i 2 - A partir da estrutura json da oferta selecionada, é necessário localizar a lista de chassi e varrer cada item da lista br / i 3 - A partir da estrdata (undefined) required
seguro_credito_protegido/post_cotacoes_planobr/ bBRASIL_SEG - /emissao/cotacao/v1/plano/b br/ br/ Registra qual foi o plano selecionado para cada tipo de objeto segurado. br/ b O plano deve ser selecionado de acordo com o objeto segurado que foi cotadob/ br/ br/ i Para obter número do tipo do objeto seguradobnrTipoObjetoSegurado/b é só recuperar da raiz do item da lista de questionário que vai ser respondido. br / br / iPara o campo identificador do planobnmIdentificadorPlano/b, busque a oferta selecionada na lista de ofertablsOferta/b dadata: {
. localizadorCotacao (string)
. nmIdentificadorPlano (string)
. nrTipoObjetoSegurado (string)
} (object) required
seguro_credito_protegido/post_cotacoes_periodicidadebr/ bBRASIL_SEG - /emissao/cotacao/v1/periodicidade/b br/ br/ Serviço para registrar qual é a periodicidade de contratação do seguro, ou seja, por quanto tempo aquele seguro estará vigente para o segurado. br / br / iPara o campo quantidade da periodicidadebqtPeriodicidade/b será aceito somente valores que estiver configurado no chassiblsChassi/b da ofertablsOferta/b selecionado. br / br / iPara o campo identificador da periodicidadebnmIdentificadorPeriodicidade/b, busque a oferta selecionada ndata: {
. localizadorCotacao (string)
. nmIdentificadorChassi (string)
. qtPeriodicidade (number)
. nmIdentificadorPeriodicidade (string)
} (object) required
seguro_credito_protegido/post_contratacoes_plano_pagamentobr/ bBRASIL_SEG - /emissao/cotacao/v0/planopagamento/b br/ br/ Registra qual foi o plano de pagamento selecionado para a cotação. br / br / iPara o campo identificador do plano de pagamentobnmIdentificadorPlanoPagamento/b, busque a oferta selecionada na lista de ofertablsOferta/b da cotação, depois busque na raiz do item da oferta selecionado a lista de plano de pagamentoblsPlanoPagamento/bdata: {
. localizadorCotacao (string)
. nmIdentificadorPlanoPagamento (string)
} (object) required
seguro_credito_protegido/post_contratacoes_plano_pagamento_parcelamentobr/ bBRASIL_SEG - /emissao/cotacao/planopagamento/parcelamento/b br/ br/ Seleciona um parcelamento disponível para o plano de pagamento escolhido. br / br / iPara o campo identificador da parcelabnmIdentificadorParcela/b, busque a oferta selecionada na lista de ofertablsOferta/b da cotação, depois busque na raiz do item da oferta selecionado a lista de plano de pagamentoblsPlanoPagamento/b e busque pelo plano de pagamento selecionado, com item do plano de pagamento selecionado busque na raiz a ldata: {
. localizadorCotacao (string)
. nmIdentificadorParcela (string)
. nrDiaVencimento (integer)
} (object) required
seguro_credito_protegido/post_contratacoes_de_acordobr/ bBRASIL_SEG - /emissao/cotacao/v0/deacordo/b br/ br/ Registra na cotação o 'de acordo' do cliente titular.data: {
. localizadorCotacao (string)
} (object) required
seguro_credito_protegido/get_contratacoes_bandeira_cartaobr/ bBRASIL_SEG - /financeiro/dadobasico/bandeiraCartao/b br/ br/ Lista as bandeirdas de cartões com seus respectivos códigos. br /No parameters
seguro_credito_protegido/post_contratacoes_contrato_cobrancabr/ bBRASIL_SEG - /emissao/cotacao/v0/contrato-cobranca/b br/ br/ Efetiva a cobrança da cotação. br / br / i A chave bdadoCartaoCredito/b deve ser preenchida de acordo com o plano de pagamento escolhido. br/ b A opção de débito em conta não está habilitada/bdata: {
. localizadorCotacao (string)
. dadoCartaoCredito (object)
. dadoDebitoConta (object)
} (object) required
seguro_credito_protegido/get_consultas_pdf_propostabr/ bBRASIL_SEG - /emissao/cotacao/pdf/nmIdentificadorPdf/b br/ br/ Lista as bandeirdas de cartões com seus respectivos códigos. br /No parameters
seguro_de_itens_pessoais/post_acessos_tokenRealiza a geração do token de acesso da BB corretora, para garantir o devido acesso aos serviços do portal do desenvolvedor.data: {
. codigoBalcaoVenda (number)
. codigoCanalVendaBalcao (number)
. codigoSecaoAtendimento (string)
. numeroTipoPessoa (number)
. textoCpfCadastroNacPessoasJuridicas (string)
} (object) required
seguro_de_itens_pessoais/post_cotacoes_emissaobr/ bBRASIL_SEG - /emissao/cotacao/v0/b br/ br/ Iniciar a cotação recebendo a modalidade e ou os dados de proponente. Será gerado o identificador da cotação, será gerado o número e versão da cotação e será solicitado para API de oferta quais as melhores ofertas para o perfil do solicitante, ou para o canal/meio de canal que foi iniciado a cotação. br/data: {
. canal (object)
. meioCanal (object)
. nrGrupoProduto (string)
. pontoVenda (object)
} (object) required
seguro_de_itens_pessoais/post_cotacoes_ofertabr/ bBRASIL_SEG - /emissao/cotacao/v0/oferta/b br/ br/ Registra qual foi a oferta selecionada para a cotação. br/data: {
. localizadorCotacao (string)
. nmIdentificadorOferta (string)
} (object) required
seguro_de_itens_pessoais/post_cotacoes_objeto_segurado_bolsabr/ bBRASIL_SEG - /emissao/cotacao/v1/objetosegurado/b br/ br/ Grava um objeto segurado de acordo com as resposta do questionário. br/ br/ iPara obter o questionário que deve ser respondido, é necessário buscar no response do último serviço executado, seguindo as etapas abaixo: br / i 1 - Localizar na lista de oferta a oferta selecionada. br / i 2 - A partir da estrutura json da oferta selecionada, é necessário localizar a lista de chassi e varrer cada item da lista br / i 3 - A partir da estrudata: {
. localizadorCotacao (string)
. nmIdentificadorChassi (string)
. nrTipoObjetoSegurado (string)
. objetoSegurado (object)
} (object) required
seguro_de_itens_pessoais/put_cotacoes_objeto_segurado_bolsabr/ bBRASIL_SEG - /emissao/cotacao/v1/objetosegurado/b br/ br/ Altera um objeto segurado de acordo com as resposta do questionário. br/ br/ iPara obter o questionário que deve ser respondido, é necessário buscar no response do último serviço executado, seguindo as etapas abaixo: br / i 1 - Localizar na lista de oferta a oferta selecionada. br / i 2 - A partir da estrutura json da oferta selecionada, é necessário localizar a lista de chassi e varrer cada item da lista br / i 3 - A partir da estrdata (undefined) required
seguro_de_itens_pessoais/post_cotacoes_objeto_segurado_contabr/ bBRASIL_SEG - /emissao/cotacao/v1/objetosegurado/b br/ br/ Grava um objeto segurado de acordo com as resposta do questionário. br/ br/ iPara obter o questionário que deve ser respondido, é necessário buscar no response do último serviço executado, seguindo as etapas abaixo: br / i 1 - Localizar na lista de oferta a oferta selecionada. br / i 2 - A partir da estrutura json da oferta selecionada, é necessário localizar a lista de chassi e varrer cada item da lista br / i 3 - A partir da estrudata: {
. localizadorCotacao (string)
. nmIdentificadorChassi (string)
. nrTipoObjetoSegurado (string)
. objetoSegurado (object)
} (object) required
seguro_de_itens_pessoais/put_cotacoes_objeto_segurado_contabr/ bBRASIL_SEG - /emissao/cotacao/v1/objetosegurado/b br/ br/ Altera um objeto segurado de acordo com as resposta do questionário. br/ br/ iPara obter o questionário que deve ser respondido, é necessário buscar no response do último serviço executado, seguindo as etapas abaixo: br / i 1 - Localizar na lista de oferta a oferta selecionada. br / i 2 - A partir da estrutura json da oferta selecionada, é necessário localizar a lista de chassi e varrer cada item da lista br / i 3 - A partir da estrdata (undefined) required
seguro_de_itens_pessoais/post_cotacoes_proponentebr/ bBRASIL_SEG - /emissao/cotacao/v0/proponente/b br/ br/ Grava o proponente na cotação. br/ br/ b Para testar a inclusão é necessário alterar os dados do proponente na requisição de exemplo./bdata: {
. localizadorCotacao (string)
. proponente (object)
} (object) required
seguro_de_itens_pessoais/put_cotacoes_proponentebr/ bBRASIL_SEG - /emissao/cotacao/v0/proponente/b br/ br/ Atualiza o proponente na cotação. br /data: {
. localizadorCotacao (string)
. proponente (object)
} (object) required
seguro_de_itens_pessoais/delete_cotacoes_proponentebr/ bBRASIL_SEG - /emissao/cotacao/v0/proponente/b br/ br/ Realiza a exclusão do proponente da cotação.data: {
. localizadorCotacao (string)
. nmCpfCnpj (string)
} (object) required
seguro_de_itens_pessoais/post_cotacoes_plano_bolsabr/ bBRASIL_SEG - /emissao/cotacao/v1/plano/b br/ br/ Registra qual foi o plano selecionado para cada tipo de objeto segurado. br/ b O plano deve ser selecionado de acordo com o objeto segurado que foi cotadob/ br/ br/ i Para obter número do tipo do objeto seguradobnrTipoObjetoSegurado/b é só recuperar da raiz do item da lista de questionário que vai ser respondido. br / br / iPara o campo identificador do planobnmIdentificadorPlano/b, busque a oferta selecionada na lista de ofertablsOferta/b dadata: {
. localizadorCotacao (string)
. nmIdentificadorPlano (string)
. nrTipoObjetoSegurado (string)
} (object) required
seguro_de_itens_pessoais/post_cotacoes_plano_contabr/ bBRASIL_SEG - /emissao/cotacao/v1/plano/b br/ br/ Registra qual foi o plano selecionado para cada tipo de objeto segurado. br/ b O plano deve ser selecionado de acordo com o objeto segurado que foi cotadob/ br/ br/ i Para obter número do tipo do objeto seguradobnrTipoObjetoSegurado/b é só recuperar da raiz do item da lista de questionário que vai ser respondido. br / br / iPara o campo identificador do planobnmIdentificadorPlano/b, busque a oferta selecionada na lista de ofertablsOferta/b dadata: {
. localizadorCotacao (string)
. nmIdentificadorPlano (string)
. nrTipoObjetoSegurado (string)
} (object) required
seguro_de_itens_pessoais/post_cotacoes_periodicidadebr/ bBRASIL_SEG - /emissao/cotacao/v1/periodicidade/b br/ br/ Serviço para registrar qual é a periodicidade de contratação do seguro, ou seja, por quanto tempo aquele seguro estará vigente para o segurado. br / br / iPara o campo quantidade da periodicidadebqtPeriodicidade/b será aceito somente valores que estiver configurado no chassiblsChassi/b da ofertablsOferta/b selecionado. br / br / iPara o campo identificador da periodicidadebnmIdentificadorPeriodicidade/b, busque a oferta selecionada ndata: {
. localizadorCotacao (string)
. nmIdentificadorChassi (string)
. qtPeriodicidade (number)
. nmIdentificadorPeriodicidade (string)
. dtInicioPeriodicidade (string)
} (object) required
seguro_de_itens_pessoais/post_contratacoes_de_acordobr/ bBRASIL_SEG - /emissao/cotacao/v0/deacordo/b br/ br/ Registra na cotação o 'de acordo' do cliente titular.data: {
. localizadorCotacao (string)
} (object) required
seguro_de_itens_pessoais/post_contratacoes_plano_pagamentobr/ bBRASIL_SEG - /emissao/cotacao/v0/planopagamento/b br/ br/ Registra qual foi o plano de pagamento selecionado para a cotação. br / br / iPara o campo identificador do plano de pagamentobnmIdentificadorPlanoPagamento/b, busque a oferta selecionada na lista de ofertablsOferta/b da cotação, depois busque na raiz do item da oferta selecionado a lista de plano de pagamentoblsPlanoPagamento/bdata: {
. localizadorCotacao (string)
. nmIdentificadorPlanoPagamento (string)
} (object) required
seguro_de_itens_pessoais/post_contratacoes_plano_pagamento_parcelamentobr/ bBRASIL_SEG - /emissao/cotacao/planopagamento/parcelamento/b br/ br/ Seleciona um parcelamento disponível para o plano de pagamento escolhido. br / br / iPara o campo identificador da parcelabnmIdentificadorParcela/b, busque a oferta selecionada na lista de ofertablsOferta/b da cotação, depois busque na raiz do item da oferta selecionado a lista de plano de pagamentoblsPlanoPagamento/b e busque pelo plano de pagamento selecionado, com item do plano de pagamento selecionado busque na raiz a ldata: {
. localizadorCotacao (string)
. nmIdentificadorParcela (string)
. nrDiaVencimento (integer)
} (object) required
seguro_de_itens_pessoais/get_contratacoes_bandeira_cartaobr/ bBRASIL_SEG - /financeiro/dadobasico/bandeiraCartao/b br/ br/ Lista as bandeirdas de cartões com seus respectivos códigos. br /No parameters
seguro_de_itens_pessoais/post_contratacoes_contrato_cobrancabr/ bBRASIL_SEG - /emissao/cotacao/v0/contrato-cobranca/b br/ br/ Efetiva a cobrança da cotação. br / br / i A chave bdadoCartaoCredito/b deve ser preenchida de acordo com o plano de pagamento escolhido. br/ b A opção de débito em conta não está habilitada/bdata: {
. localizadorCotacao (string)
. dadoCartaoCredito (object)
. dadoDebitoConta (object)
} (object) required
seguro_de_itens_pessoais/get_consultas_pdf_propostabr/ bBRASIL_SEG - /emissao/cotacao/pdf/nmIdentificadorPdf/b br/ br/ Lista as bandeirdas de cartões com seus respectivos códigos. br /No parameters
seguro_empresarial/post_acessos_tokenRealiza a geração do token de acesso da BB corretora, para garantir o devido acesso aos serviços do portal do desenvolvedor.data: {
. codigoBalcaoVenda (number)
. codigoCanalVendaBalcao (number)
. codigoSecaoAtendimento (string)
. numeroTipoPessoa (number)
. textoCpfCadastroNacPessoasJuridicas (string)
} (object) required
seguro_empresarial/post_empresarial_cotacoes_emissaobr/ bBRASIL_SEG - /emissao/cotacao/v0/b br/ br/ Iniciar a cotação recebendo a modalidade e ou os dados de proponente. Será gerado o identificador da cotação, será gerado o número e versão da cotação e será solicitado para API de oferta quais as melhores ofertas para o perfil do solicitante, ou para o canal/meio de canal que foi iniciado a cotação. br/data: {
. canal (object)
. meioCanal (object)
. pontoVenda (object)
} (object) required
seguro_empresarial/post_cotacoes_ofertabr/ bBRASIL_SEG - /emissao/cotacao/v0/oferta/b br/ br/ Registra qual foi a oferta selecionada para a cotação. br/data: {
. localizadorCotacao (string)
. nmIdentificadorOferta (string)
} (object) required
seguro_empresarial/post_cotacoes_objeto_seguradobr/ bBRASIL_SEG - /emissao/cotacao/v1/objetosegurado/b br/ br/ Grava um objeto segurado de acordo com as resposta do questionário. br/ br/ iPara obter o questionário que deve ser respondido, é necessário buscar no response do último serviço executado, seguindo as etapas abaixo: br / i 1 - Localizar na lista de oferta a oferta selecionada. br / i 2 - A partir da estrutura json da oferta selecionada, é necessário localizar a lista de chassi e varrer cada item da lista br / i 3 - A partir da estrudata: {
. localizadorCotacao (string)
. nmIdentificadorChassi (string)
. nrTipoObjetoSegurado (string)
. objetoSegurado (object)
} (object) required
seguro_empresarial/put_cotacoes_objeto_seguradobr/ bBRASIL_SEG - /emissao/cotacao/v1/objetosegurado/b br/ br/ Altera um objeto segurado de acordo com as resposta do questionário. br/ br/ iPara obter o questionário que deve ser respondido, é necessário buscar no response do último serviço executado, seguindo as etapas abaixo: br / i 1 - Localizar na lista de oferta a oferta selecionada. br / i 2 - A partir da estrutura json da oferta selecionada, é necessário localizar a lista de chassi e varrer cada item da lista br / i 3 - A partir da estrdata (undefined) required
seguro_empresarial/delete_cotacoes_objeto_seguradobr/ bBRASIL_SEG - /emissao/cotacao/v1/objetosegurado/b br/ br/ Exclui um objeto segurado de acordo com as resposta do questionário. br/ br/ iPara obter o questionário que deve ser respondido, é necessário buscar no response do último serviço executado, seguindo as etapas abaixo: br / i 1 - Localizar na lista de oferta a oferta selecionada. br / i 2 - A partir da estrutura json da oferta selecionada, é necessário localizar a lista de chassi e varrer cada item da lista br / i 3 - A partir da estrdata: {
. localizadorCotacao (string)
. nmIdentificadorObjetoSegurado (string)
} (object) required
seguro_empresarial/post_cotacoes_proponentebr/ bBRASIL_SEG - /emissao/cotacao/v0/proponente/b br/ br/ Grava o proponente na cotação. br/ br/ b Para testar a inclusão é necessário alterar os dados do proponente na requisição de exemplo./bdata: {
. localizadorCotacao (string)
. proponente (object)
} (object) required
seguro_empresarial/put_cotacoes_proponentebr/ bBRASIL_SEG - /emissao/cotacao/v0/proponente/b br/ br/ Atualiza o proponente na cotação. br /data: {
. localizadorCotacao (string)
. proponente (object)
} (object) required
seguro_empresarial/delete_cotacoes_proponentebr/ bBRASIL_SEG - /emissao/cotacao/v0/proponente/b br/ br/ Realiza a Exclusão do proponente da cotação.data: {
. localizadorCotacao (string)
. nmCpfCnpj (string)
} (object) required
seguro_empresarial/post_cotacoes_planobr/ bBRASIL_SEG - /emissao/cotacao/v1/plano/b br/ br/ Registra qual foi o plano selecionado para cada tipo de objeto segurado. br/ b O plano deve ser selecionado de acordo com o objeto segurado que foi cotadob/ br/ br/ i Para obter número do tipo do objeto seguradobnrTipoObjetoSegurado/b é só recuperar da raiz do item da lista de questionário que vai ser respondido. br / br / iPara o campo identificador do planobnmIdentificadorPlano/b, busque a oferta selecionada na lista de ofertablsOferta/b dadata: {
. localizadorCotacao (string)
. nmIdentificadorPlano (string)
. nrTipoObjetoSegurado (string)
} (object) required
seguro_empresarial/post_cotacoes_periodicidadebr/ bBRASIL_SEG - /emissao/cotacao/v1/periodicidade/b br/ br/ Serviço para registrar qual é a periodicidade de contratação do seguro, ou seja, por quanto tempo aquele seguro estará vigente para o segurado. br / br / iPara o campo quantidade da periodicidadebqtPeriodicidade/b será aceito somente valores que estiver configurado no chassiblsChassi/b da ofertablsOferta/b selecionado. br / br / iPara o campo identificador da periodicidadebnmIdentificadorPeriodicidade/b, busque a oferta selecionada ndata: {
. localizadorCotacao (string)
. nmIdentificadorChassi (string)
. qtPeriodicidade (number)
. nmIdentificadorPeriodicidade (string)
. dtInicioPeriodicidade (string)
} (object) required
seguro_empresarial/post_contratacoes_de_acordobr/ bBRASIL_SEG - /emissao/cotacao/v0/deacordo/b br/ br/ Registra na cotação o 'de acordo' do cliente titular.data: {
. localizadorCotacao (string)
} (object) required
seguro_empresarial/post_contratacoes_plano_pagamentobr/ bBRASIL_SEG - /emissao/cotacao/v0/planopagamento/b br/ br/ Registra qual foi o plano de pagamento selecionado para a cotação. br / br / iPara o campo identificador do plano de pagamentobnmIdentificadorPlanoPagamento/b, busque a oferta selecionada na lista de ofertablsOferta/b da cotação, depois busque na raiz do item da oferta selecionado a lista de plano de pagamentoblsPlanoPagamento/bdata: {
. localizadorCotacao (string)
. nmIdentificadorPlanoPagamento (string)
} (object) required
seguro_empresarial/post_contratacoes_plano_pagamento_parcelamentobr/ bBRASIL_SEG - /emissao/cotacao/v0/planopagamento/parcelamento/b br/ br/ Seleciona um parcelamento disponível para o plano de pagamento escolhido. br / br / iPara o campo identificador da parcelabnmIdentificadorParcela/b, busque a oferta selecionada na lista de ofertablsOferta/b da cotação, depois busque na raiz do item da oferta selecionado a lista de plano de pagamentoblsPlanoPagamento/b e busque pelo plano de pagamento selecionado, com item do plano de pagamento selecionado busque na raizdata: {
. localizadorCotacao (string)
. nmIdentificadorParcela (string)
} (object) required
seguro_empresarial/get_contratacoes_bandeira_cartaobr/ bBRASIL_SEG - /financeiro/dadobasico/bandeiraCartao/b br/ br/ Lista as bandeirdas de cartões com seus respectivos códigos. br /No parameters
seguro_empresarial/post_contratacoes_contrato_cobrancabr/ bBRASIL_SEG - /emissao/cotacao/v0/contrato-cobranca/b br/ br/ Efetiva a cobrança da cotação. br / br / i A chave bdadoCartaoCredito/b deve ser preenchida de acordo com o plano de pagamento escolhido. br/ b A opção de debito em conta não esta habilitada/bdata: {
. localizadorCotacao (string)
. dadoCartaoCredito (object)
. dadoDebitoConta (object)
} (object) required
seguro_empresarial/get_consultas_pdf_propostabr/ bBRASIL_SEG - /emissao/cotacao/pdf/nmIdentificadorPdf/b br/ br/ Lista as bandeirdas de cartões com seus respectivos códigos. br /No parameters
seguro_protecao_pessoal/post_acessos_tokenRealiza a geração do token de acesso da BB corretora, para garantir o devido acesso aos serviços do portal do desenvolvedor.data: {
. codigoBalcaoVenda (number)
. codigoCanalVendaBalcao (number)
. codigoSecaoAtendimento (string)
. numeroTipoPessoa (number)
. textoCpfCadastroNacPessoasJuridicas (string)
} (object) required
seguro_protecao_pessoal/post_cotacoes_emissaobr/ bBRASIL_SEG - /emissao/cotacao/v1/b br/ br/ Para iniciar o fluxo de contratação da cotação é necessário informar obrigatóriamente o canal, meio canal, ponto de venda e o grupo de produto, e caso já possua os dados do proponente e ou número da oferta já pode informar nos repectivos campos, conforme exemplo. br/ br/ iCaso o número da oferta for informado nessa etapa, a etapa de selecionar a oferta não é necessária./i br/data: {
. canal (object)
. meioCanal (object)
. pontoVenda (object)
. nrGrupoProduto (string)
. nrOferta (number)
. proponente (object)
} (object) required
seguro_protecao_pessoal/post_cotacoes_ofertabr/ bBRASIL_SEG - /emissao/cotacao/v0/oferta/b br/ br/ Registra qual foi a oferta selecionada para a cotação. br/data: {
. localizadorCotacao (string)
. nmIdentificadorOferta (string)
} (object) required
seguro_protecao_pessoal/post_cotacoes_proponentebr/ bBRASIL_SEG - /emissao/cotacao/v1/proponente/b br/ br/ Grava o proponente na cotação. br/ br/ b Para testar a inclusão é necessário alterar os dados do proponente na requisição de exemplo./bdata: {
. localizadorCotacao (string)
. proponente (object)
} (object) required
seguro_protecao_pessoal/put_cotacoes_proponentebr/ bBRASIL_SEG - /emissao/cotacao/v1/proponente/b br/ br/ Atualiza o proponente na cotação. br /data: {
. localizadorCotacao (string)
. proponente (object)
} (object) required
seguro_protecao_pessoal/delete_cotacoes_proponentebr/ bBRASIL_SEG - /emissao/cotacao/v1/proponente/b br/ br/ Realiza a Exclusão do proponente da cotação.data: {
. localizadorCotacao (string)
. nmCpfCnpj (string)
} (object) required
seguro_protecao_pessoal/post_cotacoes_objeto_seguradobr/ bBRASIL_SEG - /emissao/cotacao/v0/objetosegurado/b br/ br/ Grava um objeto segurado de acordo com as resposta do questionário. br/ br/ iPara obter o questionário que deve ser respondido, é necessário buscar no response do último serviço executado, seguindo as etapas abaixo: br / i 1 - Localizar na lista de oferta a oferta selecionada. br / i 2 - A partir da estrutura json da oferta selecionada, é necessário localizar a lista de chassi e varrer cada item da lista br / i 3 - A partir da estrudata: {
. localizadorCotacao (string)
. nmIdentificadorChassi (string)
. objetoSegurado (object)
} (object) required
seguro_protecao_pessoal/put_cotacoes_objeto_seguradobr/ bBRASIL_SEG - /emissao/cotacao/v0/objetosegurado/b br/ br/ Altera um objeto segurado de acordo com as resposta do questionário. br/ br/ iPara obter o questionário que deve ser respondido, é necessário buscar no response do último serviço executado, seguindo as etapas abaixo: br / i 1 - Localizar na lista de oferta a oferta selecionada. br / i 2 - A partir da estrutura json da oferta selecionada, é necessário localizar a lista de chassi e varrer cada item da lista br / i 3 - A partir da estrdata (undefined) required
seguro_protecao_pessoal/post_cotacoes_planobr/ bBRASIL_SEG - /emissao/cotacao/v1/plano/b br/ br/ Registra qual foi o plano selecionado para cada tipo de objeto segurado. br/ b O plano deve ser selecionado de acordo com o objeto segurado que foi cotadob/ br/ br/ i Para obter número do tipo do objeto seguradobnrTipoObjetoSegurado/b é só recuperar da raiz do item da lista de questionário que vai ser respondido. br / br / iPara o campo identificador do planobnmIdentificadorPlano/b, busque a oferta selecionada na lista de ofertablsOferta/b dadata: {
. localizadorCotacao (string)
. nmIdentificadorPlano (string)
. nrTipoObjetoSegurado (string)
} (object) required
seguro_protecao_pessoal/post_cotacoes_periodicidadebr/ bBRASIL_SEG - /emissao/cotacao/v1/periodicidade/b br/ br/ Serviço para registrar qual é a periodicidade de contratação do seguro, ou seja, por quanto tempo aquele seguro estará vigente para o segurado. br / br / iPara o campo quantidade da periodicidadebqtPeriodicidade/b será aceito somente valores que estiver configurado no chassiblsChassi/b da ofertablsOferta/b selecionado. br / br / iPara o campo identificador da periodicidadebnmIdentificadorPeriodicidade/b, busque a oferta selecionada ndata: {
. localizadorCotacao (string)
. qtPeriodicidade (number)
. nmIdentificadorPeriodicidade (string)
} (object) required
seguro_protecao_pessoal/post_contratacoes_plano_pagamentobr/ bBRASIL_SEG - /emissao/cotacao/v0/planopagamento/b br/ br/ Registra qual foi o plano de pagamento selecionado para a cotação. br / br / iPara o campo identificador do plano de pagamentobnmIdentificadorPlanoPagamento/b, busque a oferta selecionada na lista de ofertablsOferta/b da cotação, depois busque na raiz do item da oferta selecionado a lista de plano de pagamentoblsPlanoPagamento/bdata: {
. localizadorCotacao (string)
. nmIdentificadorPlanoPagamento (string)
} (object) required
seguro_protecao_pessoal/post_contratacoes_plano_pagamento_parcelamentobr/ bBRASIL_SEG - /emissao/cotacao/planopagamento/parcelamento/b br/ br/ Seleciona um parcelamento disponível para o plano de pagamento escolhido. br / br / iPara o campo identificador da parcelabnmIdentificadorParcela/b, busque a oferta selecionada na lista de ofertablsOferta/b da cotação, depois busque na raiz do item da oferta selecionado a lista de plano de pagamentoblsPlanoPagamento/b e busque pelo plano de pagamento selecionado, com item do plano de pagamento selecionado busque na raiz a ldata: {
. localizadorCotacao (string)
. nmIdentificadorParcela (string)
. nrDiaVencimento (integer)
} (object) required
seguro_protecao_pessoal/post_contratacoes_de_acordobr/ bBRASIL_SEG - /emissao/cotacao/v0/deacordo/b br/ br/ Registra na cotação o 'de acordo' do cliente titular.data: {
. localizadorCotacao (string)
} (object) required
seguro_protecao_pessoal/get_contratacoes_bandeira_cartaobr/ bBRASIL_SEG - /financeiro/dadobasico/bandeiraCartao/b br/ br/ Lista as bandeirdas de cartões com seus respectivos códigos. br /No parameters
seguro_protecao_pessoal/post_contratacoes_contrato_cobrancabr/ bBRASIL_SEG - /emissao/cotacao/v0/contrato-cobranca/b br/ br/ Efetiva a cobrança da cotação. br / br / i A chave bdadoCartaoCredito/b deve ser preenchida de acordo com o plano de pagamento escolhido. br/ b A opção de débito em conta não está habilitada/bdata: {
. localizadorCotacao (string)
. dadoCartaoCredito (object)
} (object) required
seguro_protecao_pessoal/get_consultas_pdf_propostabr/ bBRASIL_SEG - /emissao/cotacao/pdf/nmIdentificadorPdf/b br/ br/ Lista as bandeirdas de cartões com seus respectivos códigos. br /No parameters
seguro_residencial/post_acessos_tokenRealiza a geração do token de acesso da BB corretora, para garantir o devido acesso aos serviços do portal do desenvolvedor.data: {
. codigoBalcaoVenda (number)
. codigoCanalVendaBalcao (number)
. codigoSecaoAtendimento (string)
. numeroTipoPessoa (number)
. textoCpfCadastroNacPessoasJuridicas (string)
} (object) required
seguro_residencial/post_cotacoes_emissaobr/ bBRASIL_SEG - /emissao/cotacao/v1/b br/ br/ Iniciar a cotação recebendo a modalidade e ou os dados de proponente. Será gerado o identificador da cotação, será gerado o número e versão da cotação e será solicitado para API de oferta quais as melhores ofertas para o perfil do solicitante, ou para o canal/meio de canal que foi iniciado a cotação. br/data: {
. canal (object)
. meioCanal (object)
. pontoVenda (object)
. nrGrupoProduto (string)
. nrOferta (number)
. proponente (object)
} (object) required
seguro_residencial/post_cotacoes_ofertabr/ bBRASIL_SEG - /emissao/cotacao/v0/oferta/b br/ br/ Registra qual foi a oferta selecionada para a cotação. br/data: {
. localizadorCotacao (string)
. nmIdentificadorOferta (string)
} (object) required
seguro_residencial/post_cotacoes_objeto_seguradobr/ bBRASIL_SEG - /emissao/cotacao/v1/objetosegurado/b br/ br/ Grava um objeto segurado de acordo com as resposta do questionário. br/ br/ iPara obter o questionário que deve ser respondido, é necessário buscar no response do último serviço executado, seguindo as etapas abaixo: br / i 1 - Localizar na lista de oferta a oferta selecionada. br / i 2 - A partir da estrutura json da oferta selecionada, é necessário localizar a lista de chassi e varrer cada item da lista br / i 3 - A partir da estrudata: {
. localizadorCotacao (string)
. nmIdentificadorChassi (string)
. nrTipoObjetoSegurado (string)
. objetoSegurado (object)
} (object) required
seguro_residencial/put_cotacoes_objeto_seguradobr/ bBRASIL_SEG - /emissao/cotacao/v1/objetosegurado/b br/ br/ Altera um objeto segurado de acordo com as resposta do questionário. br/ br/ iPara obter o questionário que deve ser respondido, é necessário buscar no response do último serviço executado, seguindo as etapas abaixo: br / i 1 - Localizar na lista de oferta a oferta selecionada. br / i 2 - A partir da estrutura json da oferta selecionada, é necessário localizar a lista de chassi e varrer cada item da lista br / i 3 - A partir da estrdata (undefined) required
seguro_residencial/delete_cotacoes_objeto_seguradobr/ bBRASIL_SEG - /emissao/cotacao/v1/objetosegurado/b br/ br/ Exclui um objeto segurado de acordo com as resposta do questionário. br/ br/ iPara obter o questionário que deve ser respondido, é necessário buscar no response do último serviço executado, seguindo as etapas abaixo: br / i 1 - Localizar na lista de oferta a oferta selecionada. br / i 2 - A partir da estrutura json da oferta selecionada, é necessário localizar a lista de chassi e varrer cada item da lista br / i 3 - A partir da estrdata: {
. localizadorCotacao (string)
. nmIdentificadorObjetoSegurado (string)
} (object) required
seguro_residencial/post_cotacoes_proponentebr/ bBRASIL_SEG - /emissao/cotacao/v0/proponente/b br/ br/ Grava o proponente na cotação. br/ br/ b Para testar a inclusão é necessário alterar os dados do proponente na requisição de exemplo./bdata: {
. localizadorCotacao (string)
. proponente (object)
} (object) required
seguro_residencial/put_cotacoes_proponentebr/ bBRASIL_SEG - /emissao/cotacao/v0/proponente/b br/ br/ Atualiza o proponente na cotação. br /data: {
. localizadorCotacao (string)
. proponente (object)
} (object) required
seguro_residencial/delete_cotacoes_proponentebr/ bBRASIL_SEG - /emissao/cotacao/v0/proponente/b br/ br/ Realiza a Exclusão do proponente da cotação.data: {
. localizadorCotacao (string)
. nmCpfCnpj (string)
} (object) required
seguro_residencial/post_cotacoes_planobr/ bBRASIL_SEG - /emissao/cotacao/v1/plano/b br/ br/ Registra qual foi o plano selecionado para cada tipo de objeto segurado. br/ b O plano deve ser selecionado de acordo com o objeto segurado que foi cotadob/ br/ br/ i Para obter número do tipo do objeto seguradobnrTipoObjetoSegurado/b é só recuperar da raiz do item da lista de questionário que vai ser respondido. br / br / iPara o campo identificador do planobnmIdentificadorPlano/b, busque a oferta selecionada na lista de ofertablsOferta/b dadata: {
. localizadorCotacao (string)
. nmIdentificadorPlano (string)
. nrTipoObjetoSegurado (string)
} (object) required
seguro_residencial/post_cotacoes_periodicidadebr/ bBRASIL_SEG - /emissao/cotacao/v1/periodicidade/b br/ br/ Serviço para registrar qual é a periodicidade de contratação do seguro, ou seja, por quanto tempo aquele seguro estará vigente para o segurado. br / br / iPara o campo quantidade da periodicidadebqtPeriodicidade/b será aceito somente valores que estiver configurado no chassiblsChassi/b da ofertablsOferta/b selecionado. br / br / iPara o campo identificador da periodicidadebnmIdentificadorPeriodicidade/b, busque a oferta selecionada ndata: {
. localizadorCotacao (string)
. nmIdentificadorChassi (string)
. qtPeriodicidade (number)
. nmIdentificadorPeriodicidade (string)
. dtInicioPeriodicidade (string)
} (object) required
seguro_residencial/post_cotacoes_plano_beneficiobr/ bBRASIL_SEG - /emissao/cotacao/v0/plano/beneficio/b br/ br/ Seleciona benefício disponível no Plano Total. br/ b O beneficio deve ser selecionado de acordo com o plano foi cotadob/ br/ br /.data: {
. localizadorCotacao (string)
. nmIdentificadorPlanoChassi (string)
. nmIdentificadorPlano (string)
. nmIdentificadorBeneficio (string)
. cdEnderecoEntrega (number)
} (object) required
seguro_residencial/post_contratacoes_de_acordobr/ bBRASIL_SEG - /emissao/cotacao/v0/deacordo/b br/ br/ Registra na cotação o 'de acordo' do cliente titular.data: {
. localizadorCotacao (string)
} (object) required
seguro_residencial/post_contratacoes_plano_pagamentobr/ bBRASIL_SEG - /emissao/cotacao/v0/planopagamento/b br/ br/ Registra qual foi o plano de pagamento selecionado para a cotação. br / br / iPara o campo identificador do plano de pagamentobnmIdentificadorPlanoPagamento/b, busque a oferta selecionada na lista de ofertablsOferta/b da cotação, depois busque na raiz do item da oferta selecionado a lista de plano de pagamentoblsPlanoPagamento/bdata: {
. localizadorCotacao (string)
. nmIdentificadorPlanoPagamento (string)
} (object) required
seguro_residencial/post_contratacoes_plano_pagamento_parcelamentobr/ bBRASIL_SEG - /emissao/cotacao/v0/planopagamento/parcelamento/b br/ br/ Seleciona um parcelamento disponível para o plano de pagamento escolhido. br / br / iPara o campo identificador da parcelabnmIdentificadorParcela/b, busque a oferta selecionada na lista de ofertablsOferta/b da cotação, depois busque na raiz do item da oferta selecionado a lista de plano de pagamentoblsPlanoPagamento/b e busque pelo plano de pagamento selecionado, com item do plano de pagamento selecionado busque na raizdata: {
. localizadorCotacao (string)
. nmIdentificadorParcela (string)
} (object) required
seguro_residencial/get_contratacoes_bandeira_cartaobr/ bBRASIL_SEG - /financeiro/dadobasico/bandeiraCartao/b br/ br/ Lista as bandeirdas de cartões com seus respectivos códigos. br /No parameters
seguro_residencial/post_contratacoes_contrato_cobrancabr/ bBRASIL_SEG - /emissao/cotacao/v0/contrato-cobranca/b br/ br/ Efetiva a cobrança da cotação. br / br / i A chave bdadoCartaoCredito/b deve ser preenchida de acordo com o plano de pagamento escolhido. br/ b A opção de debito em conta não esta habilitada/bdata: {
. localizadorCotacao (string)
. dadoCartaoCredito (object)
. dadoDebitoConta (object)
} (object) required
seguro_residencial/get_consultas_pdf_propostabr/ bBRASIL_SEG - /emissao/cotacao/pdf//b br/ br/ Lista as bandeirdas de cartões com seus respectivos códigos. br /No parameters
servicos_de_arrecadacao/post_arrecadacoesA partir do código de barras digitado OU capturado, valor, consulta o parceiro arrecadadorAuthorization (string) required
gw-dev-app-key (string) required
data: {
. codigoClienteSolicitacao (integer)
. codigoBarraDigitado (string)
. codigoBarraCapturado (string)
. valorPagamento (number)
} (object) required
servicos_de_arrecadacao/post_liquidar_guiaLiquidar Guia do Parceiro ArrecadadorAuthorization (string) required
gw-dev-app-key (string) required
data: {
. codigoClienteSolicitacao (integer)
. valorPagamento (number)
. codigoBarraDigitado (string)
. codigoBarraCapturado (string)
. codigoConciliacao (string)
} (object) required
servicos_de_arrecadacao/get_pagamentosConsultar pagamento de Parceiro ArrecadadorAuthorization (string) required
gw-dev-app-key (string) required
codigoParceiro (number) required
codigoConciliacao (string) required
simulacao_de_pagar_boleto/post_boletos_cobranca_by_linha_digitavel_pagarPaga um boleto no ambiente de testeslinhaDigitavel (string)
validacao_de_contas/get_contas_by_agencia_by_conta_situacaoVerifica a situação da conta corrente ou poupança em uma agência específica, se ela está ativa ou não. E também verifica se o CPF/CNPJ informado é o titular da conta.agencia (string)
conta (string)
Authorization (string) required
gw-dev-app-key (string) required
cpfCnpj (integer) required