59 - Consultar Cancelamento de Boleto

Scopes:

api.ext api.boleto.consultarCancelamento

Consulta o cancelamento de boletos bancários previamente registrados.

cURL

curl --request GET \
  --url https://api.ext.dbs.moneyp.dev.br/api/Boleto/ConsultarCancelamento \
  --header 'Authorization: <api-key>'

200

{
  "sucesso": true,
  "mensagem": "<string>",
  "cancelamentos": [
    {
      "codigoCancelamento": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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.

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/Boleto/ConsultarCancelamento	Parâmetro inválido
/api/Boleto/ConsultarCancelamento	Somente um dos grupos de parâmetros deve ser informado

Autorizações

Authorization · string · header · obrigatório

Copie 'Bearer ' + token

Parâmetros de consulta

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.

Resposta

200

application/json

Success

sucesso · boolean

mensagem · string | null

cancelamentos · object[] | null

Show child attributes