Menu
Documentation
Documentation /Listar acessos de conta
API reference Producao Sandbox mTLS + JWT

Listar acessos de conta

Endpoint GET /hb/multi-access/accounts

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 acessos de conta

Endpoint: GET /hb/multi-access/accounts

Aviso de habilitacao obrigatoria

Este fluxo de Multi Acesso depende de aprovacao interna e reuniao tecnica com o time de tecnologia. Somente apos o alinhamento devem ser enviados/configurados IDs, chaves e secrets necessarios da integracao.

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/multi-access/accounts

  • Autenticacao: Bearer JWT obrigatorio
  • Contexto de conta: Exige conta ativa quando aplicavel
  • Roles: Nao declarado
  • Scopes: account.read

Request

Path params

Nao possui.

Query params

DTO: ListAccountAccessQueryDto

CampoTipoObrigatorioDetalhes
statusenumNaoValores permitidos: PENDING, ACTIVE, BLOCKED, REVOKED, INVITATION_REVOKED
accessProfileIdstringNao-
searchstringNao-
pagestringNao-
fintechIdstringNao-
limitstringNao-
includeRevokedbooleanNao-

Nao possui.

Body

Nao possui body tipado via DTO.

Headers

  • Authorization: Bearer <jwt>: obrigatorio.

Exemplos de requisicao

bash
curl -X GET "https://uzepay-mtls.deploy.pixland.com.br/hb/multi-access/accounts?status=ACTIVE&accessProfileId=123&search=string_exemplo" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer SEU_JWT"

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/multi-access/accounts",
  "details": []
}