Esse caso de uso é exclusivo para utilização de parceiros com cessão BTG.

O capital de giro é uma linha de crédito concedida a pessoas jurídicas para gerar liquidez e auxiliar o fluxo de caixa da empresa. As modalidades incluem opções com ou sem garantias, como recebíveis de cartões, duplicatas, contratos de serviços, investimentos, cotas/ações, imóveis e veículos, oferecendo flexibilidade e segurança para a gestão financeira empresarial.

Abaixo segue o passo a passo para utilização do caso de uso:

Antes de utilizar este serviço, é necessário configurar a autenticação. Consulte as instruções de autenticação para orientações detalhadas.

​
1 - Simulações (Opcional)

Conheça abaixo nossos tipos de simulações:

​
2 - Onboarding

Fluxos de cadastros de cliente e endereço:

Nesta etapa será necessário escolher um único fluxo de cadastro

​
3 - Upload de documento

Essa etapa é obrigatória para casos de formalização BMP.

1

Inclusão do documento

Nesta etapa será necessário realizar o envio dos documentos dos parceirosatravés da integração com nossa API de Inclusão de documento

curl --location 'https://api.bmpdigital.moneyp.dev.br/Pessoa/IncluirDocumento' \
--header 'IdempotencyKey: GUID UNICO PARA CADA CHAMADA' \
--header 'Content-Type: application/json' \
--data '{
    "dto": {
        "documentoCliente": "string" // Documento federal (CPF: 11 dígitos | CNPJ: 14 dígitos | temos um validador, então precisa ser um documento válido) | OBRIGATÓRIO
    },
    "documento": {
        "codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Código gerado no response da criação da pessoa em nosso sistema OU código da proposta gerado no response da criação da proposta | OBRIGATÓRIO
        "tipoDocumento": 0, // Tipo de documento do seu cliente (caso queira informar, verifique a tabela de enum no email) | OBRIGATÓRIO
        "nomeArquivo": "string", // Nome do arquivo | OBRIGATÓRIO
        "extensao": "string", // Extensão do arquivo (ex: jpg, pdf, png) | OBRIGATÓRIO
        "dtValidade": "2023-05-23T20:57:08.922Z", // Data de validade do arquivo | OBRIGATÓRIO
        "arquivo": "string" // Arquivo desejado codificado em BASE64 | OBRIGATÓRIO
    }
}'

​
4 - Contratação

1

Inclusão de Proposta

Nesta etapa será necessário realizar o envio da proposta através da integração com a API de Inclusão de cálculo externo:

