Skip to main content
PATCH
Change a PIX transaction limit

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Body

application/json
accountId
string
required

The CRM account id whose limit to change.

Example:

"acc-123"

amount
integer<int64>
required

The new limit amount in centavos (> 0).

Example:

5000000

limitType
string
required

eTransactionLimitType name (TRANSACTION/PERIOD).

Example:

"PERIOD"

periodType
string
required

ePeriodType name (DAILY/NIGHTLY/MONTHLY).

Example:

"DAILY"

payerIspb
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. Send it absent, not empty; an empty string is refused 400 PIX-0061.

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

"12345678"

Response

OK

accountId
string
required

The ledger account alias the limit is kept for.

Example:

"@pagador"

amount
integer<int64>
required

The limit amount in centavos.

Example:

5000000

id
string
required

The limit row id.

Example:

"l1f9c0a2-..."

limitType
string
required

eTransactionLimitType name.

Example:

"PERIOD"

periodType
string
required

ePeriodType name.

Example:

"DAILY"

transactionType
string
required

eTransactionType name.

Example:

"PIX"