Initial Guide
- About Credit as a Service
- Credit Operations
Developer's Guide
- API Integration Guide
APIs Reference
- Simulations
- Onboarding
- Hiring
- Guarantees
- Document Printing
- Signatures
- Disbursement
Use Cases
- Personal Loan
25 - Include
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/Proposta/Incluir \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '{
"dto": {
"codigoOperacao": "<string>",
"documentoCliente": "<string>",
"documentoParceiroCorrespondente": "<string>",
"documentoPromotor": "<string>",
"tipoContrato": "<string>",
"codigoVersaoCCB": 123,
"calculoProposta": {
"propostaModelo": 123,
"dadosCalculo": "<any>"
},
"propostaContaPagamentoDTO": {
"codigoBanco": 123,
"tipoConta": 123,
"agencia": "<string>",
"agenciaDig": "<string>",
"conta": "<string>",
"contaDig": "<string>",
"numeroBanco": "<string>",
"documentoFederalPagamento": "<string>",
"nomePagamento": "<string>"
},
"propostaLancamentos": [
{
"campoID": "<string>",
"vlrTransacao": 123,
"dtPagamento": "2023-11-07T05:31:56Z",
"linhaDigitavel": "<string>",
"codigoBanco": 123,
"numeroBanco": "<string>",
"tipoConta": 123,
"agencia": "<string>",
"agenciaDig": "<string>",
"conta": "<string>",
"contaDig": "<string>",
"documentoFederal": "<string>",
"nomePagamento": "<string>",
"documentoFederalCedente": "<string>",
"nomeCedente": "<string>"
}
]
},
"parametros": [
{
"nome": "<string>",
"valor": "<string>"
}
]
}'
{
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"numero": 123
}
Through this endpoint, the partner includes a proposal, considering the use of a calculation model through the attribute ProposalModel
.
Authorizations
Informe o token
Headers
Body
Codigo da operação
50
Documento do cliente
20
Documento do parceiro correspondente
20
Documento promotor
20
Sigla do tipo de contrato a ser criado
5
Codigo da versão CCB
Código do banco
Tipo de conta
Agência
Conta bancária
Dígito da conta
Número do banco
Dígito da agência
Novo documento federal para pagamento
Nome referente ao novo documento federal para pagamento
Valor de transação.
Identifica o tipo de lançamento.
Data de pagamento
String contendo informações do boleto, como dados do banco, destinatário etc.
60
Código do banco
Número do banco
Tipo de conta
Agencia bancária
10
Dígito da Agência
1
Conta bancária
20
Dígito da conta
1
Documento federal do cliente
20
Nome da pessoa para pagamento (quando difere do Titular)
60
Documento federal do cedente
20
Nome do cedente
60
Was this page helpful?
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/Proposta/Incluir \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '{
"dto": {
"codigoOperacao": "<string>",
"documentoCliente": "<string>",
"documentoParceiroCorrespondente": "<string>",
"documentoPromotor": "<string>",
"tipoContrato": "<string>",
"codigoVersaoCCB": 123,
"calculoProposta": {
"propostaModelo": 123,
"dadosCalculo": "<any>"
},
"propostaContaPagamentoDTO": {
"codigoBanco": 123,
"tipoConta": 123,
"agencia": "<string>",
"agenciaDig": "<string>",
"conta": "<string>",
"contaDig": "<string>",
"numeroBanco": "<string>",
"documentoFederalPagamento": "<string>",
"nomePagamento": "<string>"
},
"propostaLancamentos": [
{
"campoID": "<string>",
"vlrTransacao": 123,
"dtPagamento": "2023-11-07T05:31:56Z",
"linhaDigitavel": "<string>",
"codigoBanco": 123,
"numeroBanco": "<string>",
"tipoConta": 123,
"agencia": "<string>",
"agenciaDig": "<string>",
"conta": "<string>",
"contaDig": "<string>",
"documentoFederal": "<string>",
"nomePagamento": "<string>",
"documentoFederalCedente": "<string>",
"nomeCedente": "<string>"
}
]
},
"parametros": [
{
"nome": "<string>",
"valor": "<string>"
}
]
}'
{
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"numero": 123
}