curl --location '//Proposta/IncluirCalculoExterno' \
--header 'IdempotencyKey: <string>' // GUID único para garantir a idempotência da requisição
--header 'Content-Type: application/json' \
--data '{
  "dto": {
    "documentoCliente": "<string>", // Documento do cliente (CPF válido)
    "documentoPromotor": "<string>", // Documento de identificação do promotor
    "documentoParceiroCorrespondente": "<string>", // Documento do parceiro correspondente
    "documentoCedente": "<string>", // Documento do cedente (pessoa/instituição que cede o crédito)
    "observacoesVendedor": "<string>", // Observações adicionais do vendedor
    "codigoOperacao": "<string>", // Código identificador da operação ou transação
    "tipoEmissao": "<string>", // Tipo de emissão da proposta
    "codigoVersaoCCB": "<integer>", // Código da versão do contrato de crédito bancário
    "vlrSolicitado": "<double>", // Valor solicitado pelo cliente
    "vlrTotalDivida": "<double>", // Valor total da dívida do cliente
    "vlrTotalJuros": "<double>", // Valor total dos juros aplicados
    "vlrTotalCredito": "<double>", // Valor total do crédito concedido
    "mora": "<double>", // Valor da mora (juros por atraso)
    "baseCalculoDiasMora": "<integer>", // Base de cálculo em dias para a mora
    "multa": "<double>", // Valor da multa aplicada em caso de atraso
    "taxasJurosAtraso": "<double>", // Taxa de juros para atraso
    "encargos": "<double>", // Encargos adicionais na proposta
    "custoEfetivoTotal": "<double>", // Custo efetivo total da operação
    "baseCalculoDias": "<integer>", // Base de cálculo em dias para os juros
    "prazo": "<integer>", // Prazo total da operação (em dias ou meses)
    "percJurosNegociado": "<double>", // Percentual de juros negociado
    "vlrIOF": "<double>", // Valor do IOF (Imposto sobre Operações Financeiras)
    "percIOFAdicional": "<double>", // Percentual adicional do IOF
    "vlrParcela": "<double>", // Valor de cada parcela
    "vlrTAC": "<double>", // Valor da tarifa de abertura de crédito (TAC)
    "dtPrimeiroVencto": "<dateTime>", // Data do primeiro vencimento
    "dataVencimentoOperacao": "<dateTime>", // Data de vencimento final da operação
    "tipoContrato": "<string>", // Tipo de contrato da operação
    "juros": {
      "indexador": "<string>", // Tipo de indexador usado (ex: CDI, SELIC)
      "taxaPreIndice": "<double>", // Taxa prefixada
      "percentualPosIndice": "<double>", // Percentual pós-indexador
      "baseContagemDias": "<integer>" // Base de contagem de dias (ex: 360 ou 365)
    },
    "encargosAtrasoPagamento": {
      "indexador": "<string>", // Indexador para atraso
      "taxaPreIndice": "<double>", // Taxa prefixada para o atraso
      "percentualPosIndice": "<double>" // Percentual pós-indexador para atraso
    },
    "dataBase": "<dateTime>", // Data base para cálculos
    "dataLiquidacao": "<dateTime>", // Data de liquidação da operação
    "parcelas": [
      {
        "parcela": "<integer>", // Número da parcela
        "saldo": "<double>", // Saldo da parcela
        "amortizacao": "<double>", // Valor da amortização
        "montante": "<double>", // Valor total do montante da parcela
        "juros": "<double>", // Juros da parcela
        "dataVencimento": "<dateTime>", // Data de vencimento da parcela
        "inicioApropriacao": "<dateTime>", // Início de apropriação dos juros
        "fimApropriacao": "<dateTime>", // Fim de apropriação dos juros
        "dataPagamento": "<dateTime>", // Data de pagamento da parcela
        "iofParcela": "<double>", // IOF da parcela
        "dataPago": "<dateTime>", // Data de pagamento efetivo
        "vlrPago": "<double>", // Valor pago da parcela
        "foiPago": "<boolean>" // Indicador de pagamento da parcela
      }
    ],
    "outrasTaxas": [
      {
        "tipo": "<string>", // Tipo de taxa (ex: administrativa)
        "valor": "<double>" // Valor da taxa
      }
    ],
    "propostaContaLiquidacao": {
      "codigoBanco": "<integer>", // Código do banco para liquidação
      "tipoConta": "<integer>", // Tipo de conta (ex: corrente, poupança)
      "agencia": "<string>", // Número da agência
      "agenciaDig": "<string>", // Dígito verificador da agência
      "conta": "<string>", // Número da conta
      "contaDig": "<string>", // Dígito da conta
      "numeroBanco": "<string>" // Número do banco
    },
    "propostaContaPagamento": {
      "agencia": "<string>", // Agência do pagamento
      "conta": "<string>", // Conta de pagamento
      "tipoConta": "<integer>", // Tipo de conta para pagamento
      "codigoBanco": "<integer>", // Código do banco do pagamento
      "agenciaDig": "<string>", // Dígito da agência
      "contaDig": "<string>", // Dígito da conta
      "documentoFederalPagamento": "<string>", // Documento do titular da conta de pagamento
      "nomePagamento": "<string>" // Nome do titular da conta de pagamento
    },
    "propostaLancamentos": [
      {
        "documentoFederal": "<string>", // Documento do beneficiário do lançamento
        "dtPagamento": "<dateTime>", // Data de pagamento prevista
        "linhaDigitavel": "<string>", // Linha digitável para pagamento
        "vlrTransacao": "<double>", // Valor da transação
        "campoID": "<string>", // Identificador do campo
        "codigoBanco": "<integer>", // Código do banco do lançamento
        "numeroBanco": "<string>", // Número do banco
        "tipoConta": "<integer>", // Tipo de conta do lançamento
        "agencia": "<string>", // Agência do lançamento
        "agenciaDig": "<string>", // Dígito da agência
        "conta": "<string>", // Número da conta do lançamento
        "contaDig": "<string>", // Dígito da conta
        "nomePagamento": "<string>", // Nome do destinatário do pagamento
        "documentoFederalCedente": "<string>", // Documento do cedente do pagamento
        "nomeCedente": "<string>" // Nome do cedente do pagamento
      }
    ]
  }
}'

