Available Token Bucket Check

Retrieves the token balance available in the Token Bucket used for external Pix key lookups.

Use this operation to check the available capacity before performing ownership lookups with Check Pix Key.

The response represents the Token Bucket capacity and the number of tokens still available for lookups. When the tokens run out, new lookups are blocked until the balance is refilled.

📘

Independent limits

The Token Bucket and the Rate Limit are independent controls. Having tokens available does not remove the request limit applied to Pix key lookups.

See the Pix key lookup rules.

Related content

Guides

Responses

403

Forbidden. Occurs when the request body is filled, GET method calls must have an empty body.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json