Listar chaves PIX cadastradas

GET

{{base_url}}/api/pix-keys

Autenticação

Esta rota exige Bearer Token (sua API Key) no header. Envie EXATAMENTE assim:

Substitua o valor após Bearer pela sua API Key real (vk_live_* produção, vk_test_* sandbox). Crie a chave em https://app.dotfy.com.br/dashboard/chaves-api. Sem o header → 401. Com chave inválida/revogada → 401. Com chave sem o escopo necessário → 403 insufficient_scope.

Escopo: pix-keys:read.

Requisição

Parâmetros Header

Respostas

🟢200

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff '{{base_url}}/api/pix-keys' \
--header 'Authorization: Bearer {{api_key}}'

Response Example

{
  "pixKeys": [
    {
      "id": "clpix0001",
      "type": "CNPJ",
      "key": "12345678000190",
      "name": "Conta principal",
      "isDefault": true,
      "isVerified": true,
      "status": "APPROVED",
      "rejectionReason": null,
      "createdAt": "2026-04-01T10:00:00.000Z"
    }
  ]
}

Modificado em 2026-05-07 16:12:35

Listar chaves PIX cadastradas

Autenticação#

Requisição

Respostas

Autenticação