Cancelar recuperação de valores

Visão Geral

É possível realizar o cancelamento de uma recuperação de valores que está aberta, porém somente o participante criador da recuperação pode solicitar este cancelamento.

🚧

O cancelamento da recuperação de valores cancelará todas as notificações de infração vinculadas, independente do estado, e todas as solicitações de devoluções vinculadas a ela que ainda não estejam fechadas.


Passos para Integrar

  1. Consultar recuperação de valores - [API Reference]

Como realizar o cancelamento

Para cancelar basta chamar o endpoint [POST]
/funds-recovery/(fundsRecoveryId)/cancel, informando o parâmetro o id da recuperação de valores.

Path Parameters

CampoDescriçãoTipo CampoObrigatório
fundsRecoveryIdIdentificador da Recuperação de Valoresstring✅ Sim

Exemplo de retorno

👍

Sucesso 200

{ 
  "status": 200,
  "version": "string",
  "body":{
    "fundsRecoveryId":"ca1b9c01-ff9e-4a58-90ab-d31512e15ce0",
    "status":"CANCELLED",
    "creationTime":"2020-01-17T10:00:00.000Z",
    "lastModified":"2020-01-17T10:00:00.000Z",

  }
}

Em caso de retorno de sucesso, a recuperação de valores já estará cancelada.

Erros

Error 400

{
  "status": 400,
  "version": "string",
  "error": {
    "errorCode": "string",
    "message": "string"
  }