Skip to main content
GET
Get the tenant's Pix receiver configuration

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Organization-Id
string

Tenant organization ID. Optional. The organization context is determined by the credentials you authenticate with; this header does not select or change it.

Response

OK

complete
boolean
required

True when the key and the four members of the address are present, which is what a boleto that carries a Pix QR code needs from this configuration. It does not guarantee that an issuance is accepted: the receiver's name and document are not part of this configuration, they come from the record of the collection account when a boleto is issued. A CPF or CNPJ key is checked against the document of that account's holder; the other key types are not verified.

pixKey
string
required

The configured Pix key. It is not masked: it is public data, carried in the Pix QR code of every boleto that pays it.

Example:

"f34f8ec2-a4b7-41b4-8200-b53a07e00bac"

receiverAddress
object

The receiver's address. Omitted when none is configured; a member that is not configured is omitted too.

updatedAt
string<date-time>

When the configuration was last written with POST /v1/admin/pix-config, in UTC. Omitted for a configuration never written with it.

Example:

"2026-10-13T15:04:05Z"

updatedBy
string

Identifier of the authenticated principal that made that write: the subject of its access token. Omitted like updatedAt.