Cancelamento de Recorrência
Este fluxo é utilizado caso a empresa recebedora deseje cancelar o consentimento previamente realizado por um cliente pagador.
Neste cenário, o pagador havia autorizado o consentimento, 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 consentimento e após o retorno do PSP pagador a Celcoin enviará o webhook confirmando o cancelamento daquela jornada. Neste fluxo, não há um cenário onde o cliente pagador possa não concordar com o cancelamento da recorrência.
O cancelamento da recorrência cancelará todas as cobranças futuras associadas.
O cancelamento da recorrência 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}/cancel
Request:
{
"cancellationPersonType": "LEGAL_PERSON",
"cancellationTaxId": "19297016000136",
"cancellationReason": "ACCOUNT_CANCELLATION"
}
Response
{
"version": "1.0.0",
"status": 200,
"body": {
"recurrencyId": "RC139358932025060749927585294",
"clientRequestId": "idasasdddas-dasdasdasd-dadadasdas-ddasdasdassd",
"interval": {
"start": "2025-06-07T09:45:00-03:00",
"end": null,
"frequencyType": "MONTHLY"
},
"status": "CANCELLATION_REQUEST",
"journeys": [
{
"status": "CANCELLATION_REQUEST",
"type": 2,
"createDate": "2025-06-07T09:45:00-03:00"
}
],
"amount": 100,
"creditParty": {
"bank": "13935893",
"branch": "10203040",
"account": "98765-4",
"taxId": "19297016000136",
"name": "Empresa Fictícia"
},
"debitParty": {
"bank": "10203040",
"personType": "NATURAL_PERSON",
"taxId": "00011122233",
"accountType": "CACC",
"branch": "10203040",
"account": "98765-4",
"stateCode": "3505708"
},
"debtor": {
"personType": "NATURAL_PERSON",
"taxId": "67167948080",
"name": "Pessoa Fictícia"
},
"contract": {
"number": "Contrato-12345",
"description": "Contrato de teste "
},
"allowsNewAttemptsAfterExpiration": true,
"recurrencyMaxAmount": null,
"createDate": "2025-06-07T09:45:00-03:00",
"allowAutoSendingPaymentInstructions": false,
"cancellation": {
"id": "IC139358932025060792624279100",
"cancelledBy": "CREDIT",
"taxId": 19297016000136,
"reason": "ACCOUNT_CANCELLATION",
"date": "2025-06-07T09:45:00-03:00"
}
}
}
Webhook de cancelamento de recorrência pelo recebedor
evento: pix-automatic-recurrency-completed
{
"recurrencyId": "RC139358932025060749927585294",
"clientRequestId": "idasasdddas-dasdasdasd-dadadasdas-ddasdasdassd",
"interval": {
"start": "2025-07-21T00:00:00.0000000",
"end": null,
"frequencyType": "MONTHLY"
},
"status": "CANCELLED",
"journeys": [
{
"status": "ACCEPTED",
"type": 2,
"createDate": "2025-07-14T00:00:00.0000000"
}
],
"amount": 100,
"creditParty": {
"bank": "13935893",
"branch": "10203040",
"account": "98765-4",
"taxId": "19297016000136",
"name": "Empresa Fictícia"
},
"debitparty": {
"bank": "10203040",
"personType": "NATURAL_PERSON",
"taxId": "00011122233",
"name": null,
"branch": "10203040",
"account": "98765-4",
"accountType": "CACC",
"stateCode": "3505708"
},
"debtor": {
"personType": "NATURAL_PERSON",
"taxId": "67167948080",
"name": "Pessoa Fictícia"
},
"contract": {
"number": "Contrato-12345",
"description": "Contrato de teste "
},
"allowsNewAttemptsAfterExpiration": true,
"recurrencyMaxAmount": null,
"createDate": "2025-07-14T00:00:00.0000000",
"updateDate": "2025-07-14T19:40:02.5516987",
"allowAutoSendingPaymentInstructions": false,
"cancellation": {
"id": "IC1393589320250607619029977197",
"cancelledBy": "CREDIT",
"taxId": "19297016000136",
"reason": "ACCOUNT_CANCELLATION",
"date": "2025-06-07"
},
"webhookId": "a9df42048a6742689f58b2c02b07adc5"
}
Cancelamento pelo pagador
O webhook enviado ao recebedor quando a recorrência é cancelada pelo pagador é conforme abaixo:
{
"recurrencyId": "RC139358932025060749927585294",
"clientRequestId": "idasasdddas-dasdasdasd-dadadasdas-ddasdasdassd",
"interval": {
"start": "2025-07-21T00:00:00.0000000",
"end": null,
"frequencyType": "MONTHLY"
},
"status": "CANCELLED",
"journeys": [
{
"status": "ACCEPTED",
"type": 2,
"createDate": "2025-07-14T00:00:00.0000000"
}
],
"amount": 100,
"creditParty": {
"bank": "13935893",
"branch": "10203040",
"account": "98765-4",
"taxId": "19297016000136",
"name": "Empresa Fictícia"
},
"debitparty": {
"bank": "10203040",
"personType": "NATURAL_PERSON",
"taxId": "00011122233",
"name": null,
"branch": "10203040",
"account": "98765-4",
"accountType": "CACC",
"stateCode": "3505708"
},
"debtor": {
"personType": "NATURAL_PERSON",
"taxId": "67167948080",
"name": "Pessoa Fictícia"
},
"contract": {
"number": "Contrato-12345",
"description": "Contrato de teste "
},
"allowsNewAttemptsAfterExpiration": true,
"recurrencyMaxAmount": null,
"createDate": "2025-07-14T00:00:00.0000000",
"updateDate": "2025-07-14T19:40:02.5516987",
"allowAutoSendingPaymentInstructions": false,
"cancellation": {
"id": "IC1393589320250607619029977197",
"cancelledBy": "DEBIT",
"taxId": "19297016000136",
"reason": "ACCOUNT_CANCELLATION",
"date": "2025-06-07"
},
"webhookId": "a9df42048a6742689f58b2c02b07adc5"
}
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