Skip to main content
Chaves PIX são os identificadores que permitem receber transferências PIX na sua conta. Você pode cadastrar, consultar e remover chaves diretamente pela API.

​
O que você pode fazer

  • Cadastrar chaves dos tipos DOCUMENT, EMAIL, PHONE e RANDOM
  • Listar e consultar as chaves ativas da conta
  • Remover chaves quando não forem mais necessárias

​
Tipos de chave

TipoDescrição
DOCUMENTCPF (11 dígitos, ex: 52998224725) ou CNPJ (14 dígitos, ex: 12345678000100)
EMAILEndereço de e-mail (ex: [email protected]) — requer código de autenticação
PHONENúmero de telefone com código do país (ex: +5511999999999) — requer código de autenticação
RANDOMChave aleatória (UUID, ex: 550e8400-e29b-41d4-a716-446655440000)

​
Limites

  • Máximo de 3 chaves por tipo por conta
  • Chaves do tipo EMAIL e PHONE exigem verificação prévia via código de autenticação
  • Alguns providers não suportam chaves EMAIL e PHONE

​
Referência da API

Listar Chaves PIX

GET /api/v1/pix-keys

Buscar Chave PIX

GET /api/v1/pix-keys/{key}

Criar Chave PIX

POST /api/v1/pix-keys

Remover Chave PIX

DELETE /api/v1/pix-keys/{key}

​
Receitas

Criar chave PIX

Cadastre uma chave simples ou siga o fluxo de verificação para EMAIL e PHONE