Lista, de forma paginada, as chaves Pix vinculadas à conta autenticada.
Use status para filtrar por um único estado ou statusList para consultar múltiplos estados na mesma requisição, separados por vírgula.
A resposta informa o estado atual de cada chave e, quando aplicável, se ela pode ser removida por meio de canBeDeleted e o motivo da restrição em cannotBeDeletedReason. Quando retornado, qrCode contém a imagem em Base64 e o payload Pix Copia e Cola associado à chave.
Estado da chaveChaves em estados como
AWAITING_ACTIVATION,AWAITING_DELETIONouERRORpodem exigir uma nova consulta antes de ações que dependam do estado atual.Antes de remover uma chave, valide
canBeDeletede, quando a remoção não estiver disponível, consultecannotBeDeletedReason.
Para consultar uma chave específica pelo ID, utilize Recuperar uma única chave.
Conteúdos relacionados
Guides
Biblioteca de Erros
Forbidden. Ocorre quando o body da requisição está preenchido, chamadas de método GET precisam ter um body vazio.