Cancelar o BOLEPIX

Descrição #

Este endpoint permite o cancelamento de uma cobrança do tipo BOLEPIX que esteja com status PENDENTE. Para realizar essa operação, é necessário informar o CorrelationId da cobrança. O cancelamento deve ser realizado via requisição DELETE, conforme a estrutura detalhada abaixo.

Endpoints #

• Produção: https://api2.bancosemear.com.br/paas-billet-api/api/v1/public/paas-billets
• Homologação: https://hmlapi2.bancosemear.com.br/paas-billet-api/api/v1/public/paas-billets

Requisição (DELETE) #

Segue exemplo da requisição:

curl --location --request DELETE 'https://hmlapi2.bancosemear.com.br/paas-billet-api/api/v1/public/paas-billets' \
--header 'client_id: f7e8e9a4-8481-4713-a024-f2edb28601a3' \
--header 'access_token: 01d0923e-c184-4f8d-b763-d562a9beda13' \
--header 'Content-Type: application/json' \
--data '{
  "correlationId": "e37b99cb-450e-4c28-baf8-ebf10d2d4c7c",
  "accountNumber": "0119999991",
  "assignorDocument": "99999927000121"
}'

Parâmetros de Requisição #

Cabeçalho #

• Content-Type: Informa ao servidor de que o corpo da requisição possui o formato JSON.
• client_id: ID de cliente usado para encaminhar a requisição ao gateway de APIs
• access_token: Token recebido após executar o método oAuth (Access Token)

Estrutura do body #

Resposta (200 OK) #

{
    "hasCanceled": true,
    "errorMessage": "Sem erro"
}