Pular para o conteúdo principal
GET
/
api
/
Boleto
/
ConsultarCancelamento
Consulta o cancelamento de boletos bancários previamente registrados.
curl --request GET \
  --url https://api.ext.dbs.moneyp.dev.br/api/Boleto/ConsultarCancelamento \
  --header 'Authorization: <api-key>'
{
  "sucesso": true,
  "mensagem": "<string>",
  "cancelamentos": [
    {
      "codigoCancelamento": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "situacao": 0,
      "numCodBarras": "<string>"
    }
  ]
}
Por meio deste endpoint o parceiro pode consultar os boletos cancelados e os seus respectivos status de cancelamento, se já foram efetivados ou não.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Query Parameters

​
ListaCodigos
string<uuid>[]

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[]

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
​
cancelamentos
object[] | null