Guia Inicial
- Sobre o Credit as a Service
- Operações de crédito
Métodos de Assinaturas
Guia do Desenvolvedor
- Guia de Integração Via API
APIs Reference
- Análises de Crédito
- Simulações
- Onboarding
- Contratação
- Garantias
- Impressão de Documentos
- Assinaturas
- Desembolso
Casos de Uso
- Capital de Giro com/sem Garantia
- Capital de Giro com/sem Garantia (Cessão BTG)
- Crédito Direto ao Consumidor (CDC)
- Empréstimo Pessoal
- Home Equity
- Consignado Público e Privado
- Financiamento de Veículos
Jornada de Contratação
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:
1 - Simulações (Opcional)
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
Fluxos de cadastros de cliente e endereço:
Cadastro do Cliente
Em casos de atualização do cadastro do cliente, deve ser realizado 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", // Código para identificar o cliente em seu sistema | NÃO OBRIGATÓRIO
"Nome": "CLIENTE TESTE", // Nome do seu cliente | OBRIGATÓRIO
"DocumentoFederal": "75000000000", // Documento federal (CPF: 11 dígitos | CNPJ: 14 dígitos | temos um validador, então precisa ser um documento válido) | OBRIGATÓRIO
"PF": { // Se seu cliente for Pessoa Física, preencha esse objeto, se não, exclua esse objeto
"rg": "string",// RG do seu cliente | OBRIGATÓRIO
"rgOrgao": "string", // Orgão de emissão do RG do seu cliente | NÃO OBRIGATÓRIO
"rguf": "string", // UF do RG do seu cliente | NÃO OBRIGATÓRIO
"rgData": "2023-07-10T20:01:07.689Z", // data de emissão do rg | NÃO OBRIGATÓRIO
"dtNasc": "2023-07-10T20:01:07.689Z", // Data de nascimento do seu cliente | OBRIGATÓRIO
"sexo": "string", // Sexo do seu cliente | NÃO OBRIGATÓRIO
"nacionalidade": "string", // nacionalidade do seu cliente | NÃO OBRIGATÓRIO
"naturalDeCidade": "string", // Cidade natal do seu cliente | NÃO OBRIGATÓRIO
"naturalDeUF": "string", // UF natal do seu cliente| NÃO OBRIGATÓRIO
"estadoCivil": 0, // tipo enum, Consultar documento enviado em e-mail| NÃO OBRIGATÓRIO
"escolaridade": 0 // tipo enum, Consultar documento enviado em e-mail | NÃO OBRIGATÓRIO
},
"PJ": { // Se seu cliente for Pessoa Jurídica, preencha esse objeto, se não, exclua esse objeto
"nomeFantasia": "string", // Nome fantasia da empresa | OBRIGATÓRIO
"documentoEstadual": "string", // Informe o documento estadual da empresa || NÃO OBRIGATÓRIO
"documentoMunicipal": "string", // Informe o documento Municipal da empresa || NÃO OBRIGATÓRIO
"dtAberturaEmpresa": "2024-06-06T19:49:59.553Z", // Informe a data da abertura do CNPJ em timestamp || NÃO OBRIGATÓRIO
"nomeResponsavelEmpresa": "string", // Informe o nome do responsável pela empresa || NÃO OBRIGATÓRIO
"cpfResponsavelEmpresa": "string", // Informe o nome do cpf do responsável pela empresa || NÃO OBRIGATÓRIO
"rgResponsavelEmpresa": "string" // Informe o rg responsável do responsável pela empresa || NÃO OBRIGATÓRIO
},
"PessoaDadosContato": {
"Email": "teste@email.com.br", // E-mail do seu cliente | OBRIGATÓRIO
"TelefoneCelular1": "11923456781" // Celular do seu cliente | OBRIGATÓRIO
}
}
}'
Cadastro do Endereço
Nesta etapa será necessário realizar o cadastro ou atualização do endereço 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", // Código para identificar o endereço em seu sistema | NÃO OBRIGATÓRIO
"cep": "string", // CEP do endereço | OBRIGATÓRIO
"logradouro": "string", // logradouro do endereço | NÃO OBRIGATÓRIO
"nroLogradouro": "string", // nroLogradouro do endereço | NÃO OBRIGATÓRIO
"bairro": "string", // bairro do endereço | NÃO OBRIGATÓRIO
"complemento": "string", // complemento do endereço | NÃO OBRIGATÓRIO
"cidade": "string", // cidade do endereço | NÃO OBRIGATÓRIO
"uf": "string", // uf do endereço | NÃO OBRIGATÓRIO
"tipoEndereco": 0, // tipoEndereco do endereço | NÃO OBRIGATÓRIO
"tipoResidencia": 0, // logradouro do endereço | NÃO OBRIGATÓRIO
"enderecoDesde": "2024-04-04T12:19:46.116Z", // informe desde quando o endereço pertence ao cliente| NÃO OBRIGATÓRIO
"enderecoPrincipal": true, // é o endereço principal do cliente? | NÃO OBRIGATÓRIO
"enderecoCorrespondencia": true // é o endereço para correspondencia? | NÃO OBRIGATÓRIO
},
"param": {
"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
}
}
'
Upload e preenchimento do Arquivo Modelo de Importação
Para realizar o cadastro de clientes ou endereços em lote, você deve utilizar o seguinte arquivo:
Preenchimento do Modelo
Realize o preenchimento do modelo
Encaminhamento para BMP
Após realizarem o preenchimento do modelo, encaminhe para nosso time realizar o cadastro do cliente e endereços
Atualização de cadastros
Abaixo temos os endpoints para realizar a atualização do cadastro de cliente e de endereços após realizar a importação da planilha com nosso time.
Atualização Cadastro do Cliente
Em casos de atualização do cadastro do cliente, deve ser realizado 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", // Código para identificar o cliente em seu sistema | NÃO OBRIGATÓRIO
"Nome": "CLIENTE TESTE", // Nome do seu cliente | OBRIGATÓRIO
"DocumentoFederal": "75000000000", // Documento federal (CPF: 11 dígitos | CNPJ: 14 dígitos | temos um validador, então precisa ser um documento válido) | OBRIGATÓRIO
"PF": { // Se seu cliente for Pessoa Física, preencha esse objeto, se não, exclua esse objeto
"rg": "string",// RG do seu cliente | OBRIGATÓRIO
"rgOrgao": "string", // Orgão de emissão do RG do seu cliente | NÃO OBRIGATÓRIO
"rguf": "string", // UF do RG do seu cliente | NÃO OBRIGATÓRIO
"rgData": "2023-07-10T20:01:07.689Z", // data de emissão do rg | NÃO OBRIGATÓRIO
"dtNasc": "2023-07-10T20:01:07.689Z", // Data de nascimento do seu cliente | OBRIGATÓRIO
"sexo": "string", // Sexo do seu cliente | NÃO OBRIGATÓRIO
"nacionalidade": "string", // nacionalidade do seu cliente | NÃO OBRIGATÓRIO
"naturalDeCidade": "string", // Cidade natal do seu cliente | NÃO OBRIGATÓRIO
"naturalDeUF": "string", // UF natal do seu cliente| NÃO OBRIGATÓRIO
"estadoCivil": 0, // tipo enum, Consultar documento enviado em e-mail| NÃO OBRIGATÓRIO
"escolaridade": 0 // tipo enum, Consultar documento enviado em e-mail | NÃO OBRIGATÓRIO
},
"PJ": { // Se seu cliente for Pessoa Jurídica, preencha esse objeto, se não, exclua esse objeto
"nomeFantasia": "string", // Nome fantasia da empresa | OBRIGATÓRIO
"documentoEstadual": "string", // Informe o documento estadual da empresa || NÃO OBRIGATÓRIO
"documentoMunicipal": "string", // Informe o documento Municipal da empresa || NÃO OBRIGATÓRIO
"dtAberturaEmpresa": "2024-06-06T19:49:59.553Z", // Informe a data da abertura do CNPJ em timestamp || NÃO OBRIGATÓRIO
"nomeResponsavelEmpresa": "string", // Informe o nome do responsável pela empresa || NÃO OBRIGATÓRIO
"cpfResponsavelEmpresa": "string", // Informe o nome do cpf do responsável pela empresa || NÃO OBRIGATÓRIO
"rgResponsavelEmpresa": "string" // Informe o rg responsável do responsável pela empresa || NÃO OBRIGATÓRIO
},
"PessoaDadosContato": {
"Email": "teste@email.com.br", // E-mail do seu cliente | OBRIGATÓRIO
"TelefoneCelular1": "11923456781" // Celular do seu cliente | OBRIGATÓRIO
}
}
}'
Atualização do Cadastro do Endereço
Nesta etapa será necessário realizar o cadastro ou atualização do endereço 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", // Código para identificar o endereço em seu sistema | NÃO OBRIGATÓRIO
"cep": "string", // CEP do endereço | OBRIGATÓRIO
"logradouro": "string", // logradouro do endereço | NÃO OBRIGATÓRIO
"nroLogradouro": "string", // nroLogradouro do endereço | NÃO OBRIGATÓRIO
"bairro": "string", // bairro do endereço | NÃO OBRIGATÓRIO
"complemento": "string", // complemento do endereço | NÃO OBRIGATÓRIO
"cidade": "string", // cidade do endereço | NÃO OBRIGATÓRIO
"uf": "string", // uf do endereço | NÃO OBRIGATÓRIO
"tipoEndereco": 0, // tipoEndereco do endereço | NÃO OBRIGATÓRIO
"tipoResidencia": 0, // logradouro do endereço | NÃO OBRIGATÓRIO
"enderecoDesde": "2024-04-04T12:19:46.116Z", // informe desde quando o endereço pertence ao cliente| NÃO OBRIGATÓRIO
"enderecoPrincipal": true, // é o endereço principal do cliente? | NÃO OBRIGATÓRIO
"enderecoCorrespondencia": true // é o endereço para correspondencia? | NÃO OBRIGATÓRIO
},
"param": {
"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
}
}
'
3 - Contratação
Inclusão de Proposta
Nesta etapa será necessário realizar o envio da proposta através da integração com nossa API de Incluir Proposta
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
}
]
4 - Representantes Legais (Opcional)
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"
}
}'
5 - Garantias (Opcional)
Registro de Garantia
Nesta etapa será necessário salvar a proposta de Garantia Bem Documento através da integração com nossa API de Registro de Garantia.
curl --location --request GET 'https://api.bmpdigital.moneyp.dev.br/Proposta/SalvarPropostaGarantiaBem' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \
--data '{
"dto": {
"codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"codigoIdentificador": "string",
"nomeProprietario": "string",
"documentoFederalProprietario": "string",
"grupo": 0,
"subgrupo": 0,
"descricaoSubgrupo": "string",
"vlrTotal": 0,
"descricao": "string",
"propostaGarantiaBemFinan": {
"codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"numeroEC": "string",
"seuNumero": "string",
"dtPrimVencDuplic": "2024-07-22T19:13:06.582Z",
"dtUltVencDuplic": "2024-07-22T19:13:06.582Z",
"razaoSocial": "string",
"cnpj": "string",
"percCotasGarantia": 0,
"vlrCapitalSocial": 0,
"nomeFundo": "string",
"cnpjFundo": "string",
"qtdeCotasFundo": 0,
"qtdeCotasGarantiaFundo": 0,
"vlrCotasFundo": 0,
"dtTravaCarencia": "2024-07-22T19:13:06.582Z",
"nomeLocador": "string",
"documentoFederalLocador": "string",
"nomeLocatario": "string",
"documentoFederalLocatario": "string",
"dtInicioLocacao": "2024-07-22T19:13:06.582Z",
"dtTerminoLocacao": "2024-07-22T19:13:06.582Z",
"moedaVirtual": true,
"nroBanco": "string",
"tipoConta": 0,
"agencia": "string",
"agenciaDig": "string",
"conta": "string",
"contaDig": "string",
"titularidade": "string",
"propostaGarantiaBemFinanCartao": [
{
"codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"credenciadora": "string",
"subCredenciadora": "string",
"arranjo": "string",
"percArranjo": 0
}
],
"propostaGarantiaBemFinanSocio": [
{
"codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"documentoFederal": "string",
"nome": "string",
"qtdeCotas": 0,
"vlrCotas": 0,
"percCotas": 0
}
]
},
"propostaGarantiaBemImovel": {
"codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"cep": "string",
"logradouro": "string",
"nroLogradouro": "string",
"bairro": "string",
"complemento": "string",
"cidade": "string",
"uf": "string",
"possuiRegistroCartorio": true,
"nomeCartorio": "string",
"nroMatricula": "string",
"nroCIBNirf": "string",
"nroCEICNO": "string",
"qtdArea": 0,
"unidMedidaArea": "string"
},
"propostaGarantiaBemMovel": {
"codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"nroRegistro": "string",
"localizacaoPais": "string",
"nroSerie": "string",
"nroNotaFiscal": "string",
"chaveNFe": "string",
"marca": "string",
"modelo": "string"
},
"propostaGarantiaBemVeiculo": {
"codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"placa": "string",
"marca": "string",
"modelo": "string",
"versaoModelo": "string",
"anoFab": 0,
"anoMod": 0,
"cor": "string",
"chassi": "string",
"renavam": "string",
"financiado": true,
"saldoFinanciamento": 0,
"tipoPlaca": 0,
"tipoVeiculo": 0,
"ufPlaca": "string",
"ufLicenciamento": "string",
"vlrFipe": 0,
"periodoFipe": "string",
"zeroKM": true,
"frota": true,
"tipoChassi": 0,
"tipoRestricaoGravame": 0,
"dtRestricaoGravame": "2024-07-22T19:13:06.582Z",
"codigoFipe": "string",
"km": 0
}
},
"parametros": [
{
"nome": "string",
"valor": "string"
}
]
}'
6 - Coleta de 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"
}
]
}'
7 - 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": [
{}
]
}'
8 - 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?