Consult the temporary Pix limit usage

Returns the volume the account has already transacted during the current Pix day through the temporary rail — how much of the limit has been consumed. It is the value that decides whether a cancellation is accepted and how much of the approved limit is left.

Request

ENDPOINT

/baas/pix/limits/ACCOUNT_KEY/exceptional_usage

METHOD

GET

There is no time restriction on this operation.

Path Params

Field	Type	Description	Characters
account_key	uuidv4	Unique identification key of the account, owned by the requester.	36

Response

Response Body: 200 OK

{
  "exceptional_pix_amount_used": 300000.00
}

Response Body Params

Field	Type	Description
exceptional_pix_amount_used	number	Volume already transacted by the account during the current Pix day through the temporary rail.

What it is for

• Knowing whether a cancellation will go through. The approved request can only be cancelled while this value is 0. See Cancel a limit request.
• Knowing how much is left. The remaining volume is the approved request's total_amount minus this value.
• Knowing the floor for the next request. A new total_amount cannot be lower than this value, otherwise the response is PXT000202.

caution

The counter is per account and per Pix day (from 06:00 to 06:00 the next day), not per request. Volume transacted under a request that was later replaced keeps counting for the day. A transfer that ended up rejected does not count.