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

Through this endpoint, it is possible to cancel individual protests.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Headers

​
IdempotencyKey
string
required

Chave única para garantir que uma operação seja executada apenas uma vez.

​
IgnoraHandshake
boolean
default:true
required

(somente em homologação)

Body

​
numCodBarras
string[] | null

Lista de números de Código de Barras dos Boletos envolvidos na operação.

Response

200 - application/json
Success
​
sucesso
boolean

Indica se a operação foi realizada com sucesso.

​
mensagem
string | null

Descrição detalhada do resultado da operação, incluindo informações sobre erros ou mensagens complementares.

Was this page helpful?