Skip to main content
GET
Get available PIX limits

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Query Parameters

account_id
string
required

The CRM account id whose limits to read.

Example:

"acc-123"

payer_ispb
string

The ISPB of the direct participant whose limits these are. This deployment may act as SEVERAL direct SPI participants — one ISPB each, each with its own books — and the account id is an alias that is unique only inside ONE of them, so this field is what says whose rows to read or write. OPTIONAL while it acts as a single participant: omit it and that one answers. REQUIRED once it acts as several — omitted is 422 PIX-0127, and an ISPB this deployment does not act as is 422 PIX-0128. It is ROUTING DATA you supply and guarantee, exactly like payerIspb on an order: never a credential, never read from a header or a path, and it never widens what your token can reach. Use the SAME participant you pay as, or the headroom you read is not the headroom that gets enforced. Sending it empty (payer_ispb=) reads the same as omitting it.

Pattern: ^[0-9]{8}$
Example:

"12345678"

Response

OK

currentPeriod
string
required

The active ePeriodType name.

Example:

"DAILY"

limits
object[] | null
required

The per-limit available rows.