Pular para o conteúdo principal
GET
/
v1
/
entries
Listar chaves
curl --request GET \
  --url https://plugin-br-pix-direct-jd.sandbox.lerian.net/v1/entries \
  --header 'Authorization: Bearer <token>'
[
  {
    "key": "+5511987654321",
    "status": 1,
    "statusDescription": "ACTIVE",
    "comment": "status 1 = ACTIVE - phone key is active and operational"
  },
  {
    "key": "user@example.com",
    "status": 1,
    "statusDescription": "ACTIVE",
    "comment": "status 1 = ACTIVE - email key is active and operational"
  },
  {
    "key": "12345678901",
    "status": 0,
    "statusDescription": "FINALIZED",
    "comment": "status 0 = FINALIZED - CPF key pending confirmation"
  }
]

Autorizações

​
Authorization
string
header
obrigatório

Autenticacao por token JWT Bearer. Obtenha o token no endpoint /v1/login/oauth/access_token usando credenciais do cliente (clientId e clientSecret).

Inclua o token no header Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

O token expira apos 3600 segundos (1 hora).

Parâmetros de consulta

​
account_id
string<uuid>

Identificador da conta.

Resposta

Chaves PIX recuperadas com sucesso

​
key
string
obrigatório

Valor da chave PIX.

Exemplo:

"+5511987654321"

​
status
enum<integer>
obrigatório

Codigo de status de registro da chave PIX. Indica o estado atual de uma chave PIX em seu ciclo de vida.

Valores validos:

  • -1 = CANCELLED (Registro da chave foi cancelado)
  • 0 = FINALIZED (Chave finalizada/aguardando confirmacao)
  • 1 = ACTIVE (Chave ativa e operacional)
  • 2 = WAITING_OWNERSHIP_CONFIRMATION (Aguardando confirmacao de propriedade do usuario)
  • 3 = CREATING (Chave esta sendo criada no sistema)
  • 4 = IM_CLAIMER_PENDING_CONFIRM_CLAIM_REQUEST (Sou reivindicador, aguardando confirmacao da reivindicacao)
  • 5 = IM_CLAIMER_PENDING_OWNER_GIVEWAY (Sou reivindicador, aguardando proprietario atual liberar a chave)
  • 6 = IM_OWNER_PENDING_GIVEAWAY_CONFIRM (Sou proprietario, aguardando aprovacao para transferir a chave)
  • 7 = IM_CLAIMER_AND_OWNER_GAVEAWAY_PENDING_MY_CONFIRM (Transferencia iniciada, aguardando minha confirmacao)
Opções disponíveis:
-1,
0,
1,
2,
3,
4,
5,
6,
7
Exemplo:

1

​
statusDescription
string
obrigatório

Descricao legivel do status correspondente ao codigo de status numerico.

Exemplo:

"REGISTERED"