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.

Este serviço é utilizado para mudar a situação da CCB para cancelada e realizar a desaverbação. O cancelamento deve ser feito por API enquanto ainda não houve pagamento ou cessão da proposta.

Endpoint

POST /contrato/cancelar

Descrição dos campos da Requisição

NumeroContrato
string
obrigatório
Número da CCB que deve ser cancelada.
motivoExclusao
string
obrigatório
Motivo de exclusão que será informado na Dataprev.
  • 1 Desistência do empréstimo
  • 2 Falecimento
  • 3 Liquidação antecipada
  • 7 Ação judicial
  • 8 Exclusão por fraude
  • 9 Outros
curl --location --request POST 'https://econsignadotrabalhador.moneyp.dev.br/contrato/cancelar' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data '{
  "motivoExclusao": 1,
  "numeroContrato": "123"
}'
{
"CodigoRequisicao": "971dc07b-c9fb-47ba-a552-45fe7d5d1dd9",
"Origem": "CancelarContrato",
"Conteudo": {},
"Erros": []
}

Webhook

Dois eventos são disparados quando houver o cancelamento. Um evento confirma desaverbação na Dataprev e outro evento confirma cancelamento da proposta na BMP.
Confirmação de desaverbação na Dataprev
{
"CodigoRequisicao": "971dc07b-c9fb-47ba-a552-45fe7d5d1dd9",
"Endpoint": "/contrato/cancelar",
"Payload": {
  "Conteudo": {
    "codigoSucesso": "BF",
    "mensagem": "Exclusão efetuada com sucesso",
    "numeroContrato": "123",
    "hashOperacao": 1139911716,
    "competenciaExclusao": 202603,
    "tipoOperacao": null
  },
  "Errors": [],
  "HashOperacao": ""
}
Confirmação de cancelamento na BMP
{
"CodigoRequisicao": "971dc07b-c9fb-47ba-a552-45fe7d5d1dd9",
"Endpoint": "/contrato/cancelar",
"Payload": {
	"Conteudo": {
		"Mensagem": "Contrato nº 123 cancelado com sucesso."},
	"Erros": []}
}