取消定期付款

请求

ENDPOINT

/account/ACCOUNT_KEY/incoming_recurrence/INCOMING_RECURRENCE_KEY/cancel

方法

PATCH

请求 Path Params

字段	类型	描述	字符数
account_key *	uuid4	账户的唯一标识键。	36
incoming_recurrence_key *	uuid4	授权的唯一标识键。	36

Request Body

Request Body: 取消定期付款

{
  "incoming_recurrence_status": "cancelled",
}

Body Params

字段	类型	描述	字符数
incoming_recurrence_status *	string	Pix 定期付款的状态标识符。	cancelled

响应

STATUS

200

Response Body: 定期付款已取消

{
  "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"
}

HTTP 状态码	QI 代码 code	标题 title	描述（英文） Description	描述（葡文） 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