Accept payment recurrence

Request

ENDPOINT

/account/ACCOUNT_KEY/incoming_recurrence/INCOMING_RECURRENCE_KEY/approve

METHOD

PATCH

Request Path Params

Field	Type	Description	Characters
account_key *	uuid4	Unique account identification key.	36
incoming_recurrence_key *	uuid4	Unique authorization identification key	36

Request Body

Request Body: Approve fixed amount recurrence

{
  "incoming_recurrence_status": "active"
}

Request Body: Approve variable amount recurrence with maximum limit

{
  "incoming_recurrence_status": "active",
  "maximum_transaction_amount": 500.00
}

Body Params

Field	Type	Description	Characters
incoming_recurrence_status *	string	PIX recurrence status identifier. Must be "active" to activate the recurrence	20
maximum_transaction_amount	number	Maximum amount the user accepts to pay per transaction (optional, only for variable amount recurrences)	10

Maximum Amount for Variable Recurrences

The maximum_transaction_amount field is optional and should be used only for variable amount recurrences. It allows the payer to define the maximum amount they accept to pay per transaction within the authorized recurrence.

Response

STATUS

200

Response Body: Recurrence activated

{
  "incoming_recurrence_key": "cfa32109-a6dd-4304-94db-03a7b6d92a47",
  "incoming_recurrence_status": "active",
  "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 Code	QI Code code	Title title	Description (eng) Description	Description (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