Sweeping Accounts - Cancelamento de Consentimento
Visão Geral
O cancelamento (revogação) encerra o consentimento de Sweeping Accounts antes do término natural da sua vigência. Após o cancelamento, nenhum novo pagamento pode ser executado com o consentimento revogado.
O cancelamento pode ser solicitado:
- Pela ITP (instituição iniciadora), via API
- Pelo usuário, por meio da interface da ITP ou diretamente na detentora
Cancelar Consentimento
PATCH /open-keys/itp/api/v2/sweeping-accounts/v2/payment-initiation/:paymentInitiationId
PATCH /open-keys/itp/api/v2/sweeping-accounts/v2/payment-initiation/:paymentInitiationIdRevoga o consentimento de uma payment initiation específica, movendo seu status para REVOKED.
Autenticação: Bearer Token (application_token)
Path Parameters
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
paymentInitiationId | string | ✅ | ID da payment initiation a ser cancelada |
Request
PATCH /open-keys/itp/api/v2/sweeping-accounts/v2/payment-initiation/{{payment_initiation_id}}
Authorization: Bearer {{application_token}}
Content-Type: application/json{
"data": {
"status": "CANC",
"cancellation": {
"cancelledBy": {
"document": {
"identification": "12345678909",
"rel": "CPF"
}
}
}
}
}Campos do Request
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data.status | string | ✅ | Fixo: CANC — indica solicitação de cancelamento |
data.cancellation.cancelledBy.document.identification | string | ✅ | CPF de quem está solicitando o cancelamento |
data.cancellation.cancelledBy.document.rel | string | ✅ | Tipo do documento. Fixo: CPF |
Response
{
"data": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "REVOKED",
"revokedAt": "2026-02-20T15:30:00Z",
"consent": {
"consentId": "urn:celcoin:a1b2c3d4-e5f6...",
"status": "REVOKED"
}
}
}| Campo | Tipo | Descrição |
|---|---|---|
data.status | string | REVOKED — consentimento revogado com sucesso |
data.revokedAt | string | Data/hora do cancelamento (ISO 8601) |
data.consent.status | string | Status do consentimento na detentora: REVOKED |
Códigos de Retorno
| HTTP | Descrição |
|---|---|
200 OK | Cancelamento realizado com sucesso |
400 Bad Request | Parâmetros inválidos |
401 Unauthorized | Token inválido ou expirado |
404 Not Found | Payment initiation não encontrada |
422 Unprocessable Entity | Consentimento já cancelado, expirado ou em status que não permite cancelamento |
Estados que Permitem Cancelamento
Somente consentimentos nos seguintes estados aceitam solicitação de cancelamento:
| Status Atual | Pode Cancelar? |
|---|---|
PENDING | ✅ Sim |
AUTHORISED | ✅ Sim |
CONSUMED | ❌ Não |
REVOKED | ❌ Não (já cancelado) |
EXPIRED | ❌ Não |
Pontos de Atenção
Versão da API (v2): O endpoint de cancelamento utiliza a rota/v2/. Chamadas à versão/v1/retornam404 Not Found.
Irreversibilidade: O cancelamento é irreversível. Uma vez revogado, o consentimento não pode ser reativado. Para retomar as transferências automáticas, um novo consentimento (nova payment initiation) deve ser criado e autorizado pelo usuário.
Pagamentos em andamento: Pagamentos com statusPDNG(pendente) no momento do cancelamento não são automaticamente revertidos. Eles continuam em processamento na infra do Pix. O cancelamento impede apenas novos pagamentos.
Quem pode cancelar: O campocancelledBydeve identificar quem está solicitando o cancelamento. Utilize o CPF do usuário quando o cancelamento for iniciado por ele; utilize o CNPJ/representante da ITP quando for um cancelamento administrativo.
Conformidade OFB: O Open Finance Brasil estabelece que tanto o usuário pagador quanto o recebedor podem solicitar revogação do consentimento. A ITP deve respeitar essas solicitações e processar o cancelamento em tempo hábil.