Home Equity

Personal loans are an affordable and flexible financial solution designed to meet a variety of individual needs without requiring them to justify the use of the loan. To minimize the risk of default, different types of collateral can be offered, providing security for both the borrower and the financial institution. Among the available options, collateral includes investments, card receivables, service contracts, company shares, vehicles, and real estate. This case study explores the various types of personal loans, illustrating how each modality can be used to meet different profiles and financial needs. Below is the step-by-step guide for using this use case:

Before using this service, you must configure authentication. See the authentication instructions for detailed instructions.

1 - Simulations

The first step for contracting credit in the Working Capital modality is the simulation. The simulation can be performed in two ways:

Show Detailed Simulation

In the Detailed Simulation, the partner provides all the necessary data for the simulation and receives the available credit conditions.

To request the Detailed Simulation, it is necessary to inform:

Credit amount requested by the customer;
Number of days added to the due date of the first installment;
Interest rate;
Type of person (individual or legal entity);
Term in months for payment (number of installments);
Deadline interval (irregular or regular flow).

For more information about this endpoint, access the reference document 6 - Detailed Simulation.

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
  }
}'  

Show Multi-Installment Simulation

In the Multi-Installment Simulation, the partner only informs the requested amount and receives the available credit conditions for different terms.

In the request for the Multi-Installment Simulation, it is necessary to inform:

Credit amount requested by the customer;
Number of days added to the due date of the first installment;
Interest rate;
Type of person (individual or legal entity).

For more information about this endpoint, access the reference document 5 - Multi-Installment Simulation.

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
  }
    }'

In both simulations, the nroDiasAcrescimo field defines how many days will be added or subtracted from the default due date of the first installment. By default, the due date occurs on the same day as the simulation, but in the following month. For example: if the simulation is on 27/05, the default due date will be 27/06. If you fill in “20”, the due date will be 20 days after that default date (e.g.: 17/07). If the simulation is done on the 30th or 31st and the following month does not have those dates, the due date will be adjusted to the last day of the month (for example, a simulation on 31/01 will have a due date on 28/02).

2 - Onboarding

After simulation, it is necessary to register the customer’s data and address. This step is called onboarding. Onboarding is carried out in two stages:

Show Customer Personal Information Registration

To register a customer’s personal data, you must provide:

Customer name;
Federal ID (CPF or CNPJ);
Contact information (email and cell phone number);
If the Federal ID is a CPF, you must also provide the ID number, issuing agency, ID state, ID date of issue, date of birth, gender, nationality, hometown, and home state;
If the Federal ID is a CNPJ, you must provide the business name, state ID number, municipal ID number, company opening date, name of the company manager, CPF number of the company manager, and ID number of the company manager.

For more information about this endpoint, access the reference document 10 - Customer Registration.

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
        }
    }
}'

Show Address Registration

To register a customer’s address, you must provide:

Customer’s Federal ID (CPF or CNPJ);
Address ZIP code (required);
Other optional information.

For more information about this endpoint, access the reference document 11 - Address Registration.

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 - Uploading a Customer Document

After entering the customer’s Federal Tax ID number, you must upload the document. The document is sent as a Base94-encoded file and can be in JPG, PDF, PNG, or other formats.

Show Include Document

To upload a customer document, you must enter:

Customer’s Federal Tax ID number (CPF or CNPJ);
Code generated upon return of the customer registration request;
Document type;
File name;
File extension;
File expiration date;
Base64-encoded file.

For more information about this endpoint, see the reference document 15 - Include Document.

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 na referência de API deste endpoint) | 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 - Hiring

After the simulation, onboarding, and uploading of the client’s documents, it is necessary to submit a request for credit. We call this step Inserting a Proposal.

Show Inserting a Proposal

To submit a proposal, you must provide:

Transaction code;
Amount requested in the proposal;
Requested term (in months);
Negotiated interest percentage;
Total amount of the Tax on Financial Transactions (IOF);
Percentage of the Tax on Financial Transactions (IOF);
Installment amount;
Registration Fee (TAC);
Estimated first due date;
Account type (checking, savings, etc.);
Bank branch;
Branch digit;
Bank account;
Account digit;
Bank number.

For more information about this endpoint, please visit the reference document 23 - Inclusion with External Calculation.

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
        },
    },
}'

To use a contract with a TED split, add the object below to the previous request within the dto array:

Show TED Split

"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
        "documentoFederal": "string", //Número do Documento Federal | OBRIGATÓRIO
        "nomePagamento": "string" //Nome para pagamento | OBRIGATÓRIO
    }
]

To use a contract with a Payment Split split, add the object below to the previous request within the dto array:

Show Payment Split

 "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
        "documentoFederal": "string", //Número do Documento Federal | OBRIGATÓRIO
        "nomePagamento": "string" //Nome para pagamento | OBRIGATÓRIO
    }
]

5 - Guarantees

To apply for Home Equity credit, you must add a client’s property as collateral. Use this endpoint to include property information and register the collateral.

Show Collateral Registration

To register the property collateral, you must enter:

