Get the tenant's Pix receiver configuration

Returns the Pix key and the receiver address of the tenant of the credentials you authenticate with. They are the Pix receiver of the tenant’s hybrid boletos (type: HYBRID on POST /v1/boletos), which carry a Pix QR code. A hybrid boleto issued while the key or a member of the address is missing is refused with 422 PBP-0120, naming what is missing.

complete is true when the key and the four members of the address are present. A partial configuration, such as a key with no address, is answered 200 with complete: false, and the members it lacks are omitted. complete 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.

Only a tenant with no Pix key configured, or with no provider credential, is answered 404 PBP-0005.

GET /v1/admin/pix-config

Get the tenant's Pix receiver configuration

cURL

curl --request GET \
  --url https://api.example.com/v1/admin/pix-config \
  --header 'Authorization: Bearer <token>'

200

{
  "complete": true,
  "pixKey": "f34f8ec2-a4b7-41b4-8200-b53a07e00bac",
  "receiverAddress": {
    "city": "SAO PAULO",
    "state": "SP",
    "street": "Avenida Paulista 1000",
    "zipCode": "01310100"
  },
  "updatedAt": "2026-10-13T15:04:05Z",
  "updatedBy": "<string>"
}

Autorizações

Authorization · string · header · obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

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.

Resposta

200

application/json

OK

complete · boolean · obrigatório

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 · obrigatório

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

Exemplo:

"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.

Show child attributes

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.

Exemplo:

"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.