Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://bmpdocs.moneyp.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Com a evolução da estrutura de identificação das propostas e contratos, alguns campos anteriormente tratados apenas como numéricos passaram a suportar valores alfanuméricos. Essa alteração visa:
  • Garantir maior flexibilidade de identificação;
  • Suportar novos padrões operacionais;
  • Evitar limitações de tamanho e formato;
  • Melhorar interoperabilidade entre parceiros e sistemas.

Impactos Esperados

Os parceiros deverão revisar:
  • Validações de tipo;
  • Máscaras e regex;
  • Estruturas de banco de dados;
  • Conversões numéricas;
  • Serializações;
  • Regras de integração.

Lista Completa de APIs Impactadas

APIs de Crédito

Abaixo estão listadas as APIs contendo endpoints, controllers impactados, endpoint externo e payloads afetados.
#Endpoint
1IncluirPropostaRenegociacao
2PropostaAtualizarCampoExtra
3CreateUpdatePropostaLancamento
4PropostaAtualizarContaPagamento
5PropostaAtualizarPIXPagamento
6PropostaAtualizarPIXPagamentoParcela
7CreateUpdatePropostaBoleto
8CreateUpdatePropostaBoletoParcela
9CreateUpdatePropostaCarnet
10CreateUpdatePropostaPIX
11AtualizarProposta
12BuscarProposta
13BuscarPropostaDetalhada
14BuscarPropostaParceiro
15BuscarContrato
16BuscarContratoDetalhado
17BuscarOperacao
18BuscarOperacaoParceiro
19AtualizarOperacao
20BuscarContaPagamento
21AtualizarContaLiquidacao
22BuscarDadosPIX
23AtualizarDadosPIX
24BuscarNumeroProposta
25BuscarCodigoCCB
26BuscarDadosLiquidacao
27BuscarStatusContrato
28BuscarDadosAgenda
29BuscarDocumentoCliente
30BuscarCodigoOperacao
31AtualizarNumeroProposta
32ConsultarPropostaAlfanumerica
33CreateUpdatePropostaPIXExterno
34CreateUpdatePropostaBoletoExterno
35IncluirNotaComercial
36IncluirPropostaManual
37IncluirPropostaManualSAC
38IncluirPropostaManualSimplificado
39IncluirPropostaManualSimplificadoPrice
40IncluirPropostaManualSimplificadoSAC
41IncluirPropostaFluxoIrregular

APIs Manuais

Os seguintes endpoints compartilham o mesmo padrão de alteração:
  • IncluirPropostaManual
  • IncluirPropostaManualSAC
  • IncluirPropostaManualSimplificado
  • IncluirPropostaManualSimplificadoPrice
  • IncluirPropostaManualSimplificadoSAC
  • IncluirPropostaFluxoIrregular

Alteração Aplicada

Todos os endpoints acima passam a retornar:
{
  "Msg": "string",
  "Result": false,
  "Codigo": "Guid",
  "Numero": 0,
  "CodigoProposta": "string"
}

Campos Impactados

CampoAlteração
CodigoPropostaNumérico → Alfanumérico
CodigoOperacaoNumérico → Alfanumérico
NumeroPropostaNumérico → Alfanumérico
CodigoCCBNumérico → Alfanumérico
CodigoContratoOriginalNumérico → Alfanumérico

APIs de Agenda

#Endpoint
37/AgendaRecebivel/ConsultarBoletos
38/AgendaRecebivel/ConsultarDetalhes

APIs de Crédito

1. IncluirPropostaRenegociacao

Controllers Impactados

ControllerImpactado
BMPDigitalControllerSim
MultiploControllerNão
PartnerControllerNão

Endpoint Externo

IncluirPropostaRenegociacao

Request

{
  "dto": {
    "CodigoContratoOriginal": "string",
    "ValorPropostaPrincipal": 0,
    "DocumentoCliente": "string",
    "DocumentoPromotor": "string"
  }
}

Response

{
  "Msg": "string",
  "Result": false,
  "Codigo": "Guid",
  "Numero": 0,
  "CodigoProposta": "string"
}

Alterações Realizadas

CampoAntesDepois
CodigoContratoOriginalNuméricoAlfanumérico
CodigoPropostaNuméricoAlfanumérico

