Documentação
DocumentaçãoAPIStatusSuporteFAQscelcoin.com

Cancelamento de agendamento

Suggest Edits

O cancelamento do agendamento é o ato formal realizado pelo pagador de cancelar somente uma cobrança futura que já está agendada (por exemplo, a conta de luz do mês vigente), mas manter o consentimento ativo para todas as cobranças futuras associadas ao contrato vigente do Pix Automático.

No momento que o pagador cancelar um agendamento, a Celcoin como PSP pagadora notificará o PSP recebedor a respeito daquele agendamento específico que foi cancelado pelo usuário pagador.

⚠️

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

Uma cobrança que foi cancelada não será paga via Pix Automático e nem possuirá fluxo de retentativas. Neste caso, o usuário pagador deverá manualmente efetuar o pagamento.
Mas é importante reforçar que como o consentimento continuará ativo, no mês seguinte o recebedor continuará enviando a solição de agendamento normalmente.

Fluxo de cancelamento de um agendamento:

POST /sheduling/{endtoendid}/cancel (Fluxo do Cancelamento de 1x)

Request

{
     "reason" :"ACCOUNT_CANCELLATION||ACCOUNT_BLOCKED||RECURRENCY_AUTHORIZATION_CANCELLED||PAYMENT_FAILED||OTHERS||CREDIT_PARTY_REQUEST||DEBIT_PARTY_REQUEST",
     "taxId": "12345678900"
}

Response

{
 "version": "0.1.0",
 "status": 200,
 "body": {
    "endToEndId":"endToEndId",
   "recurrencyId":"RR1234567820250516abcdefghi",
   "amount":10.00,
   "expirationDate":"2025-12-01T00:00:00Z",
   "type":"FIRST_ATTEMPT",
   "status":"CANCELATION_REQUEST",
   "creditParty":{
      "taxId":"12345678000199",
      "bank":"0000000",
      "name":"Academia Fitness Pro"
   },
   "debitParty":{
      "personType":"NATURAL_PERSON",
      "taxId":"98765432100",
      "bank":"0000000",
      "account":"98765-4",
      "branch":"0001",
      "stateCode":"00000"
   },
   "debtor":{
      "personType":"NATURAL_PERSON",
      "taxId":"98765432100",
      "name":"Carlos Eduardo Oliveira"
   },
   "cancellation":{
      "id":"IC1234567820250516abcdefghi",
      "cancelledBy":"DEBIT",
      "personType":"NATURAL_PERSON",
      "taxId":"98765432100",
      "reason":"ACCOUNT_CANCELLATION",
      "date":"2025-05-16T15:30:00Z"
   },
   "error":null,
   "createDate":"2025-05-16T15:30:00Z",
   "cancelledDate":"2025-05-16T15:30:00Z"
}

❗️

Esta documentação ainda está sujeita a atualizações. Quando tivermos a versão final publicada, este aviso será removido de todas as páginas.

Updated 1 day ago