Proposal code;
Property group;
Property subgroup;
Other property information.

For more information about this endpoint, access the reference document 36 - Save Property Collateral Proposal.

curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/SalvarPropostaGarantiaBem' \
--header 'IdempotencyKey: GUID UNICO PARA CADA CHAMADA' \
--header 'Content-Type: application/json' \
--data '{
    "dto": {
        "codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", //OBRIGATÓRIO
        "codigoIdentificador": "string",
        "nomeProprietario": "string",
        "documentoFederalProprietario": "string",
        "grupo": 0, //OBRIGATÓRIO
        "subgrupo": 0, //OBRIGATÓRIO
        "descricaoSubgrupo": "string",
        "vlrTotal": 0,
        "descricao": "string",
        "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"
        },
        "parametros": [
            {
                "nome": "string",
                "valor": "string"
            }
        ]
    }
}'

6 - Collecting Signatures

After entering the property details and registering the guarantee, you must collect signatures from all parties involved in the proposal. To learn more about signature models, access the [Signatures] document (https://bmpmoneyplus-sandbox.mintlify.app/caas/assinaturas). Signatures can be completed in three ways:

Show Electronic Signature

To use the electronic signature, you must provide:

Name, email, document, description, cell phone number, and signature deadline of the signer;
Indicate whether the signer will receive the CCB by email, WhatsApp, or SMS;
Signature deadline.

For more information about this endpoint, please visit the reference document 39 - CCB Signature Inclusion.

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
        }
    ]
}'

Show Relogon Signature

To use the Relogon signature, it is necessary to follow the steps below:

Coleta do Modelo de Assinatura

To collect the signature model, make a request to the CCB Printing endpoint, using the proposal code and integration code parameters.

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

Relogon Signature

Through this endpoint, the partner can sign the proposal, allowing the inclusion of subscribers who have already signed in the integrator’s backend; the proposal is only finalized after all registered subscribers have signed. This method does not send notification emails and requires authentication parameters, proposal location, and a list of subscribers who have already signed with date, time, and source IP address, through integration with our Relogon Signature API.

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
    }
  ]
}'

Proposal finalization

Through this endpoint, the partner can finalize the proposal after the signing procedure is completed. After sending the Relogon signature request, it will be necessary to finalize the proposal through integration with the Proposal Finalization endpoint.

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"
        }
    ]
}'

Signed CCB Printing

This endpoint is used to request the printing of a Bank Credit Certificate (CCB), through the proposal code and integration code parameters. At this stage, it is necessary to query the CCB through integration with our CCB Printing URL for model validation before signing.

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

Show Certification Signature

Signature Model Collection

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

Sending to Certification Authority

At this stage, it will be necessary to send the CCB model to the certification authority for signing.

Certification Signature

Through this endpoint, the partner signs the proposal via a Certifier, such as Docusign, QCertifica, Clicksign, Finanblue, among others. The process begins with downloading the CCB (Contracting Agreement) without the MODELO watermark available on our portal, followed by signature by a certifying agency and subsequent attachment of the signed CCB to the proposal. After collecting the signatures, the signed CCB must be uploaded through integration with our Certifying Signature API.

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
  }
}'

Proposal Finalization

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 - Proposal release

This is the final step in the credit hiring process for Working Capital. The partner can release the proposal to the payment queue after receiving the “finalized” proposal status, with the disbursement process being the responsibility of BMP. In this step, it is necessary to release the proposal through integration with our Proposal Release URL for payment to validate the model after signing. To release the proposal, it is necessary to inform:

Proposal code;
Operation code;
Proposal parameters (if necessary).

For more information about this endpoint, see the reference document 43 - Proposal Release.

Show Request to Release Proposal

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": [
        {}
    ]
}'

Endpoints e documentos auxiliares

For this journey, it is very important that the partner knows the Technical Procedure for CaaS Callback. The following endpoints may also be useful:

28 - Consult Contract: used to consult proposal data;
31 - Include Extra Field: used to include extra fields in the proposal;
33 - Contract Cancellation: used to cancel the contract; * 38 - View Payment Receipt: used to view the proposal’s payment receipt;
44 - Bank Account Update: used to update the payment account;
46 - Split Update: used to update the payment split.

Initial Guide

Signature Methods

Developer's Guide

APIs Reference

Use Cases

Home Equity

1 - Simulations

2 - Onboarding

3 - Uploading a Customer Document

4 - Hiring

5 - Guarantees

6 - Collecting Signatures

7 - Proposal release

Endpoints e documentos auxiliares

Initial Guide

Signature Methods

Developer's Guide

APIs Reference

Use Cases

​1 - Simulations

​2 - Onboarding

​3 - Uploading a Customer Document

​4 - Hiring

​5 - Guarantees

​6 - Collecting Signatures

​7 - Proposal release

​Endpoints e documentos auxiliares

1 - Simulations

2 - Onboarding

3 - Uploading a Customer Document

4 - Hiring

5 - Guarantees

6 - Collecting Signatures

7 - Proposal release

Endpoints e documentos auxiliares