curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/api/Boleto/CancelarRegistro \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --header 'IgnoraHandshake: <ignorahandshake>' \
  --data '{
  "listaCodigos": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "listaCodigosBarras": [
    "<string>"
  ]
}'
{
  "sucesso": true,
  "mensagem": "<string>",
  "listaCodigosCancelamento": [
    {
      "codigoRegistroBoleto": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "codigoCancelamento": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "situacaoBoleto": 1,
      "sucesso": true,
      "mensagem": "<string>",
      "ticketId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Por meio desse endpoint, o parceiro pode cancelar o registro de um boleto desde que ainda não tenha sido pago.

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

​
listaCodigos
string[] | null

Lista de códigos UUID identificadores dos boletos.

​
listaCodigosBarras
string[] | null

Lista de códigos de barras dos boletos.

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.

​
listaCodigosCancelamento
object[] | null

Lista de resultados.

Esta página foi útil?