Cancel an temporary Pix limit request

Cancels an temporary Pix limit request that has not been used yet, whether it is already approved or still under manual analysis. Cancelling an approved request releases the declared volume from the integration's automatic-approval ceiling; cancelling one under analysis merely withdraws it from the queue, since it did not occupy the ceiling yet.

Request

ENDPOINT

/baas/pix/exceptional_pix_request/PIX_REQUEST_KEY/cancel

METHOD

POST

caution

Available only between 06:00 and 17:00 (Brasília time). Outside that window the response is PXT000200.

The request has no body.

Path Params

Field	Type	Description	Characters
pix_request_key	uuidv4	Unique identification key of the request to be cancelled.	36

Conditions

The cancellation is only accepted when all the conditions below are true. Any of them being false results in PXT000201.

• The request belongs to the requester making the call.
• The request is pending_approval or approved — a request in rejected, cancelled or expired cannot be cancelled.
• To cancel the approved request, the account must have transacted no temporary Pix volume during the day. After the first transfer, even a partial one, the account must keep an approved request until 20:00 — including a new request that replaced the previous one. A transfer that ended up rejected does not count as transacted volume. To know beforehand whether the cancellation will be accepted, use Consult the temporary Pix limit usage. A pending_approval request can be cancelled at any time, with or without transacted volume: it authorizes nothing, and the approved one keeps covering the account.

info

To reduce or replace a limit already in use, create a new request for the same account, with a total_amount greater than or equal to the volume already transacted during the day. A reduction applies immediately; an increase only applies once QI Tech approves it, and until then the previous request stays in force. See Request an temporary Pix limit.

Response

Response Body: 200 OK

{
  "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": "cancelled",
  "message": "Request cancelled and no longer available for use."
}

Response Body Params

Field	Type	Description
pix_request_key	uuidv4	Unique identification key of the cancelled request.
account_key	uuidv4	Account the request applied to.
total_amount	number	Total volume that had been declared.
request_reason	string	Reason informed on the request.
status	enumerator	Request status, cancelled after this operation.
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 PXT000200 and PXT000201.