73 - Solicitar Desistência

Scopes:

api.ext api.boleto.protesto.solicitarDesistencia

Solicita desistência para protestos de boleto previamente solicitados.

cURL

curl --request POST \
  --url https://api.ext.dbs.moneyp.dev.br/api/ProtestoBoleto/SolicitarDesistencia \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --header 'IgnoraHandshake: <ignorahandshake>' \
  --data '
{
  "numCodBarras": [
    "<string>"
  ]
}
'

200

{
  "sucesso": true,
  "mensagem": "<string>"
}

Por meio deste endpoint, é possível solicitar a desistência do comando de protesto.

Uma requisição de “Desistência” só poderá ser acatada antes que o comando do protesto seja formalizado.

A opção de “Desistência” só está disponível para os boletos com o status “Em protesto”.

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:

Endpoint	Mensagem de erro
/api/ProtestoBoleto/SolicitarDesistencia	Não foram informados códigos de barras válidos para desistência de protesto
/api/ProtestoBoleto/SolicitarDesistencia	Não há boletos em protestos para desistência
/api/ProtestoBoleto/SolicitarDesistencia	Data limite não pode ser menor que a data de vencimento
/api/ProtestoBoleto/SolicitarDesistencia	Data do vencimento não pode ser menor que a data atual
/api/ProtestoBoleto/SolicitarDesistencia	Valor do boleto não pode ser menor igual a zero

Autorizações

Authorization · string · header · obrigatório

Copie 'Bearer ' + token

Cabeçalhos

IdempotencyKey · string · obrigatório

IgnoraHandshake · boolean · padrão: true · obrigatório

(somente em homologação)

Corpo

application/jsontext/jsonapplication/*+json

numCodBarras · string[] | null

Lista de números de código de barras dos boletos protestados.

Observação:

• O número de cada um dos códigos de barras dos boletos protestados pode ter no máximo 44 caracteres.*

Resposta

200

application/json

Success

sucesso · boolean

mensagem · string | null