Cancelamento de Agendamento

Suggest Edits

Este fluxo é utilizado para casos de exceção, onde após um agendamento já ter sido realizado com sucesso pelo banco do cliente pagador, a empresa precise cancelar aquele agendamento.

Neste cenário, o pagador havia autorizado o agendamento, mas por qualquer que seja o motivo, a empresa recebedora deseja cancelar aquela recorrência de Pix Automático.

Neste fluxo, a empresa recebedora enviará uma notificação ao cliente pagador cancelando o agendamento e após o retorno do PSP pagador a Celcoin enviará o webhook confirmando o cancelamento daquele agendamento específico.

Neste fluxo, não há um cenário onde o cliente pagador possa não concordar com o cancelamento do agendamento.

Neste caso, após o cancelamento do agendamento ter ocorrido com sucesso, é possível que a empresa envie uma nova solicitação de agendamento, com um valor ajustado, por exemplo e entrará no fluxo de "Envio de Agendamento" normal, tendo que respeitar as mesmas regras do consentimento ativo.

O cancelamento de um agendamento não impacta na recorrência das cobranças futuras associadas.

O cancelamento de agendamentos pode ser efetuado através de duas fontes distintas:

Pelo recebedor (o destinatário do pagamento)
Pelo pagador (o originador do pagamento)

Cancelamento pelo recebedor

Endpoint POST /recurrencies/{id}/payment-instruction/{id}/cancel

Request:

{
    "cancellationPersonType": "LEGAL_PERSON",
    "cancellationTaxId": "19297016000136",
    "cancellationReason": "ACCOUNT_CANCELLATION"
}

Response

{
    "version": "1.0.0",
    "status": 200,
    "body": {
        "id": "dsdsadsad",
        "endToEndId": "E1393589320250607691358012592",
        "recurrencyId": "dsaasda",
        "amount": 100,
        "expirationDate": "2025-06-07",
        "nextWorkingDay": null,
        "status": "CANCELLATION_REQUEST",
        "creditParty": {
            "bank": "13935893",
            "branch": "10203040",
            "account": "98765-4",
            "taxId": "76008951000179",
            "name": "Empresa Fictícia"
        },
        "debtor": {
            "personType": "NATURAL_PERSON",
            "taxId": "00011122233",
            "name": "Pessoa Fictícia"
        },
        "debitParty": {
            "bank": "10203040",
            "personType": "NATURAL_PERSON",
            "taxId": "00011122233",
            "branch": "10203040",
            "accountType": "CACC",
            "account": "98765-4",
            "stateCode": "3505708"
        },
        "createDate": "2025-06-07T09:45:00-03:00",
        "clientRequestId": "7540a0ff-713f-4d49-a8db-b2b7d8d9859d",
        "cancellation": {
            "id": "IC13935893202506071632727519030",
            "cancelledBy": "CREDIT",
            "taxId": 19297016000136,
            "reason": "ACCOUNT_CANCELLATION",
            "date": "2025-06-07T09:45:00-03:00"
        }
    }
}

Webhook de cancelamento pelo recebedor

Evento: pix-automatic-payment-instruction-cancelled

{
    "body": {
        "id": "E13935893202507281501BFdLbInlHec",
        "endToEndId": "E13935893202506070244308557288",
        "recurrencyId": "RR1393589320250820fqpb80CzMdC",
        "amount": 100,
        "expirationDate": "2025-06-07",
        "isWorkingDay": false,
        "nextWorkingDay": null,
        "status": "CANCELLED",
        "creditParty": {
            "bank": "13935893",
            "branch": "10203040",
            "account": "98765-4",
            "taxId": "76008951000179",
            "name": "Empresa Fict\u00edcia"
        },
        "debitParty": {
            "bank": "10203040",
            "personType": "NATURAL_PERSON",
            "taxId": "00011122233",
            "name": null,
            "branch": "10203040",
            "account": "98765-4",
            "accountType": "CACC",
            "stateCode": "3505708"
        },
        "debtor": {
            "personType": "NATURAL_PERSON",
            "taxId": "00011122233",
            "name": "Pessoa Fict\u00edcia"
        },
        "createDate": "2025-06-07",
        "updateDate": "2025-09-12T12: 49: 43",
        "clientRequestId":"7540a0ff-713f-4d49-a8dbb2b7d8d9859d",
        "cancellation": {
            "id": "IC13935893202506077966427273936",
            "cancelledBy": "CREDIT",
            "taxId": "36057484061",
            "reason": "ACCOUNT_CANCELLATION",
            "date": "2025-09-12T12: 49: 43"
        }
    },
    "entity":"pix-automatic-payment-instructioncancelled",
    "createTimeStamp": "2025-09-12T12: 49: 43.3562885",
    "status": "CANCELLED",
    "webhookId": "5635c51064b14cc8b719e0a91787007d"
}

Webhook Cancelamento pelo pagador

Evento: pix-automatic-payment-instruction-cancelled

Repare que o evento é o mesmo, o que altera é o campo "cancelledBy = DEBIT"

{
    "body": {
        "id": "E13935893202507281501BFdLbInlHec",
        "endToEndId": "E13935893202506070244308557288",
        "recurrencyId": "RR1393589320250820fqpb80CzMdC",
        "amount": 100,
        "expirationDate": "2025-06-07",
        "isWorkingDay": false,
        "nextWorkingDay": null,
        "status": "CANCELLED",
        "creditParty": {
            "bank": "13935893",
            "branch": "10203040",
            "account": "98765-4",
            "taxId": "76008951000179",
            "name": "Empresa Fict\u00edcia"
        },
        "debitParty": {
            "bank": "10203040",
            "personType": "NATURAL_PERSON",
            "taxId": "00011122233",
            "name": null,
            "branch": "10203040",
            "account": "98765-4",
            "accountType": "CACC",
            "stateCode": "3505708"
        },
        "debtor": {
            "personType": "NATURAL_PERSON",
            "taxId": "00011122233",
            "name": "Pessoa Fict\u00edcia"
        },
        "createDate": "2025-06-07",
        "updateDate": "2025-09-12T12: 49: 43",
        "clientRequestId":"7540a0ff-713f-4d49-a8dbb2b7d8d9859d",
        "cancellation": {
            "id": "IC13935893202506077966427273936",
            "cancelledBy": "DEBIT",
            "taxId": "36057484061",
            "reason": "ACCOUNT_CANCELLATION",
            "date": "2025-09-12T12: 49: 43"
        }
    },
    "entity":"pix-automatic-payment-instructioncancelled",
    "createTimeStamp": "2025-09-12T12: 49: 43.3562885",
    "status": "CANCELLED",
    "webhookId": "5635c51064b14cc8b719e0a91787007d"
}

Updated 11 days ago