​
5 - Representantes Legais (Opcional)

1

Incluir Avalistas

Nesta etapa será necessário realizar inclusão dos avalistas através da integração com nossa API de Incluir Avalistas

curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/incluirAvalistas' \
--header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \
--header 'Content-Type: application/json' \
--data-raw '{
  "avalistas": [
    {
      "nome": "Tamires Gomes",
      "documentoFederal": "90004202023",
      "cep": "18025540",
      "logradouro": "Rua Cuba",
      "nroLogradouro": "1",
      "bairro": "Vila Barcelona",
      "complemento": null,
      "cidade": "Sorocaba",
      "uf": "SP",
      "avalistaPF": {
        "dtNasc": "2000-04-17",
        "email": "tgomes@teste.com.br",
        "naturalDeCidade": "São Paulo",
        "naturalDeUF": "SP"
      }
    }
  ],
  "dto": {
    "codigoProposta": "b066ab79-a247-4db6-83fa-289343a139f7",
    "codigoOperacao": "6697b4aa9081d6384813a235"
  }
}'

​
6 - Garantias (Opcional)

1

Registro de Garantia

Nesta etapa será necessário integração com nossa API de Registro de Garantia para adição de sua garantia.

Tipos de garantias:

​
7 - Upload de Documentos relacionados à Proposta

1

Envio do documento proposta

Nesta etapa será necessário realizar o envio do documento para proposta, através da integração com nossa API de Upload Documento.

curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirDocumento' \
--header 'IdempotencyKey: GUID UNICO PARA CADA CHAMADA' \
--header 'Content-Type: application/json' \
--data '{
  "dto": { // Apenas um dos campos abaixo deve ser informado
    "codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Colocar GUID da proposta gerado no response da inclusão da proposta
    "codigoOperacao": "string" // Colocar codigo da operação utilizado na inclusão da proposta
  },
  "documento": {
    "codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Código da proposta gerado no response da criação da proposta | OBRIGATÓRIO
    "tipoDocumento": 0, // Tipo de documento do seu cliente (caso queira informar, verifique a tabela de enum no email) | OBRIGATÓRIO
    "nomeArquivo": "string", // Nome do arquivo | OBRIGATÓRIO
    "extensao": "string", // Extensão do arquivo (ex: jpg, pdf, png) | OBRIGATÓRIO
    "dtValidade": "2023-05-23T20:57:08.922Z", // Data de validade do arquivo | OBRIGATÓRIO
    "arquivo": "string" // Arquivo desejado codificado em BASE64 | OBRIGATÓRIO
  }
}'

O envio do documento DUT para a operação de garantia de veículo é Obrigatório.

​
8 - Coleta de Assinaturas

Para conhecer mais sobre nossas assinaturas, suas particularidades e qual utilizar em seu projeto conheça nosso material explicativo sobre as assinaturas.

Com a assinatura definida durante o planejamento do escopo de projeto com o executivo comercial, selecione abaixo a opção que irá utilizar para prosseguir com o caso de uso:

​
9 - Formas de desembolso

1

Tipos de desembolso

Abaixo defina qual será sua forma de desembolso, sendo através da BMP ou desembolso externo:

​
10 - APIs Auxiliares

Atualização da Conta Bancária será utilizado nesta jornada para atualização da conta pagamento.

Procedimento Técnico Callback será utilizado nesta jornada para confirmação de assintura e confirmação de pagamento.

Consultar Contrato será utilizado nesta jornada para consultar os dados da proposta.

Consultar comprovante de Pagamento será utilizado nesta jornada para consultar o comprovante de pagamento da proposta.

Cancelamento de Contrato será utilizado nesta jornada para cancelamento de contrato.

Esta página foi útil?