Consultar solicitações de limite Pix temporário

Lista as solicitações de limite Pix temporário do próprio solicitante. É por aqui que se acompanha o desfecho de uma solicitação que ficou em análise manual, além dos webhooks.

Request

ENDPOINT

/baas/pix/exceptional_pix_request

MÉTODO

GET

Para consultar uma solicitação específica, informe a chave dela na URL: /baas/pix/exceptional_pix_request/PIX_REQUEST_KEY. A resposta tem o mesmo formato, com a lista contendo apenas a solicitação consultada.

Não há restrição de horário nesta operação.

Path Params

Campo	Tipo	Descrição	Caracteres
pix_request_key	uuidv4	Chave única de identificação da solicitação de limite. Opcional — sem ela, todas as solicitações são listadas.	36

Query Params

Campo	Tipo	Descrição	Caracteres
account_key	uuidv4	Filtra pela conta à qual a solicitação se aplica.	36
status	string	Filtra por status. Aceita vários valores separados por vírgula.	—
page	integer	Página a ser retornada.	—
page_size	integer	Quantidade de registros por página. Máximo e padrão: 30.	—

informação

A consulta é sempre restrita às solicitações do próprio solicitante — não é possível consultar a solicitação de outro parceiro, ainda que a pix_request_key seja conhecida.

Response

Response Body: 200 OK

{
  "data": [
    {
      "pix_request_key": "9c3b7d21-8f4a-4c2b-9e1d-7a6b5c4d3e2f",
      "account_key": "0f2a1e4c-1111-2222-3333-444455556666",
      "total_amount": 1200000.00,
      "request_reason": "folha de pagamento do cliente Alfa Ltda",
      "status": "approved",
      "message": "Request approved and available for use today until 20:00."
    }
  ],
  "page": 1,
  "page_size": 30,
  "has_next_page": false,
  "requires_manual_approval": false
}

Response Body Params

Campo	Tipo	Descrição
data	array	Lista de solicitações de limite Pix temporário.
page	integer	Página retornada.
page_size	integer	Quantidade de registros por página.
has_next_page	boolean	Indica se existe uma próxima página.
requires_manual_approval	boolean	Indica se o solicitante está sob análise manual obrigatória para novas solicitações. Ver Subutilização.

Campos de cada item de data:

Campo	Tipo	Descrição
pix_request_key	uuidv4	Chave única de identificação da solicitação de limite Pix temporário.
account_key	uuidv4	Conta à qual a solicitação se aplica.
total_amount	number	Volume total declarado para o dia.
request_reason	string	Motivo informado na solicitação.
status	enumerator	Status da solicitação. Ver Temporary Pix Request Status.
message	string	Texto descritivo do status, em inglês.
rejected_reason	string	Motivo da recusa, quando informado. Opcional — pode não vir mesmo em uma solicitação recusada.

Erros

Esta operação não possui erros específicos — uma pix_request_key que não pertença ao solicitante simplesmente não retorna registros. Os erros das demais operações estão em Erros de Pix temporário.