Cancelar um Pix agendado

A funcionalidade de Cancelamento de Pix Agendado permite que clientes cancelem uma transação Pix previamente agendada. Com essa API, é possível realizar o cancelamento informando dados como o valor, a data programada e os detalhes do destinatário e remetente, desde que a transação ainda esteja no status pendente.

Passos para Integrar

  1. Realizar autenticação na API - [API Reference]
  2. Cancelar uma transação Pix - [API Reference]

Fluxo de integração



Cancelar o Pix agendado

📘

Não é possível cancelar um agendamento no dia de execução do mesmo.


cURL da chamada

curl --location --request DELETE 'https://kubernetes.celcoin.dev/dev-celcoin-scheduler-webservice/scheduler/{{schedulerId}}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

Exemplo de retorno

👍

Sucesso 200

{
    "status": "CONFIRMED",
    "version": "1.0.0"
}

Error 400

{
  "version": "1.0.0",
  "status": "ERROR",
  "error": {
    "errorCode": "SCH079",
    "message": "Cancelamento não permitido. Só podem ser cancelados agendamentos com data maior que a atual."
  }
}

Tabela de errorCode

CodeMessage
SCH005Não foi possível processar recuperar o Tenant com os parametros informados.
SCH041Consulta não pode ser realizada. Verifique os parâmetros informados.
SCH078Não é possivel realizar o cancelamento de um agendamento que esteja diferente de SCHEDULED ou CREATED.
SCH079Cancelamento não permitido. Só podem ser cancelados agendamentos com data maior que a atual.