Menu
Documentation
Documentation /Listar chaves PIX
API reference Producao Sandbox mTLS + JWT

Listar chaves PIX

Endpoint GET /hb/pix/keys

Mesmo contrato

Sandbox e producao seguem a mesma referencia funcional para integracao.

Credencial separada

Cada ambiente exige token e certificado emitidos especificamente para ele.

Leitura operacional

Consulte autenticacao, seguranca e fluxos de accounts sem trocar de referencia.

Listar chaves PIX

Endpoint: GET /hb/pix/keys

Formato padrao de resposta

Envelope de sucesso (interceptor global):

{
  "status_code": 200,
  "success": true,
  "message": "OK",
  "data": {}
}

Envelope de erro (filtro global):

{
  "status_code": 400,
  "code": "VALIDATION_ERROR",
  "message": "Erro de validacao",
  "timestamp": "2026-02-13T00:00:00.000Z",
  "path": "/exemplo",
  "details": []
}

GET /hb/pix/keys

  • Autenticacao: Bearer JWT obrigatorio
  • Contexto de conta: Exige conta ativa quando aplicavel
  • Roles: FINTECH, OPERADOR, ADMIN, GERENTE
  • Scopes: pix.entries.read

Request

Path params

Nao possui.

Query params

Nao possui.

Body

Nao possui body tipado via DTO.

Headers

  • Authorization: Bearer <jwt>: obrigatorio.
  • x-account-id: obrigatorio para informar a conta do contexto da operacao.

Exemplos de requisicao

bash
curl -X GET "https://uzepay-mtls.deploy.pixland.com.br/hb/pix/keys" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer SEU_JWT" \
  -H "x-account-id: SEU_ACCOUNT_ID"

Response

Data (schema)

Nao tipado no retorno do controller. Informe um tipo de retorno para documentar automaticamente.

Sucesso (200):

{
  "status_code": 200,
  "success": true,
  "message": "OK",
  "data": "<resultado da operacao>"
}

Erro (contrato padrao):

{
  "status_code": 400,
  "code": "VALIDATION_ERROR",
  "message": "Erro de validacao",
  "timestamp": "2026-02-13T00:00:00.000Z",
  "path": "/hb/pix/keys",
  "details": []
}