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
Hiring
22 - Consult
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/Proposta/Consultar \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '{
"dto": {
"codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoOperacao": "<string>",
"numeroProposta": 123
}
}'
{
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dtInclusao": "<string>",
"situacao": 123,
"vlrFinanciado": 123,
"qtdeParcelas": 123,
"vlrParcela": 123,
"vlrTAC": 123,
"vlrBoleto": 123,
"vlrSeguro": 123,
"vlrIOF": 123,
"vlrOutrasDespesas": 123,
"vlrOutrosServicos": 123,
"vlrTotalCredito": 123,
"vlrTotalDivida": 123,
"vlrDesembolso": 123,
"percCETMensal": 123,
"percCETAnual": 123,
"percJurosMensal": 123,
"percJurosAnual": 123,
"codigoOperacao": "<string>",
"tipoContrato": "<string>",
"dtPagamento": "2023-11-07T05:31:56Z",
"codigoProposta": "<string>",
"numeroCCB": "<string>",
"motivoRejeicao": "<string>",
"textoRetornoPagamento": "<string>",
"autenticacaoBancaria": "<string>",
"controleBancario": "<string>",
"textoMotivoAnalise": "<string>",
"nomeFavorecido": "<string>",
"documentoFavorecido": "<string>",
"propostaLancamentos": [
{
"campoID": "<string>",
"descricaoCampo": "<string>",
"vlrTransacao": 123,
"dtPrevPagto": "2023-11-07T05:31:56Z",
"dtPagamento": "2023-11-07T05:31:56Z",
"situacao": 123,
"linhaDigitavel": "<string>",
"dtVenctoBoleto": "2023-11-07T05:31:56Z",
"vlrBoleto": 123,
"codigoBanco": 123,
"numeroBanco": "<string>",
"tipoConta": 123,
"agencia": "<string>",
"agenciaDig": "<string>",
"conta": "<string>",
"contaDig": "<string>",
"documentoFederal": "<string>",
"nomePagamento": "<string>",
"textoRetornoPagamento": "<string>",
"autenticacaoBancaria": "<string>",
"controleBancario": "<string>",
"descricaoOcorrencia": "<string>"
}
],
"propostaContaPagamento": {
"codigoBanco": 123,
"tipoConta": 123,
"agencia": "<string>",
"agenciaDig": "<string>",
"conta": "<string>",
"contaDig": "<string>",
"numeroBanco": "<string>",
"documentoFederalPagamento": "<string>",
"nomePagamento": "<string>"
}
}
Through this endpoint, the partner consults the proposal, obtaining the main fields’ response.
Category | Operation | Action | Code | Detailed Code | Message |
---|---|---|---|---|---|
Proposta | ConsultaProposta | Consultar | C0019 | V0001 | Produto não configurado para esta integração |
Proposta | ConsultaProposta | Consultar | C0113 | V0001 | Proposta não encontrada |
Proposta | ConsultaProposta | Consultar | C0113 | V0002 | A Proposta não pertence à esta Integração |
Authorizations
Informe o token
Headers
Body
Response
200
text/plain
OK
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
Was this page helpful?
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/Proposta/Consultar \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '{
"dto": {
"codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoOperacao": "<string>",
"numeroProposta": 123
}
}'
{
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dtInclusao": "<string>",
"situacao": 123,
"vlrFinanciado": 123,
"qtdeParcelas": 123,
"vlrParcela": 123,
"vlrTAC": 123,
"vlrBoleto": 123,
"vlrSeguro": 123,
"vlrIOF": 123,
"vlrOutrasDespesas": 123,
"vlrOutrosServicos": 123,
"vlrTotalCredito": 123,
"vlrTotalDivida": 123,
"vlrDesembolso": 123,
"percCETMensal": 123,
"percCETAnual": 123,
"percJurosMensal": 123,
"percJurosAnual": 123,
"codigoOperacao": "<string>",
"tipoContrato": "<string>",
"dtPagamento": "2023-11-07T05:31:56Z",
"codigoProposta": "<string>",
"numeroCCB": "<string>",
"motivoRejeicao": "<string>",
"textoRetornoPagamento": "<string>",
"autenticacaoBancaria": "<string>",
"controleBancario": "<string>",
"textoMotivoAnalise": "<string>",
"nomeFavorecido": "<string>",
"documentoFavorecido": "<string>",
"propostaLancamentos": [
{
"campoID": "<string>",
"descricaoCampo": "<string>",
"vlrTransacao": 123,
"dtPrevPagto": "2023-11-07T05:31:56Z",
"dtPagamento": "2023-11-07T05:31:56Z",
"situacao": 123,
"linhaDigitavel": "<string>",
"dtVenctoBoleto": "2023-11-07T05:31:56Z",
"vlrBoleto": 123,
"codigoBanco": 123,
"numeroBanco": "<string>",
"tipoConta": 123,
"agencia": "<string>",
"agenciaDig": "<string>",
"conta": "<string>",
"contaDig": "<string>",
"documentoFederal": "<string>",
"nomePagamento": "<string>",
"textoRetornoPagamento": "<string>",
"autenticacaoBancaria": "<string>",
"controleBancario": "<string>",
"descricaoOcorrencia": "<string>"
}
],
"propostaContaPagamento": {
"codigoBanco": 123,
"tipoConta": 123,
"agencia": "<string>",
"agenciaDig": "<string>",
"conta": "<string>",
"contaDig": "<string>",
"numeroBanco": "<string>",
"documentoFederalPagamento": "<string>",
"nomePagamento": "<string>"
}
}