Show Detailed Simulation
curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/CalcularGridParcelasSimplificadoPrice' \
--header 'accept: text/plain' \
--header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \
--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 of the simulation, in the following month)
"percJurosNegociado": 0, // Interest rate negotiated with your client | REQUIRED
"tipoPessoa": 0, // Enter 1 for individual and 2 for company | REQUIRED
"vlrTAC": 0, // If there's a TAC fee, fill this field. If not, it can be removed | OPTIONAL
"prazo": 0, // Enter the number of installments
"fluxoIrregular": false // Set to 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: UNIQUE GUID FOR EACH CALL' \
--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 by adding or subtracting days from the default date (always the same day of the simulation, in the next month)
"percJurosNegociado": 0, // Interest rate negotiated with your client | REQUIRED
"tipoPessoa": 0, // Enter 1 for individual and 2 for company | REQUIRED
"vlrTAC": 0 // If there is a TAC fee, include this field. If not, it can be omitted | 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 Registering Customer Personal Information
curl --location 'https://api.bmpdigital.moneyp.dev.br/Pessoa/Salvar' \
--header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \
--header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \
--header 'Content-Type: application/json' \
--data-raw '{
"dto": {
"Codigo": "1", // Code to identify the customer in your system | OPTIONAL
"Nome": "CLIENTE TESTE", // Your customer's name | REQUIRED
"DocumentoFederal": "75000000000", // Federal document (CPF: 11 digits | CNPJ: 14 digits | we have a validator, so it must be a valid document) | REQUIRED
"PF": { // If your customer is an Individual, fill in this object; if not, remove this object
"rg": "string",// Customer's RG | REQUIRED
"rgOrgao": "string", // RG issuing agency | OPTIONAL
"rguf": "string", // RG state (UF) | OPTIONAL
"rgData": "2023-07-10T20:01:07.689Z", // RG issue date | OPTIONAL
"dtNasc": "2023-07-10T20:01:07.689Z", // Customer's date of birth | REQUIRED
"sexo": "string", // Customer's gender | OPTIONAL
"nacionalidade": "string", // Customer's nationality | OPTIONAL
"naturalDeCidade": "string", // Customer's city of birth | OPTIONAL
"naturalDeUF": "string", // Customer's state of birth (UF) | OPTIONAL
"estadoCivil": 0, // Enum type, see document sent by email | OPTIONAL
"escolaridade": 0 // Enum type, see document sent by email | OPTIONAL
},
"PJ": { // If your customer is a Legal Entity, fill in this object; if not, remove this object
"nomeFantasia": "string", // Company trade name | REQUIRED
"documentoEstadual": "string", // State document of the company | OPTIONAL
"documentoMunicipal": "string", // Municipal document of the company | OPTIONAL
"dtAberturaEmpresa": "2024-06-06T19:49:59.553Z", // Company opening date in timestamp | OPTIONAL
"nomeResponsavelEmpresa": "string", // Name of the company responsible | OPTIONAL
"cpfResponsavelEmpresa": "string", // CPF of the company responsible | OPTIONAL
"rgResponsavelEmpresa": "string" // RG of the company responsible | OPTIONAL
},
"PessoaDadosContato": {
"Email": "teste@email.com.br", // Customer's email | REQUIRED
"TelefoneCelular1": "11923456781" // Customer's mobile phone | REQUIRED
}
}
}'
Show Address Registration
curl --location 'https://api.bmpdigital.moneyp.dev.br/Pessoa/SalvarEndereco' \
--header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \
--header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \
--header 'Content-Type: application/json' \
--data '{
"dto": {
"codigo": "string", // Code to identify the address in your system | OPTIONAL
"cep": "string", // ZIP code of the address | REQUIRED
"logradouro": "string", // Address street | OPTIONAL
"nroLogradouro": "string", // Address number | OPTIONAL
"bairro": "string", // Address neighborhood | OPTIONAL
"complemento": "string", // Address complement | OPTIONAL
"cidade": "string", // Address city | OPTIONAL
"uf": "string", // Address state (UF) | OPTIONAL
"tipoEndereco": 0, // Address type | OPTIONAL
"tipoResidencia": 0, // Residence type | OPTIONAL
"enderecoDesde": "2024-04-04T12:19:46.116Z", // Since when the address belongs to the customer | OPTIONAL
"enderecoPrincipal": true, // Is this the customer's main address? | OPTIONAL
"enderecoCorrespondencia": true // Is this the correspondence address? | OPTIONAL
},
"param": {
"documentoCliente": "string" // Federal document (CPF: 11 digits | CNPJ: 14 digits | we have a validator, so it must be a valid document) | REQUIRED
}
}'
Show Inserting a Proposal
curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirManualSimplificado' \
--header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \
--header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \
--header 'Content-Type: application/json' \
--data '{
"dto": {
"documentoCliente": "string", // Customer document
"documentoParceiroCorrespondente": "string", // Correspondent Partner document
"codigoOperacao": "string", // Required - Used by the Integrator. It is the operation code in the partner's system. This information is exclusive 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 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 - Interest rate of the proposal
"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 when not applicable.
"dtPrimeiroVencto": "2024-02-21T17:48:40.110Z", // Required - Estimated date of the first due date.
"tipoContrato": "string", // string(5) - Acronym indicating the type of contract for the proposal. 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
"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 payer | REQUIRED
"conta": "string", // Bank account of the payer | REQUIRED
"contaDig": "string", // Bank account digit of the payer | 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 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
"dtPagamento": "2024-02-21T17:48:40.110Z", // Expected payment date of the proposal.
"linhaDigitavel": "string", // string(60) string containing payment slip information, such as bank data, recipient, etc.
"documentoFederalCedente": "string", // string(20) Federal document of the assignor
"nomeCedente": "string", // string(60) Name of the assignor
"documentoFederal": "string", // Federal Document Number | REQUIRED
"nomePagamento": "string" // Name for payment | REQUIRED
}
]
Show Inclusion of Vehicle Data
/Proposta/IncluirDadosVeiculos
endpoint to add vehicle data.For more information about this endpoint, see the reference document 34 - Vehicle Registration. curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirDadosVeiculo' \
--header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \
--header 'Content-Type: application/json' \
--data '{
"dto": {
"codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"codigoOperacao": "string"
},
"dadosVeiculoDTOs": [
{
"codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"codigoIdentificador": "string",
"placa": "string",
"marca": "string",
"modelo": "string",
"versaoModelo": "string",
"anoFab": 0,
"anoMod": 0,
"cor": "string",
"chassis": "string",
"renavam": "string",
"proprietario": "string",
"documentoFederalProprietario": "string",
"financiado": true,
"saldoFinanciamento": 0,
"tipoPlaca": 0,
"tipoVeiculo": 0,
"ufPlaca": "string",
"ufLicenciamento": "string",
"tipoRestricao": 0,
"tipoChassi": 0,
"codigoFipe": "string",
"situacaoGravame": 0,
"descricaoGravame": "string",
"dtSituacaoGravame": "2024-04-03T15:23:35.988Z",
"origemGravame": 0,
"gravame": 0,
"nroRegristroGecov": "string"
}
]
}'
curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirDocumento' \
--header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \
--header 'Content-Type: application/json' \
--data '{
"dto": { // Only one of the fields below must be provided
"codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Enter the proposal GUID generated in the response of the proposal inclusion
"codigoOperacao": "string" // Enter the operation code used in the proposal inclusion
},
"documento": {
"codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Proposal code generated in the response of the proposal creation | REQUIRED
"tipoDocumento": 0, // Document type of your customer (if you want to inform, check the enum table in the email) | REQUIRED
"nomeArquivo": "string", // File name | REQUIRED
"extensao": "string", // File extension (e.g.: jpg, pdf, png) | REQUIRED
"dtValidade": "2023-05-23T20:57:08.922Z", // File expiration date | REQUIRED
"arquivo": "string" // Desired file encoded in BASE64 | REQUIRED
}
}'
Show Electronic Signature
curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirAssinaturaCCB' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \
--header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \
--header 'Content-Type: application/json' \
--data '{
"dto": { // Only one of the fields below must be provided
"codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Enter the proposal GUID generated in the response of the proposal inclusion
"codigoOperacao": "string" // Enter the operation code used in the proposal inclusion
},
"assinantes": [
{
"nome": "string", // Enter the subscriber's name | REQUIRED
"email": "string", // Enter the subscriber's email | REQUIRED
"documento": "string", // Enter the subscriber's federal document | REQUIRED
"descricao": "string", // Enter the subscriber's role in the operation | REQUIRED
"telefoneCelular": "string", // Enter the subscriber's mobile phone | REQUIRED
"notificarPorEmail": true, // This field controls whether the customer will receive the CCB by email for signature | REQUIRED
"notificarPorWhatsApp": true, // If the customer will receive the signature token via WhatsApp, set this field to true. If not, set to false | OPTIONAL
"notificarPorSMS": true, // If the customer will receive the signature token via SMS, set this field to true. If not, set to false | OPTIONAL
"codigoIdentificador": "string", // Subscriber identifier code within the proposal (if you want to make any changes to this subscriber, provide this code in another API call) | OPTIONAL
"dtLimiteAssinatura": "2024-02-21T19:47:38.567Z" // Deadline for the subscriber to sign | REQUIRED
}
]
}'
Show Relogon Signature
Coleta do Modelo de Assinatura
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: UNIQUE GUID FOR EACH CALL' \
--header 'Content-Type: application/json' \
--data '{
"dto": {
"codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Sequential proposal number
"codigoOperacao": "string" // string(50) Partner Operation Code
},
"assinantes": [
{
"nome": "string", // string(60) Required - Subscriber's name
"email": "string", // string(60) Required - Subscriber's email
"documento": "string", // string(20) Required – Subscriber's CPF (Individual Taxpayer Registry) or CNPJ (National Registry of Legal Entities) number
"descricao": "string", // string(100) Subscriber characterization
"notificarPorEmail": true, // Required - The subscriber marked to receive the notification will have control over all signatures and can request pending signatures. The email will be sent by BMP.
"dtAssinatura": "2024-01-15T14:21:57.250Z", // Required - Date and time the signature was performed in the integrator's backend
"ipAssinatura": "string" // string(255) Required - IP number where the signature was collected
}
]
}'
Proposal finalization
curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/Finalizar' \
--header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer g3Lmb6cowHidKJwwu8J-5xAVAViSysAZAajzeeeTXq4' \
--data '{
"dto": {
"codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Sequential proposal number
"codigoOperacao": "string" // string(50) Partner Operation Code
},
"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: UNIQUE GUID FOR EACH CALL' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer token gerado no 1º passo' \
--data '{
"dto": {
"codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Sequential proposal number
"codigoOperacao": "string" // string(50) Partner Operation Code
},
"documento": {
"codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Filled with the file code in the BMP database
"tipoDocumento": 30, // Required - See document type table
"nomeArquivo": "string", // string(500) Required - File name
"extensao": "string", // string(20) Required - File extension
"dtValidade": "2023-05-23T20:57:08.922Z", // File expiration date
"arquivo": "string" // Required - Byte array containing the file
}
}'
Proposal Finalization
curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/Finalizar' \
--header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer g3Lmb6cowHidKJwwu8J-5xAVAViSysAZAajzeeeTXq4' \
--data '{
"dto": {
"codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Sequential proposal number
"codigoOperacao": "string" // string(50) Partner Operation Code
},
"parametros": [
{
"Nome": "FINALIZACAO_VALIDARPARCELAS",
"Valor": "FALSE"
},
{
"Nome": "IP_ADDRESS",
"Valor": "00.000.000.00"
}
]
}'
Show Proposal Release
curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/Liberar' \
--header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \
--header 'Content-Type: application/json' \
--data '{
"dto": { // Only one of the fields below must be filled in
"codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Sequential proposal number
"codigoOperacao": "string" // string(50) Partner Operation Code
},
"parametros": [
{}
]
}'
Was this page helpful?