Skip to main content
PUT
Set the tenant's configured monthly rate for consignado bids

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Body

application/json
taxaMensal
string
required

The institution's configured monthly interest rate for consignado bids, as a PERCENT-per-month decimal: 1,80% per month is 1.80, never 0.018. At most 5 integer and 2 fractional digits (Manual 003 v1.19 §3.1.1, NÚMERO(7,2) (percentual)); zero is not a rate.

Pattern: ^(0\.(0[1-9]|[1-9][0-9]?)|[1-9][0-9]{0,4}(\.[0-9]{1,2})?)$
Example:

"1.80"

Response

OK

certPresent
boolean
required

Whether a client certificate is stored for the tenant.

oauthPresent
boolean
required

Whether OAuth2 client_credentials are stored for the tenant.

provider
string
required

External rail the credentials belong to.

Example:

"dataprev"

updatedAt
string<date-time>
required

Last-update timestamp (RFC 3339, UTC).

Example:

"2026-06-23T12:00:00Z"

certFingerprint
string

SHA-256 hex fingerprint of the stored certificate (absent when none).

Example:

"3b1f...c0"

certNotAfter
string<date-time>

RFC 3339 cert expiry (UTC); absent when no cert is stored.

Example:

"2027-01-01T00:00:00Z"

codigoSolicitante
string

Dataprev codigoSolicitante: the institution's BACEN COMPE code (3 digits, zero-padded, 001-999). Public, non-secret; absent when none is stored.

Example:

"341"

revokedAt
string<date-time>

Credential revocation timestamp (RFC 3339, UTC); absent when credentials were never revoked.

Example:

"2026-07-14T15:30:00Z"

taxaMensal
string

Configured monthly interest rate for consignado bids, as a PERCENT-per-month decimal (1.80 is 1,80% per month). Commercial configuration, non-secret; absent when none is stored, in which case the gateway places no bid.

Example:

"1.80"