Cancelar recorrência de pagamento

Request

ENDPOINT

/account/ACCOUNT_KEY/incoming_recurrence/INCOMING_RECURRENCE_KEY/cancel

MÉTODO

PATCH

Request Path Params

Campo	Tipo	Descrição	Caracteres
account_key *	uuid4	Chave única de identificação da conta.	36
incoming_recurrence_key *	uuid4	Chave única de identificação da autorização	36

Request Body

Request Body: Cancelar uma recorrência

{
  "incoming_recurrence_status": "cancelled",
}

Body Params

Campo	Tipo	Descrição	Caracteres
incoming_recurrence_status *	string	Identificador de status da recorrência Pix.	cancelled

Response

STATUS

200

Response Body: Recorrência cancelada

{
  "incoming_recurrence_key": "cfa32109-a6dd-4304-94db-03a7b6d92a47",
  "incoming_recurrence_status": "cancelled",
  "created_at": "2025-05-22T20:30:23.459Z",
  "updated_at": "2025-05-22T20:39:23.459Z"
}

STATUS

4XX

Response Body

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo"
}

Código HTTP	Código QI code	Título title	Descrição (eng) Description	Descrição (ptbr) translation
400	QIT000001	Bad Request	Schema Error	Erro de Schema
403	APX000025	User is not allowed to do this transaction	User is not allowed to do this transaction	Usuário não tem autorização para fazer essa transação
403	APX000017	Requester not allowed to access this endpoint	Requester has no permission to perform pix transfers on this endpoint	Requester não possui permissão de realizar transações pix através deste endpoint
404	APX000020	Account not Found	Account was not found	Conta {account_key} não foi encontrada.
404	APX000001	Recurrence not Found	Recurrence was not found	Recorrência {incoming_recurrence_key} não foi encontrada