Request an temporary Pix limit
Requests, for an account owned by the requester, the day's temporary Pix limit: the total Pix volume intended to be transacted through the temporary rail.
Request
/baas/pix/exceptional_pix_requestAvailable only between 06:00 and 17:00 (Brasília time). Outside that window the response is PXT000200.
Request Body
{
"account_key": "0f2a1e4c-1111-2222-3333-444455556666",
"total_amount": 1200000.00,
"request_reason": "folha de pagamento do cliente Alfa Ltda"
}
Body Params
| Field | Type | Description | Characters |
|---|---|---|---|
account_key * | uuidv4 | Unique identification key of the account, owned by the requester, the limit applies to. | 36 |
total_amount * | number | Total temporary Pix limit volume for today from this account. Cannot be lower than the volume already transacted today. | — |
request_reason * | string | Reason why the temporary volume is needed. Used by QI Tech during the manual analysis, when there is one. | 3 to 255 |
Response
Two success responses are possible, and the difference between them determines whether the limit can already be used:
| HTTP Code | status | Meaning |
|---|---|---|
| 201 | approved | Within the integration's automatic-approval ceiling. The limit can already be used for transfers today. |
| 202 | pending_approval | Above the automatic-approval ceiling. Goes to QI Tech's manual analysis, which may approve or refuse it; not usable while pending. |
With 202 and pending_approval, the request was recorded but does not release transfers. Attempting a transfer in
that state responds PXT000201. The analysis outcome arrives through the baas.pix.exceptional.approved or
baas.pix.exceptional.rejected webhooks, and can also be followed through
Consult the limit requests.
When you create a request for an account that already has another one open, the volumes do not add up. If the
previous one was approved and the new total_amount is lower than or equal to it, the new request is approved
immediately and the previous one becomes cancelled. If the new total_amount is higher, the new request is created
as pending_approval and the previous one stays approved and usable until QI Tech resolves it — on approval the
previous one becomes cancelled, on refusal it stays in force. See
Notes.
Response Body: 201 Created
{
"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."
}
Response Body: 202 Accepted
{
"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": "pending_approval",
"message": "Request received and forwarded to manual analysis. The result will be sent by webhook."
}
Response Body Params
| 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. |
Errors
The errors specific to temporary Pix are in
Error Table for Temporary Pix. This operation may
return PXT000206, PXT000200 and PXT000202.