Observações

  • O campo CodigoContratoOriginal passa a aceitar letras e números.
  • O campo CodigoProposta deve ser tratado como string em toda a integração.

2. PropostaAtualizarCampoExtra

Controllers Impactados

ControllerImpactado
BMPDigitalControllerSim
MultiploControllerSim
PartnerControllerNão

Endpoint Externo

AtualizarCampoExtra

Request

{
  "dto": {
    "CodigoProposta": "00000000-0000-0000-0000-000000000000",
    "CodigoOperacao": "string",
    "NumeroProposta": "string"
  }
}

Response

Retorno simplificado:
"OK"

Alterações Realizadas

CampoAntesDepois
NumeroPropostaNuméricoAlfanumérico
CodigoOperacaoNuméricoAlfanumérico

Observações

  • Não realizar parse numérico no campo NumeroProposta.
  • O endpoint retorna apenas confirmação de processamento.

3. CreateUpdatePropostaLancamento

Controllers Impactados

ControllerImpactado
BMPDigitalControllerSim
MultiploControllerSim
PartnerControllerNão

Endpoint Externo

SalvarLancamento

Request

{
  "dto": {
    "CodigoProposta": "00000000-0000-0000-0000-000000000000",
    "CodigoOperacao": "string",
    "NumeroProposta": "string"
  }
}

Response

Retorno simplificado:
"OK"

Alterações Realizadas

CampoAntesDepois
NumeroPropostaNuméricoAlfanumérico
CodigoOperacaoNuméricoAlfanumérico

4. PropostaAtualizarContaPagamento

Controllers Impactados

ControllerImpactado
BMPDigitalControllerSim
MultiploControllerSim
PartnerControllerNão

Endpoint Externo

AtualizarContaPagamento

Request

{
  "dto": {
    "CodigoProposta": "00000000-0000-0000-0000-000000000000",
    "CodigoOperacao": "string",
    "NumeroProposta": "string"
  }
}

Response

Retorno simplificado:
"OK"

Alterações Realizadas

CampoAntesDepois
NumeroPropostaNuméricoAlfanumérico
CodigoOperacaoNuméricoAlfanumérico

APIs de Agenda

1. /AgendaRecebivel/ConsultarBoletos

Response

{
  "msg": "string",
  "hasError": true,
  "boletos": [
    {
      "numeroBoleto": 0,
      "numeroProposta": 0,
      "codigoCCB": "A458F32"
    }
  ]
}

Alterações Realizadas

CampoAntesDepois
codigoCCBNuméricoAlfanumérico

Observações

  • O campo codigoCCB passa a aceitar letras e números.
  • Não utilizar validações exclusivamente numéricas.

2. /AgendaRecebivel/ConsultarDetalhes

Response

{
  "numeroProposta": 0,
  "codigoCCB": "A458F32",
  "numeroPropostaAlfa": "string"
}

Alterações Realizadas

CampoAntesDepois
codigoCCBNuméricoAlfanumérico
numeroPropostaAlfaNão existenteNovo campo

Observações

  • Foi adicionado o novo campo numeroPropostaAlfa.
  • Os parceiros devem priorizar o consumo do identificador alfanumérico quando aplicável.
  • Sistemas legados que utilizam apenas numeroProposta devem ser revisados.

Recomendações Técnicas para Parceiros

Ajustes Recomendados

Banco de Dados

Alterar tipos de campos:
AntesRecomendado
INTVARCHAR
BIGINTVARCHAR
NUMERICVARCHAR

Validações

Remover validações como:
^[0-9]+$
Substituir por:
^[A-Za-z0-9]+$

Serialização

Garantir que os campos sejam tratados como:
"string"
Evitar:
  • ParseInt;
  • Conversão automática para long/int;
  • Máscaras numéricas.

Compatibilidade

Retrocompatibilidade

Durante o período de transição:
  • Alguns endpoints poderão retornar valores exclusivamente numéricos;
  • Novos contratos poderão utilizar identificadores alfanuméricos;
  • As integrações devem suportar ambos os formatos.

Checklist de Adequação

ItemObrigatório
Ajustar banco de dadosSim
Ajustar validaçõesSim
Ajustar serializaçãoSim
Revisar logs e auditoriaSim
Revisar filtros e buscasSim
Revisar exportaçõesSim