O crédito direto ao consumidor (CDC) é uma modalidade financeira na qual instituições concedem crédito diretamente aos consumidores, geralmente para aquisição de bens de consumo duráveis, como automóveis e eletrodomésticos. Esse tipo de crédito oferece conveniência e acessibilidade aos consumidores, que podem parcelar suas compras diretamente com o fornecedor do bem, facilitando o acesso a produtos de maior valor financeiro.
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.
Através deste endpoint, o parceiro pode simular os valores da proposta, obtendo o cálculo do prazo requerido e detalhes de todas as parcelas, conforme as taxas e parametrizações cadastradas para a modalidade, por meio da integração com nossa API de Simulação Detalhada.
curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/CalcularGridParcelasSimplificadoPrice' \ --header 'accept: text/plain' \ --header 'IdempotencyKey: GUID UNICO PARA CADA CHAMADA' \ --header 'Content-Type: application/json' \ --data '{ "dto": { "vlrSolicitado": 0, // Valor solicitado pelo seu cliente | OBRIGATÓRIO "nroDiasAcrescimo": 0, // Este campo ajusta o vencimento da 1ª parcela, somando ou subtraindo dias da data padrão (sempre no mesmo dia da simulação, no mês seguinte) "percJurosNegociado": 0, // Percentual de juros negocioado com seu cliente | OBRIGATÓRIO "tipoPessoa": 0, // Para PF informar 1 e para PJ informar 2 | OBRIGATÓRIO "vlrTAC": 0, // Caso tenha TAC, informe esse campo. Caso não tenha, pode excluir | NÃO OBRIGATÓRIO "prazo": 0, // informe a quantidade de parcelas "fluxoIrregular": false // informe false para intervalo de prazo de 30 em 30 ou true para outros intervalos}}'
O campo nroDiasAcrescimo define quantos dias serão adicionados ou subtraídos da data de vencimento padrão da primeira parcela. Por padrão, o vencimento ocorre no mesmo dia da simulação, mas no mês seguinte. Exemplo: se a simulação for em 27/05, o vencimento padrão será 27/06. Se você preencher com “20”, o vencimento será 20 dias após essa data padrão (ex: 17/07). Caso a simulação seja feita nos dias 30 ou 31 e o mês seguinte não possua essas datas, o vencimento será ajustado para o último dia do mês (por exemplo, uma simulação em 31/01 terá vencimento em 28/02).
Por meio deste endpoint, o parceiro pode simular os valores da proposta antes de sua geração no sistema, visualizando as possibilidades exatas de cada prazo, por meio da integração com nossa API de Simulação Multiparcelamento.
curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/CalcularGridParcelasSimplificado' \--header 'accept: text/plain' \--header 'IdempotencyKey: GUID UNICO PARA CADA CHAMADA' \--header 'Content-Type: application/json' \--header 'Authorization: Bearer 2ec83da4-ddba-4b01-9c6a-5b5e718f5793' \--data ' { "dto": { "vlrSolicitado": 0, // Valor solicitado pelo seu cliente | OBRIGATÓRIO "nroDiasAcrescimo": 0, // Este campo ajusta o vencimento da 1ª parcela, somando ou subtraindo dias da data padrão (sempre no mesmo dia da simulação, no mês seguinte) "percJurosNegociado": 0, // Percentual de juros negocioado com seu cliente | OBRIGATÓRIO "tipoPessoa": 0, // Para PF informar 1 e para PJ informar 2 | OBRIGATÓRIO "vlrTAC": 0 // Caso tenha TAC, informe esse campo. Caso não tenha, pode excluir | NÃO OBRIGATÓRIO }
O campo nroDiasAcrescimo define quantos dias serão adicionados ou subtraídos da data de vencimento padrão da primeira parcela. Por padrão, o vencimento ocorre no mesmo dia da simulação, mas no mês seguinte. Exemplo: se a simulação for em 27/05, o vencimento padrão será 27/06. Se você preencher com “20”, o vencimento será 20 dias após essa data padrão (ex: 17/07). Caso a simulação seja feita nos dias 30 ou 31 e o mês seguinte não possua essas datas, o vencimento será ajustado para o último dia do mês (por exemplo, uma simulação em 31/01 terá vencimento em 28/02).
Por meio deste endpoint, o parceiro realiza o cadastro ou atualização de um registro de pessoa física ou jurídica, para a qual será efetuado o pagamento, incluindo dados gerais, de contato e financeiros. Nesta etapa, é necessário realizar o cadastro do cliente por meio da integração com nossa API de Cadastro de Cliente.
curl --location 'https://api.bmpdigital.moneyp.dev.br/Pessoa/Salvar' \--header 'IdempotencyKey: GUID UNICO PARA CADA CHAMADA' \--header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \--header 'Content-Type: application/json' \--data-raw '{ "dto": { "Codigo": "1", // Preenchido apenas no método SelectPessoa. Deve ser enviado sem preenchimento para Inclusão/Atualização. "Nome": "CLIENTE TESTE", //Obrigatório - Nome da pessoa "DocumentoFederal": "75000000000", // Obrigatório – Número do Documento de Cadastro de Pessoas Físicas (CPF) e Documento do Cadastro Nacional de Pessoas Jurídicas (CNPJ) com ou sem formatação "PF": { // Pessoa Física "rg": "string", // Registro Geral (RG) da pessoa "rgOrgao": "string", // Órgão de emissão do Registro Geral (RG) "rguf": "string", // Órgão de emissão do Registro Geral (RG) "rgData": "2023-07-10T20:01:07.689Z", // Data de emissão do Registro Geral (RG) "dtNasc": "2023-07-10T20:01:07.689Z", // Data de Nascimento "sexo": "string", // “M” – Masculino e “F” - Feminino "nacionalidade": "string", // Natural do País "naturalDeCidade": "string", // Cidade de Naturalização "naturalDeUF": "string", // Unidade Federal (UF) de Naturalização "estadoCivil": 0, // Consultar tabela de estado civil no endpoints. Se “Casado” deve informar cônjuge "escolaridade": 0 // Consultar tabela de escolaridade no endpoint }, "PessoaDadosContato": { "Email": "teste@email.com.br", // E-mail de contato "TelefoneCelular1": "11923456781" // Telefone celular } }}'
2
Cadastro da Loja/Conveniada/Correspondente
Por meio deste endpoint, o parceiro realiza o cadastro ou atualização de um registro de pessoa física ou jurídica, para a qual será efetuado o pagamento, incluindo dados gerais, de contato e financeiros. Nesta etapa, é necessário realizar o cadastro da loja, conveniado ou correspondente por meio da integração com nossa API de Cadastro de Cliente.
curl --location 'https://api.bmpdigital.moneyp.dev.br/Pessoa/Salvar' \--header 'IdempotencyKey: GUID UNICO PARA CADA CHAMADA' \--header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \--header 'Content-Type: application/json' \--data-raw '{ "dto": { "Codigo": "1", // Será preenchido apenas pelo método SelectPessoa "Nome": "CLIENTE TESTE", // Obrigatório - Nome da pessoa "DocumentoFederal": "75000000000", // Número do Cadastro de Pessoa Física (CPF) ou do Cadastro Nacional de Pessoa Jurídica (CNPJ) do Cliente/Fornecedor. Se informado deve ser válido. "PJ": { // Pessoa Jurídica "nomeFantasia": "string", // Nome Fantasia da empresa "documentoEstadual": "string", // Inscrição Estadual "documentoMunicipal": "string", // Inscrição Municipal "dtAberturaEmpresa": "2024-06-06T19:49:59.553Z", // Data de abertura da empresa "nomeResponsavelEmpresa": "string", // Nome do Responsável da empresa "cpfResponsavelEmpresa": "string", // Número do Cadastro de Pessoa Física (CPF) do Responsável da empresa. Se informado deve ser válido "rgResponsavelEmpresa": "string" // Registro Geral (RG) do Responsável da empresa }, "PessoaDadosContato": { "Email": "teste@email.com.br", // E-mail de contato "TelefoneCelular1": "11923456781" // Telefone celular } }}'
3
Cadastro do Endereço (cliente e loja)
Por meio deste endpoint, o parceiro pode criar ou atualizar registros de endereços de um cliente específico utilizando o CPF ou CNPJ já cadastrado. Para atualizações, é necessário informar o campo código com o número do registro na base da BMP; caso contrário, a busca será feita pelo CEP. Nesta etapa, é necessário realizar o cadastro ou atualização do endereço do cliente e da loja por meio da integração com nossa API de Cadastro de Endereço.
curl --location 'https://api.bmpdigital.moneyp.dev.br/Pessoa/SalvarEndereco' \--header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \--header 'IdempotencyKey: GUID UNICO PARA CADA CHAMADA' \--header 'Content-Type: application/json' \--data '{ "dto": { "codigo": "string", // Será preenchido apenas pelo método SelectPessoa "cep": "string", // Obrigatório – Código de endereçamento Postal "logradouro": "string", // Obrigatório - Logradouro "nroLogradouro": "string", // Número do Logradouro "bairro": "string", // Bairro "complemento": "string", // Complemento "cidade": "string", // Obrigatório - Cidade "uf": "string", // Obrigatório – Unidade Federal (UF). Exemplo: SC (Sigla de Santa Catarina) "tipoEndereco": 0, // Consultar tabela Tipo de Endereço no endpoint "tipoResidencia": 0, // Consultar tabela Tipo de residência no endpoint "enderecoDesde": "2024-04-04T12:19:46.116Z", // Data de início no endereço "enderecoPrincipal": true, // Indica se é o endereço principal "enderecoCorrespondencia": true // Indica se é o endereço recebe correspondências }, "param": { "documentoCliente": "string" // Documento federal do cliente }}'
Por meio deste endpoint, o parceiro pode incluir propostas de pessoa física e jurídica de forma manual e simplificada, permitindo que o integrador envie os campos da proposta sem alterações pelo motor de cálculo interno. Nesta etapa, é necessário realizar o cadastro ou atualização do contrato por meio da integração com nossa API de Geração de Contrato.
curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirManualSimplificado' \--header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \--header 'IdempotencyKey: GUID UNICO PARA CADA CHAMADA' \--header 'Content-Type: application/json' \--data '{ "dto": { "documentoCliente": "string", // Documento do cliente "documentoParceiroCorrespondente": "string", // Documento do Parceiro Correspondente "codigoOperacao": "string", // Obrigatório - Uso do Integrador. É o código da operação no sistema do parceiro. Esta informação é exclusiva e poderá ser utilizada para atualizar a proposta sem necessidade de guardar o código da proposta na BMP. Porém o código de proposta BMP é importante ser armazenado para uso de impressão de boletos/CCB/Nota promissória ou Protocolo. "codigoVersaoCCB": 0, // Código da versão da Cédula de Crédito Bancária – (CCB) "vlrSolicitado": 0, // Obrigatório - Valor solicitado na proposta "prazo": 0, // Obrigatório - Prazo solicitado. Será consistido conforme a parametrizado de integração. "percJurosNegociado": 0, // Obrigatório - Percentual de juros da proposta "vlrIOF": 0, // Obrigatório - Valor Total do Imposto sobre Operações Financeiras (IOF) "percIOF": 0, // Obrigatório - Percentual do Imposto sobre Operações Financeiras (IOF) "vlrParcela": 0, // Obrigatório - Valor da Parcela "vlrTAC": 0, // Obrigatório - Valor da Tarifa de Cadastro. Pode ser R$ 0,00 quando não houver. "dtPrimeiroVencto": "2024-02-21T17:48:40.110Z", // Obrigatório - Data estimada do primeiro vencimento. "tipoContrato": "string", // string(5) - Sigla indicando o tipo de contrato da proposta. Exémplo: CSG -> Capital de Giro; CCG -> Capital de Giro com Garantia "propostaContaPagamentoDTO": { "tipoConta": 0, // Obrigatório - tipo de conta "agencia": "string", // string(10) Obrigatório - Agência bancária "agenciaDig": "string", // string(1)Obrigatório - Dígito da agência "conta": "string", // string(20) Obrigatório - Conta bancária "contaDig": "string", // string(1) Obrigatório - Dígito da conta "numeroBanco": "string" //string(5) Obrigatório - Número da conta }, },}'
Para utilização de contrato com split de TED adicione o objeto abaixo na requisição anterior dentro do array dto:
"propostaLancamentos": [ { "campoID": "string", // Nome do campo responsável pelo split | OBRIGATÓRIO "vlrTransacao": 0, // Valor da transação (lembrando que deve ser menor ou igual que o valor solicitado) | OBRIGATÓRIO "tipoConta": 0, // 1 = PF, 2 = PJ | OBRIGATÓRIO "agencia": "string", // Agência bancária da conta | OBRIGATÓRIO "agenciaDig": "string", // Digíto da conta bancária do emitente | OBRIGATÓRIO "conta": "string", // Conta bancária do emitente | OBRIGATÓRIO "contaDig": "string", // Digito bancário da conta do emitente | OBRIGATÓRIO "numeroBanco": "string" // Código bancário de acordo com a tabela do BACEN | OBRIGATÓRIO } ]
Para utilização de contrato com split de BOLETO adicione o objeto abaixo na requisição anterior dentro do array dto:
"propostaLancamentos": [ { "campoID": "string", // Nome do campo responsável pelo split | OBRIGATÓRIO "vlrTransacao": 0, // Valor da transação (lembrando que deve ser menor ou igual que o valor solicitado) | OBRIGATÓRIO "dtPagamento": "2024-02-21T17:48:40.110Z", // Data prevista de pagamento da proposta. "linhaDigitavel": "string", // string(60) string contendo informações do boleto, como dados do banco, destinatário etc. "documentoFederalCedente": "string", // string(20) Documento federal do cedente "nomeCedente": "string" // string(60) Nome do cedente } ]
O campo documentoParceiroCorrespondente deve ser preenchido com o CNPJ da loja ou empresa conveniada.
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:
1
Assinatura Eletrônica
Por meio deste endpoint, o parceiro será direcionado ao nosso ambiente para realizar a assinatura da proposta. Nesta etapa, é necessário realizar a assinatura eletrônica por meio da integração com nossa API de Assinatura Eletrônica.
curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirAssinaturaCCB' \--header 'accept: text/plain' \--header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \--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 }, "assinantes": [ { "nome": "string", // Informe o nome do assinante | OBRIGATÓRIO "email": "string", // Informe o email do assinante | OBRIGATÓRIO "documento": "string", // Informe o documento federal do assinante | OBRIGATÓRIO "descricao": "string", // Informe o papel desse assinante na operação | OBRIGATÓRIO "telefoneCelular": "string", // Informe o telefone celular do assinante | OBRIGATÓRIO "notificarPorEmail": true, // Esse campo controle se o cliente receberá a CCB por email para a assinatura | OBRIGATÓRIO "notificarPorWhatsApp": true, // Se o cliente for receber o token de assinatura via WhatsApp, deixar esse campo como true. Se não, colocar false | NÃO OBRIGATÓRIO "notificarPorSMS": true, // Se o cliente for receber o token de assinatura via SMS, deixar esse campo como true. Se não, colocar false | NÃO OBRIGATÓRIO "codigoIdentificador": "string", // Código identificador do assinante dentro da proposta (caso queira realizar alguma alteração nesse assinante, informe esse código na outra chamada da API) | NÃO OBRIGATÓRIO "dtLimiteAssinatura": "2024-02-21T19:47:38.567Z" // Data limite para que o assnante realize a assinatura | OBRIGATÓRIO } ]}'
1
Coleta do Modelo de Assinatura
Este endpoint é utilizado para solicitar a consulta da impressão de um Certificado de Crédito Bancário (CCB), por meio dos parâmetros de código da proposta e código de integração. Nesta etapa, é necessário realizar a consulta do CCB através da integração com nossa URL de Impressão de CCB para validação do modelo antes da assinatura.
Por meio deste endpoint, o parceiro pode realizar a assinatura da proposta, permitindo a inclusão de assinantes que já tenham assinado no backend do integrador, pois a proposta só é finalizada após todos os assinantes cadastrados realizarem a assinatura. Este método não faz envio de e-mails de notificação e exige parâmetros de autenticação, localização da proposta e uma lista de assinantes que já realizaram a assinatura com data, hora e endereço IP de origem. Nesta etapa, é necessário realizar a assinatura Relogon por meio da integração com nossa API de Assinatura Relogon.
curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirAssinaturaCCBFinalizada' \--header 'IdempotencyKey: GUID UNICO PARA CADA CHAMADA' \--header 'Content-Type: application/json' \--data '{ "dto": { "codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Número sequencial da proposta "codigoOperacao": "string" // string(50) Código da Operação do Parceiro }, "assinantes": [ { "nome": "string", // string(60) Obrigatório - Nome do assinante "email": "string", // string(60) Obrigatório - E-mail do assinante "documento": "string", // string(20) Obrigatório – Número do Cadastro de Pessoa Física (CPF) e do Cadastro Nacional de Pessoa jurídica (CNPJ) do assinante "descricao": "string", // string(100) Caracterização do assinante "notificarPorEmail": true, // Obrigatório - O assinante que for marcado para receber a notificação terá controle sobre todas as assinaturas, podendo cobrar as assinaturas pendentes. O e-mail será enviado pela BMP. "dtAssinatura": "2024-01-15T14:21:57.250Z", // Obrigatório - Data e hora da assinatura efetuada no backend do integrador "ipAssinatura": "string" // string(255) Obrigatório -Número de IP onde a assinatura foi coletada } ]}'
3
Finalização de proposta
Por meio deste endpoint, o parceiro pode finalizar a proposta após a conclusão do procedimento de assinatura. Após o envio da requisição de assinatura Relogon, será necessário finalizar a proposta por meio da integração com o endpoint de Finalização de Proposta.
Este endpoint é utilizado para solicitar a consulta da impressão de um Certificado de Crédito Bancário (CCB), por meio dos parâmetros de código da proposta e código de integração. Nesta etapa, é necessário realizar a consulta do CCB através da integração com nossa URL de Impressão de CCB para validação do modelo antes da assinatura.
Este endpoint é utilizado para solicitar a consulta da impressão de um Certificado de Crédito Bancário (CCB), por meio dos parâmetros de código da proposta e código de integração. Nesta etapa, é necessário realizar a consulta do CCB através da integração com nossa URL de Impressão de CCB para validação do modelo antes da assinatura.
Nesta etapa será necessário enviar o modelo da CCB para a certificadora, para que seja realizada a assinatura.
3
Assinatura Certificadora
Por meio deste endpoint, o parceiro executa a assinatura da proposta via Certificadora, como Docusign, QCertifica, Clicksign, Finanblue, entre outras. O processo inicia com o download da CCB sem a marca d’água MODELO disponível em nosso portal, seguido da assinatura por uma certificadora e posterior anexação da CCB assinada à proposta. Após a coleta das assinaturas, será necessário realizar o upload da CCB assinada por meio da integração com nossa API de Assinatura Certificadora.
curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirDocumento' \--header 'IdempotencyKey: GUID UNICO PARA CADA CHAMADA' \--header 'Content-Type: application/json' \--header 'Authorization: Bearer token gerado no 1º passo' \--data '{ "dto": { "codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", //Número sequencial da proposta "codigoOperacao": "string" // string(50) Código da Operação do Parceiro }, "documento": { "codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Preenchido com o código do arquivo na base BMP "tipoDocumento": 30, // Obrigatório - Consultar tabela de tipo de documento "nomeArquivo": "string", // string(500) Obrigatório - Nome do arquivo "extensao": "string", // string(20) Obrigatório - Extensão do arquivo "dtValidade": "2023-05-23T20:57:08.922Z", // Data de Validade do Arquivo "arquivo": "string" // : Obrigatório - Array de bytes que contém o arquivo }}'
4
Finalização de proposta
Por meio deste endpoint, o parceiro pode finalizar a proposta após a conclusão do procedimento de assinatura. Após o envio da requisição de assinatura Relogon, será necessário finalizar a proposta por meio da integração com o endpoint de Finalização de Proposta.
Por meio deste endpoint, o parceiro pode liberar a proposta para a fila de pagamento após receber o status de proposta “finalizada”, sendo o processo de desembolso de responsabilidade da BMP. Nesta etapa, é necessário realizar a liberação da proposta por meio da integração com nossa URL de Liberação da proposta para pagamento para validação do modelo após a assinatura.
curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/Liberar' \--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", //Número sequencial da proposta "codigoOperacao": "string" // string(50) Código da Operação do Parceiro }, "parametros": [ {} ]}'
