Cancelamento de Agendamento
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}
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
Evento: pix-automatic-payment-instruction-cancelled
{
"id": "6bcf6cb3-a91c-4b23-b30a-20c0f5714647",
"endToEndId": "E36060950202508130000A8LzS0K0z6W",
"recurrencyId": "RC139358932025060749927585294",
"amount": 100,
"expirationDate": "08/11/2025 00:00:00",
"isWorkingDay": true,
"nextWorkingDay": null,
"status": "CANCELLED",
"creditParty": {
"bank": "13935893",
"branch": "10203040",
"account": "98765-4",
"taxId": "19297016000136",
"name": "Empresa Fictícia"
},
"debitParty": {
"bank": "13935893",
"personType": "NATURAL_PERSON",
"taxId": "67167948080",
"name": "Pessoa Fictícia",
"branch": "0001",
"account": "5234565",
"accountType": null,
"stateCode": null
},
"debtor": {
"personType": "NATURAL_PERSON",
"taxId": "67167948080",
"name": "Pessoa Fictícia"
},
"createDate": "2025-07-14T00:00:00.0000000",
"updateDate": "2025-07-14T19:40:02.5516987",
"clientRequestId": "00000000-0000-0000-0000-000000000000",
"cancellation": {
"id": "IC13935893202506071632727519030",
"cancelledBy": "CREDIT",
"taxId": 19297016000136,
"reason": "ACCOUNT_CANCELLATION",
"date": "2025-06-07T09:45:00-03:00"
},
"webhookId": "935e6f73343a4974ada18de02fbcea4e"
}
Webhook Cancelamento pelo pagador
{
"id": "6bcf6cb3-a91c-4b23-b30a-20c0f5714647",
"endToEndId": "E36060950202508130000A8LzS0K0z6W",
"recurrencyId": "RC139358932025060749927585294",
"amount": 100,
"expirationDate": "08/11/2025 00:00:00",
"isWorkingDay": true,
"nextWorkingDay": null,
"status": "CANCELLED",
"creditParty": {
"bank": "13935893",
"branch": "10203040",
"account": "98765-4",
"taxId": "19297016000136",
"name": "Empresa Fictícia"
},
"debitParty": {
"bank": "13935893",
"personType": "NATURAL_PERSON",
"taxId": "67167948080",
"name": "Pessoa Fictícia",
"branch": "0001",
"account": "5234565",
"accountType": null,
"stateCode": null
},
"debtor": {
"personType": "NATURAL_PERSON",
"taxId": "67167948080",
"name": "Pessoa Fictícia"
},
"createDate": "2025-07-14T00:00:00.0000000",
"updateDate": "2025-07-14T19:40:02.5516987",
"clientRequestId": "00000000-0000-0000-0000-000000000000",
"cancellation": {
"id": "IC13935893202506071632727519030",
"cancelledBy": "DEBIT",
"taxId": 19297016000136,
"reason": "ACCOUNT_CANCELLATION",
"date": "2025-06-07T09:45:00-03:00"
},
"webhookId": "935e6f73343a4974ada18de02fbcea4e"
}
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 about 21 hours ago