Pular para o conteúdo principal
POST
/
api
/
Boleto
/
CancelarRegistro
Cancela o registro de um boleto bancário previamente registrado.
curl --request POST \
  --url https://api.ext.dbs.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
​
IgnoraHandshake
boolean
default:true
required

(somente em homologação)

Body

​
listaCodigos
string<uuid>[] | null

Lista de códigos UUID identificadores dos boletos.

Observação:

  • Quando a 'lista de códigos UUID de identificadores dos boletos' (listaCodigos) for informada, a 'lista de códigos de barras dos boletos' (listaCodigosBarras) não deve ser preenchida.
​
listaCodigosBarras
string[] | null

Lista de códigos de barras dos boletos.

Observação:

  • Quando a 'lista de códigos de barras dos boletos' (listaCodigosBarras) for informada, a 'lista de códigos UUID de identificadores dos boletos' (listaCodigos) não deve ser preenchida.

Response

Success

​
sucesso
boolean
​
mensagem
string | null
​
listaCodigosCancelamento
object[] | null