Show 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, // Amount requested by your client | REQUIRED
"nroDiasAcrescimo": 0, // This field adjusts the due date of the 1st installment, adding or subtracting days from the default date (always on the same day as the simulation, in the following month)
"percJurosNegociado": 0, // Percentage of interest negotiated with your client | REQUIRED
"tipoPessoa": 0, // For individuals enter 1, for companies enter 2 | REQUIRED
"vlrTAC": 0, // If there is a registration fee (TAC), inform this field. If not, you can remove it | OPTIONAL
"prazo": 0, // Enter the number of installments
"fluxoIrregular": false // Enter false for intervals of 30 days or true for other intervals
}
}'
Show 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, // Amount requested by your client | REQUIRED
"nroDiasAcrescimo": 0, // This field adjusts the due date of the 1st installment, adding or subtracting days from the default date (always on the same day as the simulation, in the following month)
"percJurosNegociado": 0, // Percentage of interest negotiated with your client | REQUIRED
"tipoPessoa": 0, // For individuals enter 1, for companies enter 2 | REQUIRED
"vlrTAC": 0 // If there is a registration fee (TAC), inform this field. If not, you can remove it | OPTIONAL
}
}'
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).Show Customer Registration
Request for Client 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", // Filled only in the SelectPessoa method. Must be sent empty for Inclusion/Update.
"Nome": "CLIENTE TESTE", // Required - Person's name
"DocumentoFederal": "75000000000", // Required – Federal Document Number (CPF or CNPJ) with or without formatting
"PF": { // Individual
"rg": "string", // General Registry (RG) of the person
"rgOrgao": "string", // RG issuing agency
"rguf": "string", // RG issuing state
"rgData": "2023-07-10T20:01:07.689Z", // RG issue date
"dtNasc": "2023-07-10T20:01:07.689Z", // Date of birth
"sexo": "string", // “M” – Male and “F” – Female
"nacionalidade": "string", // Nationality
"naturalDeCidade": "string", // City of birth
"naturalDeUF": "string", // State of birth
"estadoCivil": 0, // Check marital status table in the endpoints. If “Married”, must inform spouse
"escolaridade": 0 // Check education level table in the endpoint
},
"PessoaDadosContato": {
"Email": "teste@email.com.br", // Contact email
"TelefoneCelular1": "11923456781" // Mobile phone number
}
}
}'
Store/Partner/Correspondent Registration
PJ
object to register a legal entity, providing the store, partner, or correspondent information.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", // Filled only by the SelectPessoa method
"Nome": "CLIENTE TESTE", // Required - Person's name
"DocumentoFederal": "75000000000", // Customer/Supplier's CPF or CNPJ number. If provided, it must be valid.
"PJ": { // Legal Entity
"nomeFantasia": "string", // Company trade name
"documentoEstadual": "string", // State registration
"documentoMunicipal": "string", // Municipal registration
"dtAberturaEmpresa": "2024-06-06T19:49:59.553Z", // Company opening date
"nomeResponsavelEmpresa": "string", // Company manager's name
"cpfResponsavelEmpresa": "string", // Company manager's CPF number. If provided, it must be valid
"rgResponsavelEmpresa": "string" // Company manager's RG number
},
"PessoaDadosContato": {
"Email": "teste@email.com.br", // Contact email
"TelefoneCelular1": "11923456781" // Mobile phone number
}
}
}'
Address Registration (customer and store)
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", // Filled only by the SelectPessoa method
"cep": "string", // Required – Postal Code (ZIP code)
"logradouro": "string", // Required - Street name
"nroLogradouro": "string", // Street number
"bairro": "string", // Neighborhood
"complemento": "string", // Additional address information
"cidade": "string", // Required - City
"uf": "string", // Required – State abbreviation (UF). Example: SC (Santa Catarina)
"tipoEndereco": 0, // Check Address Type table in the endpoint
"tipoResidencia": 0, // Check Residence Type table in the endpoint
"enderecoDesde": "2024-04-04T12:19:46.116Z", // Start date at this address
"enderecoPrincipal": true, // Indicates if this is the main address
"enderecoCorrespondencia": true // Indicates if this address receives correspondence
},
"param": {
"documentoCliente": "string" // Customer's federal document
}
}'
Show Request for Proposal Inclusion
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", // Customer's document
"documentoParceiroCorrespondente": "string", // Partner/Correspondent's document
"codigoOperacao": "string", // Required - Used by the integrator. It is the operation code in the partner's system. This information is unique and can be used to update the proposal without needing to store the BMP proposal code. However, the BMP proposal code is important to store for printing payment slips/CCB/Promissory Note or Protocol.
"codigoVersaoCCB": 0, // Bank Credit Certificate (CCB) version code
"vlrSolicitado": 0, // Required - Amount requested in the proposal
"prazo": 0, // Required - Requested term. Will be validated according to integration parameters.
"percJurosNegociado": 0, // Required - Proposal interest rate
"vlrIOF": 0, // Required - Total amount of Tax on Financial Transactions (IOF)
"percIOF": 0, // Required - Percentage of Tax on Financial Transactions (IOF)
"vlrParcela": 0, // Required - Installment amount
"vlrTAC": 0, // Required - Registration Fee amount. Can be R$ 0.00 if not applicable.
"dtPrimeiroVencto": "2024-02-21T17:48:40.110Z", // Required - Estimated date of first due date
"tipoContrato": "string", // string(5) - Acronym indicating the contract type. Example: CSG -> Working Capital; CCG -> Working Capital with Guarantee
"propostaContaPagamentoDTO": {
"tipoConta": 0, // Required - Account type
"agencia": "string", // string(10) Required - Bank branch
"agenciaDig": "string", // string(1) Required - Branch digit
"conta": "string", // string(20) Required - Bank account number
"contaDig": "string", // string(1) Required - Account digit
"numeroBanco": "string" // string(5) Required - Bank number
},
},
}'
dto
array:
Show TED Split
"propostaLancamentos": [
{
"campoID": "string", // Name of the field responsible for the split | REQUIRED
"vlrTransacao": 0, // Transaction amount (must be less than or equal to the requested amount) | REQUIRED
"tipoConta": 0, // 1 = Individual, 2 = Legal Entity | REQUIRED
"agencia": "string", // Bank branch of the account | REQUIRED
"agenciaDig": "string", // Account branch digit of the issuer | REQUIRED
"conta": "string", // Issuer's bank account | REQUIRED
"contaDig": "string", // Issuer's account digit | REQUIRED
"numeroBanco": "string", // Bank code according to BACEN table | REQUIRED
"documentoFederal": "string", // Federal document number | REQUIRED
"nomePagamento": "string" // Name for payment | REQUIRED
}
]
dto
array:
Show Payment Slip 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
}
]
documentoParceiroCorrespondente
field must be filled in with the CNPJ of the partner store or company.Show Electronic Signature
Electronic Signature
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
Signature Model Collection
curl --location 'https://reports.moneyp.dev.br/imprimir?impressao=S&tipo=ccb&code=GUIDPROPOSTA&integracao=CODPARAMETRO&copias=1&versao=' \
Relogon Signature
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
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
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
Certification Signature
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"
}
]
}'
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": [
{}
]
}'
Was this page helpful?