- BMP SOCIEDADE DE CRÉDITO DIRETO S.A
- MONEY PLUS SOCIEDADE DE CRÉDITO AO MICROEMPREENDEDOR E A EMPRESA DE PEQUENO PORTE LTDA
Diagrama caso de uso
Abaixo segue o passo a passo para utilização do caso de uso:
1 - Simulações
Nessa etapa, você pode consultar os valores disponíveis para saque do FGTS e executar simulações. Após isso, poderá realizar empréstimos com garantia do FGTS e os valores serão inclusos em uma proposta. A seguir, detalharemos as opções de simulações disponíveis. Confira qual delas se ajusta melhor às necessidades da sua operação:Mostrar 1.1 - /FGTS/BuscarSimulacao
Mostrar 1.1 - /FGTS/BuscarSimulacao
Mostrar Simulação com a Calculadora BMP (sem consultar a CEF)
Mostrar Simulação com a Calculadora BMP (sem consultar a CEF)
Mostrar Simulação com quantidade de períodos
Mostrar Simulação com quantidade de períodos
curl --location 'https://api.bmpdigital.moneyp.dev.br/FGTS/BuscarSimulacao' \
--header 'Idempotencykey: identificador Unico' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer token' \
--data '
{
"dto": {
"Saldo": 0, // Valor que o seu cliente tem disponível para saque na CEF | NÃO OBRIGATÓRIO
"VlrEmprestimo": 0, // Valor desejado pelo seu cliente | NÃO OBRIGATÓRIO
"Periodo": 0, // Quantidade de períodos que deseja consultar | NÃO OBRIGATÓRIO
"TaxaMensal": 1.79, // Taxa parametrizada no sistema (deixar padrão) | NÃO OBRIGATÓRIO
"VlrTAC": "150", // Informar ou VlrTAC ou PercTAC | NÃO OBRIGATÓRIO
"PercTAC": "5", // Informar ou VlrTAC ou PercTAC | NÃO OBRIIGATÓRIO
"DtAniversario": "2024-09-30T18:30:50.905Z" // Data de nascimento do cliente | NÃO OBRIGATÓRIO
}
}'
Mostrar Simulação com períodos predefinidos por data e valor
Mostrar Simulação com períodos predefinidos por data e valor
curl --location 'https://api.bmpdigital.moneyp.dev.br/FGTS/BuscarSimulacao' \
--header 'Idempotencykey: identificador Unico' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer token' \
--data '
{
"dto": {
"Saldo": 0, // Valor que o seu cliente tem disponível para saque na CEF | NÃO OBRIGATÓRIO
"VlrEmprestimo": 0, // Valor desejado pelo seu cliente | NÃO OBRIGATÓRIO
"Periodos": [ // Datas e valores dos repasses | NÃO OBRIGATÓRIO
{
"DataRepasse": "2026-04-01", // Data que a Caixa realizará o repasse ao cliente | OBRIGATÓRIO
"VlrRepasse": 500 // Valor do repasse do cliente na data do repasse | OBRIGATÓRIO
},
{
"DataRepasse": "2027-04-01", // Data que a Caixa realizará o repasse ao cliente | OBRIGATÓRIO
"VlrRepasse": 500 // Valor do repasse do cliente na data do repasse | OBRIGATÓRIO
}
],
"TaxaMensal": 1.79, // Taxa parametrizada no sistema (deixar padrão) | NÃO OBRIGATÓRIO
"VlrTAC": "150", // Informar ou VlrTAC ou PercTAC | NÃO OBRIGATÓRIO
"PercTAC": "5", // Informar ou VlrTAC ou PercTAC | NÃO OBRIIGATÓRIO
"DtAniversario": "2024-09-30T18:30:50.905Z" // Data de nascimento do cliente | NÃO OBRIGATÓRIO
}
}'
Mostrar Consulta de Saldo pelo CPF (com consulta à CEF)
Mostrar Consulta de Saldo pelo CPF (com consulta à CEF)
curl --location 'https://api.bmpdigital.moneyp.dev.br/FGTS/BuscarSimulacao' \
--header 'Idempotencykey: identificador Unico' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer token' \
--data '
{
"dto": {
"CpfTrabalhador": "string", // CPF do cliente que deseja realizar a consulta de saldo | NÃO OBRIGATÓRIO
}
}'
Mostrar Simulação de saldo pelo CPF (com consulta à CEF)
Mostrar Simulação de saldo pelo CPF (com consulta à CEF)
Mostrar Simulação de saldo pelo CPF com quantidade de períodos
Mostrar Simulação de saldo pelo CPF com quantidade de períodos
curl --location 'https://api.bmpdigital.moneyp.dev.br/FGTS/BuscarSimulacao' \
--header 'Idempotencykey: identificador Unico' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer token' \
--data '
{
"dto": {
"VlrEmprestimo": 0, // Valor desejado pelo seu cliente | NÃO OBRIGATÓRIO
"Periodo": 0, // Quantidade de períodos deseja consultar | NÃO OBRIGATÓRIO
"TaxaMensal": 1.79, // Taxa parametrizada no sistema (deixar padrão) | NÃO OBRIGATÓRIO
"VlrTAC": "150", // Informar ou VlrTAC ou PercTAC | NÃO OBRIGATÓRIO
"PercTAC": "5", // Informar ou VlrTAC ou PercTAC | NÃO OBRIIGATÓRIO
"DtAniversario": "2024-09-30T18:30:50.905Z" , // Data de nascimento do cliente | NÃO OBRIGATÓRIO
"CpfTrabalhador": "string", // CPF do cliente que deseja realizar a consulta de saldo | NÃO OBRIGATÓRIO
}
}'
Mostrar Simulação de saldo pelo CPF com períodos predefinidos
Mostrar Simulação de saldo pelo CPF com períodos predefinidos
curl --location 'https://api.bmpdigital.moneyp.dev.br/FGTS/BuscarSimulacao' \
--header 'Idempotencykey: identificador Unico' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer token' \
--data '
{
"dto": {
"VlrEmprestimo": 0, // Valor desejado pelo seu cliente | NÃO OBRIGATÓRIO
"Periodos": [ // Datas e valores dos repasses | NÃO OBRIGATÓRIO
{
"DataRepasse": "2026-04-01", // Data que a Caixa realizará o repasse ao cliente | OBRIGATÓRIO
"VlrRepasse": 1500 // Valor do repasse do cliente na data do repasse | OBRIGATÓRIO
},
{
"DataRepasse": "2027-04-01", // Data que a Caixa realizará o repasse ao cliente | OBRIGATÓRIO
"VlrRepasse": 1000 // Valor do repasse do cliente na data do repasse | OBRIGATÓRIO
}
],
"TaxaMensal": 1.79, // Taxa parametrizada no sistema (deixar padrão) | NÃO OBRIGATÓRIO
"VlrTAC": "150", // Informar ou VlrTAC ou PercTAC | NÃO OBRIGATÓRIO
"PercTAC": "5", // Informar ou VlrTAC ou PercTAC | NÃO OBRIIGATÓRIO
"DtAniversario": "2024-09-30T18:30:50.905Z" , // Data de nascimento do cliente | NÃO OBRIGATÓRIO
"CpfTrabalhador": "string", // CPF do cliente que deseja realizar a consulta de saldo | NÃO OBRIGATÓRIO
}
}'
Mostrar 1.2 - /FGTS/BuscarSimulacaoMultiPeriodo
Mostrar 1.2 - /FGTS/BuscarSimulacaoMultiPeriodo
- Parâmetros de busca: o CPF, valor ou percentual da TAC e taxa mensal (o campo período não é preenchido).
- Retorno: simulação para vários períodos (anos).
-
O sistema trará uma lista de todos os anos possíveis para saque, informando:
- O saldo disponível em cada período.
- As possíveis quantidades e valores de parcela de cada período.
- Isso permite ao cliente ver a possibilidade máxima de parcelas e o valor total disponível para saque em cada ano.
Mostrar Simulação de Empréstimo Multiperíodo com a Calculadora BMP (sem consultar à CEF)
Mostrar Simulação de Empréstimo Multiperíodo com a Calculadora BMP (sem consultar à CEF)
curl --location 'https://api.bmpdigital.moneyp.dev.br/FGTS/BuscarSimulacao' \
--header 'Idempotencykey: identificador Unico' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer token' \
--data '
{
"dto": {
"Saldo": 0, // Valor que o seu cliente tem disponível para saque na CEF | NÃO OBRIGATÓRIO
"VlrEmprestimo": 0, // Valor desejado pelo seu cliente | NÃO OBRIGATÓRIO
"Periodo": 0, // Quantidade de períodos deseja consultar | NÃO OBRIGATÓRIO
"TaxaMensal": 1.79, // Taxa parametrizada no sistema (deixar padrão) | NÃO OBRIGATÓRIO
"VlrTAC": "150", // Informar ou VlrTAC ou PercTAC | NÃO OBRIGATÓRIO
"PercTAC": "5", // Informar ou VlrTAC ou PercTAC | NÃO OBRIIGATÓRIO
"DtAniversario": "2024-09-30T18:30:50.905Z" , // Data de nascimento do cliente | NÃO OBRIGATÓRIO
}
}'
Mostrar Consulta Multiperíodo de Saldo pelo CPF (com consulta à CEF)
Mostrar Consulta Multiperíodo de Saldo pelo CPF (com consulta à CEF)
curl --location 'https://api.bmpdigital.moneyp.dev.br/FGTS/BuscarSimulacao' \
--header 'Idempotencykey: identificador Unico' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer token' \
--data '
{
"dto": {
"CpfTrabalhador": "string", // CPF do cliente que deseja realizar a consulta de saldo | NÃO OBRIGATÓRIO
}
}'
Mostrar Simulação Multiperíodo de Saldo pelo CPF (com consulta à CEF)
Mostrar Simulação Multiperíodo de Saldo pelo CPF (com consulta à CEF)
curl --location 'https://api.bmpdigital.moneyp.dev.br/FGTS/BuscarSimulacao' \
--header 'Idempotencykey: identificador Unico' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer token' \
--data '
{
"dto": {
"VlrEmprestimo": 0, // Valor desejado pelo seu cliente | NÃO OBRIGATÓRIO
"Periodo": 0, // Quantidade de períodos deseja consultar | NÃO OBRIGATÓRIO
"TaxaMensal": 1.79, // Taxa parametrizada no sistema (deixar padrão) | NÃO OBRIGATÓRIO
"VlrTAC": "150", // Informar ou VlrTAC ou PercTAC | NÃO OBRIGATÓRIO
"PercTAC": "5", // Informar ou VlrTAC ou PercTAC | NÃO OBRIIGATÓRIO
"DtAniversario": "2024-09-30T18:30:50.905Z" , // Data de nascimento do cliente | NÃO OBRIGATÓRIO
"CpfTrabalhador": "string", // CPF do cliente que deseja realizar a consulta de saldo | NÃO OBRIGATÓRIO
}
}'
ConsultaCache for false, a requisição consultará o saldo do FGTS atualizado diretamente na Caixa Econômica Federal (CEF); quando for true, o saldo será obtido do cache da BMP. Este campo não é obrigatório, caso não seja informado, o sistema assume o valor true como padrão.2 - Onboarding
Nesta etapa, ocorre o cadastro do cliente via requisição, onde será solicitado o empréstimo com garantia do FGTS. Para isso, será necessário:Cadastro dos dados pessoais do cliente
curl --location 'https://api.bmpdigital.moneyp.dev.br/Pessoa/Salvar' \
--header 'IdempotencyKey: GUID UNICO PARA CADA CHAMADA' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer token gerado no 1º passo' \
--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": {
"rg": "string", // RG do seu cliente | OBRIGATÓRIO
"dtNasc": "2024-02-26T16:33:57.775Z" // Data de nascimento do seu cliente | OBRIGATÓRIO
},
"PessoaDadosContato": {
"Email": "[email protected]", // E-mail do seu cliente | OBRIGATÓRIO
"TelefoneCelular1": "11923456781" // Celular do seu cliente | OBRIGATÓRIO
}
}
}'
Cadastro ou atualização do endereço completo do cliente
curl --location 'https://api.bmpdigital.moneyp.dev.br/Pessoa/SalvarEndereco' \
--header 'IdempotencyKey: GUID UNICO PARA CADA CHAMADA' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer token gerado no 1º passo' \
--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
},
"param": {
"documentoCliente": "string" // Documento federal CPF: 11 dígitos | temos um validador, então precisa ser um documento válido | OBRIGATÓRIO
}
}'
3 - Contratação
Nesta etapa é realizado o envio da proposta, inserindo os dados solicitados:- Valor do empréstimo
- Valor ou Percentual da TAC (se houver)
- Data de aniversário
- CPF
- Taxa de juros aplicada
- Conta destino para pagamento
- Quantidade de períodos desejada
Inclusão de Proposta
Mostrar Contratação com quantidade de periodos
Mostrar Contratação com quantidade de periodos
Periodo retornará erro caso o valor não seja entre 1 e 5.curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/FGTS/IncluirProposta \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '{
"dto": {
"CodigoOperacao": "string", // Identificador Unico Por proposta | OBRIGATÓRIO
"VlrEmprestimo": 0, // Valor solicitado | OBRIGATÓRIO
"TipoContrato": "string", // Tipo de contrato informado pelo time de implantação | OBRIGATÓRIO
"Periodo": 0, // Prazo (de 1 a 5) | OBRIGATÓRIO
"DtAniversario": "2023-08-10T18:04:36.349Z", // Data de aniversário do seu cliente | OBRIGATÓRIO
"TaxaMensal": 1.79, // Taxa parametrizada no sistema | OBRIGATÓRIO
"CpfTrabalhador": "string", // CPF do seu cliente | OBRIGATÓRIO
"VlrTAC": "150", // Informar ou VlrTAC ou PercTAC | NÃO OBRIGATÓRIO
"PercTAC": "10", // Informar ou VlrTAC ou PercTAC | NÃO OBRIIGATÓRIO
"propostaContaPagamento": { // Nesse objeto voce informa os dados bancários do desembolso | OBRIGATÓRIO
"tipoConta": 0, // 1 = Conta poupança 2 = Conta Corrente | OBRIGATÓRIO
"agencia": "string", // Agência bancária do emitente | 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
}
}
}'
Mostrar Contratação com períodos predefinidos
Mostrar Contratação com períodos predefinidos
VlrRepasse retornará erro caso o valor não seja entre 100 e 500.curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/FGTS/IncluirProposta \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '{
"dto": {
"CodigoOperacao": "string", // Identificador Unico Por proposta | OBRIGATÓRIO
"VlrEmprestimo": 0, // Valor solicitado | OBRIGATÓRIO
"TipoContrato": "string", // Tipo de contrato informado pelo time de implantação | OBRIGATÓRIO
"Periodos": [ // Datas e valores dos repasses | OBRIGATÓRIO
{
"DataRepasse": "2026-04-01", // Data que a Caixa realizará o repasse ao cliente | OBRIGATÓRIO
"VlrRepasse": 500 // Valor do repasse do cliente na data do repasse (Mínimo 100 e Máximo 500) | OBRIGATÓRIO
},
{
"DataRepasse": "2027-04-01", // Data que a Caixa realizará o repasse ao cliente | OBRIGATÓRIO
"VlrRepasse": 500 // Valor do repasse do cliente na data do repasse (Mínimo 100 e Máximo 500) | OBRIGATÓRIO
}
],
"DtAniversario": "2023-08-10T18:04:36.349Z", // Data de aniversário do seu cliente | OBRIGATÓRIO
"TaxaMensal": 1.79, // Taxa parametrizada no sistema | OBRIGATÓRIO
"CpfTrabalhador": "string", // CPF do seu cliente | OBRIGATÓRIO
"VlrTAC": "150", // Informar ou VlrTAC ou PercTAC | NÃO OBRIGATÓRIO
"PercTAC": "10", // Informar ou VlrTAC ou PercTAC | NÃO OBRIIGATÓRIO
"propostaContaPagamento": { // Nesse objeto voce informa os dados bancários do desembolso | OBRIGATÓRIO
"tipoConta": 0, // 1 = Conta poupança 2 = Conta Corrente | OBRIGATÓRIO
"agencia": "string", // Agência bancária do emitente | 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
}
}
}'
dto:Mostrar Split de TED
Mostrar Split de TED
"propostaLancamentos": [
{
"campoID": "string",
"vlrTransacao": 0,
"tipoConta": 0,
"agencia": "string",
"agenciaDig": "string",
"conta": "string",
"contaDig": "string",
"numeroBanco": "string"
}
]
dto:Mostrar Split de Boleto
Mostrar Split de Boleto
"propostaLancamentos": [
{
"campoID": "string",
"vlrTransacao": 0,
"dtPagamento": "2024-02-21T17:48:40.110Z",
"linhaDigitavel": "string",
"documentoFederalCedente": "string",
"nomeCedente": "string"
}
]
4 - Coleta de Assinaturas
Após a finalização da inclusão da proposta, é necessário realizar a assinatura da CCB, pois se trata da formalização de um empréstimo e comprova a responsabilidade pelo devido pagamento.Mostrar 4.1 Assinatura Eletrônica
Mostrar 4.1 Assinatura Eletrônica
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
}
]
}'
Mostrar 4.2 Assinatura Relogon
Mostrar 4.2 Assinatura Relogon
Coleta do Modelo de Assinatura
curl --location 'https://reports.moneyp.dev.br/imprimir?impressao=S&tipo=ccb&code=GUIDPROPOSTA&integracao=CODPARAMETRO&copias=1&versao=' \
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",
"codigoOperacao": "string"
},
"assinantes": [
{
"nome": "string",
"email": "string",
"documento": "string",
"descricao": "string",
"notificarPorEmail": true,
"dtAssinatura": "2024-01-15T14:21:57.250Z",
"ipAssinatura": "string"
}
]
}'
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",
"codigoOperacao": "string"
},
"parametros": [
{
"Nome": "FINALIZACAO_VALIDARPARCELAS",
"Valor": "FALSE"
},
{
"Nome": "IP_ADDRESS",
"Valor": "00.000.000.00"
}
]
}'
Impressão de CCB Assinada
curl --location 'https://reports.moneyp.dev.br/imprimir?impressao=S&tipo=ccb&code=GUIDPROPOSTA&integracao=CODPARAMETRO&copias=1&versao=' \
Mostrar 4.3 Assinatura Certificadora
Mostrar 4.3 Assinatura Certificadora
Coleta do Modelo de Assinatura
curl --location 'https://reports.moneyp.dev.br/imprimir?impressao=S&tipo=ccb&code=GUIDPROPOSTA&integracao=CODPARAMETRO&copias=1&versao=' \
Envio para Certificadora
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",
"codigoOperacao": "string"
},
"documento": {
"codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tipoDocumento": 30,
"nomeArquivo": "string",
"extensao": "string",
"dtValidade": "2023-05-23T20:57:08.922Z",
"arquivo": "string"
}
}'
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",
"codigoOperacao": "string"
},
"parametros": [
{
"Nome": "FINALIZACAO_VALIDARPARCELAS",
"Valor": "FALSE"
},
{
"Nome": "IP_ADDRESS",
"Valor": "00.000.000.00"
}
]
}'
5 - Solicitação da Trava do Saldo
Após a assinatura da operação (ID=6), a BMP solicitará à CEF que realize a reserva do saldo do CPF em questão. Enquanto a reserva está em processo de andamento, a CEF mantém o valor bloqueado, garantindo que não haverá novas solicitações de trava daquele saldo.StatusProtocoloCEF na resposta do endpoint 7 - Consultar Proposta.Mostrar Trava realizada com sucesso
Mostrar Trava realizada com sucesso
Mostrar Proposta Paga
Mostrar Proposta Paga
Mostrar Operação Pendente de Pagamento
Mostrar Operação Pendente de Pagamento
Atualização de dados bancários
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/Proposta/AtualizarContaPagamento \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '{
"dto": {
"codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoOperacao": "<string>",
"numeroProposta": 123
},
"dtoPagto": {
"tipoConta": 123,
"agencia": "<string>",
"agenciaDig": "<string>",
"conta": "<string>",
"contaDig": "<string>",
"numeroBanco": "<string>",
"documentoFederalPagamento": "<string>",
"nomePagamento": "<string>"
}
}'
Proposta Desembolsada
Mostrar Trava não realizada
Mostrar Trava não realizada
Mostrar Pendente
Mostrar Pendente
Verifique o motivo da pendência
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/FGTS/ConsultaProposta \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '{
"dto": {
"CodigoProposta": "<string>",
"CodigoOperacao": "<string>"
}
}'
Reserva de saldo
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/Proposta/Finalizar \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '{
"dto": {
"codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoOperacao": "<string>",
"numeroProposta": 123
},
"parametros": [
{
"nome": "<string>",
"valor": "<string>"
}
]
}'
Mostrar Cancelada
Mostrar Cancelada
6 - Cancelamento (Opcional)
Por meio deste endpoint, será solicitado o cancelamento do contrato de antecipação junto à CEF:curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/FGTS/CancelarProposta \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: GUID UNICO POR CHAMADA \
--data '{
"dto": {
"CodigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CodigoOperacao": "<string>",
"TextoMotivoCancelamento": "<string>"
}
}'

