Cancelamento de empréstimo

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": []
}

{
    "CodigoRequisicao": "bc32955d-0b59-4db8-8f3c-27d4faee50bb",
    "Origem": "CancelarContrato",
    "Conteudo": null,
    "Erros": [
        {
            "Codigo": "CON_003",
            "Message": "Não é permitido cancelar: proposta paga.",
            "Id": "5f9d9d82-7c2a-4b1f-93a4-0c9f5e3a2002",
            "Campo": null
        }
    ]
}

{
    "CodigoRequisicao": "3f52bd56-1821-4a3d-90ba-6c3c0a0c87f9",
    "Origem": "CancelarContrato",
    "Conteudo": null,
    "Erros": [
        {
            "Codigo": "CON_003",
            "Message": "Não é permitido cancelar: proposta cedida.",
            "Id": "6a8c2c07-9b2b-4a8f-9f7f-79c7aa64d001",
            "Campo": null
        }
    ]
}

{
    "CodigoRequisicao": "71fe2003-d925-416b-8cf4-597ceea7ae3d",
    "Origem": "CancelarContrato",
    "Conteudo": null,
    "Erros": [
        {
            "Codigo": "CON_003",
            "Message": "Contrato nº A0000F00 está cancelado.",
            "Id": "f5ad1480-9a39-4e52-b4b8-122f5b439b80",
            "Campo": "NumeroContrato"
        }
    ]
}

{
    "CodigoRequisicao": "732b089d-0e70-4aaa-a1fc-3659b757ad9a",
    "Origem": "CancelarContrato",
    "Conteudo": null,
    "Erros": [
        {
            "Codigo": "CON_003",
            "Message": "Contrato nº A0000HP1 inexistente.",
            "Id": "b6b5d1f0-0f3d-4d64-9a1c-1a1a1a1a0004",
            "Campo": "NumeroContrato"
        }
    ]
}

Fluxo de cancelamento

Ao receber uma solicitação de cancelamento, a BMP executa as etapas abaixo, nesta ordem. Se qualquer validação falhar, o processo é interrompido e um erro é retornado (ver exemplos de resposta 400 abaixo) — nenhuma etapa seguinte é executada.

Validação do contrato — verifica se o número do contrato informado existe.
Validação da situação da proposta — verifica se a proposta pode ser cancelada. Não é possível cancelar uma proposta que já esteja paga, cedida ou cancelada.
Exclusão na Dataprev (desaverbação) — a BMP envia a exclusão do empréstimo consignado para a Dataprev. Ao ser confirmada, é disparado o webhook de confirmação de desaverbação (ver seção Webhooks).
Cancelamento no BMP Digital — a situação da proposta é alterada para cancelada no sistema da BMP. Ao ser concluído, é disparado o webhook de confirmação de cancelamento (ver seção Webhooks).

Descrição dos campos da Requisição

string

obrigatório

Número da CCB que deve ser cancelada.

number

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": []
}

{
    "CodigoRequisicao": "bc32955d-0b59-4db8-8f3c-27d4faee50bb",
    "Origem": "CancelarContrato",
    "Conteudo": null,
    "Erros": [
        {
            "Codigo": "CON_003",
            "Message": "Não é permitido cancelar: proposta paga.",
            "Id": "5f9d9d82-7c2a-4b1f-93a4-0c9f5e3a2002",
            "Campo": null
        }
    ]
}

{
    "CodigoRequisicao": "3f52bd56-1821-4a3d-90ba-6c3c0a0c87f9",
    "Origem": "CancelarContrato",
    "Conteudo": null,
    "Erros": [
        {
            "Codigo": "CON_003",
            "Message": "Não é permitido cancelar: proposta cedida.",
            "Id": "6a8c2c07-9b2b-4a8f-9f7f-79c7aa64d001",
            "Campo": null
        }
    ]
}

{
    "CodigoRequisicao": "71fe2003-d925-416b-8cf4-597ceea7ae3d",
    "Origem": "CancelarContrato",
    "Conteudo": null,
    "Erros": [
        {
            "Codigo": "CON_003",
            "Message": "Contrato nº A0000F00 está cancelado.",
            "Id": "f5ad1480-9a39-4e52-b4b8-122f5b439b80",
            "Campo": "NumeroContrato"
        }
    ]
}

{
    "CodigoRequisicao": "732b089d-0e70-4aaa-a1fc-3659b757ad9a",
    "Origem": "CancelarContrato",
    "Conteudo": null,
    "Erros": [
        {
            "Codigo": "CON_003",
            "Message": "Contrato nº A0000HP1 inexistente.",
            "Id": "b6b5d1f0-0f3d-4d64-9a1c-1a1a1a1a0004",
            "Campo": "NumeroContrato"
        }
    ]
}

Webhooks

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": []}
}

Guia do Desenvolvedor

Tipos de Contratação

Outros

Autorregulação

Cancelamento de empréstimo

Fluxo de cancelamento

Descrição dos campos da Requisição

Webhooks

​Fluxo de cancelamento

​Descrição dos campos da Requisição

​Webhooks

Fluxo de cancelamento

Descrição dos campos da Requisição

Webhooks