6 - Cancelar Proposta

cURL

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/FGTS/CancelarProposta \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '{}'

200

{
  "Msg": "<string>",
  "HasError": true,
  "Messages": [
    {
      "Code": "<string>",
      "Context": "<string>",
      "Description": "<string>",
      "Field": "<string>"
    }
  ],
  "Boleto": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Não é possível realizar a chamada do endpoint de cancelamento com 7 dias do desembolso da proposta ou se ela se encontrar com o status de cedida (ID = 10).

Por meio desta endpoint o parceiro cancela uma operação de FGTS. Regras:

• A operação não pode ultrapassar o prazo de 7 dias do momento do desembolso
• Caso ocorra desembolso da operação, será necessária a devolução do valor para nós.

​

Mensagens de erro

A tabela abaixo representa as mensagens de erro que podem ser retornadas ao tentar realizar uma requisição.

Mostrar Mensagens de requisições com erro

O retorno de uma requisição com status HTTP 400 (Bad Request) pode incluir as seguintes mensagens de erro:

Código	Mensagem Técnica	Mensagem ao Usuário	Tipo de Erro
400	4. Número de CPF inválido	O número do CPF informado é inválido	Erro de validação
400	5. Existe uma Operação Fiduciária em andamento. Tente mais tarde	Existe uma Operação Fiduciária em andamento. Tente mais tarde	Erro de negócio
400	10. Operação não permitida antes de determinada data	A operação não é permitida antes de determinada data	Erro de negócio
400	13. Operação não permitida por pendência no processo de pagamento de saque-aniversário	A operação não é permitida por pendência no processo de pagamento de saque-aniversário	Erro de negócio
400	27. Operação já cancelada	A operação já foi cancelada	Erro de negócio
400	28. Cancelamento não permitido	O cancelamento não é permitido	Erro de negócio
400	38. Identificador da Solicitação inválido	O identificador da solicitação é inválido	Erro de negócio

Autorizações

Authorization · string · header · obrigatório

Informe o token

Cabeçalhos

IdempotencyKey · string · obrigatório

Corpo

application/jsontext/jsonapplication/*+json

dto · object

Show child attributes

Resposta

200

text/plain

OK

Msg · string | null

HasError · boolean

Messages · object[] | null

Show child attributes

Boleto · string<uuid> | null