Listagem de Chaves PIX

Retorna todas as chaves PIX registradas e ativas associadas a uma conta específica.

Este endpoint permite consultar a lista de chaves PIX vinculadas a uma conta bancária identificada pelo accountId.

Ele retorna todas as chaves registradas (ativas, pendentes ou inativas), juntamente com seus identificadores únicos, tipos e status de uso.

Este endpoint é frequentemente utilizado em:

  • painéis administrativos para visualização de chaves vinculadas,

  • verificação antes de registrar novas chaves,

  • ou sincronização de dados com sistemas de CRM e backoffice.

Este endpoint é protegido e requer o uso do cabeçalho Authorization: Bearer <token> e x-tenant-id.

Create a new user

GET /accounts/{accountId}/pix/keys

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

x-tenant-id

Tenant ID

Response

{
  "keys": [
    {
      "id": "38e291bb-609b-40e7-9b28-e35718aa7d7f",
      "key": "92603db1-e89d-4de4-b6f9-32869f6c6853",
      "type": "EVP",
      "status": "ACTIVE"
    },
    {
      "id": "f447e406-e1bd-45f0-94c3-166d65bf5446",
      "key": "868d2cb7-6c6c-43fc-aee1-b44bbccba518",
      "type": "EVP",
      "status": "ACTIVE"
    },
    {
      "id": "482a92ef-6fd8-4f6a-a6e4-2709d7fd1775",
      "key": "dadac161-81df-4683-a232-fee79d706713",
      "type": "EVP",
      "status": "ACTIVE"
    },
    {
      "id": "6e23b1d0-9123-4296-8be5-4679543db4a0",
      "key": "90e6b147-b07b-41fb-a89f-5e13359811cb",
      "type": "EVP",
      "status": "ACTIVE"
    },
    {
      "id": "a0362e97-8542-4cb9-990f-3c09824ac253",
      "key": "6d21058f-5ba6-41cf-ab64-a12f83d4ef16",
      "type": "EVP",
      "status": "ACTIVE"
    }
  ]
}