Consult temporary Pix limit requests

Lists the requester's own temporary Pix limit requests. This is how you follow the outcome of a request left under manual analysis, in addition to the webhooks.

Request

ENDPOINT

/baas/pix/exceptional_pix_request

METHOD

GET

To consult one specific request, inform its key on the URL: /baas/pix/exceptional_pix_request/PIX_REQUEST_KEY. The response has the same shape, with the list containing only the consulted request.

There is no time restriction on this operation.

Path Params

Field	Type	Description	Characters
`pix_request_key`	uuidv4	Unique identification key of the limit request. Optional — without it, every request is listed.	36

Query Params

Field	Type	Description	Characters
`account_key`	uuidv4	Filters by the account the request applies to.	36
`status`	string	Filters by status. Accepts several comma-separated values.	—
`page`	integer	Page to be returned.	—
`page_size`	integer	Number of records per page. Maximum and default: 30.	—

info

The inquiry is always restricted to the requester's own requests — it is not possible to consult another partner's request, even if the pix_request_key is known.

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

Field	Type	Description
`data`	array	List of temporary Pix limit requests.
`page`	integer	Page returned.
`page_size`	integer	Number of records per page.
`has_next_page`	boolean	Indicates whether there is a next page.
`requires_manual_approval`	boolean	Indicates whether the requester is under mandatory manual analysis for new requests. See Underutilization.

Fields of each data item:

Field	Type	Description
`pix_request_key`	uuidv4	Unique identification key of the temporary Pix limit request.
`account_key`	uuidv4	Account the request applies to.
`total_amount`	number	Total volume declared for the day.
`request_reason`	string	Reason informed on the request.
`status`	enumerator	Request status. See Temporary Pix Request Status.
`message`	string	Descriptive text of the status, in English.
`rejected_reason`	string	Reason for the refusal, when informed. Optional — it may not come even on a refused request.

Errors

This operation has no specific errors — a pix_request_key that does not belong to the requester simply returns no records. The errors of the other operations are in Error Table for Temporary Pix.

Request​

Path Params​

Query Params​

Response​

Response Body Params​

Errors​