PIX

Listar minhas chaves

Retorna as chaves PIX da sua própria conta. Use-as para receber por chave ou para preencher o campo pix_key ao criar uma cobrança.

GET/v1/pix/keys

Headers

x-api-keystringobrigatório

Sua chave de API com escopo pix:read.

Campos de cada chave

idstringopcional

Identificador (UUID) da chave na Onnix.

typestringopcional

cpf, cnpj, email, phone ou evp (chave aleatória).

keystring | nullopcional

O valor da chave. Vem null enquanto uma chave aleatória (evp) ainda não foi devolvida pelo provedor.

statusstringopcional

pending (aguardando o provedor), active (utilizável) ou removed.

created_atstringopcional

Data de criação (ISO 8601).

Somente leitura

Criar e remover chaves continua no painel da Onnix. Chaves de e-mail e telefone exigem confirmar um código enviado ao próprio contato, uma etapa que não cabe numa integração servidor a servidor.

Requisição

curl https://apiv2.onnixpay.com/v1/pix/keys \
  -H "x-api-key: sk_live_sua_chave_aqui"

Resposta

{
  "object": "list",
  "data": [
    {
      "id": "019e9045-8a9b-7f76-9017-297fcf4fd5cf",
      "object": "pix_key",
      "type": "evp",
      "key": "8f2c1d7e-4b3a-49f1-9c62-0a5d7e1b8f34",
      "status": "active",
      "created_at": "2026-06-04T01:35:37.115Z"
    },
    {
      "id": "019e6ae7-7945-7c29-b346-341f14a86a7a",
      "object": "pix_key",
      "type": "email",
      "key": "contato@lojadojoao.com",
      "status": "active",
      "created_at": "2026-05-27T19:26:55.299Z"
    }
  ],
  "has_more": false
}

AnteriorConsultar chave (DICT)Próximo Consultar saldo