Cancelar Boleto

POST/api/billissuer/request-cancellation?accountNumber={accountNumber}&integrationBillIssuedId={integrationBillIssuedId}

Este endpoint é utilizado para solicitar o cancelamento de um boleto emitido. Após a solicitação, uma rotina processará o pedido para efetivar o cancelamento ou retornará um status de falha com o motivo.

Recebe o ID do boleto a ser cancelado e retorna uma mensagem confirmando o status da solicitação.

Requisição

{
  "accountNumber": "long",
  "integrationBillIssuedId": "string"
}

Dicionário de dados - Parâmetros

Exemplo de requisição

curl --request POST \
  --url 'https://integration.enoqbank.com/enoq/api/billissuer/request-cancellation?accountNumber={accountNumber}&integrationBillIssuedId={integrationBillIssuedId}' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json'

Retorno (200)

Exemplo de resposta

{
  "message": "string"
}

Dicionário de dados

Erros

As respostas de erro conhecidas estão abaixo. Os retornos observados em homologação estão identificados separadamente dos exemplos documentados; as respostas podem variar conforme o ambiente e a configuração.

Observado em homologação

Requisição sem o header Authorization. A camada de autenticação pode rejeitar a chamada antes de resolver a rota ou validar os dados.

HTTP/1.1 401 Unauthorized

A resposta não possui corpo. Não há campos JSON para interpretar neste cenário.