Jornada de Contratação

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.

1 - Simulações

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

Por meio deste endpoint será possível realizar a simulação através 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, // Esse campo indica quantos dias de carência terá a proposta (podendo considerar o mês com 30 ou 31 dias) 
    "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
}
}'  

Nesta etapa será necessário realizar a simulação através 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, // Esse campo indica quantos dias de carência terá a proposta (podendo considerar o mês com 30 ou 31 dias) 
    "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
  }

2 - Onboarding

Cadastro do Cliente

Nesta etapa será necessário realizar o cadastro do clientes através 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
        }
    }
}'

Cadastro da Loja/Conveniada/Correspondente

Nesta etapa será necessário realizar o cadastro da loja, conveniado ou correspondente através 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 
        }
    }
}'

Cadastro do Endereço (cliente e loja)

Nesta etapa será necessário realizar o cadastro ou atualização do endereço do cliente e da loja através 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
  }
}
'

3 - Contratação

Geração de Contrato

Nesta etapa será necessário realizar o cadastro ou atualização do contrato através 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.

4 - 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:

Assinatura Eletrônica

Nesta etapa será necessário realizar a assinatura eletrônica através 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
        }
    ]
}'

Coleta do Modelo de Assinatura

Nesta etapa será necessário realizar a consulta do CCB através da integração com nossa URL de Impressão de CCB para realizar a validação do modelo antes da assinatura.

curl --location 'https://reports.moneyp.dev.br/imprimir?impressao=S&tipo=ccb&code=GUIDPROPOSTA&integracao=CODPARAMETRO&copias=1&versao=' \

Assinatura Relogon

Nesta etapa será necessário realizar a assinatura Relogon através 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
    }
  ]
}'

Finalização de proposta

Após o envio da requisição de assinatura Relogon, será necessário finalizar a proposta através da integração com o endpoint de Finalização de proposta.

curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/Finalizar' \
--header 'IdempotencyKey: GUID UNICO PARA CADA CHAMADA' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer g3Lmb6cowHidKJwwu8J-5xAVAViSysAZAajzeeeTXq4' \
--data '{
    "dto": { 
        "codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Número sequencial da proposta
        "codigoOperacao": "string" // string(50) Código da Operação
    },
    "parametros": [ 
        {
            "Nome": "FINALIZACAO_VALIDARPARCELAS",
            "Valor": "FALSE"
        },
        {
            "Nome": "IP_ADDRESS",
            "Valor": "00.000.000.00"
        }
    ]
}'

Impressão de CCB Assinada

Nesta etapa será necessário realizar a consulta do CCB através da integração com nossa URL de Impressão de CCB para realizar a validação do modelo antes da assinatura.

curl --location 'https://reports.moneyp.dev.br/imprimir?impressao=S&tipo=ccb&code=GUIDPROPOSTA&integracao=CODPARAMETRO&copias=1&versao=' \

Coleta do Modelo de Assinatura

Nesta etapa será necessário realizar a consulta do CCB através da integração com nossa URL de Impressão de CCB para realizar a validação do modelo antes da assinatura.

curl --location 'https://reports.moneyp.dev.br/imprimir?impressao=S&tipo=ccb&code=GUIDPROPOSTA&integracao=CODPARAMETRO&copias=1&versao=' \

Envio para Certificadora

Nesta etapa será necessário enviar o modelo da CCB para a certificadora, para que seja realizada a assinatura.

Assinatura Certificadora

Após a coleta das assinaturas, será necessário realizar o upload da CCB assinada, através 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
  }
}'

Finalização de proposta

Após o envio da requisição de assinatura Relogon, será necessário finalizar a proposta através da integração com o endpoint de Finalização de proposta.

curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/Finalizar' \
--header 'IdempotencyKey: GUID UNICO PARA CADA CHAMADA' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer g3Lmb6cowHidKJwwu8J-5xAVAViSysAZAajzeeeTXq4' \
--data '{
    "dto": { 
        "codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", //Número sequencial da proposta 
        "codigoOperacao": "string" // string(50)  Código da Operação do Parceiro 
    },
    "parametros": [ 
        {
            "Nome": "FINALIZACAO_VALIDARPARCELAS",
            "Valor": "FALSE"
        },
        {
            "Nome": "IP_ADDRESS",
            "Valor": "00.000.000.00"
        }
    ]
}'

5 - Liberação de proposta

Liberação de proposta

Nesta etapa será necessário realizar a liberação da proposta através da integração com nossa URL de Liberação da proposta para pagamento para realizar a 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": [
        {}
    ]
}'

6 - 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.

Guia Inicial

Métodos de Assinaturas

Guia do Desenvolvedor

APIs Reference

Casos de Uso

Jornada de Contratação

1 - Simulações

2 - Onboarding

3 - Contratação

4 - Coleta de Assinaturas

5 - Liberação de proposta

6 - APIs Auxiliares

Guia Inicial

Métodos de Assinaturas

Guia do Desenvolvedor

APIs Reference

Casos de Uso

​1 - Simulações

​2 - Onboarding

​3 - Contratação

​4 - Coleta de Assinaturas

​5 - Liberação de proposta

​6 - APIs Auxiliares

1 - Simulações

2 - Onboarding

3 - Contratação

4 - Coleta de Assinaturas

5 - Liberação de proposta

6 - APIs Auxiliares