Query Recurrence

Query Pix recurrence by incoming_recurrency_key

Request

ENDPOINT

/account/ACCOUNT_KEY/incoming_recurrence/INCOMING_RECURRENCE_KEY

METHOD

GET

Path Params

Field	Type	Description	Characters
account_key *	uuid4	QI account unique identification key.	36
incoming_recurrency_key *	uuid4	Automatic Pix recurrence unique identification key.	36

Response

STATUS

200

Response Body: Recurrence query

{
  "incoming_recurrence_key": "c2f3eefa-1b8e-4d5f-9b9d-123456789abc",
  "incoming_recurrence_status": "pending_confirmation",
  "request_control_key": "e04197f6-433e-48d2-8a8e-9258a70aba0b",
  "transaction_amount": "150.00",
  "periodicity": "monthly",
  "journey_type": "journey_one",
  "pix_transfer_type": "key",
  "end_to_end_id": "E1234567890123456789012",
  "start_date": "2025-06-01",
  "end_date": "2026-06-01",
  "next_execution_date": "2025-07-01",
  "receiver_conciliation_id": "rec-conc-789",
  "target_pix_key": "receiver@bank.com.br",
  "payer_document_number": "12345678900",
  "pix_message": "Pagamento mensal de serviço",
  "created_at": "2025-05-22T10:00:00Z",
  "updated_at": "2025-05-22T12:00:00Z",
}

Field	Type	Description	Max. Characters
incoming_recurrence_key	uuid4	Authorization unique identification key	36
incoming_recurrence_status	string	Recurrence status identifier	Enumerator incoming_recurrence_status
request_control_key	uuid4	Request unique identification key used by the client	36
transaction_amount	number	Transfer amount for fixed value occurrence.	10
minimum_transaction_amount	number	Minimum transfer amount for variable value occurrence.	10
maximum_transaction_amount	number	Maximum transfer amount for variable value occurrence.	10
periodicity	enumerator	Periodicity type associated with the payment	Enumerators periodicity
journey_type	enumerator	Request journey type	Enumerators journey_type
pix_transfer_type	enumerator	Type of pix to be performed	Enumerators pix_transfer_type
end_to_end_id	string	Idempotency key of a Pix transaction within SPI (Instant Payment System). This key is returned in the Pix key query.	32
start_date	string	Recurrence start date	-
end_date	string	Recurrence end date, for indefinite time cases, send as null
next_execution_date	string	Next recurrence transaction execution date	-
receiver_conciliation_id	string	Receiver conciliation identification.	35
target_pix_key	string	Transaction account pix key.	100
payer_document_number	string	Transaction payer document number.	14
pix_message	string	Message to be sent along with the Pix transfer.	140
created_at	string	Recurrence request creation time	-
updated_at	string	Recurrence request update time	-

Enumerator incoming_recurrence_status

Enumerator	Description
pending_confirmation	Recurrence pending confirmation
active	Active recurrence
cancelled	Cancelled recurrence
suspended	Suspended recurrence
expired	Expired recurrence

Enumerators periodicity

Enumerator	Description
weekly	Weekly recurrence
monthly	Monthly recurrence
quarterly	Quarterly recurrence
semiannual	Semiannual recurrence
annual	Annual recurrence

Enumerators journey_type

Enumerator	Description
journey_one	Authorization request via app notification
jouney_two	Authorization request via QR Code reading
journey_three	Recurrence authorization through immediate pix via QR Code reading
journey_four	Payment or scheduling of a pix with a recurrence authorization request in sequence

Enumerators pix_transfer_type

Enumerator	Description
manual	Pix using destination account data
key	Pix using a pix key
static_qr_code	Pix using a static QR code
dynamic_qr_code	Pix using a dynamic QR code

STATUS

4xx

Response Body: Error

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

HTTP Code	QI Code code	Title title	Description (eng) Description	Description (ptbr) translation
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