Chaves PIX

Lista as chaves PIX registradas na conta associada a API Key.

Endpoint

GET /api/v2/external/pix/keys

Headers

Header	Tipo	Obrigatorio	Descricao
Authorization	String	Sim	Bearer {access_token}

Exemplo

curl -X GET https://api.owem.com.br/api/v2/external/pix/keys \
  -H "Authorization: Bearer $TOKEN"

Resposta de Sucesso (200)

{
  "worked": true,
  "keys": [
    {
      "key": "12345678901",
      "key_type": "cpf",
      "status": "active",
      "created_at": "2026-02-05T12:00:00Z"
    },
    {
      "key": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "key_type": "evp",
      "status": "active",
      "created_at": "2026-02-10T14:30:00Z"
    },
    {
      "key": "contato@empresa.com.br",
      "key_type": "email",
      "status": "active",
      "created_at": "2026-02-15T09:00:00Z"
    }
  ]
}

Campo	Tipo	Descricao
worked	Boolean	true indica sucesso na operacao
keys	Array	Lista de chaves PIX da conta
keys[].key	String	Valor da chave PIX
keys[].key_type	String	Tipo da chave (veja tabela abaixo)
keys[].status	String	Status atual da chave
keys[].created_at	String	Data de registro (ISO 8601)

Tipos de Chave

Tipo	Formato	Exemplo
cpf	11 digitos	12345678901
cnpj	14 digitos	12345678000190
email	E-mail valido	contato@empresa.com.br
phone	+55 + DDD + numero	+5511999998888
evp	UUID v4 (chave aleatoria)	a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d

Status da Chave

Status	Descricao
active	Chave ativa e operacional
pending	Registro em processamento no DICT
portability	Em processo de portabilidade

Resposta de Erro (401)

{
  "worked": false,
  "detail": "Token invalido ou expirado"
}

Limites por tipo de chave

Contas PF: ate 5 chaves. Contas PJ: ate 20 chaves. Apenas 1 chave CPF/CNPJ por conta e permitida.