Consultar Recorrência

Consultar recorrência Pix por incoming_recurrency_key

Request

ENDPOINT

/account/ACCOUNT_KEY/incoming_recurrence/INCOMING_RECURRENCE_KEY

MÉTODO

GET

Path Params

Campo	Tipo	Descrição	Caracteres
account_key *	uuid4	Chave única de identificação da conta QI.	36
incoming_recurrency_key *	uuid4	Chave única de identificação da recorrência de Pix automático.	36

Response

STATUS

200

Response Body: Consulta da recorrência

{
  "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": "j1_in_app_only_recurrence",
  "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",
}

Campo	Tipo	Descrição	Max. Caracteres
incoming_recurrence_key	uuid4	Chave única de identificação da autorização	36
incoming_recurrence_status	string	Identificador de status da recorrência	Enumerador incoming_recurrence_status
request_control_key	uuid4	Chave única de identificação da request utilizada pelo cliente	36
transaction_amount	number	Valor da transferência para ocorrência de valor fixo.	10
minimum_transaction_amount	number	Valor mínimo da transferência para ocorrência de valor variável.	10
maximum_transaction_amount	number	Valor máximo da transferência para ocorrência de valor valor variável.	10
periodicity	enumerator	Tipo da periodicidade associada ao pagamento	Enumeradores periodicity
journey_type	enumerator	Tipo da jornada de solicitação	Enumeradores journey_type
pix_transfer_type	enumerator	Tipo do pix a ser realizado	Enumeradores pix_transfer_type
end_to_end_id	string	Chave de idempotência de uma transação Pix dentro do SPI (Sistema de Pagamento Instantâneo). Esta chave é retornada na consulta de chave Pix.	32
start_date	string	Data de ínicio da recorrência	-
end_date	string	Data de término da recorrência, para os casos de tempo indeterminado, enviar como null
next_execution_date	string	Data de execução da próxima transação da recorrência	-
receiver_conciliation_id	string	Identicação de conciliação do recebedor.	35
target_pix_key	string	Chave pix da conta da transação.	100
payer_document_number	string	Número de documento do pagador da transação transação.	14
pix_message	string	Mensagem a ser enviada junto à transferência Pix.	140
created_at	string	Horário da criação da solicitação de recorrência	-
updated_at	string	Horário de atualização da solicitação de recorrência	-

Enumerador incoming_recurrence_status

Enumerador	Descrição
pending_confirmation	Recorrência pendente de confirmação
active	Recorrência ativa
cancelled	Recorrência cancelada
suspended	Recorrência suspensa
expired	Recorrência expirada

Enumeradores periodicity

Enumerador	Descrição
weekly	Recorrência semanal
monthly	Recorrência mensal
quarterly	Recorrência trimestral
semiannual	Recorrência semestral
annual	Recorrência anual

Enumeradores journey_type

Enumerador	Descrição
j1_in_app_only_recurrence	Solicitação de autorização mediante uma notificação no aplicativo
j2_recurrence_only_qrcode	Solicitação de autorização mediante a leitura de um QR Code
j3_payment_and_recurrence_qrcode	Autorização de recorrência por meio de um pix imediato mediante leitura de um QR Code
j4_recurrence_offer_post_payment	Pagamento ou agendamento de um pix com uma solicitação de autorização da recorrência em sequência

Enumeradores pix_transfer_type

Enumerador	Descrição
manual	Pix utilizando os dados da conta destino
key	Pix utilizando uma chave pix
static_qr_code	Pix utilizando um QR code estático
dynamic_qr_code	Pix utilizando um QR code dinâmico

STATUS

4xx

Response Body: Error

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

Código HTTP	Código QI code	Título title	Descrição (eng) Description	Descrição (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